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

UnityAudioClipStream Class

A class for generating and appending to audio clips while streaming
Meta::Voice::Audio::UnityAudioClipStream extends Meta.Voice.Audio.AudioClipStream.
Meta::Voice::Audio::UnityAudioClipStream extends Meta.Voice.Audio.IAudioClipProvider.
Meta::Voice::Audio::UnityAudioClipStream extends Meta.Voice.Audio.IAudioClipSetter.

Overview

Properties

AudioClip
Clip[Get]
The audio clip to be used for Unity AudioSource playback

Public Member Functions

UnityAudioClipStream
( int newChannels,
int newSampleRate,
float newStreamReadyLength,
float newChunkLength )
Constructor with specific chunk size
bool
SetClip
( AudioClip newClip )
Sets an audio clip & disables adding additional samples
override void
AddSamples
( float [] newSamples )
Adds an array of samples to the current stream
override void
SetExpectedSamples
( int expectedSamples )
Calls on occassions where the total samples are known. Either prior to a disk load or following a stream completion.
override void
Unload ( )
Called when clip stream should be completely removed from ram

Static Public Member Functions

static void
PreloadCachedClips
( int total,
int lengthSamples,
int channels,
int frequency )
Method used to preload clips to improve performance at runtime
static void
Destroy all cached clips

Details

Properties

AudioClip Meta.Voice.Audio.UnityAudioClipStream.Clip
The audio clip to be used for Unity AudioSource playback

Member Functions

Meta.Voice.Audio.UnityAudioClipStream.UnityAudioClipStream
( int newChannels,
int newSampleRate,
float newStreamReadyLength,
float newChunkLength )
Constructor with specific chunk size
Parameters
newChannels
The audio channels/tracks for the incoming audio data
newSampleRate
The sample rate for incoming audio data
newStreamReadyLength
The minimum length in seconds required before the OnStreamReady method is called
newChunkSamples
Samples to increase audio clip by
bool Meta.Voice.Audio.UnityAudioClipStream.SetClip
( AudioClip newClip )
Sets an audio clip & disables adding additional samples
Parameters
newClip
Audio clip to be used for playback
override void Meta.Voice.Audio.UnityAudioClipStream.AddSamples
( float [] newSamples )
Adds an array of samples to the current stream
Parameters
samples
A list of decoded floats from 0f to 1f
override void Meta.Voice.Audio.UnityAudioClipStream.SetExpectedSamples
( int expectedSamples )
Calls on occassions where the total samples are known. Either prior to a disk load or following a stream completion.
Parameters
expectedSamples
The final number of samples expected to be received
override void Meta.Voice.Audio.UnityAudioClipStream.Unload ( )
Called when clip stream should be completely removed from ram

Static Member Functions

static void Meta.Voice.Audio.UnityAudioClipStream.PreloadCachedClips
( int total,
int lengthSamples,
int channels,
int frequency )
Method used to preload clips to improve performance at runtime
Parameters
total
Total clips to preload. This should be the number of clips that could be running at once
static void Meta.Voice.Audio.UnityAudioClipStream.DestroyCachedClips ( )
Destroy all cached clips
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