API reference
UnityAudioPlayer Class
Extends BaseAudioPlayer, IAudioSourceProvider
Unity specific audio player that will play any IAudioClipStream that includes an IAudioClipProvider or RawAudioClipStreams via AudioClip streaming.
Fields
AudioSource AudioSource[Get]
bool CloneAudioSource[Get]
override bool IsPlaying[Get]
Whether the player is currently playing back audio
override bool CanSetElapsedSamples[Get]
Elapsed samples can be used if not using a clip buffer
override int ElapsedSamples[Get]
Use time samples directly if possible, otherwise leave it to TTS to determine elapsed samples
Member Functions
virtual override void Init ( )
Performs all player initialization
virtual override string GetPlaybackErrors ( )
A string returned to describe any reasons playback is currently unavailable
virtual override void Pause ( )
Performs a pause if the current clip is playing
virtual override void Resume ( )
Performs a resume if the current clip is paused
virtual override void Stop ( )
Stops playback & removes the current clip reference
Protected Functions
virtual AudioClip CreateStreamedClip
( int offset,
int channels,
int sampleRate )
Get local audio clip
virtual override void Play
( int offsetSamples )
Sets audio clip via an IAudioClipProvider or generates one if using a RawAudioClipStream. Then begins playback at a specified offset.
Parameters
offsetSamples
The starting offset of the clip in samples
virtual void OnDestroy ( )
Destroy clip if applicable
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta