Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • InitOptions

Index

Properties

assetPath?: string
param assetPath

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

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

Optional customization options for the embedded client.

Type declaration

  • Optional activeApps?: { popper?: PopperStyle }
    param activeApps

    Customization options for the active apps notifier popper position.

  • Optional chat?: { notificationCls?: PositionStyle; popper?: PopperStyle }

    Customization options for chat notifications and panel.

    param notificationCls

    Options for chat notifications.

    param popper

    Options for the underlying popper element.

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

  • Optional meeting?: { popper?: PopperStyle }

    Customization options for the meeting info panel.

    param popper

    Options for the underlying popper element.

  • Optional meetingInfo?: MeetingInfoType[]

    Customization options for meeting info attributes.

  • Optional participants?: { popper?: PopperStyle }

    Customization options for the participants panel.

    param popper

    Options for the underlying popper element.

  • Optional setting?: { popper?: PopperStyle }

    Customization options for the settings panel.

    param popper

    Options for the underlying popper element.

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

    • Optional options?: { hideShareAudioOption?: boolean }

      Start-screen-share options

      • Optional hideShareAudioOption?: boolean

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

  • Optional toolbar?: { buttons?: CustomButton[] }

    Customization options for the toolbar.

    param buttons

    Custom buttons to add to the toolbar dropdown menu.

  • Optional video?: VideoOptions

    Customization options for the video or suspension view.

debug?: 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"
param language

Default 'en-US'.

property

de-DE - German Deutsch

property

es-ES - Spanish Español

property

fr-FR - French Français

property

id-ID - Indonesian Bahasa Indonesia

property

it-IT - Italian Italia

property

jp-JP - Japanese 日本語

property

ko-KO - Korean 한국

property

nl-NL - Dutch Nederlands

property

pl-PL - Polish Polska

property

pt-PT - Portuguese Português

property

ru-RU - Russian Русский

property

tr-TR - Turkish Türkçe

property

zh-CN - Chinese 简体中文

property

zh-TW - Chinese 繁体中文

property

vi-VN - Vietnamese Tiếng Việt

property

en-US - English Default

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 Web Meeting SDK version. Note that you will still need to manually upgrade to major and minor version releases.

webEndpoint?: string
param webEndpoint

Default 'zoom.us'.

zoomAppRoot: undefined | HTMLElement

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

param zoomAppRoot

The HTML element, typically a

, to render the toolbar in.

Generated using TypeDoc