Function init

init(
    args: {
        audioPanelAlwaysOpen?: boolean;
        debug?: boolean;
        defaultView?: "gallery" | "speaker" | "multiSpeaker";
        disableCallOut?: boolean;
        disableCORP?: boolean;
        disableInvite?: boolean;
        disableJoinAudio?: boolean;
        disablePictureInPicture?: boolean;
        disablePreview?: boolean;
        disableRecord?: boolean;
        disableReport?: boolean;
        disableVoIP?: boolean;
        disableZoomLogo?: boolean;
        disableZoomPhone?: boolean;
        enableFullHD?: boolean;
        enableHD?: boolean;
        enableWaitingRoomPreview?: boolean;
        error?: Function;
        externalLinkPage?: string;
        helper?: string;
        hideShareAudioOption?: boolean;
        inviteUrlFormat?: string;
        isLockBottom?: boolean;
        isShowJoiningErrorDialog?: boolean;
        isSupportAV?: boolean;
        isSupportBreakout?: boolean;
        isSupportCC?: boolean;
        isSupportChat?: boolean;
        isSupportNonverbal?: boolean;
        isSupportPolling?: boolean;
        isSupportQA?: boolean;
        isSupportSimulive?: boolean;
        leaveOnPageUnload?: boolean;
        leaveUrl: string;
        loginWindow?: { height: string; width: string };
        meetingInfo?: MeetingInfoType[];
        onInviteSearchZoomPhoneCallback?: Function;
        onRetryCallback?: Function;
        patchJsMedia?: boolean;
        screenShare?: boolean;
        sharingMode?: string;
        showMeetingHeader?: boolean;
        showPureSharingContent?: boolean;
        success?: Function;
        videoDrag?: boolean;
        videoHeader?: boolean;
        webEndpoint?: string;
    },
): void
Initializes a Zoom Meeting. You must initialize a Zoom meeting in order to start or join it. This method only requires the leaveUrl parameter.
Parameters
- args: {
      audioPanelAlwaysOpen?: boolean;
      debug?: boolean;
      defaultView?: "gallery" | "speaker" | "multiSpeaker";
      disableCallOut?: boolean;
      disableCORP?: boolean;
      disableInvite?: boolean;
      disableJoinAudio?: boolean;
      disablePictureInPicture?: boolean;
      disablePreview?: boolean;
      disableRecord?: boolean;
      disableReport?: boolean;
      disableVoIP?: boolean;
      disableZoomLogo?: boolean;
      disableZoomPhone?: boolean;
      enableFullHD?: boolean;
      enableHD?: boolean;
      enableWaitingRoomPreview?: boolean;
      error?: Function;
      externalLinkPage?: string;
      helper?: string;
      hideShareAudioOption?: boolean;
      inviteUrlFormat?: string;
      isLockBottom?: boolean;
      isShowJoiningErrorDialog?: boolean;
      isSupportAV?: boolean;
      isSupportBreakout?: boolean;
      isSupportCC?: boolean;
      isSupportChat?: boolean;
      isSupportNonverbal?: boolean;
      isSupportPolling?: boolean;
      isSupportQA?: boolean;
      isSupportSimulive?: boolean;
      leaveOnPageUnload?: boolean;
      leaveUrl: string;
      loginWindow?: { height: string; width: string };
      meetingInfo?: MeetingInfoType[];
      onInviteSearchZoomPhoneCallback?: Function;
      onRetryCallback?: Function;
      patchJsMedia?: boolean;
      screenShare?: boolean;
      sharingMode?: string;
      showMeetingHeader?: boolean;
      showPureSharingContent?: boolean;
      success?: Function;
      videoDrag?: boolean;
      videoHeader?: boolean;
      webEndpoint?: string;
  }
  - OptionalaudioPanelAlwaysOpen?: boolean
    audioPanelAlwaysOpen: default: false, optional. Sets the default state of the audio panel on join. Always open or closed.
  - Optionaldebug?: boolean
    debug: default: false, optional. Turns on debug mode to print logs in the browser console.
  - OptionaldefaultView?: "gallery" | "speaker" | "multiSpeaker"
    Sets the default video layout for the session. Optional.
    
    Remarks
    Mobile device limitations:
    
    'multiSpeaker' is not supported and will automatically switch to 'speaker' view
    
    When participant count is less than 3, 'gallery' view will automatically switch to 'speaker' view
  - OptionaldisableCallOut?: boolean
    disableCallOut: default: false, optional. Enables or disables the call out function.
  - OptionaldisableCORP?: boolean
    disableCORP: default: false, optional. Enables or disables web isolation mode (developer environment feature).
  - OptionaldisableInvite?: boolean
    disableInvite: default: false, optional. Enables or disables the invite function.
  - OptionaldisableJoinAudio?: boolean
    disableJoinAudio: default: false, optional. Enables or disables the join audio function.
  - OptionaldisablePictureInPicture?: boolean
    disablePictureInPicture: default: false, optional. Enables or disables the Picture in Picture feature.
  - OptionaldisablePreview?: boolean
    disablePreview: default: false, optional. Enables or disables the audio and video preview features.
  - OptionaldisableRecord?: boolean
    disableRecord: default: false, optional. Enables or disables the call out function.
  - OptionaldisableReport?: boolean
    disableReport: default: false, optional. Enables or disables the report feature.
  - OptionaldisableVoIP?: boolean
    disableVoIP: default: false, optional. Enables or disables the Voice over IP (VoIP) feature.
  - OptionaldisableZoomLogo?: boolean
    disableZoomLogo: default: false, optional. If true, removes the Zoom workplace logo. Disabling the Zoom logo will not be available in the future. For a custom experience, build with the Zoom Video SDK.
  - OptionaldisableZoomPhone?: boolean
    disableZoomPhone: default: false, optional. Enables or disables the Invite->Zoom Phone feature.
  - OptionalenableFullHD?: boolean
    enableFullHD: optional, >= 2.9.0 default=false, enable webinar attendee receive 1080P video when zoom backend support.
  - OptionalenableHD?: boolean
    enableHD: optional, >=2.8.0 default=true. <2.8.0 default is false. Enables or disables 720p (bandwidth and hardware restrictions apply). See for details: https://developers.zoom.us/docs/meeting-sdk/web/720p/
  - OptionalenableWaitingRoomPreview?: boolean
    enableWaitingRoomPreview: default: true, optional. Enables or disables the audio and video preview in the waiting room or when the participant is waiting for the host to start the meeting.
  - Optionalerror?: Function
    error: optional, callback function on error.
  - OptionalexternalLinkPage?: string
    externalLinkPage: an intermediary HTML page for outgoing hyperlinks.
  - Optionalhelper?: string
    helper: optional, default: ''. Sets a helper HTML page for working around CORS issues. Example: https://github.com/zoom/meetingsdk-web/blob/master/helper.html
  - OptionalhideShareAudioOption?: boolean
    Shows (false, default value) or hides (true) the "Share tab audio" checkbox when sharing a Chrome tab.
  - OptionalinviteUrlFormat?: string
    inviteUrlFormat: default: '', optional. Customizes the invite URL format. Use the syntax: https://yourdomain/{0}?pwd={1}. Only available for v2.4.0+. Requires that Zoom sets the Enable Client SDK Customize Invite URL flag for your account. Contact Zoom Developer Support for details.
  - OptionalisLockBottom?: boolean
    isLockBottom: default: true, optional. Shows or hides the footer.
  - OptionalisShowJoiningErrorDialog?: boolean
    isShowJoiningErrorDialog: default: true, optional. Enables or disables the join error popup dialog when the SDK fails to join a meeting.
  - OptionalisSupportAV?: boolean
    isSupportAV: default: true, optional. Enables or disables the audio and video features.
  - OptionalisSupportBreakout?: boolean
    isSupportBreakout: default: true, optional. Enables or disables the meeting breakout room feature.
  - OptionalisSupportCC?: boolean
    isSupportCC: default: true, optional. Enables or disables the meeting closed caption feature.
  - OptionalisSupportChat?: boolean
    isSupportChat: default: true, optional. Enables or disables the chat feature.
  - OptionalisSupportNonverbal?: boolean
    isSupportNonverbal: default: true, optional. Enables or disables the nonverbal feedback feature such as slow down or speed up icons. For more details about this feature, see: https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions-
  - OptionalisSupportPolling?: boolean
    isSupportPolling: default: true, optional. Enables or disables the meeting polling feature.
  - OptionalisSupportQA?: boolean
    isSupportQA: default: true, optional. Enables or disables the webinar Q&A feature.
  - OptionalisSupportSimulive?: boolean
    isSupportSimulive, default false, Simulive not with credentialless mode. https://developer.chrome.com/blog/coep-credentialless-origin-trial/
  - OptionalleaveOnPageUnload?: boolean
    Quickly leave the meeting when refreshing or closing the page, instead of experiencing meeting failover. Caveat for two scenarios: PSTN: Phone user who is bound to the current user. The phone will hang up instead of staying connected. Breakout room: Users in a Breakout room need to be assigned again instead of having been assigned and auto-joining the room.
  - leaveUrl: string
    leaveUrl: Required. The URL to post after the user leaves the meeting. Example: “http://www.zoom.us” If you do not set a leaveURL, the default will be -> window.location.origin Other substitutions include the following.
    
    http://127.0.0.1 -> http://127.0.0.1 (no change)
    
    https://127.0.0.1 -> https://127.0.0.1 (no change)
    
    about:blank -> about:blank
    
    /meeting -> window.location.origin/meeting
    
    zoom.us -> https://zoom.us
  - OptionalloginWindow?: { height: string; width: string }
    loginWindow: Defines the registration and login popup window size.
    
    height: string
    height: default: 380, optional. Login popup window height, in pixels.
    
    width: string
    width: default: 400, optional. Login popup window width, in pixels.
  - OptionalmeetingInfo?: MeetingInfoType[]
    meetingInfo: default: ['topic','host','mn','pwd','telPwd','invite','participant','dc', 'enctype', 'report'], optional. Choose the meeting information to display: the meeting topic, host, meeting number (mn), password (pwd), telephone password (telPwd), etc.
  - OptionalonInviteSearchZoomPhoneCallback?: Function
    onInviteSearchZoomPhoneCallback, callback when the user uses Invite->Zoom Phone-> search number. isSameAccount = true, support direct call internal ext number. Example:
    
    onInviteSearchZoomPhoneCallback: function (e) { const searchResult =[ { "firstName": "firstName1", "lastName": "lastName1", "displayName": "firstName1 lastName1", "snsEmail": "xxxxxx1@gmail.com", "pbx": {dn: ['+1xxxxxxxxxx'], ext: 800}, isSameAccount: true }, { "firstName": "firstName2", "lastName": "lastName2", "displayName": "firstName2 lastName2", "snsEmail": "xxxx2@zoom.us", "pbx": {dn: ['+2xxxxxxxxxx'], ext: 800}, isSameAccount: false }]; return Promise.resolve(searchResult); }
  - OptionalonRetryCallback?: Function
    onRetryCallback: default: null, optional. Sets an on-retry callback function.
  - OptionalpatchJsMedia?: boolean
    patchJsMedia: Optional. Default: false. Set to true to automatically apply the latest media dependency fix for the current Web Meeting SDK version. Note that you will still need to manually upgrade to major and minor version releases.
  - OptionalscreenShare?: boolean
    screenShare: default: true, optional. Enables or disables the browser URL sharing feature (Chrome only).
  - OptionalsharingMode?: string
    sharingMode: default: 'both', optional. Shares screen. 'fit' - disables sharing "origin size".
  - OptionalshowMeetingHeader?: boolean
    showMeetingHeader: default: true, optional. Shows or hides the meeting header, including the meeting number and topic.
  - OptionalshowPureSharingContent?: boolean
    showPureSharingContent, default: false, optional. Prevents elements from covering sharing content when show is true.
  - Optionalsuccess?: Function
    success: optional, callback function on success.
  - OptionalvideoDrag?: boolean
    videoDrag: default: true, optional. Enable or disable the drag video tile feature.
  - OptionalvideoHeader?: boolean
    videoHeader: default: true, optional. Shows or hides the video tile header.
  - OptionalwebEndpoint?: string
    webEndpoint: optional. Web domain option for Zoom PSO environment.
