API reference
BaseAudioPlayer Class
Extends MonoBehaviour, IAudioPlayer
Custom MonoBehaviour audio player that handles some custom method handling
Properties
Action< float[]> OnPlaySamples[Get]
IAudioClipStream ClipStream[Get]
The currently playing clip stream
WitResponseNode SpeechNode[Get]
Wit response node containing originating speech data of currently playing clip stream.
Fields
bool IsPlaying[Get]
Whether the player is currently playing back audio
bool CanSetElapsedSamples[Get]
Default to not being able to obtain elapsed samples
int ElapsedSamples[Get]
The currently elapsed sample count for accurate sample based animations and determination of playback completion.
Member Functions
abstract void Init ( )
Performs all player initialization
abstract string GetPlaybackErrors ( )
A string returned to describe any reasons playback is currently unavailable
void Play
( IAudioClipStream clipStream,
int offsetSamples,
WitResponseNode speechNode )
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
abstract void Pause ( )
Performs a pause if the current clip is playing
abstract void Resume ( )
Performs a resume if the current clip is paused
virtual void Stop ( )
Stops playback & removes the current clip reference
Protected Functions
abstract void Play
( int offsetSamples )
Performs playback starting with a specific sample
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