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

    Interface ToMetaboxMessagePayloads

    Interface for messages sent from the application to the Basic Metabox API.

    Defines payload structures for different types of outgoing messages to MetaBox. Contains data models for various command parameters.

    Payload type definitions for all outgoing command types. Defines required and optional fields per command. Essential TypeScript reference for type-safe command construction.

    Use as TypeScript type reference for proper typing when building dynamic command dispatchers. Each key corresponds to a command name and its value defines the expected payload structure.

    interface ToMetaboxMessagePayloads {
        applyZoom: { zoom: number };
        getCallToActionInformation: void;
        getCamera: void;
        getPdf: void;
        getScreenshot: { format: MimeType; size?: { x: number; y: number } };
        initShowcase: void;
        metaboxConfig: { appId: string; config: MetaboxCommandConfig };
        pauseShowcase: void;
        playShowcase: void;
        resetCamera: void;
        sendCommandToUnreal: object;
        setCamera: { camera: CameraCommandPayload };
        setEnvironment: { id: string };
        setEnvironmentMaterialById: { materialId: string; slotId: string };
        setProduct: { productId: string };
        setProductMaterialById: { materialId: string; slotId: string };
        showEmbeddedMenu: { visible: boolean };
        showOverlayInterface: { visible: boolean };
        stopShowcase: void;
    }
    Index

    Properties

    applyZoom getCallToActionInformation getCamera getPdf getScreenshot initShowcase metaboxConfig pauseShowcase playShowcase resetCamera sendCommandToUnreal setCamera setEnvironment setEnvironmentMaterialById setProduct setProductMaterialById showEmbeddedMenu showOverlayInterface stopShowcase

    Properties

    applyZoom: { zoom: number }
    getCallToActionInformation: void
    getCamera: void
    getPdf: void
    getScreenshot: { format: MimeType; size?: { x: number; y: number } }
    initShowcase: void
    metaboxConfig: { appId: string; config: MetaboxCommandConfig }
    pauseShowcase: void
    playShowcase: void
    resetCamera: void
    sendCommandToUnreal: object
    setCamera: { camera: CameraCommandPayload }
    setEnvironment: { id: string }
    setEnvironmentMaterialById: { materialId: string; slotId: string }
    setProduct: { productId: string }
    setProductMaterialById: { materialId: string; slotId: string }
    showEmbeddedMenu: { visible: boolean }
    showOverlayInterface: { visible: boolean }
    stopShowcase: void

    Settings

    Member Visibility

    On This Page

    What does it unlock?Practical ApplicationAI Coding Best Practices
    Properties