API reference
API reference
Select your platform
No SDKs available
No versions available

IAudioPlayer Interface

An interface for performing playback and interactions for an audio clip

Properties

CanSetElapsedSamples : bool
[Get]
Whether or not elapsed samples can be determined from this audio player
Signature 
bool Meta.Voice.Audio.IAudioPlayer.CanSetElapsedSamples
ClipStream : IAudioClipStream
[Get]
The currently playing clip stream
Signature 
IAudioClipStream Meta.Voice.Audio.IAudioPlayer.ClipStream
ElapsedSamples : int
[Get]
The currently elapsed sample count
Signature 
int Meta.Voice.Audio.IAudioPlayer.ElapsedSamples
IsPlaying : bool
[Get]
Whether the player is currently playing back audio
Signature 
bool Meta.Voice.Audio.IAudioPlayer.IsPlaying

Methods

GetPlaybackErrors ()
A string returned to describe any reasons playback is currently unavailable
Signature 
string Meta.Voice.Audio.IAudioPlayer.GetPlaybackErrors()
Returns
string
Init ()
Called once to perform all player initialization
Signature 
void Meta.Voice.Audio.IAudioPlayer.Init()
Returns
void
Pause ()
Performs a pause if the current clip is playing
Signature 
void Meta.Voice.Audio.IAudioPlayer.Pause()
Returns
void
Play ( clipStream , offsetSamples )
Stops previous playback if applicable, sets clip stream and begins local playback
Signature 
void Meta.Voice.Audio.IAudioPlayer.Play(IAudioClipStream clipStream, int offsetSamples)
Parameters
clipStream: IAudioClipStream  The clip stream to be played
offsetSamples: int  The starting offset of the clip
Returns
void
Resume ()
Performs a resume if the current clip is paused
Signature 
void Meta.Voice.Audio.IAudioPlayer.Resume()
Returns
void
Stop ()
Stops playback & removes the current clip reference
Signature 
void Meta.Voice.Audio.IAudioPlayer.Stop()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta