Class ChannelClaim

A channel claim.

Inheritance

System.Object

ChannelClaim

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class ChannelClaim : object

Constructors

ChannelClaim(String)

Initializes a new instance of the ChannelClaim class.

Declaration

public ChannelClaim(string id)

Parameters

Type	Name	Description
System.String	id	The channel identifier.

Properties

Action

Gets or sets the action of this channel claim. Possible values are in the ClaimAction class.

Declaration

public string Action { get; set; }

Property Value

Type	Description
System.String

AllowedLayoutPriority

Gets or sets the lowest allowed LayoutPriority. Lower numbers take priority over higher numbers.

Declaration

public int? AllowedLayoutPriority { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

AllowedLayoutZones

Gets or sets the LayoutZones that can be used by upstream connections.

Declaration

public string[] AllowedLayoutZones { get; set; }

Property Value

Type	Description
System.String[]

AudioReceiveWhitelist

Gets or sets a whitelist of roles whose member's audio can be received from. Null disables the whitelist whereas an empty list disables all receiving.

Declaration

public string[] AudioReceiveWhitelist { get; set; }

Property Value

Type	Description
System.String[]

Broadcast

Gets or sets if this is a broadcast channel or not.

Declaration

public bool Broadcast { get; set; }

Property Value

Type	Description
System.Boolean

CanKick

Gets or sets whether the user is authorized kick other users from this channel.

Declaration

public bool CanKick { get; set; }

Property Value

Type	Description
System.Boolean

CanUpdate

Gets or sets whether the user is authorized to update a media server channel.

Declaration

public bool CanUpdate { get; set; }

Property Value

Type	Description
System.Boolean

CanUpdateLayout

Gets or sets whether the user is authorized to update the LayoutZone and LayoutPriority properties on connections.

Declaration

public bool CanUpdateLayout { get; set; }

Property Value

Type	Description
System.Boolean

DataReceiveWhitelist

Gets or sets a whitelist of roles whose member's data can be received from. Null disables the whitelist whereas an empty list disables all receiving.

Declaration

public string[] DataReceiveWhitelist { get; set; }

Property Value

Type	Description
System.String[]

DisableMcu

Gets or sets whether the user is NOT authorized to create MCU connections.

Declaration

public bool DisableMcu { get; set; }

Property Value

Type	Description
System.Boolean

DisablePeer

Gets or sets whether the user is NOT authorized to create peer connections.

Declaration

public bool DisablePeer { get; set; }

Property Value

Type	Description
System.Boolean

DisableRemoteClientEvents

Gets or sets whether to disable remote client join/update/leave messages and events.

Declaration

public bool DisableRemoteClientEvents { get; set; }

Property Value

Type	Description
System.Boolean

DisableRemoteUpstreamConnectionEvents

Gets or sets whether to disable remote connection open/update/close messages and events.

Declaration

public bool DisableRemoteUpstreamConnectionEvents { get; set; }

Property Value

Type	Description
System.Boolean

DisableSendAudio

Gets or sets whether the user is NOT authorized to send audio.

Declaration

public bool DisableSendAudio { get; set; }

Property Value

Type	Description
System.Boolean

DisableSendData

Gets or sets whether the user is NOT authorized to send data.

Declaration

public bool DisableSendData { get; set; }

Property Value

Type	Description
System.Boolean

DisableSendMessage

Gets or sets whether the user is NOT authorized to send messages.

Declaration

public bool DisableSendMessage { get; set; }

Property Value

Type	Description
System.Boolean

DisableSendVideo

Gets or sets whether the user is NOT authorized to send video.

Declaration

public bool DisableSendVideo { get; set; }

Property Value

Type	Description
System.Boolean

DisableSfu

Gets or sets whether the user is NOT authorized to create SFU connections.

Declaration

public bool DisableSfu { get; set; }

Property Value

Type	Description
System.Boolean

EnableHiddenObserverMode

Gets or sets whether to stop remote users from being notified when a local user joins a channel. When set to true, the local user won’t be able to initiate upstreams, send messages, update the channel, or kick users.

Declaration

public bool EnableHiddenObserverMode { get; set; }

Property Value

Type	Description
System.Boolean

Id

Gets or sets the channel identifier.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

VideoReceiveWhitelist

Gets or sets a whitelist of roles whose member's video can be received from. Null disables the whitelist whereas an empty list disables all receiving.

Declaration

public string[] VideoReceiveWhitelist { get; set; }

Property Value

Type	Description
System.String[]

Methods

FromJson(String)

Deserializes a channel claim from JSON.

Declaration

public static ChannelClaim FromJson(string channelClaimJson)

Parameters

Type	Name	Description
System.String	channelClaimJson	The channel claim JSON.

Returns

Type	Description
ChannelClaim

FromJsonArray(String)

Deserializes an array of channel claims from JSON.

Declaration

public static ChannelClaim[] FromJsonArray(string channelClaimsJson)

Parameters

Type	Name	Description
System.String	channelClaimsJson	The channel claims JSON.

Returns

Type	Description
ChannelClaim[]

ToJson()

Serializes this channel claim to JSON.

Declaration

public string ToJson()

Returns

Type	Description
System.String

ToJson(ChannelClaim)

Serializes a channel claim to JSON.

Declaration

public static string ToJson(ChannelClaim channelClaim)

Parameters

Type	Name	Description
ChannelClaim	channelClaim	The channel claim to serialize.

Returns

Type	Description
System.String

ToJsonArray(ChannelClaim[])

Serializes an array of channel claims to JSON.

Declaration

public static string ToJsonArray(ChannelClaim[] channelClaims)

Parameters

Type	Name	Description
ChannelClaim[]	channelClaims	The channel claims.

Returns

Type	Description
System.String