Search Results for

    / fm / liveswitch / ChannelConfig

    Class: ChannelConfig

    fm.liveswitch.ChannelConfig

    Channel configuration.

    Table of contents

    Constructors

    • constructor

    Methods

    • getAudioMuted
    • getAudioUnmuteDisabled
    • getEnableRtmp
    • getExcludedClientIds
    • getExcludedConnectionIds
    • getExcludedDeviceIds
    • getExcludedUserIds
    • getRecording
    • getRecordingMode
    • getRecordingTag
    • getTypeString
    • getVideoMuted
    • getVideoUnmuteDisabled
    • setAudioMuted
    • setAudioUnmuteDisabled
    • setEnableRtmp
    • setExcludedClientIds
    • setExcludedConnectionIds
    • setExcludedDeviceIds
    • setExcludedUserIds
    • setRecording
    • setRecordingMode
    • setRecordingTag
    • setVideoMuted
    • setVideoUnmuteDisabled
    • toJson
    • fromJson
    • toJson

    Constructors

    constructor

    + new ChannelConfig(): ChannelConfig

    Returns: ChannelConfig

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:35

    Methods

    getAudioMuted

    ▸ getAudioMuted(): boolean

    Gets whether to mute or unmute audio.

    Returns: boolean

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


    getAudioUnmuteDisabled

    ▸ getAudioUnmuteDisabled(): boolean

    Gets whether to disable audio unmuting.

    Returns: boolean

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


    getEnableRtmp

    ▸ getEnableRtmp(): boolean

    Gets whether to enable rtmp.

    Returns: boolean

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


    getExcludedClientIds

    ▸ getExcludedClientIds(): string[]

    Gets the client identifiers to exclude.

    Returns: string[]

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


    getExcludedConnectionIds

    ▸ getExcludedConnectionIds(): string[]

    Gets the connection identifiers to exclude.

    Returns: string[]

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


    getExcludedDeviceIds

    ▸ getExcludedDeviceIds(): string[]

    Gets the device identifiers to exclude.

    Returns: string[]

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


    getExcludedUserIds

    ▸ getExcludedUserIds(): string[]

    Gets the user identifiers to exclude.

    Returns: string[]

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


    getRecording

    ▸ getRecording(): boolean

    Gets whether to enable recording.

    Returns: boolean

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


    getRecordingMode

    ▸ getRecordingMode(): string

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

    Returns: string

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


    getRecordingTag

    ▸ getRecordingTag(): string

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

    Returns: string

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

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


    getVideoMuted

    ▸ getVideoMuted(): boolean

    Gets whether to mute or unmute video.

    Returns: boolean

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


    getVideoUnmuteDisabled

    ▸ getVideoUnmuteDisabled(): boolean

    Gets whether to disable video unmuting.

    Returns: boolean

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


    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/ChannelConfig.ts:305


    setAudioUnmuteDisabled

    ▸ setAudioUnmuteDisabled(value: boolean): void

    Sets whether to disable audio unmuting.

    Parameters:

    Name Type
    value boolean

    Returns: void

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


    setEnableRtmp

    ▸ setEnableRtmp(value: boolean): void

    Sets whether to enable rtmp.

    Parameters:

    Name Type
    value boolean

    Returns: void

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


    setExcludedClientIds

    ▸ setExcludedClientIds(value: string[]): void

    Sets the client identifiers to exclude.

    Parameters:

    Name Type
    value string[]

    Returns: void

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


    setExcludedConnectionIds

    ▸ setExcludedConnectionIds(value: string[]): void

    Sets the connection identifiers to exclude.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:353


    setExcludedDeviceIds

    ▸ setExcludedDeviceIds(value: string[]): void

    Sets the device identifiers to exclude.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:365


    setExcludedUserIds

    ▸ setExcludedUserIds(value: string[]): void

    Sets the user identifiers to exclude.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:377


    setRecording

    ▸ setRecording(value: boolean): void

    Sets whether to enable recording.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:389


    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/ChannelConfig.ts:401


    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/ChannelConfig.ts:413


    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/ChannelConfig.ts:425


    setVideoUnmuteDisabled

    ▸ setVideoUnmuteDisabled(value: boolean): void

    Sets whether to disable video unmuting.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:437


    toJson

    ▸ toJson(): string

    Serializes this channel configuration to JSON.

    Returns: string

    The channel configuration as JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/ChannelConfig.ts:450


    fromJson

    ▸ StaticfromJson(channelConfigJson: string): ChannelConfig

    Deserializes a channel configuration from JSON.

    Parameters:

    Name Type Description
    channelConfigJson string The channel configuration as JSON.

    Returns: ChannelConfig

    The channel configuration.

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


    toJson

    ▸ StatictoJson(channelConfig: ChannelConfig): string

    Serializes a channel configuration to JSON.

    Parameters:

    Name Type Description
    channelConfig ChannelConfig The channel configuration.

    Returns: string

    The channel configuration as JSON.

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

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