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

AudioPlayer Class

Custom MonoBehaviour audio player that handles some custom method handling
Meta::Voice::Audio::AudioPlayer extends MonoBehaviour.
Meta::Voice::Audio::AudioPlayer extends Meta.Voice.Audio.IAudioPlayer.

Overview

Properties

IAudioClipStream
The currently playing clip stream
abstract int
The currently elapsed sample count

Data Fields

bool
Whether the player is currently playing back audio

Public Member Functions

abstract void
Init ( )
Performs all player initialization
abstract 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
abstract void
Pause ( )
Performs a pause if the current clip is playing
abstract void
Resume ( )
Performs a resume if the current clip is paused
void
Stop ( )
Stops playback & removes the current clip reference

Object Data

abstract void
Play
( int offsetSamples )
Performs playback starting with a specific sample

Details

Properties

IAudioClipStream Meta.Voice.Audio.AudioPlayer.ClipStream
The currently playing clip stream
abstract int Meta.Voice.Audio.AudioPlayer.ElapsedSamples
The currently elapsed sample count

Fields

virtual bool Meta.Voice.Audio.AudioPlayer.IsPlaying
Whether the player is currently playing back audio

Member Functions

abstract void Meta.Voice.Audio.AudioPlayer.Init ( )
Performs all player initialization
abstract string Meta.Voice.Audio.AudioPlayer.GetPlaybackErrors ( )
A string returned to describe any reasons playback is currently unavailable
void Meta.Voice.Audio.AudioPlayer.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
abstract void Meta.Voice.Audio.AudioPlayer.Pause ( )
Performs a pause if the current clip is playing
abstract void Meta.Voice.Audio.AudioPlayer.Resume ( )
Performs a resume if the current clip is paused
virtual void Meta.Voice.Audio.AudioPlayer.Stop ( )
Stops playback & removes the current clip reference

Object Data

abstract void Meta.Voice.Audio.AudioPlayer.Play
( int offsetSamples )
Performs playback starting with a specific sample
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)
© 2026 Meta