A channel claim. More...

Instance Methods
(NSString *)	- action
	Gets the action of this channel claim. More...

(FMLiveSwitchNullableInt *)	- allowedLayoutPriority
	Gets the lowest allowed LayoutPriority. More...

(NSMutableArray *)	- allowedLayoutZones
	Gets the LayoutZones that can be used by upstream connections. More...

(NSMutableArray *)	- audioReceiveWhitelist
	Gets a whitelist of roles whose member's audio can be received from. More...

(bool)	- broadcast
	Gets if this is a broadcast channel or not. More...

(bool)	- canKick
	Gets whether the user is authorized kick other users from this channel. More...

(bool)	- canUpdate
	Gets whether the user is authorized to update a media server channel. More...

(bool)	- canUpdateLayout
	Gets whether the user is authorized to update the LayoutZone and LayoutPriority properties on connections. More...

(NSMutableArray *)	- dataReceiveWhitelist
	Gets a whitelist of roles whose member's data can be received from. More...

(bool)	- disableMcu
	Gets whether the user is NOT authorized to create MCU connections. More...

(bool)	- disablePeer
	Gets whether the user is NOT authorized to create peer connections. More...

(bool)	- disableRemoteClientEvents
	Gets whether to disable remote client join/update/leave messages and events. More...

(bool)	- disableRemoteUpstreamConnectionEvents
	Gets whether to disable remote connection open/update/close messages and events. More...

(bool)	- disableSendAudio
	Gets whether the user is NOT authorized to send audio. More...

(bool)	- disableSendData
	Gets whether the user is NOT authorized to send data. More...

(bool)	- disableSendMessage
	Gets whether the user is NOT authorized to send messages. More...

(bool)	- disableSendVideo
	Gets whether the user is NOT authorized to send video. More...

(bool)	- disableSfu
	Gets whether the user is NOT authorized to create SFU connections. More...

(bool)	- enableHiddenObserverMode
	Gets whether to stop remote users from being notified when a local user joins a channel. More...

(NSString *)	- id
	Gets the channel identifier. More...

(instancetype)	- initWithId:
	Initializes a new instance of the FMLiveSwitchChannelClaim class. More...

(void)	- setAction:
	Sets the action of this channel claim. More...

(void)	- setAllowedLayoutPriority:
	Sets the lowest allowed LayoutPriority. More...

(void)	- setAllowedLayoutZones:
	Sets the LayoutZones that can be used by upstream connections. More...

(void)	- setAudioReceiveWhitelist:
	Sets a whitelist of roles whose member's audio can be received from. More...

(void)	- setBroadcast:
	Sets if this is a broadcast channel or not. More...

(void)	- setCanKick:
	Sets whether the user is authorized kick other users from this channel. More...

(void)	- setCanUpdate:
	Sets whether the user is authorized to update a media server channel. More...

(void)	- setCanUpdateLayout:
	Sets whether the user is authorized to update the LayoutZone and LayoutPriority properties on connections. More...

(void)	- setDataReceiveWhitelist:
	Sets a whitelist of roles whose member's data can be received from. More...

(void)	- setDisableMcu:
	Sets whether the user is NOT authorized to create MCU connections. More...

(void)	- setDisablePeer:
	Sets whether the user is NOT authorized to create peer connections. More...

(void)	- setDisableRemoteClientEvents:
	Sets whether to disable remote client join/update/leave messages and events. More...

(void)	- setDisableRemoteUpstreamConnectionEvents:
	Sets whether to disable remote connection open/update/close messages and events. More...

(void)	- setDisableSendAudio:
	Sets whether the user is NOT authorized to send audio. More...

(void)	- setDisableSendData:
	Sets whether the user is NOT authorized to send data. More...

(void)	- setDisableSendMessage:
	Sets whether the user is NOT authorized to send messages. More...

(void)	- setDisableSendVideo:
	Sets whether the user is NOT authorized to send video. More...

(void)	- setDisableSfu:
	Sets whether the user is NOT authorized to create SFU connections. More...

(void)	- setEnableHiddenObserverMode:
	Sets whether to stop remote users from being notified when a local user joins a channel. More...

(void)	- setId:
	Sets the channel identifier. More...

(void)	- setVideoReceiveWhitelist:
	Sets a whitelist of roles whose member's video can be received from. More...

(NSString *)	- toJson
	Serializes this channel claim to JSON. More...

(NSMutableArray *)	- videoReceiveWhitelist
	Gets a whitelist of roles whose member's video can be received from. More...

Class Methods
(FMLiveSwitchChannelClaim *)	+ channelClaimWithId:
	Initializes a new instance of the FMLiveSwitchChannelClaim class. More...

(NSMutableArray *)	+ fromJsonArrayWithChannelClaimsJson:
	Deserializes an array of channel claims from JSON. More...

(FMLiveSwitchChannelClaim *)	+ fromJsonWithChannelClaimJson:
	Deserializes a channel claim from JSON. More...

(NSString *)	+ toJsonArrayWithChannelClaims:
	Serializes an array of channel claims to JSON. More...

(NSString *)	+ toJsonWithChannelClaim:
	Serializes a channel claim to JSON. More...

Detailed Description

A channel claim.

Method Documentation

◆ action

- (NSString*) action

Gets the action of this channel claim.

Possible values are in the FMLiveSwitchClaimAction class.

◆ allowedLayoutPriority

- (FMLiveSwitchNullableInt*) allowedLayoutPriority

Gets the lowest allowed LayoutPriority.

Lower numbers take priority over higher numbers.

◆ allowedLayoutZones

- (NSMutableArray*) allowedLayoutZones

Gets the LayoutZones that can be used by upstream connections.

◆ audioReceiveWhitelist

- (NSMutableArray*) audioReceiveWhitelist

Gets a whitelist of roles whose member's audio can be received from.

Null disables the whitelist whereas an empty list disables all receiving.

◆ broadcast

- (bool) broadcast

Gets if this is a broadcast channel or not.

Deprecated:: Will be removed in a future release.

◆ canKick

- (bool) canKick

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

◆ canUpdate

- (bool) canUpdate

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

◆ canUpdateLayout

- (bool) canUpdateLayout

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

◆ channelClaimWithId:

+ (FMLiveSwitchChannelClaim*) channelClaimWithId: (NSString *) idValue

Initializes a new instance of the FMLiveSwitchChannelClaim class.

Parameters

idValue The channel identifier.

◆ dataReceiveWhitelist

- (NSMutableArray*) dataReceiveWhitelist

Gets a whitelist of roles whose member's data can be received from.

Null disables the whitelist whereas an empty list disables all receiving.

◆ disableMcu

- (bool) disableMcu

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

◆ disablePeer

- (bool) disablePeer

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

◆ disableRemoteClientEvents

- (bool) disableRemoteClientEvents

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

◆ disableRemoteUpstreamConnectionEvents

- (bool) disableRemoteUpstreamConnectionEvents

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

◆ disableSendAudio

- (bool) disableSendAudio

Gets whether the user is NOT authorized to send audio.

◆ disableSendData

- (bool) disableSendData

Gets whether the user is NOT authorized to send data.

◆ disableSendMessage

- (bool) disableSendMessage

Gets whether the user is NOT authorized to send messages.

◆ disableSendVideo

- (bool) disableSendVideo

Gets whether the user is NOT authorized to send video.

◆ disableSfu

- (bool) disableSfu

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

◆ enableHiddenObserverMode

- (bool) enableHiddenObserverMode

Gets 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.

◆ fromJsonArrayWithChannelClaimsJson:

+ (NSMutableArray*) fromJsonArrayWithChannelClaimsJson: (NSString *) channelClaimsJson

Deserializes an array of channel claims from JSON.

Parameters

channelClaimsJson The channel claims JSON.

◆ fromJsonWithChannelClaimJson:

+ (FMLiveSwitchChannelClaim*) fromJsonWithChannelClaimJson: (NSString *) channelClaimJson

Deserializes a channel claim from JSON.

Parameters

channelClaimJson The channel claim JSON.

◆ id

- (NSString*) id

Gets the channel identifier.

◆ initWithId:

- (instancetype) initWithId: (NSString *) idValue

Initializes a new instance of the FMLiveSwitchChannelClaim class.

Parameters

idValue The channel identifier.

◆ setAction:

- (void) setAction: (NSString *) value

Sets the action of this channel claim.

Possible values are in the FMLiveSwitchClaimAction class.

◆ setAllowedLayoutPriority:

- (void) setAllowedLayoutPriority: (FMLiveSwitchNullableInt *) value

Sets the lowest allowed LayoutPriority.

Lower numbers take priority over higher numbers.

◆ setAllowedLayoutZones:

- (void) setAllowedLayoutZones: (NSMutableArray *) value

Sets the LayoutZones that can be used by upstream connections.

◆ setAudioReceiveWhitelist:

- (void) setAudioReceiveWhitelist: (NSMutableArray *) value

Sets a whitelist of roles whose member's audio can be received from.

Null disables the whitelist whereas an empty list disables all receiving.

◆ setBroadcast:

- (void) setBroadcast: (bool) value

Sets if this is a broadcast channel or not.

Deprecated:: Will be removed in a future release.

◆ setCanKick:

- (void) setCanKick: (bool) value

