Interface PlayerInternalApi

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 PlayerInternalApi {
    audioInternal: PlayerAudioInternalApi;
    isMainMediaLoaded: boolean;
    onEvent$: Observable<PlayerEvent>;
    playerSession: PlayerSession;
    textInternal: PlayerTextInternalApi;
    convertTime<S extends MediaTemporalFormat, D extends MediaTemporalFormat>(
        value: MediaTemporalFormatValueMap[S],
        valueFormat: S,
        destinationFormat: D,
    ): MediaTemporalFormatValueMap[D];
    extractVideoKeyframe(
        options?: VideoKeyframeOptions,
    ): Observable<VideoKeyframe>;
    getCurrentTime<F extends MediaTemporalFormat>(
        format: F,
    ): MediaTemporalFormatValueMap[F];
    getDuration<F extends MediaTemporalFormat>(
        format: F,
    ): MediaTemporalFormatValueMap[F];
    loadSidecarTrack(
        trackId: string,
        loadOptions?: TrackLoadOptions,
    ): Observable<void>;
    pause(): Observable<void>;
    play(): Observable<void>;
    removeAllSidecarTracks(): Observable<void>;
    removeSidecarTrack(trackId: string): Observable<void>;
    restorePlayerSession(playerSession: PlayerSession): 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
- PlayerInternalApi
  - PlayerLocalApi
  - PlayerDetachedApi

Properties

audioInternal

audioInternal: PlayerAudioInternalApi

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.).

textInternal

textInternal: PlayerTextInternalApi

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]
Inherited from PlayerCommonApi.convertTime
- Defined in src/player/player-api.ts:359

extractVideoKeyframe

extractVideoKeyframe(options?: VideoKeyframeOptions): Observable<VideoKeyframe>
Parameters
- Optionaloptions: VideoKeyframeOptions
Returns Observable<VideoKeyframe>
- Defined in src/player/player-api.ts:171

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]
Inherited from PlayerCommonApi.getCurrentTime
- Defined in src/player/player-api.ts:261

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]
Inherited from PlayerCommonApi.getDuration
- Defined in src/player/player-api.ts:269

loadSidecarTrack

loadSidecarTrack(
trackId: string,
loadOptions?: TrackLoadOptions,
): Observable<void>
Parameters
- trackId: string
- OptionalloadOptions: TrackLoadOptions
Returns Observable<void>
- Defined in src/player/player-api.ts:168

pause

pause(): Observable<void>
Pauses playback.

Returns Observable<void>
Inherited from PlayerCommonApi.pause
- Defined in src/player/player-api.ts:253

play

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

Returns Observable<void>
Inherited from PlayerCommonApi.play
- Defined in src/player/player-api.ts:248

removeAllSidecarTracks

removeAllSidecarTracks(): Observable<void>
Returns Observable<void>
- Defined in src/player/player-api.ts:170

removeSidecarTrack

removeSidecarTrack(trackId: string): Observable<void>
Parameters
- trackId: string
Returns Observable<void>
- Defined in src/player/player-api.ts:169

restorePlayerSession

restorePlayerSession(playerSession: PlayerSession): Observable<void>
Parameters
- playerSession: PlayerSession
Returns Observable<void>
- Defined in src/player/player-api.ts:166

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.
Inherited from PlayerCommonApi.seekFromCurrentTime
- Defined in src/player/player-api.ts:313

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.
Inherited from PlayerCommonApi.seekTo
- Defined in src/player/player-api.ts:291

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>
Inherited from PlayerCommonApi.setPlaybackRate
- Defined in src/player/player-api.ts:365

toggleFullScreen

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

Returns Observable<void>
Inherited from PlayerCommonApi.toggleFullScreen
- Defined in src/player/player-api.ts:370

unloadMainMedia

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

Returns Observable<void>
Inherited from PlayerCommonApi.unloadMainMedia
- Defined in src/player/player-api.ts:243

Interface PlayerInternalApi

Hierarchy (View Summary)

Index

Properties

Methods

Properties

audioInternal

isMainMediaLoaded

onEvent$

playerSession

textInternal

Methods

convertTime

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[D]

extractVideoKeyframe

Parameters

Returns Observable<VideoKeyframe>

getCurrentTime

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[F]

getDuration

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[F]

loadSidecarTrack

Parameters

Returns Observable<void>

pause

Returns Observable<void>

play

Returns Observable<void>

removeAllSidecarTracks

Returns Observable<void>

removeSidecarTrack

Parameters

Returns Observable<void>

restorePlayerSession

Parameters

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