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

    Class PauseShowcase

    Represents a command to pause Showcase for a product when it is already initialized and playing. This class sends a command to the Metabox API to pause showcase for a product if it is already initialized and playing.

    To listen for changes after sending this command, listen to the 'showcaseStatusChanged' event.

    Pauses the showcase/timeline playback. Can be called independently without requiring any flag parameters.

    Pauses showcase animation playback. The showcase remains initialized and can be resumed with PlayShowcase. Use when you need to temporarily freeze the animation (e.g., on a "Pause" button click).

    Call api.sendCommandToMetabox(new PauseShowcase()). No parameters. Subscribe to showcaseStatusChanged to confirm 'pause' state. Use PlayShowcase to resume or StopShowcase to reset.

    import { Communicator,ShowCaseStatus,PauseShowcase } from '@3dsource/metabox-front-api';
    window.env3DSource.apiReady = (api: Communicator) => {

    //Subscribe to the event before sending the command to ensure you capture the response
    api.addEventListener('showcaseStatusChanged', (data:ShowCaseStatus) => {
    console.log('Showcase status value after changed:', data);
    });

    api.sendCommandToMetabox(new PauseShowcase());
    };
    Index

    Constructors

    Properties

    Constructors

    Properties

    data: ToMetaBoxMessageEnvelope

    The message envelope populated by subclass constructors and sent via Communicator.sendCommandToMetabox.