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

BaseAudioPlayer Class

Extends MonoBehaviour
Implements Meta.Voice.Audio.IAudioPlayer
Custom MonoBehaviour audio player that handles some custom method handling

Fields

CanSetElapsedSamples : bool
Default to not being able to obtain elapsed samples
Signature 
virtual bool Meta.Voice.Audio.BaseAudioPlayer.CanSetElapsedSamples
ElapsedSamples : int
The currently elapsed sample count for accurate sample based animations and determination of playback completion.
Signature 
virtual int Meta.Voice.Audio.BaseAudioPlayer.ElapsedSamples
IsPlaying : bool
Whether the player is currently playing back audio
Signature 
virtual bool Meta.Voice.Audio.BaseAudioPlayer.IsPlaying

Properties

ClipStream : IAudioClipStream
[Get]
The currently playing clip stream
Signature 
IAudioClipStream Meta.Voice.Audio.BaseAudioPlayer.ClipStream

Protected Methods

Play ( offsetSamples )
Performs playback starting with a specific sample
Signature 
abstract void Meta.Voice.Audio.BaseAudioPlayer.Play(int offsetSamples)
Parameters
offsetSamples: int
Returns
abstract void

Methods

GetPlaybackErrors ()
A string returned to describe any reasons playback is currently unavailable
Signature 
abstract string Meta.Voice.Audio.BaseAudioPlayer.GetPlaybackErrors()
Returns
abstract string
Init ()
Performs all player initialization
Signature 
abstract void Meta.Voice.Audio.BaseAudioPlayer.Init()
Returns
abstract void
Pause ()
Performs a pause if the current clip is playing
Signature 
abstract void Meta.Voice.Audio.BaseAudioPlayer.Pause()
Returns
abstract void
Play ( clipStream , offsetSamples )
Stops previous playback if applicable, sets clip stream and begins local playback
Signature 
void Meta.Voice.Audio.BaseAudioPlayer.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 
abstract void Meta.Voice.Audio.BaseAudioPlayer.Resume()
Returns
abstract void
Stop ()
Stops playback & removes the current clip reference
Signature 
virtual void Meta.Voice.Audio.BaseAudioPlayer.Stop()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta