Optional ReadonlyframeExact frame timing when the source provides an index; null otherwise.
Optional ReadonlyframeIndexed moves and observable scrub landings for push-based indexed sources.
OptionalsetResize engine-backed display-box output without reopening the source. Resolves after the resized frame is presented; supersession rejects with AbortError. Available only on sources that support live output sizing.
Flips playback without the caller first reading which way it is going, so a frame presented between the read and the call cannot invert the result. Rejects when the play it decides on fails.
Lands on mediaTime and resolves once the frame there is presented.
Moves the playhead for a gesture that is still moving, such as a timeline
drag between pointer down and up. The frame that answers it may be an
approximation; seek is what lands the released position exactly.
Re-read detections and redraw the currently presented media frame.
Encodes the media frame that is currently presented.
The renderer keeps decode and render ownership: the returned image is a copy of the presented media pixels taken before encoding starts, so a frame presented while the encoder runs cannot change the result.
Optionaloptions: MediaFrameCaptureOptionsReplaces selection; an ordered detectionIds list returns its last valid pick.
OptionalsetReplaces the depth that depth renderers draw, or removes it with
null, and redraws the frame on screen. Rejects with a RangeError for a
malformed map or one whose aspect ratio differs from the media's.
OptionalgetThe depth map on screen, with the media size it is stretched over, or
null when no depth is drawn. Pass it to readDepthAt for a readout.
Explicit renders issued under the render-on-change policy, which a media
source that pushes presented frames and a still image run under: the count
moves when something on screen changed, so a paused, untouched renderer
holds it still. It is null when the renderer pulls samples from media
that plays, because Pixi's ticker then paints every animation frame and no
count describes that, so a null here is an answer rather than a failure.
Span and per-frame readiness of the prepared annotation window, for
instruments; null when the scene free-runs on the ticker or no window
exists, so a null here is an answer rather than a failure.
Apply an exact natural-media-to-CSS transform, including while locked. The scale must be positive and finite. Locking suppresses pointer viewport gestures; it does not block explicit toolbar or restored viewport state.
Prevent pointer viewport gestures without blocking explicit transforms.
Returns the label rectangle exactly as laid out by the renderer.
Coordinates are relative to the renderer container and already include fit, pan, zoom, screen-stable label sizing, and media-edge clamping.
Optionalset
Lower-level renderer controller.
Prefer
MediaSessionfor application code unless you need to own media preparation and detection buffering yourself.