Class OmakasePlayer

Implements

Index

Constructors

Properties

Accessors

alerts audio subtitles timeline video

Methods

createMarkerList createTimeline destroy initializeRouterVisualization loadVideo setAuthentication setThumbnailVttUrl

Constructors

constructor

new OmakasePlayer(config?: Partial<OmakasePlayerConfig>): OmakasePlayer
Parameters
- Optionalconfig: Partial<OmakasePlayerConfig>
Returns OmakasePlayer
- Defined in project/src/omakase-player.ts:127

Properties

`Static`instance

instance: OmakasePlayerApi

Accessors

alerts

get alerts(): AlertsApi
Returns AlertsApi
Alerts API
Implementation of OmakasePlayerApi.alerts
- Defined in project/src/omakase-player.ts:265

audio

get audio(): AudioApi
Returns AudioApi
Audio API
Implementation of OmakasePlayerApi.audio
- Defined in project/src/omakase-player.ts:257

subtitles

get subtitles(): SubtitlesApi
Returns SubtitlesApi
Subtitles API
Implementation of OmakasePlayerApi.subtitles
- Defined in project/src/omakase-player.ts:261

timeline

get timeline(): undefined | TimelineApi
Returns undefined | TimelineApi
Timeline API
Implementation of OmakasePlayerApi.timeline
- Defined in project/src/omakase-player.ts:249

video

get video(): VideoApi
Returns VideoApi
Video API
Implementation of OmakasePlayerApi.video
- Defined in project/src/omakase-player.ts:253

Methods

createMarkerList

createMarkerList(config: MarkerListConfig): Observable<MarkerListApi>
Creates Marker List
Parameters
- config: MarkerListConfig
  Marker List configuration
Returns Observable<MarkerListApi>
Implementation of OmakasePlayerApi.createMarkerList
- Defined in project/src/omakase-player.ts:226

createTimeline

createTimeline(
config: Partial<ConfigWithOptionalStyle<TimelineConfig>>,
): Observable<TimelineApi>
Creates Timeline
Parameters
- config: Partial<ConfigWithOptionalStyle<TimelineConfig>>
  Timeline configuration
Returns Observable<TimelineApi>
Implementation of OmakasePlayerApi.createTimeline
- Defined in project/src/omakase-player.ts:199

destroy

destroy(): void
Destroys OmakasePlayer instance and frees up memory

Returns void
Implementation of Destroyable.destroy
- Defined in project/src/omakase-player.ts:269

initializeRouterVisualization

initializeRouterVisualization(
config: RouterVisualizationConfig,
): RouterVisualizationApi
Initializes Router Visualization component
Parameters
- config: RouterVisualizationConfig
  Router Visualization configuration
Returns RouterVisualizationApi
Implementation of OmakasePlayerApi.initializeRouterVisualization
- Defined in project/src/omakase-player.ts:245

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>
Implementation of OmakasePlayerApi.loadVideo
- Defined in project/src/omakase-player.ts:195

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
Implementation of OmakasePlayerApi.setAuthentication
- Defined in project/src/omakase-player.ts:187

setThumbnailVttUrl

setThumbnailVttUrl(thumbnailVttUrl: string): void
Set thumbnail vtt url for media chrome thumbnail preview
Parameters
- thumbnailVttUrl: string
  Thumbnail Vtt Url
Returns void
Implementation of OmakasePlayerApi.setThumbnailVttUrl
- Defined in project/src/omakase-player.ts:191