Class StopStream

Represents a command to stop the pixel streaming session. This class sends a message to the Metabox API to stop the active stream and release its resources.

What does it unlock?

Stops the Unreal Engine pixel streaming connection, terminating the active session and freeing server-side resources.

Practical Application

Used to explicitly end the 3D streaming session — e.g., when the user closes a modal, navigates away, or a custom "Stop"/"Disconnect" button is pressed. Pair with ResumeStream to restart the session later without a full page reload.

AI Coding Best Practices

Call api.sendCommandToMetabox(new StopStream()). No parameters. Stops the existing streaming session — does not reset product/environment state. Use ResumeStream to reconnect afterwards.

Example

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

Index

Constructors

constructor

Properties

data

Constructors

constructor

new StopStream(): StopStream

Returns StopStream

Overrides CommandBase.constructor

Properties

data

data: ToMetaBoxMessageEnvelope

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

Class StopStream

What does it unlock?

Practical Application

AI Coding Best Practices

Example

Index

Constructors

Properties

Constructors

constructor

Returns StopStream

Properties

data

Settings

On This Page