Interface PlayerCommonApi

Shared API surface inherited by all player variants (PlayerApi, PlayerInternalApi, PlayerLocalApi, PlayerDetachedApi).

Provides playback control, seeking (supporting multiple temporal formats), time conversion, playback rate, and fullscreen toggling.

interface PlayerCommonApi {
    isMainMediaLoaded: boolean;
    onEvent$: Observable<PlayerEvent>;
    playerSession: PlayerSession;
    convertTime<S extends MediaTemporalFormat, D extends MediaTemporalFormat>(
        value: MediaTemporalFormatValueMap[S],
        valueFormat: S,
        destinationFormat: D,
    ): MediaTemporalFormatValueMap[D];
    getCurrentTime<F extends MediaTemporalFormat>(
        format: F,
    ): MediaTemporalFormatValueMap[F];
    getDuration<F extends MediaTemporalFormat>(
        format: F,
    ): MediaTemporalFormatValueMap[F];
    pause(): Observable<void>;
    play(): Observable<void>;
    seekFromCurrentTime<F extends MediaTemporalFormat>(
        value: MediaTemporalFormatValueMap[F],
        format: F,
    ): Observable<boolean>;
    seekTo<F extends MediaTemporalFormat>(
        value: MediaTemporalFormatValueMap[F],
        format: F,
    ): Observable<boolean>;
    setPlaybackRate(playbackRate: number): Observable<void>;
    toggleFullScreen(): Observable<void>;
    unloadMainMedia(): Observable<void>;
}

Hierarchy (View Summary)

PlayerCommonApi
- PlayerApi
- PlayerInternalApi

Index

Properties

isMainMediaLoaded onEvent$ playerSession

Methods

convertTime getCurrentTime getDuration pause play seekFromCurrentTime seekTo setPlaybackRate toggleFullScreen unloadMainMedia

Properties

isMainMediaLoaded

isMainMediaLoaded: boolean

Whether a main media source is currently loaded and ready.

onEvent$

onEvent$: Observable<PlayerEvent>

Observable stream of player lifecycle and playback events.

playerSession

playerSession: PlayerSession

Current player session state (playback position, audio/text selection, etc.).

Methods

convertTime

convertTime<S extends MediaTemporalFormat, D extends MediaTemporalFormat>(
    value: MediaTemporalFormatValueMap[S],
    valueFormat: S,
    destinationFormat: D,
): MediaTemporalFormatValueMap[D]
Converts a time value from one MediaTemporalFormat to another (e.g. seconds → timecode, frame count → percent).
Type Parameters
- S extends MediaTemporalFormat
- D extends MediaTemporalFormat
Parameters
- value: MediaTemporalFormatValueMap[S]
  The time value to convert.
- valueFormat: S
  The format of the input value.
- destinationFormat: D
  The desired output format.
Returns MediaTemporalFormatValueMap[D]
- Defined in src/player/player-api.ts:363

getCurrentTime

getCurrentTime<F extends MediaTemporalFormat>(
format: F,
): MediaTemporalFormatValueMap[F]
Returns the current playback time. Defaults to seconds; pass a MediaTemporalFormat to get the value in another format (frame count, percent, timecode, media time, countdown).
Type Parameters
- F extends MediaTemporalFormat
Parameters
- format: F
Returns MediaTemporalFormatValueMap[F]
- Defined in src/player/player-api.ts:265

getDuration

getDuration<F extends MediaTemporalFormat>(
format: F,
): MediaTemporalFormatValueMap[F]
Returns the media duration. Defaults to seconds; pass a MediaTemporalFormat to get the value in another format.
Type Parameters
- F extends MediaTemporalFormat
Parameters
- format: F
Returns MediaTemporalFormatValueMap[F]
- Defined in src/player/player-api.ts:273

pause

pause(): Observable<void>
Pauses playback.

Returns Observable<void>
- Defined in src/player/player-api.ts:257

play

play(): Observable<void>
Starts or resumes playback.

Returns Observable<void>
- Defined in src/player/player-api.ts:252

seekFromCurrentTime

seekFromCurrentTime<F extends MediaTemporalFormat>(
value: MediaTemporalFormatValueMap[F],
format: F,
): Observable<boolean>
Seeks by a relative offset from the current playback position. The value is interpreted according to the given MediaTemporalFormat (defaults to seconds).
Type Parameters
- F extends MediaTemporalFormat
Parameters
- value: MediaTemporalFormatValueMap[F]
- format: F
Returns Observable<boolean>
Observable that emits true if the seek succeeded.
- Defined in src/player/player-api.ts:317

seekTo

seekTo<F extends MediaTemporalFormat>(
value: MediaTemporalFormatValueMap[F],
format: F,
): Observable<boolean>
Seeks to an absolute position. The value is interpreted according to the given MediaTemporalFormat (defaults to seconds).
Type Parameters
- F extends MediaTemporalFormat
Parameters
- value: MediaTemporalFormatValueMap[F]
- format: F
Returns Observable<boolean>
Observable that emits true if the seek succeeded.
- Defined in src/player/player-api.ts:295

setPlaybackRate

setPlaybackRate(playbackRate: number): Observable<void>
Sets the playback rate.
Parameters
- playbackRate: number
  Decimal value in the range [0.1, 16]. For example, 2 plays at 2x speed.
Returns Observable<void>
- Defined in src/player/player-api.ts:369

toggleFullScreen

toggleFullScreen(): Observable<void>
Toggles between fullscreen and windowed display.

Returns Observable<void>
- Defined in src/player/player-api.ts:374

unloadMainMedia

unloadMainMedia(): Observable<void>
Unloads the current main media and releases associated resources.

Returns Observable<void>
- Defined in src/player/player-api.ts:247

Interface PlayerCommonApi

Hierarchy (View Summary)

Index

Properties

Methods

Properties

isMainMediaLoaded

onEvent$

playerSession

Methods

convertTime

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[D]

getCurrentTime

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[F]

getDuration

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[F]

pause

Returns Observable<void>

play

Returns Observable<void>

seekFromCurrentTime

Type Parameters

Parameters

Returns Observable<boolean>

seekTo

Type Parameters

Parameters

Returns Observable<boolean>

setPlaybackRate

Parameters

Returns Observable<void>

toggleFullScreen

Returns Observable<void>

unloadMainMedia

Returns Observable<void>

Settings

On This Page