Type alias JoinMeetingConfig

JoinMeetingConfig: {
    appPrivilegeToken?: string;
    customMeetingId?: string;
    customerKey?: string;
    inviteOptions?: ZoomInviteOption;
    isAudioRawDataStereo?: boolean;
    isMyVoiceInMix?: boolean;
    joinToken?: string;
    meetingNumber: string;
    meetingViewsOptions?: ZoomMeetingViewsOption;
    noAudio?: boolean;
    noBottomToolbar?: boolean;
    noChatMsgToast?: boolean;
    noDrivingMode?: boolean;
    noInvite?: boolean;
    noMeetingEndMessage?: boolean;
    noMeetingErrorMessage?: boolean;
    noPhoneDialIn?: boolean;
    noPhoneDialOut?: boolean;
    noRecord?: boolean;
    noShare?: boolean;
    noTitleBar?: boolean;
    noUnmuteConfirmDialog?: boolean;
    noVideo?: boolean;
    noWebinarRegisterDialog?: boolean;
    password?: string;
    userName: string;
    userType?: number;
    vanityID?: string;
    webinarToken?: string;
    zoomAccessToken?: string;
}

Parameters used to join an existing Zoom meeting.

Mirrors the native MobileRTCMeetingJoinParam (iOS) / JoinMeetingParams (Android) parameter objects, combined with the meeting-options flags exposed by MeetingOptions on Android.

Field availability differs between platforms — fields marked Android only are silently ignored by the iOS bridge (see ios/RNZoomSDK.m joinMeeting:).

Type declaration

  • Optional appPrivilegeToken?: string

    Token granting extra privileges when joining a meeting — e.g. local recording permissions, streaming to raw, or archiving to raw. iOS and Android.

  • Optional customMeetingId?: string

    Custom meeting ID to display in the title bar instead of the real one. Android only.

  • Optional customerKey?: string

    Developer-specified string to track the end user. Max length 35. iOS and Android.

  • Optional inviteOptions?: ZoomInviteOption

    Symbolic key configuring which invite source is enabled. Android only. Only a single key can be supplied; see ZoomInviteOption.

  • Optional isAudioRawDataStereo?: boolean

    Whether captured audio raw data is stereo. Defaults to mono when omitted. iOS and Android.

  • Optional isMyVoiceInMix?: boolean

    Whether the local user's voice is included in the mixed audio raw data. iOS and Android.

  • Optional joinToken?: string

    Token used to join the meeting directly without web sign-in. iOS and Android.

  • meetingNumber: string

    Meeting number, formatted like 1234567890. iOS and Android.

  • Optional meetingViewsOptions?: ZoomMeetingViewsOption

    Symbolic key configuring which meeting view button or text is hidden. Android only. Only a single key can be supplied; see ZoomMeetingViewsOption.

  • Optional noAudio?: boolean

    Join the meeting with audio disabled. iOS and Android.

  • Optional noBottomToolbar?: boolean

    Hide the bottom toolbar. Android only.

  • Optional noChatMsgToast?: boolean

    Suppress the chat message toast shown when receiving a new chat message. Android only.

  • Optional noDrivingMode?: boolean

    Hide the in-meeting Driving Mode UI. Android only.

  • Optional noInvite?: boolean

    Hide the Invite action. Android only.

  • Optional noMeetingEndMessage?: boolean

    Hide the "Meeting has ended" message after the meeting ends. Android only.

  • Optional noMeetingErrorMessage?: boolean

    Hide meeting error message dialogs. Android only.

  • Optional noPhoneDialIn?: boolean

    Hide the "Call In By Phone" option. Android only.

  • Optional noPhoneDialOut?: boolean

    Hide the "Call Out" option. Android only.

  • Optional noRecord?: boolean

    Hide the record action. Android only.

  • Optional noShare?: boolean

    Hide the share action. Android only.

  • Optional noTitleBar?: boolean

    Hide the in-meeting title bar. Android only.

  • Optional noUnmuteConfirmDialog?: boolean

    Suppress the host "unmute yourself" confirmation dialog. Android only.

  • Optional noVideo?: boolean

    Join the meeting with video disabled. iOS and Android.

  • Optional noWebinarRegisterDialog?: boolean

    Suppress the webinar registration dialog. Android only. When disabled, the host must provide the registration info themselves.

  • Optional password?: string

    Meeting password, when the meeting requires one. iOS and Android.

  • userName: string

    Display name shown for the local user in the meeting. iOS and Android.

  • Optional userType?: number

    User type (see native MobileRTCUserType / ZoomUserType). Android only.

  • Optional vanityID?: string

    Special ID for the personal link name in an organization URL — e.g. yourcompany in yourcompany.zoom.us. iOS and Android.

  • Optional webinarToken?: string

    Token used when joining a webinar. iOS and Android.

  • Optional zoomAccessToken?: string

    Zoom Access Key (ZAK) token for joining as a logged-in user. iOS and Android.

Settings

Member Visibility

Theme

Generated using TypeDoc