joinVideoChat

Join a video chat. User-only.

Parameters

id: string

The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.

params_: string

WebRTC connection parameters.

joinAs?: ID

The identifier of a chat to join the video chat on behalf of.

inviteHash?: string

Invite hash.

audio?: boolean

Whether to enable audio. Enabled by default.

video?: boolean

Whether to enable video. Enabled by default.

Result

string

Parameters to be passed to the used WebRTC library.

Syntax

// Required parameters only.
await client.joinVideoChat(id, params_);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.joinVideoChat(id, params_, {
    joinAs,
    inviteHash,
    audio,
    video,
});