API reference
IAudioPlayer Interface
An interface for performing playback and interactions for an audio clip
Properties
IAudioClipStream ClipStream[Get]
The currently playing clip stream
bool IsPlaying[Get]
Whether the player is currently playing back audio
bool CanSetElapsedSamples[Get]
Whether or not elapsed samples can be determined from this audio player
int ElapsedSamples[Get]
The currently elapsed sample count
Member Functions
void Init ( )
Called once to perform all player initialization
string GetPlaybackErrors ( )
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
Parameters
clipStream
The clip stream to be played
offsetSamples
The starting offset of the clip
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
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