AudioClip
A container for audio data.
Read time 5 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.AudioModule
- Inherits from: AudioResource
- Implements: IAudioGenerator, ICapabilities
public sealed class AudioClip : AudioResource, IAudioGenerator, GeneratorInstance.ICapabilities
Remarks
An AudioClip stores the audio file either compressed as ogg vorbis or uncompressed. AudioClips are referenced and used by AudioSources to play sounds.
Additional Resources: AudioClip component in the Components Reference.
Properties
Property | Description |
|---|---|
| ambisonic | Returns true if this audio clip is ambisonic (read-only). |
| channels | The number of channels in the audio clip. (Read Only) |
| frequency | The sample frequency of the clip in Hertz. (Read Only) |
| length | The length of the audio clip in seconds. (Read Only) |
| loadInBackground | Enable this property to load the AudioClip asynchronously in the background instead of on the main thread. Set this property in the Inspector (Read Only). |
| loadState | Returns the current load state of the audio data associated with an AudioClip. |
| loadType | The load type of the clip (read-only). |
| preloadAudioData | Enable this property in the Inspector to preload audio data from the audio clip when loading the clip Asset (Read Only). |
| samples | The length of the audio clip in samples. (Read Only) |
Methods
Method | Description |
|---|---|
| CreateInstance | Factory method for creating a GeneratorInstance of this clip. |
| GetData | Fills an array with sample data from the audio clip. |
| LoadAudioData | Loads the asset data of an AudioClip into memory, so it will immediately be ready to play. |
| SetData | Fills an audio clip with sample data from an array or Span. Overwrites existing data if necessary. |
| UnloadAudioData | Unloads the audio data associated with the clip. This works only for AudioClips that are based on actual sound file assets. |
Static Methods
Method | Description |
|---|---|
| Create | Creates a user AudioClip with a name and with the given length in samples, channels and frequency. |
Delegates
Delegate | Description |
|---|---|
| AudioClip.PCMReaderCallback | Unity calls this delegate each time AudioClip reads data. |
| AudioClip.PCMSetPositionCallback | Unity calls this delegate each time AudioClip changes read position. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |