public interface ILocalMedia<TLocalMedia, TIAudioTrack, TIVideoTrack> : IMedia<TIAudioTrack, TIVideoTrack> where TLocalMedia : class where TIAudioTrack : IAudioTrack where TIVideoTrack : IVideoTrack

Type Parameters

Name	Description
TLocalMedia
TIAudioTrack
TIVideoTrack

Properties

AudioEncoding

Gets the first (primary) local audio encoding.

Declaration

AudioEncodingConfig AudioEncoding { get; }

Property Value

Type	Description
AudioEncodingConfig

AudioEncodings

Gets or sets the local audio encodings.

Declaration

AudioEncodingConfig[] AudioEncodings { get; set; }

Property Value

Type	Description
AudioEncodingConfig[]

AudioSimulcastDisabled

Gets or sets whether audio simulcast is disabled.

Declaration

bool AudioSimulcastDisabled { get; set; }

Property Value

Type	Description
System.Boolean

AudioSimulcastEncodingCount

Gets or sets the number of audio simulcast encodings.

Declaration

int AudioSimulcastEncodingCount { get; set; }

Property Value

Type	Description
System.Int32

AudioSimulcastPreferredBitrate

Gets or sets the preferred audio simulcast bitrate, in kbps.

Declaration

int AudioSimulcastPreferredBitrate { get; set; }

Property Value

Type	Description
System.Int32

AudioSourceInput

Gets or sets the current audio source input of the first audio track.

Declaration

SourceInput AudioSourceInput { get; set; }

Property Value

Type	Description
SourceInput

State

Gets the current state.

Declaration

LocalMediaState State { get; }

Property Value

Type	Description
LocalMediaState

VideoEncoding

Gets the first (primary) local video encoding.

Declaration

VideoEncodingConfig VideoEncoding { get; }

Property Value

Type	Description
VideoEncodingConfig

VideoEncodings

Gets or sets the local video encodings.

Declaration

VideoEncodingConfig[] VideoEncodings { get; set; }

Property Value

Type	Description
VideoEncodingConfig[]

VideoSimulcastBitsPerPixel

Gets or sets the desired video simulcast bits-per-pixel (bpp).

Declaration

double VideoSimulcastBitsPerPixel { get; set; }

Property Value

Type	Description
System.Double

VideoSimulcastDegradationPreference

Gets or sets the video simulcast degradation preference.

Declaration

VideoDegradationPreference VideoSimulcastDegradationPreference { get; set; }

Property Value

Type	Description
VideoDegradationPreference

VideoSimulcastDisabled

Gets or sets whether video simulcast is disabled.

Declaration

bool VideoSimulcastDisabled { get; set; }

Property Value

Type	Description
System.Boolean

VideoSimulcastEncodingCount

Gets or sets the number of video simulcast encodings.

Declaration

int VideoSimulcastEncodingCount { get; set; }

Property Value

Type	Description
System.Int32

VideoSimulcastPreferredBitrate

Gets or sets the preferred video simulcast bitrate, in kbps.

Declaration

int VideoSimulcastPreferredBitrate { get; set; }

Property Value

Type	Description
System.Int32

VideoSourceInput

Gets or sets the current video source input of the first video track.

Declaration

SourceInput VideoSourceInput { get; set; }

Property Value

Type	Description
SourceInput

Methods

ChangeAudioSourceInput(SourceInput)

Changes the audio source input of the first audio track while the media is active.

Declaration

Future<object> ChangeAudioSourceInput(SourceInput audioSourceInput)

Parameters

Type	Name	Description
SourceInput	audioSourceInput	The audio source input.

Returns

Type	Description
Future<System.Object>

ChangeVideoSourceInput(SourceInput)

Changes the video source input of the first video track while the media is active.

Declaration

Future<object> ChangeVideoSourceInput(SourceInput videoSourceInput)

Parameters

Type	Name	Description
SourceInput	videoSourceInput	The video source input.

Returns

Type	Description
Future<System.Object>

GetAudioSourceInputs()

Gets the available audio source inputs of the first audio track.

Declaration

Future<SourceInput[]> GetAudioSourceInputs()

Returns

Type	Description
Future<SourceInput[]>	A future with an array of audio source inputs.

GetVideoSourceInputs()

Gets the available video source inputs of the first video track.

Declaration

Future<SourceInput[]> GetVideoSourceInputs()

Returns

Type	Description
Future<SourceInput[]>	A future with an array of video source inputs.

Start()

Starts the media track sources.

Declaration

Future<TLocalMedia> Start()

Returns

Type	Description
Future<TLocalMedia>

Stop()

Stops the media track sources.

Declaration

Future<TLocalMedia> Stop()

Returns

Type	Description
Future<TLocalMedia>

Events

OnAudioMuted

Raised when the audio track is muted.

Declaration

event Action0 OnAudioMuted

Event Type

Type	Description
Action0

OnAudioStarted

Raised when the audio track is started.

Declaration

event Action0 OnAudioStarted

Event Type

Type	Description
Action0

OnAudioStopped

Raised when the audio track is stopped.

Declaration

event Action0 OnAudioStopped

Event Type

Type	Description
Action0

OnAudioUnmuted

Raised when the audio track is unmuted.

Declaration

event Action0 OnAudioUnmuted

Event Type

Type	Description
Action0

OnVideoMuted

Raised when the video track is muted.

Declaration

event Action0 OnVideoMuted

Event Type

Type	Description
Action0

OnVideoStarted

Raised when the video track is started.

Declaration

event Action0 OnVideoStarted

Event Type

Type	Description
Action0

OnVideoStopped

Raised when the video track is stopped.

Declaration

event Action0 OnVideoStopped

Event Type

Type	Description
Action0

OnVideoUnmuted

Raised when the video track is unmuted.

Declaration

event Action0 OnVideoUnmuted

Event Type

Type	Description
Action0