Scena Instance

Object returned by mount() providing access to api, constants, visibility, and preview.

The handle returned by a successful mount call. It groups the video controller, event bus, config store, and feature APIs into a single object that lives for the lifetime of the widget.

const instance = await scena.mount({
  video: { src: '/video.mp4' },
});

Properties

Property	Type	Description
`api`	`ScenaApi`	Video controller, component refs, and event bus
`component`	`ScenaRef`	Reference to the mounted Svelte component
`config`	`UseScenaConfigReturns`	Reactive config store
`preview`	`PreviewApi`	Preview mode controls
`visibility`	`VisibilityApi`	Show/hide controls

api

The main API surface for interacting with a mounted widget.

Property	Type	Description
`api.controller`	`UseVideoControllerReturns`	Video playback control (play, pause, seek, volume)
`api.components`	`ScenaComponents`	References to all child component instances
`api.events`	`ScenaEventEmitter`	Pub/sub event bus

// Control playback
instance.api.controller.play();

// Subscribe to events
instance.api.events.on(ScenaEvent.ON_VIDEO_PLAY, ({ state }) => {
  console.log('Playing at', state.currentTime);
});

See Video Controller for the full playback API.

config

Reactive config store with get, set, and merge methods.

instance.config.mergeConfig({
  size: ComponentSize.LG,
});

See useConfig() for all available methods.

preview

Controls preview mode at runtime.

instance.preview.start();
instance.preview.stop();
instance.preview.isPreviewing;

See Preview API for details.

visibility

Controls widget visibility at runtime.

instance.visibility.show();
instance.visibility.hide();
instance.visibility.isHidden;

See Visibility API for details.

components

Provides references to all child component instances. Nullable refs correspond to components that can be disabled via config (false).

Property	Type
`container`	`ScenaContainerRef`
`video`	`ScenaVideoRef`
`videoContainer`	`ScenaVideoContainerRef`
`videoLoader`	`ScenaVideoLoaderRef \| null`
`videoProgress`	`ScenaVideoProgressRef \| null`
`videoControls`	`ScenaVideoControlsRef \| null`
`videoVolume`	`ScenaVideoVolumeRef \| null`
`closeButton`	`ScenaCloseButtonRef \| null`
`ctaButton`	`ScenaCtaButtonRef \| null`

Each ref exposes a getElements() method that returns the underlying DOM nodes:

const { root, video } = instance.api.components.video.getElements();

console.log(video.currentTime);

useConfig

Get, set, and deep merge widget configuration at runtime with getConfig, setConfig, and mergeConfig.

Video Controller

Control playback with play, pause, stop, seek, mute, unmute, setVolume, and reactive state properties.