Interface OmakasePlayerApi

Primary API for the Omakase Player

interface OmakasePlayerApi {
    alerts: AlertsApi;
    chroming: ChromingApi;
    player: PlayerApi;
    session: SessionApi;
    timeline: TimelineApi | undefined;
    tools: OmakaseToolsApi;
    track: OmakaseTrackApi;
    ui: UiApi;
    attachPlayer(): Observable<void>;
    detachPlayer(): Observable<void>;
    loadMainMedia(
        url: string,
        loadOptions?: MainMediaLoadOptions,
    ): Observable<MainMedia>;
    setAuthentication(authentication: AuthenticationData): Observable<void>;
}

Hierarchy

OmakasePlayerCommonApi
- OmakasePlayerApi

Implemented by

OmakasePlayer

Index

Properties

alerts chroming player session timeline tools track ui

Methods

attachPlayer detachPlayer loadMainMedia setAuthentication

Properties

alerts

alerts: AlertsApi

Alerts API.

chroming

chroming: ChromingApi

Chroming (UI) API.

player

player: PlayerApi

Player control API.

session

session: SessionApi

Session API for observing session state changes and accessing the current session snapshot

timeline

timeline: TimelineApi | undefined

Timeline API.

tools

tools: OmakaseToolsApi

Tools API.

track

track: OmakaseTrackApi

Track management API for adding, removing, loading, and querying marker and thumbnail tracks.

ui

UI API.

Methods

attachPlayer

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

Returns Observable<void>
- Defined in src/omakase-player-api.ts:101

detachPlayer

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

Returns Observable<void>
- Defined in src/omakase-player-api.ts:96

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.
- Defined in src/omakase-player-api.ts:91

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>
Inherited from OmakasePlayerCommonApi.setAuthentication
- Defined in src/omakase-player-api.ts:37