Search Results for

    / fm / liveswitch / ChannelDeviceConfig

    Class: ChannelDeviceConfig

    fm.liveswitch.ChannelDeviceConfig

    Channel device configuration.

    Table of contents

    Constructors

    • constructor

    Methods

    • getAudioMuted
    • getAudioUnmuteDisabled
    • getExcludedClientIds
    • getExcludedConnectionIds
    • getRecording
    • getRecordingMode
    • getRecordingTag
    • getTypeString
    • getVideoMuted
    • getVideoUnmuteDisabled
    • setAudioMuted
    • setAudioUnmuteDisabled
    • setExcludedClientIds
    • setExcludedConnectionIds
    • setRecording
    • setRecordingMode
    • setRecordingTag
    • setVideoMuted
    • setVideoUnmuteDisabled
    • toJson
    • fromJson
    • toJson

    Constructors

    constructor

    + new ChannelDeviceConfig(): ChannelDeviceConfig

    Returns: ChannelDeviceConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:29

    Methods

    getAudioMuted

    ▸ getAudioMuted(): boolean

    Gets whether to mute or unmute audio.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:137


    getAudioUnmuteDisabled

    ▸ getAudioUnmuteDisabled(): boolean

    Gets whether to disable audio unmuting.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:149


    getExcludedClientIds

    ▸ getExcludedClientIds(): string[]

    Gets the client identifiers to exclude.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:161


    getExcludedConnectionIds

    ▸ getExcludedConnectionIds(): string[]

    Gets the connection identifiers to exclude.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:173


    getRecording

    ▸ getRecording(): boolean

    Gets whether to enable recording.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:185


    getRecordingMode

    ▸ getRecordingMode(): string

    Gets the mode for the recording, if recording is being enabled.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:197


    getRecordingTag

    ▸ getRecordingTag(): string

    Gets the tag for the recording, if recording is being enabled.

    Returns: string

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

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


    getVideoMuted

    ▸ getVideoMuted(): boolean

    Gets whether to mute or unmute video.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:221


    getVideoUnmuteDisabled

    ▸ getVideoUnmuteDisabled(): boolean

    Gets whether to disable video unmuting.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:233


    setAudioMuted

    ▸ setAudioMuted(value: boolean): void

    Sets whether to mute or unmute audio.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:245


    setAudioUnmuteDisabled

    ▸ setAudioUnmuteDisabled(value: boolean): void

    Sets whether to disable audio unmuting.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:257


    setExcludedClientIds

    ▸ setExcludedClientIds(value: string[]): void

    Sets the client identifiers to exclude.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:269


    setExcludedConnectionIds

    ▸ setExcludedConnectionIds(value: string[]): void

    Sets the connection identifiers to exclude.

    Parameters:

    Name Type
    value string[]

    Returns: void

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


    setRecording

    ▸ setRecording(value: boolean): void

    Sets whether to enable recording.

    Parameters:

    Name Type
    value boolean

    Returns: void

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


    setRecordingMode

    ▸ setRecordingMode(value: string): void

    Sets the mode for the recording, if recording is being enabled.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setRecordingTag

    ▸ setRecordingTag(value: string): void

    Sets the tag for the recording, if recording is being enabled.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setVideoMuted

    ▸ setVideoMuted(value: boolean): void

    Sets whether to mute or unmute video.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:329


    setVideoUnmuteDisabled

    ▸ setVideoUnmuteDisabled(value: boolean): void

    Sets whether to disable video unmuting.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:341


    toJson

    ▸ toJson(): string

    Serializes this channel device configuration to JSON.

    Returns: string

    The channel device configuration as JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:354


    fromJson

    ▸ StaticfromJson(channelDeviceConfigJson: string): ChannelDeviceConfig

    Deserializes a channel device configuration from JSON.

    Parameters:

    Name Type Description
    channelDeviceConfigJson string The channel device configuration as JSON.

    Returns: ChannelDeviceConfig

    The channel device configuration.

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:49


    toJson

    ▸ StatictoJson(channelDeviceConfig: ChannelDeviceConfig): string

    Serializes a channel device configuration to JSON.

    Parameters:

    Name Type Description
    channelDeviceConfig ChannelDeviceConfig The channel device configuration.

    Returns: string

    The channel device configuration as JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelDeviceConfig.ts:97

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