Version: Unity 6.1 Beta (6000.1)
LanguageEnglish
  • C#

AudioClip

class in UnityEngine

/

Inherits from:Audio.AudioResource

/

Implemented in:UnityEngine.AudioModule

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

Submission failed

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

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.

Additional resources: AudioClip component in the Components Reference.

Properties

ambisonicReturns true if this audio clip is ambisonic (read-only).
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)
loadInBackgroundEnable this property to load the AudioClip asynchronously in the background instead of on the main thread. Set this property in the Inspector (Read Only).
loadStateReturns the current load state of the audio data associated with an AudioClip.
loadTypeThe load type of the clip (read-only).
preloadAudioDataEnable this property in the Inspector to preload audio data from the audio clip when loading the clip Asset (Read Only).
samplesThe length of the audio clip in samples. (Read Only)

Public Methods

GetDataFills an array with sample data from the audio clip.
LoadAudioDataLoads the asset data of an AudioClip into memory, so it will immediately be ready to play.
SetDataFills an audio clip with sample data from an array or Span. Overwrites existing data if necessary.
UnloadAudioDataUnloads the audio data associated with the clip. This works only for AudioClips that are based on actual sound file assets.

Static Methods

CreateCreates a user AudioClip with a name and with the given length in samples, channels and frequency.

Delegates

PCMReaderCallbackUnity calls this delegate each time AudioClip reads data.
PCMSetPositionCallbackUnity calls this delegate each time AudioClip changes read position.

Inherited Members

Properties

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

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

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.