Returns void
- Defined in index.d.ts:781

Function init

Parameters

OptionalaudioPanelAlwaysOpen?: boolean

Optionaldebug?: boolean

OptionaldefaultView?: "gallery" | "speaker" | "multiSpeaker"

Remarks

OptionaldisableCallOut?: boolean

OptionaldisableCORP?: boolean

OptionaldisableInvite?: boolean

OptionaldisableJoinAudio?: boolean

OptionaldisablePictureInPicture?: boolean

OptionaldisablePreview?: boolean

OptionaldisableRecord?: boolean

OptionaldisableReport?: boolean

OptionaldisableVoIP?: boolean

OptionaldisableZoomLogo?: boolean

OptionaldisableZoomPhone?: boolean

OptionalenableFullHD?: boolean

OptionalenableHD?: boolean

OptionalenableWaitingRoomPreview?: boolean

Optionalerror?: Function

OptionalexternalLinkPage?: string

Optionalhelper?: string

OptionalhideShareAudioOption?: boolean

OptionalinviteUrlFormat?: string

OptionalisLockBottom?: boolean

OptionalisShowJoiningErrorDialog?: boolean

OptionalisSupportAV?: boolean

OptionalisSupportBreakout?: boolean

OptionalisSupportCC?: boolean

OptionalisSupportChat?: boolean

