Class MediaStream

Base stream

Declaration

public abstract class MediaStream : IDisposable

Derived:
OdinNative.Odin.Media.MicrophoneStream, OdinNative.Odin.Media.PlaybackStream

Implements:
Global.IDisposable

Properties

Id

Handle ID

Declaration

public long Id { get; }

MediaConfig

Audio config of the media stream

Declaration

public OdinMediaConfig MediaConfig { get; }

CancellationSource

Control of async read and write tasks

Declaration

public CancellationTokenSource CancellationSource { get; }

IsActive

Indicates wether or not the media stream is active and sending/receiving data

Declaration

public bool IsActive { get; }

HasErrors

Indicates wether or not the last media stream api call result is an error code

Declaration

public bool HasErrors { get; }

IsInvalid

Indicates wether or not the media stream handle is invalid or closed

Declaration

public bool IsInvalid { get; }

Methods

GetMediaId()

Returns the media stream ID and updates OdinNative.Odin.Media.MediaStream.Id.

Declaration

public ushort GetMediaId()

Returns

System.UInt16: id value### GetPeerId() Returns the ID of the peer that own this media stream.

Declaration

public ulong GetPeerId()

Returns

System.UInt64: id### AudioPushData(float[], int) Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Declaration

public virtual void AudioPushData(float[] buffer, int length)

Parameters

Type	Name	Description
System.Single[]	buffer	audio data
System.Int32	length	bytes to write

AudioPushData(float[])

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Declaration

public virtual void AudioPushData(float[] buffer)

Parameters

Type	Name	Description
System.Single[]	buffer	audio data

AudioPushDataTask(float[], CancellationToken)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Declaration

public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

Returns

Global.Task

Parameters

Type	Name	Description
System.Single[]	buffer	interleaved audio data
Global.CancellationToken	cancellationToken

AudioPushDataAsync(float[])

Sends audio data using a custom OdinNative.Odin.Media.MediaStream.CancellationSource. The data has to be interleaved [-1, 1] float data.

Declaration

public virtual void AudioPushDataAsync(float[] buffer)

Parameters

Type	Name	Description
System.Single[]	buffer	interleaved audio data

AudioReset()

Declaration

public abstract bool AudioReset()

Returns

System.Boolean

AudioReadData(float[])

Reads data from the audio stream.

Declaration

public virtual uint AudioReadData(float[] buffer)

Returns

System.UInt32: count of written bytes into buffer

Parameters

Type	Name	Description
System.Single[]	buffer	buffer to write into

AudioStats(out OdinAudioStreamStats)

Retrieves statistics for the specified OdinNative.Odin.Media.MediaStream.

Declaration

public virtual bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.OdinAudioStreamStats	stats	Audio stream statistics

AudioReadData(float[], int)

Reads data from the audio stream.

Declaration

public virtual uint AudioReadData(float[] buffer, int length)

Returns

System.UInt32: count of written bytes into buffer

Parameters

Type	Name	Description
System.Single[]	buffer	buffer to write into
System.Int32	length	bytes to read

AudioReadDataTask(float[], CancellationToken)

Reads data from the audio stream.

Declaration

public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

Returns

Global.Task<System.UInt32>: count of written bytes into buffer

Parameters

Type	Name	Description
System.Single[]	buffer	buffer to write into
Global.CancellationToken	cancellationToken

AudioReadDataAsync(float[])

Read audio data using a custom custom OdinNative.Odin.Media.MediaStream.CancellationSource.

Declaration

public virtual Task<uint> AudioReadDataAsync(float[] buffer)

Returns

Global.Task<System.UInt32>: count of written bytes into buffer

Parameters

Type	Name	Description
System.Single[]	buffer	buffer to write into

AudioResample(float[], uint, out float[], out int)

Set a resampler and resamples a chunk of audio.

Declaration

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)

Returns

System.Boolean: true on success or false if missmatch of capacity i.e. errorcode

Parameters

Type	Name	Description
System.Single[]	input	current buffer
System.UInt32	outputSampleRate	resample samplerate
System.Single[]	output	resampled buffer
System.Int32	capacity	size of resampled buffer

AudioResample(float[], uint, float[], int)

Set a resampler and resamples a chunk of audio.

Declaration

public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Returns

System.UInt32: sample count on success or errorcode on failure

Parameters

Type	Name	Description
System.Single[]	input	source buffer
System.UInt32	outputSampleRate	to samplerate
System.Single[]	output	target buffer
System.Int32	capacity	target capacity

Cancel()

Cancel the custom OdinNative.Odin.Media.MediaStream.CancellationSource.

Declaration

public bool Cancel()

Returns

System.Boolean: true if the token was canceled or false### ToString() Debug

Declaration

public override string ToString()

Returns

System.String: info### Dispose(bool) On dispose will free the stream and resampler

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name
System.Boolean	disposing

~MediaStream()

Default deconstructor

Declaration

protected ~MediaStream()

Dispose()

On dispose will free the stream and resampler

Declaration

public void Dispose()

Implements

• Global.IDisposable