Function init

Parameters

• args: {
      audioPanelAlwaysOpen?: boolean;
      debug?: boolean;
      defaultView?: "gallery" | "speaker" | "multiSpeaker";
      disableCORP?: boolean;
      disableCallOut?: 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;
  }

  • Optional audioPanelAlwaysOpen?: boolean

    audioPanelAlwaysOpen: default: false, optional. Sets the default state of the audio panel on join. Always open or closed.

  • Optional debug?: boolean

    debug: default: false, optional. Turns on debug mode to print logs in the browser console.

  • Optional defaultView?: "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

  • Optional disableCORP?: boolean

    disableCORP: default: false, optional. Enables or disables web isolation mode (developer environment feature).

  • Optional disableCallOut?: boolean

    disableCallOut: default: false, optional. Enables or disables the call out function.

  • Optional disableInvite?: boolean

    disableInvite: default: false, optional. Enables or disables the invite function.

  • Optional disableJoinAudio?: boolean

    disableJoinAudio: default: false, optional. Enables or disables the join audio function.

  • Optional disablePictureInPicture?: boolean

    disablePictureInPicture: default: false, optional. Enables or disables the Picture in Picture feature.

  • Optional disablePreview?: boolean

    disablePreview: default: false, optional. Enables or disables the audio and video preview features.

  • Optional disableRecord?: boolean

    disableRecord: default: false, optional. Enables or disables the call out function.

  • Optional disableReport?: boolean

    disableReport: default: false, optional. Enables or disables the report feature.

  • Optional disableVoIP?: boolean

    disableVoIP: default: false, optional. Enables or disables the Voice over IP (VoIP) feature.

  • Optional disableZoomLogo?: 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.

  • Optional disableZoomPhone?: boolean

    disableZoomPhone: default: false, optional. Enables or disables the Invite->Zoom Phone feature.

  • Optional enableFullHD?: boolean

    enableFullHD: optional, >= 2.9.0 default=false, enable webinar attendee receive 1080P video when zoom backend support.

  • Optional enableHD?: 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/

  • Optional enableWaitingRoomPreview?: 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.

  • Optional error?: Function

    error: optional, callback function on error.

  • Optional externalLinkPage?: string

    externalLinkPage: an intermediary HTML page for outgoing hyperlinks.

  • Optional helper?: 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

  • Optional hideShareAudioOption?: boolean

    Shows (false, default value) or hides (true) the "Share tab audio" checkbox when sharing a Chrome tab.

  • Optional inviteUrlFormat?: 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.

  • Optional isLockBottom?: boolean

    isLockBottom: default: true, optional. Shows or hides the footer.

  • Optional isShowJoiningErrorDialog?: boolean

    isShowJoiningErrorDialog: default: true, optional. Enables or disables the join error popup dialog when the SDK fails to join a meeting.

  • Optional isSupportAV?: boolean

    isSupportAV: default: true, optional. Enables or disables the audio and video features.

  • Optional isSupportBreakout?: boolean

    isSupportBreakout: default: true, optional. Enables or disables the meeting breakout room feature.

  • Optional isSupportCC?: boolean

    isSupportCC: default: true, optional. Enables or disables the meeting closed caption feature.

  • Optional isSupportChat?: boolean

    isSupportChat: default: true, optional. Enables or disables the chat feature.

  • Optional isSupportNonverbal?: 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-

  • Optional isSupportPolling?: boolean

    isSupportPolling: default: true, optional. Enables or disables the meeting polling feature.

  • Optional isSupportQA?: boolean

    isSupportQA: default: true, optional. Enables or disables the webinar Q&A feature.

  • Optional isSupportSimulive?: boolean

    isSupportSimulive, default false, Simulive not with credentialless mode. https://developer.chrome.com/blog/coep-credentialless-origin-trial/

  • Optional leaveOnPageUnload?: 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

  • Optional loginWindow?: {
        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.

  • Optional meetingInfo?: 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.

  • Optional onInviteSearchZoomPhoneCallback?: 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);
     }
    Copy

  • Optional onRetryCallback?: Function

    onRetryCallback: default: null, optional. Sets an on-retry callback function.

  • Optional patchJsMedia?: 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.

  • Optional screenShare?: boolean

    screenShare: default: true, optional. Enables or disables the browser URL sharing feature (Chrome only).

  • Optional sharingMode?: string

    sharingMode: default: 'both', optional. Shares screen. 'fit' - disables sharing "origin size".

  • Optional showMeetingHeader?: boolean

    showMeetingHeader: default: true, optional. Shows or hides the meeting header, including the meeting number and topic.

  • Optional showPureSharingContent?: boolean

    showPureSharingContent, default: false, optional. Prevents elements from covering sharing content when show is true.

  • Optional success?: Function

    success: optional, callback function on success.

  • Optional videoDrag?: boolean

    videoDrag: default: true, optional. Enable or disable the drag video tile feature.

  • Optional videoHeader?: boolean

    videoHeader: default: true, optional. Shows or hides the video tile header.

  • Optional webEndpoint?: string

    webEndpoint: optional. Web domain option for Zoom PSO environment.