IVideoPlayerState

interface
Composable Returns

Reactive state surface returned by useVideoPlayer. Extends the media-shared IMediaPlayerState baseline with video-specific reactive refs: fullscreen and pip.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

fullscreen
required
Ref<boolean>
True when the element (or wrapper) is in fullscreen.
pip
required
Ref<boolean>
True when the video is in picture-in-picture.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reading fullscreen and PIP state

typescript