Interface OmakasePlayerApi

alerts

chroming

localization

player

session

timeline

timelines

tools

track

ui

attachPlayer

• attachPlayer(): Observable<void>

  Re-attaches a previously detached player.

  Returns Observable<void>

createTimeline

• createTimeline(
      configAndStyle?: ConfigAndStyle<TimelineConfig, TimelineStyle>,
  ): Observable<TimelineApi>

  Creates a timeline and appends it to the end of the HTML element identified by TimelineConfig.htmlElementId. Multiple timelines can exist at the same time, in the same or in different HTML elements.

  Parameters

  • OptionalconfigAndStyle: ConfigAndStyle<TimelineConfig, TimelineStyle>

    Timeline configuration and style.

  Returns Observable<TimelineApi>

  Observable that emits the created timeline.

detachPlayer

• detachPlayer(): Observable<void>

  Detaches the player, transitioning it into a remote playback mode.

  Returns Observable<void>

getTimeline

• getTimeline(id: string): TimelineApi | undefined

  Returns the timeline with the given id, or undefined if it doesn't exist or was destroyed.

  Parameters

  • id: string

    Timeline id, see TimelineApi.id.

  Returns TimelineApi | undefined

loadMainMedia

• loadMainMedia(
      url: string,
      loadOptions?: MainMediaLoadOptions,
  ): Observable<MainMedia>

  Loads the primary media source (HLS, MP4, or audio file).

  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 loaded MainMedia instance.