Class ChannelConfig
Channel configuration.
Inheritance
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class ChannelConfig
Properties
AudioMuted
Gets or sets whether to mute or unmute audio.
Declaration
public bool? AudioMuted { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
AudioUnmuteDisabled
Gets or sets whether to disable audio unmuting.
Declaration
public bool? AudioUnmuteDisabled { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
EnableRtmp
Gets or sets whether to enable rtmp.
Declaration
public bool? EnableRtmp { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
ExcludedClientIds
Gets or sets the client identifiers to exclude.
Declaration
public string[] ExcludedClientIds { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
ExcludedConnectionIds
Gets or sets the connection identifiers to exclude.
Declaration
public string[] ExcludedConnectionIds { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
ExcludedDeviceIds
Gets or sets the device identifiers to exclude.
Declaration
public string[] ExcludedDeviceIds { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
ExcludedUserIds
Gets or sets the user identifiers to exclude.
Declaration
public string[] ExcludedUserIds { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
Recording
Gets or sets whether to enable recording.
Declaration
public bool? Recording { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
RecordingMode
Gets or sets the mode for the recording, if recording is being enabled.
Declaration
public string RecordingMode { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RecordingTag
Gets or sets the tag for the recording, if recording is being enabled.
Declaration
public string RecordingTag { get; set; }
Property Value
Type | Description |
---|---|
System.String |
VideoMuted
Gets or sets whether to mute or unmute video.
Declaration
public bool? VideoMuted { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
VideoUnmuteDisabled
Gets or sets whether to disable video unmuting.
Declaration
public bool? VideoUnmuteDisabled { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
Methods
FromJson(String)
Deserializes a channel configuration from JSON.
Declaration
public static ChannelConfig FromJson(string channelConfigJson)
Parameters
Type | Name | Description |
---|---|---|
System.String | channelConfigJson | The channel configuration as JSON. |
Returns
Type | Description |
---|---|
ChannelConfig | The channel configuration. |
ToJson()
Serializes this channel configuration to JSON.
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
System.String | The channel configuration as JSON. |
ToJson(ChannelConfig)
Serializes a channel configuration to JSON.
Declaration
public static string ToJson(ChannelConfig channelConfig)
Parameters
Type | Name | Description |
---|---|---|
ChannelConfig | channelConfig | The channel configuration. |
Returns
Type | Description |
---|---|
System.String | The channel configuration as JSON. |