Type alias StartMeetingConfig

StartMeetingConfig: {
    customMeetingId?: string;
    customerKey?: string;
    inviteContactId?: string;
    inviteOptions?: ZoomInviteOption;
    isAudioRawDataStereo?: boolean;
    isMyVoiceInMix?: boolean;
    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;
    userName: string;
    userType?: number;
    vanityID?: string;
    zoomAccessToken: string;
}

Parameters used to start a new Zoom meeting.

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

Field availability differs sharply between platforms. The iOS bridge (ios/RNZoomSDK.m startMeeting:) only reads userName, meetingNumber, zoomAccessToken, and userType — every other field is Android only and is silently ignored on iOS.

Type declaration

  • 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. Android only.

  • Optional inviteContactId?: string

    Contact ID used for automatic meeting invitation. Android only.

  • 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. Android only.

  • Optional isMyVoiceInMix?: boolean

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

  • Optional meetingNumber?: string

    Meeting number to start, formatted like 1234567890. Required when starting an existing scheduled meeting; omit to start an instant meeting. 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

    Start the meeting with audio disabled. Android only.

  • 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

    Start the meeting with video disabled. Android only.

  • Optional noWebinarRegisterDialog?: boolean

    Suppress the webinar registration dialog. Android only.

  • userName: string

    Display name shown for the host. iOS and Android.

  • Optional userType?: number

    User type (see native MobileRTCUserType / ZoomUserType). iOS and Android.

  • Optional vanityID?: string

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

  • zoomAccessToken: string

    Zoom Access Key (ZAK) token for the host. Required when starting a meeting on behalf of a logged-in Zoom user. iOS and Android.

Settings

Member Visibility

Theme

Generated using TypeDoc