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

Overview

Properties

IAudioClipStream
The currently playing clip stream
bool
Whether the player is currently playing back audio
bool
Whether or not elapsed samples can be determined from this audio player
int
The currently elapsed sample count

Public Member Functions

void
Init ( )
Called once to perform all player initialization
string
A string returned to describe any reasons playback is currently unavailable
void
Play
( IAudioClipStream clipStream,
int offsetSamples )
Stops previous playback if applicable, sets clip stream and begins local playback
void
Pause ( )
Performs a pause if the current clip is playing
void
Resume ( )
Performs a resume if the current clip is paused
void
Stop ( )
Stops playback & removes the current clip reference

Details

Properties

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

Member Functions

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