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

IAudioClipStream Interface

An interface to be used for audio clip streams. Samples added to this stream are always decoded to 0f - 1f.

Overview

Properties

bool
IsReady[Get]
Whether or not the stream is ready for playback
bool
Whether or not the stream has been completed by receiving the total sample count and applying all samples.
int
A getter for the current number of channels in this audio data stream
int
A getter for the current sample rate of how many samples per second should be played
int
The total number of samples currently added to this stream
int
The total number of samples expected from the stream. When streaming, this is not set until the stream is complete.
int
The maximum known total of samples currently in this stream. Typically Max(AddedSamples, ExpectedSamples)
float
Length[Get]
The known length of the stream in seconds. Typically TotalSamples / (Channels * SampleRate)
float
A getter for the minimum length in seconds required before the stream is considered ready for playback.
The callback delegate for stream ready for playback. This can be set externally but should only be called within the clip stream itself.
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. This can be set externally but should only be called within the clip stream itself.

Public Member Functions

void
AddSamples
( float [] samples )
Adds an array of samples to the current stream
void
SetExpectedSamples
( int expectedSamples )
Calls on occasions where the total samples are known. Either prior to a disk load or following a stream completion.
void
Unload ( )
Called when clip stream should be completely removed from RAM

Details

Properties

bool Meta.Voice.Audio.IAudioClipStream.IsReady
Whether or not the stream is ready for playback
bool Meta.Voice.Audio.IAudioClipStream.IsComplete
Whether or not the stream has been completed by receiving the total sample count and applying all samples.
int Meta.Voice.Audio.IAudioClipStream.Channels
A getter for the current number of channels in this audio data stream
int Meta.Voice.Audio.IAudioClipStream.SampleRate
A getter for the current sample rate of how many samples per second should be played
int Meta.Voice.Audio.IAudioClipStream.AddedSamples
The total number of samples currently added to this stream
int Meta.Voice.Audio.IAudioClipStream.ExpectedSamples
The total number of samples expected from the stream. When streaming, this is not set until the stream is complete.
int Meta.Voice.Audio.IAudioClipStream.TotalSamples
The maximum known total of samples currently in this stream. Typically Max(AddedSamples, ExpectedSamples)
float Meta.Voice.Audio.IAudioClipStream.Length
The known length of the stream in seconds. Typically TotalSamples / (Channels * SampleRate)
float Meta.Voice.Audio.IAudioClipStream.StreamReadyLength
A getter for the minimum length in seconds required before the stream is considered ready for playback.
AudioClipStreamDelegate Meta.Voice.Audio.IAudioClipStream.OnStreamReady
The callback delegate for stream ready for playback. This can be set externally but should only be called within the clip stream itself.
AudioClipStreamDelegate Meta.Voice.Audio.IAudioClipStream.OnStreamUpdated
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 Meta.Voice.Audio.IAudioClipStream.OnStreamComplete
The callback delegate for stream completion once SetContentLength is called & all samples have been added via the AddSamples(float[] samples) method. This can be set externally but should only be called within the clip stream itself.

Member Functions

void Meta.Voice.Audio.IAudioClipStream.AddSamples
( float [] samples )
Adds an array of samples to the current stream
Parameters
samples
A list of decoded floats from 0f to 1f
void Meta.Voice.Audio.IAudioClipStream.SetExpectedSamples
( int expectedSamples )
Calls on occasions 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
void Meta.Voice.Audio.IAudioClipStream.Unload ( )
Called when clip stream should be completely removed from RAM
Did you find this page helpful?
Thumbs up icon
Thumbs down icon