Class OmakasePlayer

constructor

• new OmakasePlayer(
      config?: WithOptionalPartial<OmakasePlayerConfig, "protocol">,
  ): OmakasePlayer

• Parameters

  • Optionalconfig: WithOptionalPartial<OmakasePlayerConfig, "protocol">

  Returns OmakasePlayer

Staticinstance

alerts

• get alerts(): AlertsApi

• Returns AlertsApi

  Alerts API

audio

• get audio(): AudioApi

• Returns AudioApi

  Audio API

subtitles

• get subtitles(): SubtitlesApi

• Returns SubtitlesApi

  Subtitles API

timeline

• get timeline(): undefined | TimelineApi

• Returns undefined | TimelineApi

  Timeline API

video

• get video(): VideoApi

• Returns VideoApi

  Video API

createMarkerList

• createMarkerList(config: MarkerListConfig): Observable<MarkerListApi>

• Creates Marker List

  Parameters

  • config: MarkerListConfig

    Marker List configuration

  Returns Observable<MarkerListApi>

createTimeline

• createTimeline(
      config: Partial<ConfigWithOptionalStyle<TimelineConfig>>,
  ): Observable<TimelineApi>

• Creates Timeline

  Parameters

  • config: Partial<ConfigWithOptionalStyle<TimelineConfig>>

    Timeline configuration

  Returns Observable<TimelineApi>

destroy

• destroy(): void

• Destroys OmakasePlayer instance and frees up memory

  Returns void

loadVideo

• loadVideo(
      videoSourceUrl: string,
      frameRate: string | number,
      options?: VideoLoadOptions,
  ): Observable<Video>

• Loads new video

  Parameters

  • videoSourceUrl: string

    Video manifest URL
  • frameRate: string | number

    Video frame rate
  • Optionaloptions: VideoLoadOptions

  Returns Observable<Video>

setAuthentication

• setAuthentication(authentication: AuthenticationData): void

• Set authentication for HLS.js, VTT and thumbnail image requests

  Parameters

  • authentication: AuthenticationData

    Basic authentication, Bearer token authentication or custom authentication function

  Returns void

setThumbnailVttUrl

• setThumbnailVttUrl(thumbnailVttUrl: string): void

• Set thumbnail vtt url for media chrome thumbnail preview

  Parameters

  • thumbnailVttUrl: string

    Thumbnail Vtt Url

  Returns void