Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta
bool | IsReady[Get] Whether or not the stream is ready for playback |
bool | IsComplete[Get] Whether or not the stream has been completed by receiving the total sample count and applying all samples. |
int | Channels[Get] A getter for 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 |
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. |
int | TotalSamples[Get] 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 | StreamReadyLength[Get] A getter for the minimum length in seconds required before the stream is considered ready for playback. |
OnAddSamples[Get] The callback delegate for stream samples added. | |
OnStreamReady[Get] The callback delegate for stream ready for playback. This can be set externally but should only be called within the clip stream itself. | |
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. | |
OnStreamComplete[Get] 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. |
void | AddSamples ( float [] samples ) Adds an array of samples to the current stream in its entirety. |
void | Adds an array of samples to the current stream using a specified offset & length. |
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 |
| 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. |
| AudioClipStreamSampleDelegate Meta.Voice.Audio.IAudioClipStream.OnAddSamples |
|---|
The callback delegate for stream samples added. |
| 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. |
| void Meta.Voice.Audio.IAudioClipStream.AddSamples ( float [] samples ) |
|---|
Adds an array of samples to the current stream in its entirety. Parameters samples A list of decoded floats from 0f to 1f that will be used in their entirety |
| void Meta.Voice.Audio.IAudioClipStream.AddSamples ( float [] samples, int offset, int length ) |
|---|
Adds an array of samples to the current stream using a specified offset & length. Parameters samples A list of decoded floats from 0f to 1f offsetThe index of samples to begin adding from lengthThe total number of samples that should be added |
| 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 |