Sets whether the user is authorized kick other users from this channel.

◆ setCanUpdate:

- (void) setCanUpdate: (bool) value

Sets whether the user is authorized to update a media server channel.

◆ setCanUpdateLayout:

- (void) setCanUpdateLayout: (bool) value

Sets whether the user is authorized to update the LayoutZone and LayoutPriority properties on connections.

◆ setDataReceiveWhitelist:

- (void) setDataReceiveWhitelist: (NSMutableArray *) value

Sets a whitelist of roles whose member's data can be received from.

Null disables the whitelist whereas an empty list disables all receiving.

◆ setDisableMcu:

- (void) setDisableMcu: (bool) value

Sets whether the user is NOT authorized to create MCU connections.

◆ setDisablePeer:

- (void) setDisablePeer: (bool) value

Sets whether the user is NOT authorized to create peer connections.

◆ setDisableRemoteClientEvents:

- (void) setDisableRemoteClientEvents: (bool) value

Sets whether to disable remote client join/update/leave messages and events.

◆ setDisableRemoteUpstreamConnectionEvents:

- (void) setDisableRemoteUpstreamConnectionEvents: (bool) value

Sets whether to disable remote connection open/update/close messages and events.

◆ setDisableSendAudio:

- (void) setDisableSendAudio: (bool) value

Sets whether the user is NOT authorized to send audio.

◆ setDisableSendData:

- (void) setDisableSendData: (bool) value

Sets whether the user is NOT authorized to send data.

◆ setDisableSendMessage:

- (void) setDisableSendMessage: (bool) value

Sets whether the user is NOT authorized to send messages.

◆ setDisableSendVideo:

- (void) setDisableSendVideo: (bool) value

Sets whether the user is NOT authorized to send video.

◆ setDisableSfu:

- (void) setDisableSfu: (bool) value

Sets whether the user is NOT authorized to create SFU connections.

◆ setEnableHiddenObserverMode:

- (void) setEnableHiddenObserverMode: (bool) value

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.

◆ setId:

- (void) setId: (NSString *) value

Sets the channel identifier.

◆ setVideoReceiveWhitelist:

- (void) setVideoReceiveWhitelist: (NSMutableArray *) value

Sets a whitelist of roles whose member's video can be received from.

Null disables the whitelist whereas an empty list disables all receiving.

◆ toJson

- (NSString*) toJson

Serializes this channel claim to JSON.

◆ toJsonArrayWithChannelClaims:

+ (NSString*) toJsonArrayWithChannelClaims: (NSMutableArray *) channelClaims

Serializes an array of channel claims to JSON.

Parameters

channelClaims The channel claims.

◆ toJsonWithChannelClaim:

+ (NSString*) toJsonWithChannelClaim: (FMLiveSwitchChannelClaim *) channelClaim

Serializes a channel claim to JSON.

Parameters

channelClaim The channel claim to serialize.

◆ videoReceiveWhitelist

- (NSMutableArray*) videoReceiveWhitelist

Gets a whitelist of roles whose member's video can be received from.

Null disables the whitelist whereas an empty list disables all receiving.

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ action

◆ allowedLayoutPriority

◆ allowedLayoutZones

◆ audioReceiveWhitelist

◆ broadcast

◆ canKick

◆ canUpdate

◆ canUpdateLayout

◆ channelClaimWithId:

◆ dataReceiveWhitelist

◆ disableMcu

◆ disablePeer

◆ disableRemoteClientEvents

◆ disableRemoteUpstreamConnectionEvents

◆ disableSendAudio

◆ disableSendData

◆ disableSendMessage

◆ disableSendVideo

◆ disableSfu

◆ enableHiddenObserverMode

◆ fromJsonArrayWithChannelClaimsJson:

◆ fromJsonWithChannelClaimJson:

◆ id

◆ initWithId:

◆ setAction:

◆ setAllowedLayoutPriority:

◆ setAllowedLayoutZones:

◆ setAudioReceiveWhitelist:

◆ setBroadcast:

◆ setCanKick:

◆ setCanUpdate:

◆ setCanUpdateLayout:

◆ setDataReceiveWhitelist:

◆ setDisableMcu:

◆ setDisablePeer:

◆ setDisableRemoteClientEvents:

◆ setDisableRemoteUpstreamConnectionEvents:

◆ setDisableSendAudio:

◆ setDisableSendData:

◆ setDisableSendMessage:

◆ setDisableSendVideo:

◆ setDisableSfu:

◆ setEnableHiddenObserverMode:

◆ setId:

◆ setVideoReceiveWhitelist:

◆ toJson

◆ toJsonArrayWithChannelClaims:

◆ toJsonWithChannelClaim:

◆ videoReceiveWhitelist