Class OmakasePlayer

Primary API for the Omakase Player

Hierarchy

BaseOmakasePlayer
- OmakasePlayer

Implements

OmakasePlayerApi

Index

Constructors

Accessors

alerts chroming player session timeline tools track ui

Methods

attachPlayer createTimeline destroy detachPlayer getTimeline loadMainMedia setAuthentication

Constructors

constructor

new OmakasePlayer(config?: Partial<OmakasePlayerConfig>): OmakasePlayer
Parameters
- Optionalconfig: Partial<OmakasePlayerConfig>
Returns OmakasePlayer
Overrides BaseOmakasePlayer.constructor
- Defined in src/omakase-player.ts:88

Accessors

alerts

get alerts(): AlertsApi
Alerts API.

Returns AlertsApi
Implementation of OmakasePlayerApi.alerts
- Defined in src/omakase-player.ts:453

chroming

get chroming(): ChromingApi
Chroming (UI) API.

Returns ChromingApi
Implementation of OmakasePlayerApi.chroming
- Defined in src/omakase-player.ts:437

player

get player(): PlayerApi
Player control API.

Returns PlayerApi
Implementation of OmakasePlayerApi.player
- Defined in src/omakase-player.ts:433

session

get session(): SessionApi
Session API for observing session state changes and accessing the current session snapshot

Returns SessionApi
Implementation of OmakasePlayerApi.session
- Defined in src/omakase-player.ts:441

timeline

get timeline(): TimelineApi | undefined
Timeline API.

Returns TimelineApi | undefined
Implementation of OmakasePlayerApi.timeline
- Defined in src/omakase-player.ts:457

tools

get tools(): OmakaseToolsApi
Tools API.

Returns OmakaseToolsApi
Implementation of OmakasePlayerApi.tools
- Defined in src/omakase-player.ts:449

track

get track(): OmakaseTrackApi
Track management API for adding, removing, loading, and querying marker and thumbnail tracks.

Returns OmakaseTrackApi
Implementation of OmakasePlayerApi.track
- Defined in src/omakase-player.ts:445

ui

get ui(): UiApi
UI API.

Returns UiApi
Implementation of OmakasePlayerApi.ui
- Defined in src/omakase-player.ts:461

Methods

attachPlayer

attachPlayer(): Observable<void>
Re-attaches a previously detached player.

Returns Observable<void>
Implementation of OmakasePlayerApi.attachPlayer
- Defined in src/omakase-player.ts:329

createTimeline

createTimeline(
configAndStyle?: ConfigAndStyle<TimelineConfig, TimelineStyle>,
): Observable<TimelineApi>
Parameters
- OptionalconfigAndStyle: ConfigAndStyle<TimelineConfig, TimelineStyle>
Returns Observable<TimelineApi>
- Defined in src/omakase-player.ts:465

destroy

destroy(): void
Returns void
Overrides BaseOmakasePlayer.destroy
- Defined in src/omakase-player.ts:501

detachPlayer

detachPlayer(): Observable<void>
Detaches the player, transitioning it into a remote playback mode.

Returns Observable<void>
Implementation of OmakasePlayerApi.detachPlayer
- Defined in src/omakase-player.ts:170

getTimeline

getTimeline(id?: string): TimelineApi | undefined
Parameters
- Optionalid: string
Returns TimelineApi | undefined
- Defined in src/omakase-player.ts:493

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

setAuthentication

setAuthentication(authentication: AuthenticationData): Observable<void>
Configures authentication for media requests. Supports basic, bearer, and custom header strategies.
Parameters
- authentication: AuthenticationData
  Authentication configuration (basic, bearer, or custom headers).
Returns Observable<void>
Implementation of OmakasePlayerApi.setAuthentication
- Defined in src/omakase-player.ts:426