Search Results for

    / fm / liveswitch / MutedConfig

    Class: MutedConfig

    fm.liveswitch.MutedConfig

    Muted configuration.

    Table of contents

    Constructors

    • constructor

    Methods

    • getAudioMuted
    • getAudioUnmuteDisabled
    • getExcludedClientIds
    • getExcludedConnectionIds
    • getExcludedDeviceIds
    • getExcludedUserIds
    • getTypeString
    • getVideoMuted
    • getVideoUnmuteDisabled
    • setAudioMuted
    • setAudioUnmuteDisabled
    • setExcludedClientIds
    • setExcludedConnectionIds
    • setExcludedDeviceIds
    • setExcludedUserIds
    • setVideoMuted
    • setVideoUnmuteDisabled
    • toJson
    • fromJson
    • toJson

    Constructors

    constructor

    + new MutedConfig(): MutedConfig

    Returns: MutedConfig

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:27

    Methods

    getAudioMuted

    ▸ getAudioMuted(): boolean

    Gets whether audio is muted.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:129


    getAudioUnmuteDisabled

    ▸ getAudioUnmuteDisabled(): boolean

    Gets whether audio unmute is disabled.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:141


    getExcludedClientIds

    ▸ getExcludedClientIds(): string[]

    Gets the excluded client identifiers.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:153


    getExcludedConnectionIds

    ▸ getExcludedConnectionIds(): string[]

    Gets the excluded connection identifiers.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:165


    getExcludedDeviceIds

    ▸ getExcludedDeviceIds(): string[]

    Gets the excluded device identifiers.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:177


    getExcludedUserIds

    ▸ getExcludedUserIds(): string[]

    Gets the excluded user identifiers.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:189


    getTypeString

    ▸ getTypeString(): string

    Returns: string

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


    getVideoMuted

    ▸ getVideoMuted(): boolean

    Gets whether video is muted.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:201


    getVideoUnmuteDisabled

    ▸ getVideoUnmuteDisabled(): boolean

    Gets whether video unmute is disabled.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:213


    setAudioMuted

    ▸ setAudioMuted(value: boolean): void

    Sets whether audio is muted.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:225


    setAudioUnmuteDisabled

    ▸ setAudioUnmuteDisabled(value: boolean): void

    Sets whether audio unmute is disabled.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:237


    setExcludedClientIds

    ▸ setExcludedClientIds(value: string[]): void

    Sets the excluded client identifiers.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:249


    setExcludedConnectionIds

    ▸ setExcludedConnectionIds(value: string[]): void

    Sets the excluded connection identifiers.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:261


    setExcludedDeviceIds

    ▸ setExcludedDeviceIds(value: string[]): void

    Sets the excluded device identifiers.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:273


    setExcludedUserIds

    ▸ setExcludedUserIds(value: string[]): void

    Sets the excluded user identifiers.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:285


    setVideoMuted

    ▸ setVideoMuted(value: boolean): void

    Sets whether video is muted.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:297


    setVideoUnmuteDisabled

    ▸ setVideoUnmuteDisabled(value: boolean): void

    Sets whether video unmute is disabled.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:309


    toJson

    ▸ toJson(): string

    Serializes this muted configuration to JSON.

    Returns: string

    The muted configuration as JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:322


    fromJson

    ▸ StaticfromJson(mutedConfigJson: string): MutedConfig

    Deserializes a muted configuration from JSON.

    Parameters:

    Name Type Description
    mutedConfigJson string The muted configuration as JSON.

    Returns: MutedConfig

    The muted configuration.

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:47


    toJson

    ▸ StatictoJson(mutedConfig: MutedConfig): string

    Serializes a muted configuration to JSON.

    Parameters:

    Name Type Description
    mutedConfig MutedConfig The muted configuration.

    Returns: string

    The muted configuration as JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/MutedConfig.ts:92

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