Zoom VideoSDK UI Toolkit
    Preparing search index...

    Type Alias CustomizationOptions

    Configuration options for customizing the Zoom Video SDK UI Toolkit.

    type CustomizationOptions = {
        debug?: boolean;
        dependentAssets?: string;
        features?: OldUIkitFeature[];
        featuresOptions?: {
            audio?: {
                backgroundNoiseSuppression?: boolean;
                enable: boolean;
                joinAudioConsent?: boolean;
                originalSound?: boolean;
                syncButtonsOnHeadset?: boolean;
            };
            caption?: { enable: boolean };
            chat?: { enable: boolean; enableEmoji: boolean };
            feedback?: { enable: boolean };
            footer?: { enable: boolean };
            header?: { enable: boolean };
            invite?: { enable: boolean; inviteLink?: string };
            leave?: { enable: boolean };
            phone?: { enable: boolean };
            playback?: { audioVideoPlaybacks: AudioVideoPlaybacks[]; enable: boolean };
            preview?: { enable: boolean; isAllowModifyName?: boolean };
            recording?: { enable: boolean };
            screenshot?: { share?: { enable: boolean }; video?: { enable: boolean } };
            secondaryAudio?: { enable: boolean };
            settings?: { enable: boolean };
            share?: { enable: boolean };
            subsession?: { enable: boolean };
            theme?: {
                defaultTheme?: "light" | "dark" | "blue" | "green";
                enable: boolean;
            };
            troubleshoot?: { enable: boolean };
            users?: { enable: boolean };
            video?: {
                enable: boolean;
                enforceMultipleVideos?: boolean;
                originalRatio?: boolean;
                virtualBackground?: boolean;
            };
            viewMode?: {
                defaultViewMode: SuspensionViewValue;
                enable: boolean;
                viewModes: SuspensionViewValue[];
            };
            virtualBackground?: {
                allowVirtualBackgroundUpload?: boolean;
                enable: boolean;
                enforceVirtualBackground?: boolean;
                virtualBackgrounds?: { displayName?: string; url: string }[];
            };
            whiteboard?: {
                enable: boolean;
                enableExport?: boolean;
                enableViewerUserExport?: boolean;
            };
        };
        language?: string;
        leaveOnPageUnload?: boolean;
        options?: {
            audio?: {
                backgroundNoiseSuppression?: boolean;
                originalSound?: boolean;
                syncButtonsOnHeadset?: boolean;
            };
            init?: {
                enforceMultipleVideos?: boolean;
                enforceVirtualBackground?: boolean;
                webEndpoint?: string;
            };
            share?: {
                controls?: boolean;
                displaySurface?: boolean;
                hideShareAudioOption?: boolean;
                optimizedForSharedVideo?: boolean;
            };
            video?: { originalRatio?: boolean; virtualBackground?: boolean };
        };
        sessionIdleTimeoutMins?: number;
        sessionName: string;
        sessionPasscode?: string;
        userName: string;
        videoSDKJWT: string;
        virtualBackground?: {
            allowVirtualBackground?: boolean;
            allowVirtualBackgroundUpload?: boolean;
            virtualBackgrounds?: string[];
        };
        webEndpoint?: string;
    }
    Index

    Properties

    debug? dependentAssets? features? featuresOptions? language? leaveOnPageUnload? options? sessionIdleTimeoutMins? sessionName sessionPasscode? userName videoSDKJWT virtualBackground? webEndpoint?

    Properties

    debug?: boolean

    Enable debug mode

    dependentAssets?: string

    Path to dependent assets

    features?: OldUIkitFeature[]

    Use featuresOptions instead.

    featuresOptions?: {
        audio?: {
            backgroundNoiseSuppression?: boolean;
            enable: boolean;
            joinAudioConsent?: boolean;
            originalSound?: boolean;
            syncButtonsOnHeadset?: boolean;
        };
        caption?: { enable: boolean };
        chat?: { enable: boolean; enableEmoji: boolean };
        feedback?: { enable: boolean };
        footer?: { enable: boolean };
        header?: { enable: boolean };
        invite?: { enable: boolean; inviteLink?: string };
        leave?: { enable: boolean };
        phone?: { enable: boolean };
        playback?: { audioVideoPlaybacks: AudioVideoPlaybacks[]; enable: boolean };
        preview?: { enable: boolean; isAllowModifyName?: boolean };
        recording?: { enable: boolean };
        screenshot?: { share?: { enable: boolean }; video?: { enable: boolean } };
        secondaryAudio?: { enable: boolean };
        settings?: { enable: boolean };
        share?: { enable: boolean };
        subsession?: { enable: boolean };
        theme?: {
            defaultTheme?: "light" | "dark" | "blue" | "green";
            enable: boolean;
        };
        troubleshoot?: { enable: boolean };
        users?: { enable: boolean };
        video?: {
            enable: boolean;
            enforceMultipleVideos?: boolean;
            originalRatio?: boolean;
            virtualBackground?: boolean;
        };
        viewMode?: {
            defaultViewMode: SuspensionViewValue;
            enable: boolean;
            viewModes: SuspensionViewValue[];
        };
        virtualBackground?: {
            allowVirtualBackgroundUpload?: boolean;
            enable: boolean;
            enforceVirtualBackground?: boolean;
            virtualBackgrounds?: { displayName?: string; url: string }[];
        };
        whiteboard?: {
            enable: boolean;
            enableExport?: boolean;
            enableViewerUserExport?: boolean;
        };
    }

    Advanced options for specific features

    language?: string

    Interface language setting

    leaveOnPageUnload?: boolean

    leaveOnPageUnload

    options?: {
        audio?: {
            backgroundNoiseSuppression?: boolean;
            originalSound?: boolean;
            syncButtonsOnHeadset?: boolean;
        };
        init?: {
            enforceMultipleVideos?: boolean;
            enforceVirtualBackground?: boolean;
            webEndpoint?: string;
        };
        share?: {
            controls?: boolean;
            displaySurface?: boolean;
            hideShareAudioOption?: boolean;
            optimizedForSharedVideo?: boolean;
        };
        video?: { originalRatio?: boolean; virtualBackground?: boolean };
    }

    Type declaration

    • Optionalaudio?: {
          backgroundNoiseSuppression?: boolean;
          originalSound?: boolean;
          syncButtonsOnHeadset?: boolean;
      }

      Use featuresOptions.audio instead.

    • Optionalinit?: {
          enforceMultipleVideos?: boolean;
          enforceVirtualBackground?: boolean;
          webEndpoint?: string;
      }
      • OptionalenforceMultipleVideos?: boolean

        Use featuresOptions.video.enforceMultipleVideos instead.

      • OptionalenforceVirtualBackground?: boolean

        Use featuresOptions.virtualBackground.enforceVirtualBackground instead.

      • OptionalwebEndpoint?: string

        Use webEndpoint instead.

    • Optionalshare?: {
          controls?: boolean;
          displaySurface?: boolean;
          hideShareAudioOption?: boolean;
          optimizedForSharedVideo?: boolean;
      }

      Use featuresOptions.share instead.

    • Optionalvideo?: { originalRatio?: boolean; virtualBackground?: boolean }

      Use featuresOptions.video instead.

    Use featuresOptions.audio/video/share/virtualBackground and webEndpoint instead.

    sessionIdleTimeoutMins?: number

    Session timeout duration in minutes

    sessionName: string

    Name of the session to join

    sessionPasscode?: string

    Password/passcode for the session

    userName: string

    Display name of the user

    videoSDKJWT: string

    Authentication token for the Video SDK

    virtualBackground?: {
        allowVirtualBackground?: boolean;
        allowVirtualBackgroundUpload?: boolean;
        virtualBackgrounds?: string[];
    }

    Use featuresOptions.virtualBackground instead.

    webEndpoint?: string

    Web endpoint URL for the session

    Settings

    Member Visibility

    On This Page

    Properties