Class OmakasePlayer

constructor

• new OmakasePlayer(config?: Partial<OmakasePlayerConfig>): OmakasePlayer

  Parameters

  • Optionalconfig: Partial<OmakasePlayerConfig>

  Returns OmakasePlayer

Staticinstance

alerts

• get alerts(): AlertsApi

  Returns AlertsApi

  Alerts API

audio

• get audio(): AudioApi

  Returns AudioApi

  Audio API

progressMarkerTrack

• get progressMarkerTrack(): undefined | TimeRangeMarkerTrackApi

  Get the progress bar marker track

  Returns undefined | TimeRangeMarkerTrackApi

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>

createMarkerTrack

• createMarkerTrack(config: MarkerTrackConfig): Observable<MarkerTrackApi>

  Creates Marker Track

  Parameters

  • config: MarkerTrackConfig

    Marker Track configuration

  Returns Observable<MarkerTrackApi>

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

initializeRouterVisualization

• initializeRouterVisualization(
      config: RouterVisualizationConfig,
  ): RouterVisualizationApi

  Initializes Router Visualization component

  Parameters

  • config: RouterVisualizationConfig

    Router Visualization configuration

  Returns RouterVisualizationApi

loadVideo

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

  Loads new video

  Parameters

  • videoSourceUrl: string

    Video manifest URL
  • 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 player chroming thumbnail preview

  Parameters

  • thumbnailVttUrl: string

    Thumbnail Vtt Url

  Returns void

setWatermark

• setWatermark(watermark: string): void

  Set watermark text or svg for player chroming

  Parameters

  • watermark: string

    Watermark text or svg

  Returns void