API reference

BaseAudioSystem Class

Extends MonoBehaviour
Implements Meta.Voice.Audio.IAudioSystem
An abstract audio system class that defaults to use RawAudioClipStream and

Fields

clipPreloadCount : int
Number of audio clip streams to pool immediately on awake.
Signature 
int Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.clipPreloadCount
maxLength : float
Maximum length of audio clip stream in seconds.
Signature 
float Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.maxLength
readyLength : float
Total seconds of audio required before OnReady callbacks occur.
Signature 
float Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.readyLength

Protected Methods

Awake ()
Preload clips into audio clip cache
Signature 
virtual void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.Awake()
Returns
void
GenerateClip ()
Abstract method for generating new audio clip streams
Signature 
abstract TAudioClipStream Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GenerateClip()
Returns
abstract TAudioClipStream
OnDestroy ()
Destroy all audio clips in the cache
Signature 
virtual void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.OnDestroy()
Returns
void

Methods

DestroyClipCache ()
Destroys all generated TAudioClipStreams
Signature 
void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.DestroyClipCache()
Returns
void
GetAudioClipStream ( channels , sampleRate )
Returns a new audio clip stream for audio stream handling
Signature 
IAudioClipStream Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GetAudioClipStream(int channels, int sampleRate)
Parameters
channels: int  Number of channels within audio
sampleRate: int  Desired rate of playback
Returns
IAudioClipStream
GetAudioPlayer ( root )
Returns a new audio player for managing audio clip stream playback states
Signature 
IAudioPlayer Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GetAudioPlayer(GameObject root)
Parameters
root: GameObject  The gameobject to add the player to if applicable
Returns
IAudioPlayer
PreloadClipCache ( count )
Ensures the specified amount of TAudioClipStreams are generated and ready for use
Signature 
void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.PreloadClipCache(int count)
Parameters
count: int
Returns
void
Nav Logo
English (US)
© 2026 Meta