Class OmakasePlayer

constructor

• new OmakasePlayer(config?): OmakasePlayer

• Parameters

  • Optionalconfig: OmakasePlayerConfig

  Returns OmakasePlayer

Staticinstance

alerts

• get alerts(): AlertsApi

• Returns AlertsApi

  Alerts API

audio

• get audio(): AudioApi

• Returns AudioApi

  Audio API

EVENTS

• get EVENTS(): OmakasePlayerEventsMappingType<OmakasePlayerEventMap>

• Returns OmakasePlayerEventsMappingType<OmakasePlayerEventMap>

  Omakase Player events enumeration

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): Observable<MarkerListApi>

• Creates Marker List

  Parameters

  • config: MarkerListConfig

    Marker List configuration

  Returns Observable<MarkerListApi>

createTimeline

• createTimeline(config): 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

emit

• emit<K>(eventKey, event): void

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • eventKey: K
  • event: OmakasePlayerEventMap[K]

  Returns void

listenerCount

• listenerCount<K>(eventKey): void

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • eventKey: K

  Returns void

listeners

• listeners<K>(eventKey): OmakaseEventListener<OmakasePlayerEventMap[K]>[]

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • eventKey: K

  Returns OmakaseEventListener<OmakasePlayerEventMap[K]>[]

loadVideo

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

• Loads new video

  Parameters

  • videoSourceUrl: string

    Video manifest URL
  • frameRate: string | number

    Video frame rate
  • Optionaloptions: VideoLoadOptions

  Returns Observable<Video>

off

• off<K>(eventKey, handler): void

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • eventKey: K
  • handler: OmakaseEventListener<OmakasePlayerEventMap[K]>

  Returns void

on

• on<K>(eventKey, handler): void

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • eventKey: K
  • handler: OmakaseEventListener<OmakasePlayerEventMap[K]>

  Returns void

once

• once<K>(eventKey, handler): void

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • eventKey: K
  • handler: OmakaseEventListener<OmakasePlayerEventMap[K]>

  Returns void

removeAllListeners

• removeAllListeners<K>(eventKey?): void

• Type Parameters

  • K extends
        | (keyof VideoEventMap)
        | "omakaseAudioSwitched"
        | (keyof SubtitlesEventMap)
        | (keyof TimelineEventMap)
        | (keyof MarkerListEventMap)

  Parameters

  • OptionaleventKey: K

  Returns void

setAuthentication

• setAuthentication(authentication): 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): void

• Set thumbnail vtt url for media chrome thumbnail preview

  Parameters

  • thumbnailVttUrl: string

  Returns void