OptionalisSupportNonverbal?: boolean

OptionalisSupportPolling?: boolean

OptionalisSupportQA?: boolean

OptionalisSupportSimulive?: boolean

OptionalleaveOnPageUnload?: boolean

leaveUrl: string

OptionalloginWindow?: { height: string; width: string }

height: string

width: string

OptionalmeetingInfo?: MeetingInfoType[]

OptionalonInviteSearchZoomPhoneCallback?: Function

OptionalonRetryCallback?: Function

OptionalpatchJsMedia?: boolean

OptionalscreenShare?: boolean

OptionalsharingMode?: string

OptionalshowMeetingHeader?: boolean

OptionalshowPureSharingContent?: boolean

Optionalsuccess?: Function

OptionalvideoDrag?: boolean

OptionalvideoHeader?: boolean

OptionalwebEndpoint?: string

Returns void

Settings

`Optional`audioPanelAlwaysOpen?: boolean

`Optional`debug?: boolean

`Optional`defaultView?: "gallery" | "speaker" | "multiSpeaker"

`Optional`disableCallOut?: boolean

`Optional`disableCORP?: boolean

`Optional`disableInvite?: boolean

`Optional`disableJoinAudio?: boolean

`Optional`disablePictureInPicture?: boolean

`Optional`disablePreview?: boolean

