@3dsource/metabox-front-api
    Preparing search index...

    Interface IntegrateMetaboxConfig

    Configuration options for integrating the Metabox Basic Configurator iframe into a host page. Passed as the config parameter to integrateMetabox.

    Configuration interface for initializing the configurator. Passed to integrateMetabox function with settings like domain, host, and standalone mode.

    Config interface for integrateMetabox() initialization. Supports: standalone (boolean — disables all built-in UI), introImage/introVideo (URLs), loadingImage (URL), state (initial state), domain (HTTPS override), showLoadingProgress (boolean — loading progress bar), showResumeStreamPopup (boolean — resume-stream popup), showUserInactivityTimer (boolean — AFK countdown popup), userInactivityTimeout (number — AFK seconds), autoStartStream (boolean — whether the stream starts automatically on load).

    Pass as the 4th parameter to integrateMetabox(). Key: standalone:true for custom UI builds. loadingImage for branded loading. domain only if overriding the default MetaBox server. All URLs must be HTTPS. The state field lets you restore a previously saved configuration. Set autoStartStream:false to defer the pixel stream and start it manually via the ResumeStream command.

    interface IntegrateMetaboxConfig {
        autoStartStream?: boolean;
        domain?: string;
        introImage?: string;
        introVideo?: string;
        loadingImage?: string;
        showLoadingProgress?: boolean;
        showResumeStreamPopup?: boolean;
        showUserInactivityTimer?: boolean;
        standalone?: boolean;
        state?: string;
        userInactivityTimeout?: number;
    }
    Index
    autoStartStream? domain? introImage? introVideo? loadingImage? showLoadingProgress? showResumeStreamPopup? showUserInactivityTimer? standalone? state? userInactivityTimeout?
    autoStartStream?: boolean

    Controls whether the pixel stream starts automatically on load (added as ?autoStartStream=...). Set to false to defer streaming until you start it manually via the ResumeStream command.

    domain?: string

    Custom domain for testing purposes. Defaults to metabox.3dsource.com. HTTPS is enforced.

    introImage?: string

    URL to an image shown on the intro screen (added as ?introImage=...).

    introVideo?: string

    URL to a video shown on the intro screen (added as ?introVideo=...).

    loadingImage?: string

    URL to an image displayed while the configurator is loading (added as ?loadingImage=...).

    showLoadingProgress?: boolean

    If true, shows the loading progress bar inside the configurator (added as ?showLoadingProgress=true).

    showResumeStreamPopup?: boolean

    If true, shows the resume stream popup when the stream is paused (added as ?showResumeStreamPopup=true).

    showUserInactivityTimer?: boolean

    If true, shows the user inactivity countdown popup before disconnecting (added as ?showUserInactivityTimer=true).

    standalone?: boolean

    If true, disables Metabox custom template and all related logic.

    state?: string

    Predefined state for the configurator on initial loading in rison format (see https://github.com/Nanonid/rison) (added as ?state=...).

    userInactivityTimeout?: number

    Inactivity timeout in seconds before the user is warned and eventually disconnected (added as ?userInactivityTimeout=...).

    Settings
    Member Visibility

    On This Page
    What does it unlock?Practical ApplicationAI Coding Best Practices
    Properties