Class ResumeStream

Represents a command to resume the pixel streaming session. This class sends a message to the Metabox API to resume a paused or disconnected stream.

What does it unlock?

Resumes the Unreal Engine pixel streaming connection after it has been paused, disconnected, or stopped due to inactivity (AFK timeout).

Practical Application

Used to reconnect the 3D streaming session without a full page reload. Essential for 'Reconnect' or 'Resume' buttons shown when the stream is interrupted, e.g., after an idle timeout or network disruption.

AI Coding Best Practices

Call api.sendCommandToMetabox(new ResumeStream()). No parameters. Resumes the existing streaming session — does not reinitialize the configurator or reset product/environment state.

Example

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

Index

Constructors

constructor

Properties

data

Constructors

constructor

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

Properties

data

data: ToMetaBoxMessageEnvelope

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

Class ResumeStream

What does it unlock?

Practical Application

AI Coding Best Practices

Example

Index

Constructors

Properties

Constructors

constructor

Returns ResumeStream

Properties

data

Settings

On This Page