Search Results for

    / fm / liveswitch / ChannelClaim

    Class: ChannelClaim

    fm.liveswitch.ChannelClaim

    A channel claim.

    Table of contents

    Constructors

    • constructor

    Methods

    • fmliveswitchChannelClaimInit
    • getAction
    • getAllowedLayoutPriority
    • getAllowedLayoutZones
    • getAudioReceiveWhitelist
    • getBroadcast
    • getCanKick
    • getCanUpdate
    • getCanUpdateLayout
    • getDataReceiveWhitelist
    • getDisableMcu
    • getDisablePeer
    • getDisableRemoteClientEvents
    • getDisableRemoteUpstreamConnectionEvents
    • getDisableSendAudio
    • getDisableSendData
    • getDisableSendMessage
    • getDisableSendVideo
    • getDisableSfu
    • getEnableHiddenObserverMode
    • getId
    • getTypeString
    • getVideoReceiveWhitelist
    • setAction
    • setAllowedLayoutPriority
    • setAllowedLayoutZones
    • setAudioReceiveWhitelist
    • setBroadcast
    • setCanKick
    • setCanUpdate
    • setCanUpdateLayout
    • setDataReceiveWhitelist
    • setDisableMcu
    • setDisablePeer
    • setDisableRemoteClientEvents
    • setDisableRemoteUpstreamConnectionEvents
    • setDisableSendAudio
    • setDisableSendData
    • setDisableSendMessage
    • setDisableSendVideo
    • setDisableSfu
    • setEnableHiddenObserverMode
    • setId
    • setVideoReceiveWhitelist
    • toJson
    • fromJson
    • fromJsonArray
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new ChannelClaim(): ChannelClaim

    Returns: ChannelClaim

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:71

    + new ChannelClaim(idValue: string): ChannelClaim

    Initializes a new instance of the [[fm.liveswitch.channelClaim]] class.

    Parameters:

    Name Type Description
    idValue string The channel identifier.

    Returns: ChannelClaim

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:72

    Methods

    fmliveswitchChannelClaimInit

    ▸ PrivatefmliveswitchChannelClaimInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:55


    getAction

    ▸ getAction(): string

    Gets the action of this channel claim. Possible values are in the [[fm.liveswitch.claimAction]] class.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:293


    getAllowedLayoutPriority

    ▸ getAllowedLayoutPriority(): number

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

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:305


    getAllowedLayoutZones

    ▸ getAllowedLayoutZones(): string[]

    Gets the LayoutZones that can be used by upstream connections.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:317


    getAudioReceiveWhitelist

    ▸ getAudioReceiveWhitelist(): string[]

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

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:330


    getBroadcast

    ▸ getBroadcast(): boolean

    Gets if this is a broadcast channel or not.

    deprecated Will be removed in a future release.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:343


    getCanKick

    ▸ getCanKick(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:355


    getCanUpdate

    ▸ getCanUpdate(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:367


    getCanUpdateLayout

    ▸ getCanUpdateLayout(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:379


    getDataReceiveWhitelist

    ▸ getDataReceiveWhitelist(): string[]

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

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:392


    getDisableMcu

    ▸ getDisableMcu(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:404


    getDisablePeer

    ▸ getDisablePeer(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:416


    getDisableRemoteClientEvents

    ▸ getDisableRemoteClientEvents(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:428


    getDisableRemoteUpstreamConnectionEvents

    ▸ getDisableRemoteUpstreamConnectionEvents(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:440


    getDisableSendAudio

    ▸ getDisableSendAudio(): boolean

    Gets whether the user is NOT authorized to send audio.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:452


    getDisableSendData

    ▸ getDisableSendData(): boolean

    Gets whether the user is NOT authorized to send data.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:464


    getDisableSendMessage

    ▸ getDisableSendMessage(): boolean

    Gets whether the user is NOT authorized to send messages.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:476


    getDisableSendVideo

    ▸ getDisableSendVideo(): boolean

    Gets whether the user is NOT authorized to send video.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:488


    getDisableSfu

    ▸ getDisableSfu(): boolean

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

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:500


    getEnableHiddenObserverMode

    ▸ getEnableHiddenObserverMode(): boolean

    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.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:513


    getId

    ▸ getId(): string

    Gets the channel identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:525


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:9


    getVideoReceiveWhitelist

    ▸ getVideoReceiveWhitelist(): string[]

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

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:538


    setAction

    ▸ setAction(value: string): void

    Sets the action of this channel claim. Possible values are in the [[fm.liveswitch.claimAction]] class.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:550


    setAllowedLayoutPriority

    ▸ setAllowedLayoutPriority(value: number): void

    Sets the lowest allowed LayoutPriority. Lower numbers take priority over higher numbers.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:562


    setAllowedLayoutZones

    ▸ setAllowedLayoutZones(value: string[]): void

    Sets the LayoutZones that can be used by upstream connections.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:574


    setAudioReceiveWhitelist

    ▸ setAudioReceiveWhitelist(value: string[]): void

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

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:587


    setBroadcast

    ▸ setBroadcast(value: boolean): void

    Sets if this is a broadcast channel or not.

    deprecated Will be removed in a future release.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:600


    setCanKick

    ▸ setCanKick(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:612


    setCanUpdate

    ▸ setCanUpdate(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:624


    setCanUpdateLayout

    ▸ setCanUpdateLayout(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:636


    setDataReceiveWhitelist

    ▸ setDataReceiveWhitelist(value: string[]): void

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

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:649


    setDisableMcu

    ▸ setDisableMcu(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:661


    setDisablePeer

    ▸ setDisablePeer(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:673


    setDisableRemoteClientEvents

    ▸ setDisableRemoteClientEvents(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:685


    setDisableRemoteUpstreamConnectionEvents

    ▸ setDisableRemoteUpstreamConnectionEvents(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:697


    setDisableSendAudio

    ▸ setDisableSendAudio(value: boolean): void

    Sets whether the user is NOT authorized to send audio.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:709


    setDisableSendData

    ▸ setDisableSendData(value: boolean): void

    Sets whether the user is NOT authorized to send data.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:721


    setDisableSendMessage

    ▸ setDisableSendMessage(value: boolean): void

    Sets whether the user is NOT authorized to send messages.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:733


    setDisableSendVideo

    ▸ setDisableSendVideo(value: boolean): void

    Sets whether the user is NOT authorized to send video.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:745


    setDisableSfu

    ▸ setDisableSfu(value: boolean): void

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

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:757


    setEnableHiddenObserverMode

    ▸ setEnableHiddenObserverMode(value: boolean): void

    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.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:770


    setId

    ▸ setId(value: string): void

    Sets the channel identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:782


    setVideoReceiveWhitelist

    ▸ setVideoReceiveWhitelist(value: string[]): void

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

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:795


    toJson

    ▸ toJson(): string

    Serializes this channel claim to JSON.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:807


    fromJson

    ▸ StaticfromJson(channelClaimJson: string): ChannelClaim

    Deserializes a channel claim from JSON.

    Parameters:

    Name Type Description
    channelClaimJson string The channel claim JSON.

    Returns: ChannelClaim

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:112


    fromJsonArray

    ▸ StaticfromJsonArray(channelClaimsJson: string): ChannelClaim[]

    Deserializes an array of channel claims from JSON.

    Parameters:

    Name Type Description
    channelClaimsJson string The channel claims JSON.

    Returns: ChannelClaim[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:192


    toJson

    ▸ StatictoJson(channelClaim: ChannelClaim): string

    Serializes a channel claim to JSON.

    Parameters:

    Name Type Description
    channelClaim ChannelClaim The channel claim to serialize.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:209


    toJsonArray

    ▸ StatictoJsonArray(channelClaims: ChannelClaim[]): string

    Serializes an array of channel claims to JSON.

    Parameters:

    Name Type Description
    channelClaims ChannelClaim[] The channel claims.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelClaim.ts:281

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.16.0