JoinSessionConfig: {
    audioOptions?: {
        autoAdjustSpeakerVolume?: boolean;
        connect?: boolean;
        mute?: boolean;
    };
    sessionIdleTimeoutMins: number;
    sessionName: string;
    sessionPassword?: string;
    token: string;
    userName: string;
    videoOptions?: { localVideoOn?: boolean };
}

Type declaration

  • OptionalaudioOptions?: { autoAdjustSpeakerVolume?: boolean; connect?: boolean; mute?: boolean }

    The audio option of join session

    • OptionalautoAdjustSpeakerVolume?: boolean

      Set if it is able to auto-adjust the volume of the speaker when joining the meeting

    • Optionalconnect?: boolean

      Local audio connect or not

    • Optionalmute?: boolean

      Local audio mute or not

  • sessionIdleTimeoutMins: number

    The amount of time in minutes after which an idle session will end. Default value: 40. If the value is less than 0, the session will stay alive indefinitely. When there is only one user remaining in a session, that session is considered idle.

  • sessionName: string

    Session Name. sessionName The string length must be less than 150. Supported character scopes are: Letters, numbers, spaces, and the following characters: "!", "#", "$", "%", "&", "(", ")", "", "", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "", "}", "|", "~", ","

  • OptionalsessionPassword?: string

    Session Password

  • token: string

    JWT token to join the session.

  • userName: string

    User Name.

  • OptionalvideoOptions?: { localVideoOn?: boolean }

    The video option of join session

    • OptionallocalVideoOn?: boolean

      Local video on or off

MMNEPVFCICPMFPCPTTAAATR