API reference
UnityAudioPlayer Class
Unity specific audio player that will play any IAudioClipStream that includes an IAudioClipProvider or RawAudioClipStreams via AudioClip streaming.
Meta::Voice::Audio::UnityAudioPlayer extends Meta.Voice.Audio.AudioPlayer.
Meta::Voice::Audio::UnityAudioPlayer extends Meta.Voice.Audio.IAudioSourceProvider.
Overview
Data Fields
AudioSource | AudioSource[Get] |
bool | CloneAudioSource[Get] |
override bool | IsPlaying[Get] Whether the player is currently playing back audio |
override int | ElapsedSamples[Get] The currently elapsed sample count |
Public Member Functions
override void | Init ( ) Performs all player initialization |
override string | A string returned to describe any reasons playback is currently unavailable |
override void | Pause ( ) Performs a pause if the current clip is playing |
override void | Resume ( ) Performs a resume if the current clip is paused |
override void | Stop ( ) Stops playback & removes the current clip reference |
Object Data
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. |
Details
Fields
| AudioSource Meta.Voice.Audio.UnityAudioPlayer.AudioSource |
|---|
No description available.
|
| bool Meta.Voice.Audio.UnityAudioPlayer.CloneAudioSource |
|---|
No description available.
|
| override bool Meta.Voice.Audio.UnityAudioPlayer.IsPlaying |
|---|
Whether the player is currently playing back audio |
| override int Meta.Voice.Audio.UnityAudioPlayer.ElapsedSamples |
|---|
The currently elapsed sample count |
Member Functions
| override void Meta.Voice.Audio.UnityAudioPlayer.Init ( ) |
|---|
Performs all player initialization |
| override string Meta.Voice.Audio.UnityAudioPlayer.GetPlaybackErrors ( ) |
|---|
A string returned to describe any reasons playback is currently unavailable |
| override void Meta.Voice.Audio.UnityAudioPlayer.Pause ( ) |
|---|
Performs a pause if the current clip is playing |
| override void Meta.Voice.Audio.UnityAudioPlayer.Resume ( ) |
|---|
Performs a resume if the current clip is paused |
| override void Meta.Voice.Audio.UnityAudioPlayer.Stop ( ) |
|---|
Stops playback & removes the current clip reference |
Object Data
| override void Meta.Voice.Audio.UnityAudioPlayer.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 |
Did you find this page helpful?
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