`Optional`disableRecord?: boolean

`Optional`disableReport?: boolean

`Optional`disableVoIP?: boolean

`Optional`disableZoomLogo?: boolean

`Optional`disableZoomPhone?: boolean

`Optional`enableFullHD?: boolean

`Optional`enableHD?: boolean

`Optional`enableWaitingRoomPreview?: boolean

`Optional`error?: Function

`Optional`externalLinkPage?: string

`Optional`helper?: string

`Optional`hideShareAudioOption?: boolean

`Optional`inviteUrlFormat?: string

`Optional`isLockBottom?: boolean

`Optional`isShowJoiningErrorDialog?: boolean

`Optional`isSupportAV?: boolean

`Optional`isSupportBreakout?: boolean

`Optional`isSupportCC?: boolean

`Optional`isSupportChat?: boolean

`Optional`isSupportNonverbal?: boolean

`Optional`isSupportPolling?: boolean

`Optional`isSupportQA?: boolean

`Optional`isSupportSimulive?: boolean

`Optional`leaveOnPageUnload?: boolean

`Optional`loginWindow?: { height: string; width: string }

`Optional`meetingInfo?: MeetingInfoType[]

`Optional`onInviteSearchZoomPhoneCallback?: Function

`Optional`onRetryCallback?: Function

`Optional`patchJsMedia?: boolean

`Optional`screenShare?: boolean

`Optional`sharingMode?: string

`Optional`showMeetingHeader?: boolean

`Optional`showPureSharingContent?: boolean

`Optional`success?: Function

`Optional`videoDrag?: boolean

`Optional`videoHeader?: boolean

`Optional`webEndpoint?: string