Class PlayShowcase

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

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

What does it unlock?

Starts or resumes the showcase/timeline playback. Executes the internal MetaBox play command internally.

Practical Application

Starts or resumes showcase playback. Use for 'Play Demo' buttons on landing pages, auto-play on page load, or resuming demos after inactivity timeout on kiosk displays.

AI Coding Best Practices

Call api.sendCommandToMetabox(new PlayShowcase()). Must call InitShowcase() first or it won't play. Subscribe to showcaseStatusChanged to track state. Auto-play pattern: wait for viewportReady → InitShowcase → PlayShowcase.

Example

import { Communicator,PlayShowcase } 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) => {
       console.log('Showcase status value after changed:', data);
    });

    api.sendCommandToMetabox(new PlayShowcase());
};

Index

Constructors

constructor

Properties

data

Constructors

constructor

new PlayShowcase(): PlayShowcase
Returns PlayShowcase
Overrides CommandBase.constructor

Properties

data

data: ToMetaBoxMessageEnvelope

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

Class PlayShowcase

What does it unlock?

Practical Application

AI Coding Best Practices

Example

Index

Constructors

Properties

Constructors

constructor

Returns PlayShowcase

Properties

data

Settings

On This Page