Interface PlayerApi

Player API.

interface PlayerApi {
    audio: PlayerAudioApi;
    htmlMediaElement: HTMLMediaElement | undefined;
    isMainMediaLoaded: boolean;
    mainMedia: MainMedia | undefined;
    onEvent$: Observable<PlayerEvent>;
    playerSession: PlayerSession;
    text: PlayerTextApi;
    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];
    getPlaybackEngine<T extends MainMediaType>(
        mainMediaType: T,
    ): PlayerPlaybackEngineMapping[T];
    isFullScreen(): boolean;
    loadMainMedia(
        url: string,
        loadOptions?: MainMediaLoadOptions,
    ): Observable<MainMedia>;
    loadSidecarTrack(
        source: Source,
        loadOptions?: TrackLoadOptions,
    ): Observable<Track<TrackState, OmpEvent<any, any>>>;
    loadSidecarTrack(
        url: string,
        loadOptions?: TrackLoadOptions,
    ): Observable<Track<TrackState, OmpEvent<any, any>>>;
    loadSlate(slateType: BLACK): Observable<MainMedia>;
    pause(): Observable<void>;
    play(): Observable<void>;
    removeAllSidecarTracks(): Observable<void>;
    removeSidecarTrack(id: 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

PlayerCommonApi
- PlayerApi

Implemented by

Player

Properties

audio

audio: PlayerAudioApi

Audio API.

htmlMediaElement

htmlMediaElement: HTMLMediaElement | undefined

The underlying HTML element, or undefined if not yet created.

isMainMediaLoaded

isMainMediaLoaded: boolean

Whether a main media source is currently loaded and ready.

mainMedia

mainMedia: MainMedia | undefined

The currently loaded main media, or undefined if nothing is loaded.

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

text

text: PlayerTextApi

Text API.

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:363

extractVideoKeyframe

extractVideoKeyframe(options?: VideoKeyframeOptions): Observable<VideoKeyframe>
Extracts video frame from current playhead position
Parameters
- Optionaloptions: VideoKeyframeOptions
Returns Observable<VideoKeyframe>
- Defined in src/player/player-api.ts:137

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

getPlaybackEngine

getPlaybackEngine<T extends MainMediaType>(
mainMediaType: T,
): PlayerPlaybackEngineMapping[T]
Returns the playback engine instance for the given media type, providing access to engine-specific configuration (e.g. HLS.js internals).
Type Parameters
- T extends MainMediaType
Parameters
- mainMediaType: T
Returns PlayerPlaybackEngineMapping[T]
- Defined in src/player/player-api.ts:128

isFullScreen

isFullScreen(): boolean
Whether the player is currently in fullscreen mode.

Returns boolean
- Defined in src/player/player-api.ts:131

loadMainMedia

loadMainMedia(
url: string,
loadOptions?: MainMediaLoadOptions,
): Observable<MainMedia>
Loads the primary media source.
Parameters
- url: string
  URL of the media source.
- OptionalloadOptions: MainMediaLoadOptions
  Optional load configuration (frame rate, DRM data, poster, etc.).
Returns Observable<MainMedia>
Observable that emits the MainMedia once its load stage reaches success.
- Defined in src/player/player-api.ts:88

loadSidecarTrack

loadSidecarTrack(
source: Source,
loadOptions?: TrackLoadOptions,
): Observable<Track<TrackState, OmpEvent<any, any>>>
Loads a sidecar track (audio or text) from a Source object or URL string.
Parameters
- source: Source
  A Source object or URL string pointing to the sidecar data.
- OptionalloadOptions: TrackLoadOptions
  Optional configuration specifying track type, text, or audio options.
Returns Observable<Track<TrackState, OmpEvent<any, any>>>
Observable that emits the loaded Track.
- Defined in src/player/player-api.ts:97
loadSidecarTrack(
url: string,
loadOptions?: TrackLoadOptions,
): Observable<Track<TrackState, OmpEvent<any, any>>>
Parameters
- url: string
- OptionalloadOptions: TrackLoadOptions
Returns Observable<Track<TrackState, OmpEvent<any, any>>>
- Defined in src/player/player-api.ts:98

loadSlate

loadSlate(slateType: BLACK): Observable<MainMedia>
Replaces the current media with a slate (e.g. a black frame placeholder).
Parameters
- slateType: BLACK
  The type of slate to load.
Returns Observable<MainMedia>
Observable that emits the slate as a MainMedia instance.
- Defined in src/player/player-api.ts:106

pause

pause(): Observable<void>
Pauses playback.

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

play

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

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

removeAllSidecarTracks

removeAllSidecarTracks(): Observable<void>
Removes all sidecar tracks.

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

removeSidecarTrack

removeSidecarTrack(id: string): Observable<void>
Removes a single sidecar track by its id.
Parameters
- id: string
Returns Observable<void>
- Defined in src/player/player-api.ts:109

restorePlayerSession

restorePlayerSession(playerSession: PlayerSession): Observable<void>
Restores a previously persisted player session (playback position, audio/text state, etc.).
Parameters
- playerSession: PlayerSession
Returns Observable<void>
- Defined in src/player/player-api.ts:116

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

toggleFullScreen

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

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

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:247

Interface PlayerApi

Hierarchy

Implemented by

Index

Properties

Methods

Properties

audio

htmlMediaElement

isMainMediaLoaded

mainMedia

onEvent$

playerSession

text

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]

getPlaybackEngine

Type Parameters

Parameters

Returns PlayerPlaybackEngineMapping[T]

isFullScreen

Returns boolean

loadMainMedia

Parameters

Returns Observable<MainMedia>

loadSidecarTrack

Parameters

Returns Observable<Track<TrackState, OmpEvent<any, any>>>

Parameters

Returns Observable<Track<TrackState, OmpEvent<any, any>>>

loadSlate

Parameters

Returns Observable<MainMedia>

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