Class MediaStreamInfo
Media stream information.
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class MediaStreamInfo : StreamInfo
Properties
ControlTransportId
Gets or sets the control transport id.
This will be null
if BUNDLE is active.
Declaration
public string ControlTransportId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Direction
Gets or sets the media stream direction.
Declaration
public string Direction { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LocalBandwidth
Gets or sets the media stream's local bandwidth.
Declaration
public int LocalBandwidth { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
MaxFrameHeight
Gets or sets the media stream's maximum frame height.
Declaration
public int MaxFrameHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
MaxFrameWidth
Gets or sets the media stream's maximum frame width.
Declaration
public int MaxFrameWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ReceiveContent
Gets or sets the media stream's receive content.
Declaration
public string ReceiveContent { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ReceiveDisabled
Gets or sets whether the media stream has the receive direction disabled.
Declaration
public bool ReceiveDisabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ReceiveEncodings
Gets or sets the media stream receive encodings.
Declaration
public EncodingInfo[] ReceiveEncodings { get; set; }
Property Value
Type | Description |
---|---|
EncodingInfo[] |
ReceiveFormats
Gets or sets the media stream receive formats.
Declaration
public FormatInfo[] ReceiveFormats { get; set; }
Property Value
Type | Description |
---|---|
FormatInfo[] |
Receiver
Gets or sets the first media stream receiver information.
Declaration
public MediaReceiverInfo Receiver { get; }
Property Value
Type | Description |
---|---|
MediaReceiverInfo |
Receivers
Gets or sets the media stream receivers information.
Declaration
public MediaReceiverInfo[] Receivers { get; set; }
Property Value
Type | Description |
---|---|
MediaReceiverInfo[] |
RemoteBandwidth
Gets or sets the media stream's remote bandwidth.
Declaration
public int RemoteBandwidth { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
SendContent
Gets or sets the media stream's send content.
Declaration
public string SendContent { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SendDisabled
Gets or sets whether the media stream has the send direction disabled.
Declaration
public bool SendDisabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SendEncodings
Gets or sets the media stream send encodings.
Declaration
public EncodingInfo[] SendEncodings { get; set; }
Property Value
Type | Description |
---|---|
EncodingInfo[] |
Sender
Gets or sets the first media stream sender information.
Declaration
public MediaSenderInfo Sender { get; }
Property Value
Type | Description |
---|---|
MediaSenderInfo |
Senders
Gets or sets the media stream senders information.
Declaration
public MediaSenderInfo[] Senders { get; set; }
Property Value
Type | Description |
---|---|
MediaSenderInfo[] |
SendFormats
Gets or sets the media stream send formats.
Declaration
public FormatInfo[] SendFormats { get; set; }
Property Value
Type | Description |
---|---|
FormatInfo[] |
SendMuted
Gets or sets whether the sender is muted. Returns true if the sender is muted and false otherwise.
Declaration
public bool SendMuted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SendUnmuteDisabled
Gets or sets whether the sender cannot be unmuted. Returns true if the sender cannot be unmuted and false otherwise.
Declaration
public bool SendUnmuteDisabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
WebSocketStreamId
Gets or sets the WebSocket Stream id.
Declaration
public int WebSocketStreamId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
DeserializeProperties(String, String)
Deserializes the properties.
Declaration
protected override void DeserializeProperties(string key, string valueJson)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The key. |
System.String | valueJson | The value in JSON format. |
Overrides
FromJson(String)
Deserializes an instance from JSON.
Declaration
public static MediaStreamInfo FromJson(string mediaStreamInfoJson)
Parameters
Type | Name | Description |
---|---|---|
System.String | mediaStreamInfoJson | The serialized JSON. |
Returns
Type | Description |
---|---|
MediaStreamInfo | The deserialized instance. |
FromJsonArray(String)
Deserializes an array from JSON.
Declaration
public static MediaStreamInfo[] FromJsonArray(string mediaStreamInfosJson)
Parameters
Type | Name | Description |
---|---|---|
System.String | mediaStreamInfosJson | The serialized JSON. |
Returns
Type | Description |
---|---|
MediaStreamInfo[] | The deserialized array. |
SerializeProperties(Dictionary<String, String>)
Serializes the properties.
Declaration
protected override void SerializeProperties(Dictionary<string, string> jsonObject)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.Dictionary<System.String, System.String> | jsonObject | The JSON object. |
Overrides
ToJson()
Serializes this instance to JSON.
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String |
ToJson(MediaStreamInfo)
Serializes an instance to JSON.
Declaration
public static string ToJson(MediaStreamInfo mediaStreamInfo)
Parameters
Type | Name | Description |
---|---|---|
MediaStreamInfo | mediaStreamInfo | The instance to serialize. |
Returns
Type | Description |
---|---|
System.String | The serialized JSON. |
ToJsonArray(MediaStreamInfo[])
Serializes an array to JSON.
Declaration
public static string ToJsonArray(MediaStreamInfo[] mediaStreamInfos)
Parameters
Type | Name | Description |
---|---|---|
MediaStreamInfo[] | mediaStreamInfos | The array to serialize. |
Returns
Type | Description |
---|---|
System.String | The serialized JSON. |