Zoom Meeting SDK for Web - Component View
    Preparing search index...

    Interface InitOptions

    interface InitOptions {
        assetPath?: string;
        customize?: {
            activeApps?: { popper?: PopperStyle };
            callMe?: { popper?: PopperStyle };
            chat?: { notificationCls?: PositionStyle; popper?: PopperStyle };
            invite?: { popper?: PopperStyle };
            inviteUrlFormat?: string;
            meeting?: { popper?: PopperStyle };
            meetingInfo?: MeetingInfoType[];
            participants?: { popper?: PopperStyle };
            setting?: { popper?: PopperStyle };
            sharing?: { options?: { hideShareAudioOption?: boolean } };
            toolbar?: { buttons?: CustomButton[] };
            video?: VideoOptions;
        };
        debug?: boolean;
        enforceVirtualBackground?: boolean;
        language?: | "en-US"
        | "de-DE"
        | "es-ES"
        | "fr-FR"
        | "jp-JP"
        | "pt-PT"
        | "ru-RU"
        | "zh-CN"
        | "zh-TW"
        | "ko-KO"
        | "vi-VN"
        | "it-IT"
        | "pl-PL"
        | "tr-TR"
        | "id-ID"
        | "nl-NL"
        | "sv-SE"
        | "ja-JP"
        | "ko-KR";
        leaveOnPageUnload?: boolean;
        maximumVideosInGalleryView?: number;
        patchJsMedia?: boolean;
        webEndpoint?: string;
        zoomAppRoot: undefined
        | HTMLElement;
    }
    Index

    Properties

    assetPath? customize? debug? enforceVirtualBackground? language? leaveOnPageUnload? maximumVideosInGalleryView? patchJsMedia? webEndpoint? zoomAppRoot

    Properties

    assetPath?: string

    Default 'https://source.zoom.us/{version}/lib/av'.

    customize?: {
        activeApps?: { popper?: PopperStyle };
        callMe?: { popper?: PopperStyle };
        chat?: { notificationCls?: PositionStyle; popper?: PopperStyle };
        invite?: { popper?: PopperStyle };
        inviteUrlFormat?: string;
        meeting?: { popper?: PopperStyle };
        meetingInfo?: MeetingInfoType[];
        participants?: { popper?: PopperStyle };
        setting?: { popper?: PopperStyle };
        sharing?: { options?: { hideShareAudioOption?: boolean } };
        toolbar?: { buttons?: CustomButton[] };
        video?: VideoOptions;
    }

    Type Declaration

    • OptionalactiveApps?: { popper?: PopperStyle }

      Customization options for the active apps notifier popper position.

    • OptionalcallMe?: { popper?: PopperStyle }

      Customization options for the call-me panel.

      Options for the underlying popper element.

    • Optionalchat?: { notificationCls?: PositionStyle; popper?: PopperStyle }

      Customization options for chat notifications and panel.

      Options for chat notifications.

      Options for the underlying popper element.

    • Optionalinvite?: { popper?: PopperStyle }

      Customization options for the invite panel.

      Options for the underlying popper element.

    • OptionalinviteUrlFormat?: string

      Customize the meeting invite URL format (e.g. https://yourdomain/{0}?pwd={1}). This will not work by default, you need to set Enable Client SDK Customize Invite Url.

    • Optionalmeeting?: { popper?: PopperStyle }

      Customization options for the meeting info panel.

      Options for the underlying popper element.

    • OptionalmeetingInfo?: MeetingInfoType[]

      Customization options for meeting info attributes.

    • Optionalparticipants?: { popper?: PopperStyle }

      Customization options for the participants panel.

      Options for the underlying popper element.

    • Optionalsetting?: { popper?: PopperStyle }

      Customization options for the settings panel.

      Options for the underlying popper element.

    • Optionalsharing?: { options?: { hideShareAudioOption?: boolean } }

      Customization options for screen sharing. When sharing a Chromium browser tab, users can transmit both audio playing in the tab and from their microphone. When sharing using a non-Chromium browser, users can only share their window or entire browser and no screen audio, but they can use their microphone audio.

      • Optionaloptions?: { hideShareAudioOption?: boolean }

        Start-screen-share options

        • OptionalhideShareAudioOption?: boolean

          Show (default, false) or hide (true) the "Share tab audio" checkbox when sharing a Chrome tab

    • Optionaltoolbar?: { buttons?: CustomButton[] }

      Customization options for the toolbar.

      Custom buttons to add to the toolbar dropdown menu.

    • Optionalvideo?: VideoOptions

      Customization options for the video or suspension view.

    Optional customization options for the embedded client.

    debug?: boolean
    enforceVirtualBackground?: boolean

    Enforce virtual background on Chromium-like browser without SharedArrayBuffer. Note

    • that this may result in high CPU and memory usage.
    language?:
        | "en-US"
        | "de-DE"
        | "es-ES"
        | "fr-FR"
        | "jp-JP"
        | "pt-PT"
        | "ru-RU"
        | "zh-CN"
        | "zh-TW"
        | "ko-KO"
        | "vi-VN"
        | "it-IT"
        | "pl-PL"
        | "tr-TR"
        | "id-ID"
        | "nl-NL"
        | "sv-SE"
        | "ja-JP"
        | "ko-KR"

    Default 'en-US'. jp-JP/ko-KO deprecated in v4.0.0, please use new ja-JP/ko-KR, will not accept jp-JP/ko-KO in 6.0.0

    leaveOnPageUnload?: boolean

    Immediately leave the meeting when refreshing or closing the page, instead of experiencing a delay in leaving the meeting (failover). Caveat for the scenario:

    • Breakout room: in rooms users need to be assigned again instead of being assigned and auto join the room.
    maximumVideosInGalleryView?: number

    Maximum participants displayed per screen in gallery view, up to 25.

    patchJsMedia?: boolean

    patchJsMedia: Optional. Default: false. Set to true to automatically apply the latest media dependency fix for the current Meeting SDK for web version. Note that you will still need to manually upgrade to major and minor version releases.

    webEndpoint?: string

    Default 'zoom.us'.

    zoomAppRoot: undefined | HTMLElement

    Renders the toolbar and main-panel-view using ReactDOM into the given container.

    The HTML element, typically a

    , to render the toolbar in.

    Settings

    Member Visibility

    On This Page

    Properties