Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InitOptions

Initializes options of the init method.

Hierarchy

  • InitOptions

Index

Properties

Properties

Optional alternativeNameForVideoPlayer

alternativeNameForVideoPlayer?: string

Alternative name for Zoom Video Player to avoid name conflict with existing web component.

Optional enforceMultipleVideos

enforceMultipleVideos?: boolean | { disableRenderLimits?: boolean }

Optional Enforces multiple videos if true (up to 3 videos of others and 1 video of self) on platform without SharedArrayBuffer. If false, limits the view to one video. This may result in high CPU and memory usage. To increase the limit to up to 25 videos, set disableRenderLimits to true: enforceMultipleVideos({ disableRenderLimits: true }) Note that the video quality may be poor and unreliable. See browser support for details.

Optional enforceVirtualBackground

enforceVirtualBackground?: boolean

Optional Enforces virtual background on browser. This may result in high CPU and memory usage. See browser support for details.

Optional isLogDetailed

isLogDetailed?: boolean

Whether to enable the detailed log report.

*Note: Default is true.

If enabled, the detailed log will be reported to the Zoom server when the session ends or the user leaves the session.

since

2.2.0

Optional leaveOnPageUnload

leaveOnPageUnload?: boolean

Quickly leave the session when refreshing or closing the page, instead of experiencing session failover.

*Note: This feature relies on the browser's beforeunload event, which may not fire reliably on some browsers (especially Firefox) and platforms (especially mobile). See MDN: Window beforeunload event for browser compatibility details.

Caveat for two scenarios:

  • PSTN: Phone user who is bound to the current user. The phone will hang up instead of staying connected.
  • Subsession: Users in a subsession need to be assigned again instead of having been assigned and auto-joining the subsession.

Optional patchJsMedia

patchJsMedia?: boolean

Optional Automatically apply the latest media dependency fixes. Default is false, but as a best practice, we recommend that you set it to true.

Optional skipJsMedia

skipJsMedia?: boolean

Optional Do not load dependent assets. Used to address specific edge-cases. Do not use for almost all use-cases.

Optional stayAwake

stayAwake?: boolean

Prevents devices from dimming or locking the screen when in a session.

Optional webEndpoint

webEndpoint?: string

Optional Specifies the web endpoint. The default is zoom.us.