API reference
BaseAudioClipStream Class
Extends IAudioClipStream
A simple abstract class that can be used to simplify the code required for a custom IAudioClipStream
Properties
int Channels[Get]
The current number of channels in this audio data stream
int SampleRate[Get]
A getter for the current sample rate of how many samples per second should be played
float StreamReadyLength[Get]
A getter for the minimum length in seconds required before the OnStreamReady method is called
float StreamMaxLength[Get]
A getter for the maximum length in seconds allowed for the clip stream. If unlimited, -1 will be returned
bool IsReady[Get]
Whether or not the stream is ready for playback
bool IsComplete[Get]
Whether or not the stream has been completed
int AddedSamples[Get]
The total number of samples currently added to this stream.
int ExpectedSamples[Get]
The total number of samples expected from the stream. When streaming, this is not set until the stream is complete.
AudioClipStreamSampleDelegate OnAddSamples[Get]
The callback delegate for stream samples added.
AudioClipStreamDelegate OnStreamReady[Get]
The callback delegate for stream completion once SetContentLength is called & all samples have been added via the AddSamples(float[] samples) method.
AudioClipStreamDelegate OnStreamUpdated[Get]
The callback delegate for stream update if any additional data such as the AudioClip is expected to update mid stream. This can be set externally but should only be called within the clip stream itself.
AudioClipStreamDelegate OnStreamComplete[Get]
The callback delegate for stream completion once SetContentLength is called & all samples have been added via the AddSamples(float[] samples) method.
AudioClipStreamDelegate OnStreamUnloaded[Get]
The callback when the stream has unloaded all data
Fields
int TotalSamples[Get]
The maximum known total of samples currently in this stream.
float Length[Get]
The length of the stream in seconds.
Protected Functions
BaseAudioClipStream
( int newChannels,
int newSampleRate )
The constructor that takes in a total channel & sample rate
Parameters
newChannels
The channels to be used for streaming
newSampleRate
The new sample rate
BaseAudioClipStream
( int newChannels,
int newSampleRate,
float newStreamReadyLength )
The constructor that takes in a total channel, sample rate & ready length
Parameters
newChannels
The channels to be used for streaming
newSampleRate
The new sample rate
newStreamReadyLength
The minimum length in seconds required before the OnStreamReady method is called
BaseAudioClipStream
( int newChannels,
int newSampleRate,
float newStreamReadyLength,
float newStreamMaxLength )
The constructor that takes in a total channel, sample rate, ready length and max length
Parameters
newChannels
The channels to be used for streaming
newSampleRate
The new sample rate
newStreamReadyLength
The minimum length in seconds required before the OnStreamReady method is called
newStreamMaxLength
If applicable, The maximum length in seconds allowed before this clip audio will be cut off
virtual void Reset ( )
Method for clearing all data
virtual bool IsEnoughBuffered ( )
A check if the clip stream has buffered enough to be considered ready
virtual void RaiseStreamReady ( )
Method that calls OnStreamReady on the main thread
virtual void HandleStreamUpdated ( )
Perform on stream update following ready
virtual void RaiseStreamUpdated ( )
Method that calls OnStreamUpdated on the main thread
virtual void RaiseStreamComplete ( )
Method that calls OnStreamComplete on the main thread
Member Functions
abstract void AddSamples
( float [] samples,
int offset,
int length )
Adds a sample buffer to the current stream in its entirety.
abstract int ReadSamples
( int readOffset,
float [] destinationSamples,
int destinationOffset )
Reads as many samples as possible from the specified read offset into the destination with the specified offset
abstract int ReadSamples
( int readOffset,
AudioClipStreamSampleDelegate onReadSamples )
Reads as many samples as possible from the specified read offset
virtual void 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
virtual void UpdateState ( )
Calls to determine if completion method should be called
virtual void Unload ( )
Called when clip stream should clear ram and ready for re-use
Static Member Functions
static float GetLength
( int totalSamples,
int channels,
int samplesPerSecond )
Calculates length in seconds based on total samples, channels & samples per second
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