Our new developer documentation is now available. Please check it out!

PlaybackStream

public class PlaybackStream : MediaStream, IDisposable

Representation of a read only audio stream

Public Methods

Name	Description
AudioPushData	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataTask	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataAsync	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioReset	This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Boolean	Indicates wether or not the media stream handle is invalid or closed

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler