fm.liveswitch.ChannelClaim Class Reference

A channel claim. More...

Public Member Functions
	ChannelClaim (String idValue)
	Initializes a new instance of the fm.liveswitch.ChannelClaim class. More...
String	getAction ()
	Gets the action of this channel claim. More...
fm.liveswitch.NullableInteger	getAllowedLayoutPriority ()
	Gets the lowest allowed LayoutPriority. More...
String[]	getAllowedLayoutZones ()
	Gets the LayoutZones that can be used by upstream connections. More...
String[]	getAudioReceiveWhitelist ()
	Gets a whitelist of roles whose member's audio can be received from. More...
boolean	getBroadcast ()
	Gets if this is a broadcast channel or not. More...
boolean	getCanKick ()
	Gets whether the user is authorized kick other users from this channel. More...
boolean	getCanUpdate ()
	Gets whether the user is authorized to update a media server channel. More...
boolean	getCanUpdateLayout ()
	Gets whether the user is authorized to update the LayoutZone and LayoutPriority properties on connections. More...
String[]	getDataReceiveWhitelist ()
	Gets a whitelist of roles whose member's data can be received from. More...
boolean	getDisableMcu ()
	Gets whether the user is NOT authorized to create MCU connections. More...
boolean	getDisablePeer ()
	Gets whether the user is NOT authorized to create peer connections. More...
boolean	getDisableRemoteClientEvents ()
	Gets whether to disable remote client join/update/leave messages and events. More...
boolean	getDisableRemoteUpstreamConnectionEvents ()
	Gets whether to disable remote connection open/update/close messages and events. More...
boolean	getDisableSendAudio ()
	Gets whether the user is NOT authorized to send audio. More...
boolean	getDisableSendData ()
	Gets whether the user is NOT authorized to send data. More...
boolean	getDisableSendMessage ()
	Gets whether the user is NOT authorized to send messages. More...
boolean	getDisableSendVideo ()
	Gets whether the user is NOT authorized to send video. More...
boolean	getDisableSfu ()
	Gets whether the user is NOT authorized to create SFU connections. More...
boolean	getEnableHiddenObserverMode ()
	Gets whether to stop remote users from being notified when a local user joins a channel. More...
String	getId ()
	Gets the channel identifier. More...
String[]	getVideoReceiveWhitelist ()
	Gets a whitelist of roles whose member's video can be received from. More...
void	setAction (String value)
	Sets the action of this channel claim. More...
void	setAllowedLayoutPriority (fm.liveswitch.NullableInteger value)
	Sets the lowest allowed LayoutPriority. More...
void	setAllowedLayoutZones (String[] value)
	Sets the LayoutZones that can be used by upstream connections. More...
void	setAudioReceiveWhitelist (String[] value)
	Sets a whitelist of roles whose member's audio can be received from. More...
void	setBroadcast (boolean value)
	Sets if this is a broadcast channel or not. More...
void	setCanKick (boolean value)
	Sets whether the user is authorized kick other users from this channel. More...
void	setCanUpdate (boolean value)
	Sets whether the user is authorized to update a media server channel. More...
void	setCanUpdateLayout (boolean value)
	Sets whether the user is authorized to update the LayoutZone and LayoutPriority properties on connections. More...
void	setDataReceiveWhitelist (String[] value)
	Sets a whitelist of roles whose member's data can be received from. More...
void	setDisableMcu (boolean value)
	Sets whether the user is NOT authorized to create MCU connections. More...
void	setDisablePeer (boolean value)
	Sets whether the user is NOT authorized to create peer connections. More...
void	setDisableRemoteClientEvents (boolean value)
	Sets whether to disable remote client join/update/leave messages and events. More...
void	setDisableRemoteUpstreamConnectionEvents (boolean value)
	Sets whether to disable remote connection open/update/close messages and events. More...
void	setDisableSendAudio (boolean value)
	Sets whether the user is NOT authorized to send audio. More...
void	setDisableSendData (boolean value)
	Sets whether the user is NOT authorized to send data. More...
void	setDisableSendMessage (boolean value)
	Sets whether the user is NOT authorized to send messages. More...
void	setDisableSendVideo (boolean value)
	Sets whether the user is NOT authorized to send video. More...
void	setDisableSfu (boolean value)
	Sets whether the user is NOT authorized to create SFU connections. More...
void	setEnableHiddenObserverMode (boolean value)
	Sets whether to stop remote users from being notified when a local user joins a channel. More...
void	setId (String value)
	Sets the channel identifier. More...
void	setVideoReceiveWhitelist (String[] value)
	Sets a whitelist of roles whose member's video can be received from. More...
String	toJson ()
	Serializes this channel claim to JSON. More...

Static Public Member Functions
static fm.liveswitch.ChannelClaim	fromJson (String channelClaimJson)
	Deserializes a channel claim from JSON. More...
static fm.liveswitch.ChannelClaim[]	fromJsonArray (String channelClaimsJson)
	Deserializes an array of channel claims from JSON. More...
static String	toJson (final fm.liveswitch.ChannelClaim channelClaim)
	Serializes a channel claim to JSON. More...
static String	toJsonArray (fm.liveswitch.ChannelClaim[] channelClaims)
	Serializes an array of channel claims to JSON. More...

Detailed Description

A channel claim.

Constructor & Destructor Documentation

ChannelClaim()

fm.liveswitch.ChannelClaim.ChannelClaim

(

String

idValue

)

Initializes a new instance of the fm.liveswitch.ChannelClaim class.

Parameters

idValue

The channel identifier.

Member Function Documentation

fromJson()

static fm.liveswitch.ChannelClaim fm.liveswitch.ChannelClaim.fromJson ( String  channelClaimJson )

static

Deserializes a channel claim from JSON.

Parameters

channelClaimJson

The channel claim JSON.

fromJsonArray()

static fm.liveswitch.ChannelClaim [] fm.liveswitch.ChannelClaim.fromJsonArray ( String  channelClaimsJson )

static

Deserializes an array of channel claims from JSON.

Parameters

channelClaimsJson

The channel claims JSON.

getAction()

String fm.liveswitch.ChannelClaim.getAction

(

)

Gets the action of this channel claim.

Possible values are in the fm.liveswitch.ClaimAction class.

getAllowedLayoutPriority()

fm.liveswitch.NullableInteger fm.liveswitch.ChannelClaim.getAllowedLayoutPriority

(

)

Gets the lowest allowed LayoutPriority.

Lower numbers take priority over higher numbers.

getAllowedLayoutZones()

String [] fm.liveswitch.ChannelClaim.getAllowedLayoutZones

(

)

Gets the LayoutZones that can be used by upstream connections.

getAudioReceiveWhitelist()

String [] fm.liveswitch.ChannelClaim.getAudioReceiveWhitelist

(

)

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

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

getBroadcast()

boolean fm.liveswitch.ChannelClaim.getBroadcast

(

)

Gets if this is a broadcast channel or not.

Deprecated:

Will be removed in a future release.

getCanKick()

boolean fm.liveswitch.ChannelClaim.getCanKick

(

)

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

getCanUpdate()

boolean fm.liveswitch.ChannelClaim.getCanUpdate

(

)

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

getCanUpdateLayout()

boolean fm.liveswitch.ChannelClaim.getCanUpdateLayout

(

)

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

getDataReceiveWhitelist()

String [] fm.liveswitch.ChannelClaim.getDataReceiveWhitelist

(

)

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

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

getDisableMcu()

boolean fm.liveswitch.ChannelClaim.getDisableMcu

(

)

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

getDisablePeer()

boolean fm.liveswitch.ChannelClaim.getDisablePeer

(

)

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

getDisableRemoteClientEvents()

boolean fm.liveswitch.ChannelClaim.getDisableRemoteClientEvents

(

)

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

getDisableRemoteUpstreamConnectionEvents()

boolean fm.liveswitch.ChannelClaim.getDisableRemoteUpstreamConnectionEvents

(

)

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

getDisableSendAudio()

boolean fm.liveswitch.ChannelClaim.getDisableSendAudio

(

)

Gets whether the user is NOT authorized to send audio.

getDisableSendData()

boolean fm.liveswitch.ChannelClaim.getDisableSendData

(

)

Gets whether the user is NOT authorized to send data.

getDisableSendMessage()

boolean fm.liveswitch.ChannelClaim.getDisableSendMessage

(

)

Gets whether the user is NOT authorized to send messages.

getDisableSendVideo()

boolean fm.liveswitch.ChannelClaim.getDisableSendVideo

(

)

Gets whether the user is NOT authorized to send video.

getDisableSfu()

boolean fm.liveswitch.ChannelClaim.getDisableSfu

(

)

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

getEnableHiddenObserverMode()

boolean fm.liveswitch.ChannelClaim.getEnableHiddenObserverMode

(

)

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.

getId()

String fm.liveswitch.ChannelClaim.getId

(

)

Gets the channel identifier.

getVideoReceiveWhitelist()

String [] fm.liveswitch.ChannelClaim.getVideoReceiveWhitelist

(

)

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

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

setAction()

void fm.liveswitch.ChannelClaim.setAction

(

String

value

)

Sets the action of this channel claim.

Possible values are in the fm.liveswitch.ClaimAction class.

setAllowedLayoutPriority()

void fm.liveswitch.ChannelClaim.setAllowedLayoutPriority

(

fm.liveswitch.NullableInteger

value

)

Sets the lowest allowed LayoutPriority.

Lower numbers take priority over higher numbers.

setAllowedLayoutZones()

void fm.liveswitch.ChannelClaim.setAllowedLayoutZones

(

String[]

value

)

Sets the LayoutZones that can be used by upstream connections.

setAudioReceiveWhitelist()

void fm.liveswitch.ChannelClaim.setAudioReceiveWhitelist

(

String[]

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 fm.liveswitch.ChannelClaim.setBroadcast

(

boolean

value

)

Sets if this is a broadcast channel or not.

Deprecated:

Will be removed in a future release.

setCanKick()

void fm.liveswitch.ChannelClaim.setCanKick

(

boolean

value

)

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

setCanUpdate()

void fm.liveswitch.ChannelClaim.setCanUpdate

(

boolean

value

)

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

setCanUpdateLayout()

void fm.liveswitch.ChannelClaim.setCanUpdateLayout

(

boolean

value

)

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

setDataReceiveWhitelist()

void fm.liveswitch.ChannelClaim.setDataReceiveWhitelist

(

String[]

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 fm.liveswitch.ChannelClaim.setDisableMcu

(

boolean

value

)

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

setDisablePeer()

void fm.liveswitch.ChannelClaim.setDisablePeer

(

boolean

value

)

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

setDisableRemoteClientEvents()

void fm.liveswitch.ChannelClaim.setDisableRemoteClientEvents

(

boolean

value

)

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

setDisableRemoteUpstreamConnectionEvents()

void fm.liveswitch.ChannelClaim.setDisableRemoteUpstreamConnectionEvents

(

boolean

value

)

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

setDisableSendAudio()

void fm.liveswitch.ChannelClaim.setDisableSendAudio

(

boolean

value

)

Sets whether the user is NOT authorized to send audio.

setDisableSendData()

void fm.liveswitch.ChannelClaim.setDisableSendData

(

boolean

value

)

Sets whether the user is NOT authorized to send data.

setDisableSendMessage()

void fm.liveswitch.ChannelClaim.setDisableSendMessage

(

boolean

value

)

Sets whether the user is NOT authorized to send messages.

setDisableSendVideo()

void fm.liveswitch.ChannelClaim.setDisableSendVideo

(

boolean

value

)

Sets whether the user is NOT authorized to send video.

setDisableSfu()

void fm.liveswitch.ChannelClaim.setDisableSfu

(

boolean

value

)

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

setEnableHiddenObserverMode()

void fm.liveswitch.ChannelClaim.setEnableHiddenObserverMode

(

boolean

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 fm.liveswitch.ChannelClaim.setId

(

String

value

)

Sets the channel identifier.

setVideoReceiveWhitelist()

void fm.liveswitch.ChannelClaim.setVideoReceiveWhitelist

(

String[]

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() [1/2]

String fm.liveswitch.ChannelClaim.toJson

(

)

Serializes this channel claim to JSON.

toJson() [2/2]

static String fm.liveswitch.ChannelClaim.toJson ( final fm.liveswitch.ChannelClaim  channelClaim )

static

Serializes a channel claim to JSON.

Parameters

channelClaim

The channel claim to serialize.

toJsonArray()

static String fm.liveswitch.ChannelClaim.toJsonArray ( fm.liveswitch.ChannelClaim[]  channelClaims )

static

Serializes an array of channel claims to JSON.

Parameters

channelClaims

The channel claims.