Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.Close
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.Close
A container for audio data.
An AudioClip stores the audio file either compressed as ogg vorbis or uncompressed.
AudioClips are referenced and used by AudioSources to play sounds.
See Also: AudioClip component in the Components Reference.
|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||Corresponding to the "Load In Background" flag in the inspector, when this flag is set, the loading will happen delayed without blocking the main thread.|
|loadState||Returns the current load state of the audio data associated with an AudioClip.|
|loadType||The load type of the clip (read-only).|
|preloadAudioData||Preloads audio data of the clip when the clip asset is loaded. When this flag is off, scripts have to call AudioClip.LoadAudioData() to load the data before the clip can be played. Properties like length, channels and format are available before the audio data has been loaded.|
|samples||The length of the audio clip in samples. (Read Only)|
|GetData||Fills an array with sample data from the clip.|
|LoadAudioData||Loads the audio data of a clip. Clips that have "Preload Audio Data" set will load the audio data automatically.|
|SetData||Set sample data in a clip.|
|UnloadAudioData||Unloads the audio data associated with the clip. This works only for AudioClips that are based on actual sound file assets.|
|Create||Creates a user AudioClip with a name and with the given length in samples, channels and frequency.|
|PCMReaderCallback||Delegate called each time AudioClip reads data.|
|PCMSetPositionCallback||Delegate called each time AudioClip changes read position.|
|hideFlags||Should the object be hidden, saved with the scene or modifiable by the user?|
|name||The name of the object.|
|GetInstanceID||Returns the instance id of the object.|
|ToString||Returns the name of the game object.|
|Destroy||Removes a gameobject, component or asset.|
|DestroyImmediate||Destroys the object obj immediately. You are strongly recommended to use Destroy instead.|
|DontDestroyOnLoad||Makes the object target not be destroyed automatically when loading a new scene.|
|FindObjectOfType||Returns the first active loaded object of Type type.|
|FindObjectsOfType||Returns a list of all active loaded objects of Type type.|
|Instantiate||Clones the object original and returns the clone.|