Zoom Video SDK for React - v0.0.2
    Preparing search index...

    Interface InitOptions

    Initializes options of the init method.

    interface InitOptions {
        alternativeNameForVideoPlayer?: string;
        enforceMultipleVideos?: boolean | { disableRenderLimits?: boolean };
        enforceVirtualBackground?: boolean;
        isLogDetailed?: boolean;
        leaveOnPageUnload?: boolean;
        patchJsMedia?: boolean;
        skipJsMedia?: boolean;
        stayAwake?: boolean;
        webEndpoint?: string;
    }
    Index

    Properties

    alternativeNameForVideoPlayer? enforceMultipleVideos? enforceVirtualBackground? isLogDetailed? leaveOnPageUnload? patchJsMedia? skipJsMedia? stayAwake? webEndpoint?

    Properties

    alternativeNameForVideoPlayer?: string

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

    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.

    Type Declaration

    • boolean
    • { disableRenderLimits?: boolean }
      • OptionaldisableRenderLimits?: boolean

        Remove the maximum video render limit, default is to limit to 4. For best performance when rendering multiple videos, use SharedArrayBuffer. If you cannot enable SharedArrayBuffer and need to render multiple videos, set enforceMultipleVideos to true. To render more than 4 without SharedArrayBuffer, for advanced use cases, set disableRenderLimits: true

    enforceVirtualBackground?: boolean

    Optional Enforces virtual background on browser without SharedArrayBuffer. This may result in high CPU and memory usage. Use CanvasElement to render the self video. See browser support for details.

    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.

    2.2.0

    leaveOnPageUnload?: boolean

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

    *Note: Due to limitations in Firefox support, this feature is not available on the Firefox browser.

    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.
    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.

    skipJsMedia?: boolean

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

    stayAwake?: boolean

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

    webEndpoint?: string

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

    Settings

    Member Visibility

    On This Page

    Properties