Interface PlayerCommonApi

isMainMediaLoaded

onEvent$

playerSession

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]

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]

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]

pause

• pause(): Observable<void>

  Pauses playback.

  Returns Observable<void>

play

• play(): Observable<void>

  Starts or resumes playback.

  Returns Observable<void>

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.

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.

seekToLive

• seekToLive(): Observable<boolean>

  Live mode only. Seeks to the current live edge (the recommended sync position). No-ops (false) when the loaded media isn't live.

  Returns Observable<boolean>

  Observable that emits true if the seek succeeded, false if not currently live.

setMediaRotation

• setMediaRotation(mediaRotation: MediaRotationValue): Observable<void>

  Rotates the video element by the given number of degrees. Ignored while the loaded main media is audio-only.

  Note: native <track> and hls.js-embedded subtitles render inside the video element itself and will visually rotate along with it. Use the PlayerTextHandlerType.MEDIA_CAPTIONS text handler (the library default) to keep captions upright regardless of rotation.

  Parameters

  • mediaRotation: MediaRotationValue

  Returns Observable<void>

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>

toggleFullScreen

• toggleFullScreen(): Observable<void>

  Toggles between fullscreen and windowed display.

  Returns Observable<void>

unloadMainMedia

• unloadMainMedia(): Observable<void>

  Unloads the current main media and releases associated resources.

  Returns Observable<void>