Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AudioClip

class in UnityEngine

/

Inherits from: Object

Suggest a change

Success!

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

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.

Variables

channelsThe number of channels in the audio clip. (Read Only)
frequencyThe sample frequency of the clip in Hertz. (Read Only)
lengthThe length of the audio clip in seconds. (Read Only)
loadInBackgroundCorresponding to the "Load In Background" flag in the inspector, when this flag is set, the loading will happen delayed without blocking the main thread.
loadStateReturns the current load state of the audio data associated with an AudioClip.
loadTypeThe load type of the clip (read-only).
preloadAudioDataPreloads 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.
samplesThe length of the audio clip in samples. (Read Only)

Public Functions

GetDataFills an array with sample data from the clip.
LoadAudioDataLoads the audio data of a clip. Clips that have "Preload Audio Data" set will load the audio data automatically.
SetDataSet sample data in a clip.
UnloadAudioDataUnloads the audio data associated with the clip. This works only for AudioClips that are based on actual sound file assets.

Delegates

PCMReaderCallbackDelegate called each time AudioClip reads data.
PCMSetPositionCallbackDelegate called each time AudioClip changes read position.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.