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

BaseAudioClipStream Class

A simple abstract class that can be used to simplify the code required for a custom IAudioClipStream

Properties

The current number of channels in this audio data stream
A getter for the current sample rate of how many samples per second should be played
A getter for the minimum length in seconds required before the OnStreamReady method is called
Whether or not the stream is ready for playback
Whether or not the stream has been completed
The total number of samples currently added to this stream.
The total number of samples expected from the stream. When streaming, this is not set until the stream is complete.
The callback delegate for stream samples added.
The callback delegate for stream completion once SetContentLength is called & all samples have been added via the AddSamples(float[] samples) method.
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.
The callback delegate for stream completion once SetContentLength is called & all samples have been added via the AddSamples(float[] samples) method.
The callback when the stream has unloaded all data

Fields

The maximum known total of samples currently in this stream.
The length of the stream in seconds.

Protected Functions

The constructor that takes in a total channel & sample rate
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
Method for clearing all data
A check if the clip stream has buffered enough to be considered ready
Method that calls OnStreamReady on the main thread
Perform on stream update following ready
Method that calls OnStreamUpdated on the main thread
Method that calls OnStreamComplete on the main thread

Member Functions

Adds a sample buffer to the current stream in its entirety.
Parameters
samples
A buffer of decoded floats that were decoded
offset
The offset of the buffer to be used
length
The total samples to be used
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
Calls to determine if completion method should be called
Called when clip stream should clear ram and ready for re-use

Static Member Functions

Calculates length in seconds based on total samples, channels & samples per second
Did you find this page helpful?
Thumbs up icon
Thumbs down icon