public abstract class LocalMediaBase<TLocalMedia, TAudioTrack, TVideoTrack> : Media<TAudioTrack, TVideoTrack>, IMedia<TAudioTrack, TVideoTrack> where TLocalMedia : LocalMediaBase<TLocalMedia, TAudioTrack, TVideoTrack> where TAudioTrack : AudioTrack where TVideoTrack : VideoTrack

Type Parameters

Name	Description
TLocalMedia
TAudioTrack
TVideoTrack

Constructors

LocalMediaBase()

Initializes a new instance of the LocalMediaBase<TLocalMedia, TAudioTrack, TVideoTrack> class.

Declaration

public LocalMediaBase()

Properties

AudioEncoding

Gets the first (primary) local audio encoding.

Declaration

public AudioEncodingConfig AudioEncoding { get; }

Property Value

Type	Description
AudioEncodingConfig

AudioEncodings

Gets or sets the local audio encodings.

Declaration

public AudioEncodingConfig[] AudioEncodings { get; set; }

Property Value

Type	Description
AudioEncodingConfig[]

AudioSimulcastDisabled

Gets or sets whether audio simulcast is disabled.

Declaration

public bool AudioSimulcastDisabled { get; set; }

Property Value

Type	Description
System.Boolean

AudioSimulcastEncodingCount

Gets or sets the number of audio simulcast encodings.

Declaration

public int AudioSimulcastEncodingCount { get; set; }

Property Value

Type	Description
System.Int32

AudioSimulcastPreferredBitrate

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

Declaration

public int AudioSimulcastPreferredBitrate { get; set; }

Property Value

Type	Description
System.Int32

DefaultVideoBitsPerPixel

Gets or sets the default bits-per-pixel for video.

Declaration

public static double DefaultVideoBitsPerPixel { get; set; }

Property Value

Type	Description
System.Double

State

Gets the state.

Declaration

public LocalMediaState State { get; }

Property Value

Type	Description
LocalMediaState

VideoEncoding

Gets the first (primary) local video encoding.

Declaration

public VideoEncodingConfig VideoEncoding { get; }

Property Value

Type	Description
VideoEncodingConfig

VideoEncodings

Gets or sets the local video encodings.

Declaration

public VideoEncodingConfig[] VideoEncodings { get; set; }

Property Value

Type	Description
VideoEncodingConfig[]

VideoSimulcastBitsPerPixel

Gets or sets the desired video simulcast bits-per-pixel (bpp). If this value is set and the video source has declared a target width, height, and frame-rate, encoding bitrates will be automatically calculated using this value instad of using preferred bitrate.

Declaration

public double VideoSimulcastBitsPerPixel { get; set; }

Property Value

Type	Description
System.Double

VideoSimulcastDegradationPreference

Gets or sets the video simulcast degradation preference.

Declaration

public VideoDegradationPreference VideoSimulcastDegradationPreference { get; set; }

Property Value

Type	Description
VideoDegradationPreference

VideoSimulcastDisabled

Gets or sets whether video simulcast is disabled.

Declaration

public bool VideoSimulcastDisabled { get; set; }

Property Value

Type	Description
System.Boolean

VideoSimulcastEncodingCount

Gets or sets the number of video simulcast encodings.

Declaration

public int VideoSimulcastEncodingCount { get; set; }

Property Value

Type	Description
System.Int32

VideoSimulcastPreferredBitrate

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

Declaration

public int VideoSimulcastPreferredBitrate { get; set; }

Property Value

Type	Description
System.Int32

Methods

AbortStart(Promise<TLocalMedia>, Exception)

Aborts the start.

Declaration

protected void AbortStart(Promise<TLocalMedia> promise, Exception exception)

Parameters

Type	Name	Description
Promise<TLocalMedia>	promise	The promise.
Exception	exception	The exception.

DoGetAudioEncodings()

Gets the local audio encodings.

Declaration

protected abstract AudioEncodingConfig[] DoGetAudioEncodings()

Returns

Type	Description
AudioEncodingConfig[]	The local audio encodings.

DoGetVideoEncodings()

Gets the local video encodings.

Declaration

protected abstract VideoEncodingConfig[] DoGetVideoEncodings()

Returns

Type	Description
VideoEncodingConfig[]	The local video encodings.

DoSetAudioEncodings(AudioEncodingConfig[])

Sets the local audio encodings.

Declaration

protected abstract void DoSetAudioEncodings(AudioEncodingConfig[] encodings)

Parameters

Type	Name	Description
AudioEncodingConfig[]	encodings	The local audio encodings.

DoSetVideoEncodings(VideoEncodingConfig[])

Sets the local video encodings.

Declaration

protected abstract void DoSetVideoEncodings(VideoEncodingConfig[] encodings)

Parameters

Type	Name	Description
VideoEncodingConfig[]	encodings	The local video encodings.

DoStart()

Starts the local media.

Declaration

protected abstract Future<TLocalMedia> DoStart()

Returns

Type	Description
Future<TLocalMedia>

DoStop()

Stops the local media.

Declaration

protected abstract Future<TLocalMedia> DoStop()

Returns

Type	Description
Future<TLocalMedia>

LockAudioEncodings()

Locks the audio encodings in prior to initialization.

Declaration

protected void LockAudioEncodings()

LockVideoEncodings()

Locks the video encodings in prior to initialization.

Declaration

protected void LockVideoEncodings()

LockVideoEncodings(VideoType)

Locks the video encodings in prior to initialization.

Declaration

protected void LockVideoEncodings(VideoType sourceType)

Parameters

Type	Name	Description
VideoType	sourceType

LockVideoEncodings(VideoType, Int32, Int32, Double)

Locks the video encodings in prior to initialization.

Declaration

protected void LockVideoEncodings(VideoType sourceType, int sourceWidth, int sourceHeight, double sourceFrameRate)

Parameters

Type	Name	Description
VideoType	sourceType
System.Int32	sourceWidth
System.Int32	sourceHeight
System.Double	sourceFrameRate

Start()

Starts the media track sources.

Declaration

public Future<TLocalMedia> Start()

Returns

Type	Description
Future<TLocalMedia>

Stop()

Stops the media track sources.

Declaration

public Future<TLocalMedia> Stop()

Returns

Type	Description
Future<TLocalMedia>

Implements

IMedia<TIAudioTrack, TIVideoTrack>