Class PlayerSidecarVideoTrack

Hierarchy

BasePlayerTrack<
    MediaContainerTrackState,
    PlayerVideoTrackState,
    PlayerVideoLoadOptions,
>
- PlayerSidecarVideoTrack

Implements

PlayerVideoTrack

Index

Constructors

constructor

new PlayerSidecarVideoTrack(
    trackState: MediaContainerTrackState,
    playerController: PlayerController,
    loadOptions: PlayerVideoLoadOptions | undefined,
    controllerConfig?: Partial<
        Pick<
            SidecarTrackControllerConfig,
            "seekStep"
            | "minSeekInterval"
            | "metadataLoad"
            | "awakeBudget",
        >,
    >,
    frameImageConfig?: Partial<FrameImageConfig>,
): PlayerSidecarVideoTrack
Parameters
- trackState: MediaContainerTrackState
- playerController: PlayerController
- loadOptions: PlayerVideoLoadOptions | undefined
- OptionalcontrollerConfig: Partial<
      Pick<
          SidecarTrackControllerConfig,
          "seekStep"
          | "minSeekInterval"
          | "metadataLoad"
          | "awakeBudget",
      >,
  >
- OptionalframeImageConfig: Partial<FrameImageConfig>
Returns PlayerSidecarVideoTrack
Overrides BasePlayerTrack<MediaContainerTrackState, PlayerVideoTrackState, PlayerVideoLoadOptions>.constructor
- Defined in src/player/player-video-track.ts:72

Accessors

active

get active(): boolean
Whether sidecar video is active.

Returns boolean
Implementation of PlayerVideoTrack.active
- Defined in src/player/player-video-track.ts:134

loadStage

get loadStage(): OpStage
Returns OpStage
Implementation of PlayerVideoTrack.loadStage
Inherited from BasePlayerTrack.loadStage
- Defined in src/player/player-track.ts:141

onEvent$

get onEvent$(): Observable<PlayerTrackEvent>
Returns Observable<PlayerTrackEvent>
Implementation of PlayerVideoTrack.onEvent$
Inherited from BasePlayerTrack.onEvent$
- Defined in src/player/player-track.ts:149

state

get state(): S
Returns S
Implementation of PlayerVideoTrack.state
Inherited from BasePlayerTrack.state
- Defined in src/player/player-track.ts:145

trackState

get trackState(): T
Returns T
Implementation of PlayerVideoTrack.trackState
Inherited from BasePlayerTrack.trackState
- Defined in src/player/player-track.ts:137

videoTrackController

get videoTrackController(): SidecarTrackController
Returns SidecarTrackController
Implementation of PlayerVideoTrack.videoTrackController
- Defined in src/player/player-video-track.ts:130

Methods

destroy

destroy(): void
Returns void
Implementation of PlayerVideoTrack.destroy
Overrides BasePlayerTrack.destroy
- Defined in src/player/player-video-track.ts:184

loadError

loadError(error: string | undefined): void
Parameters
- error: string | undefined
Returns void
Implementation of PlayerVideoTrack.loadError
Inherited from BasePlayerTrack.loadError
- Defined in src/player/player-track.ts:122

loadSource

loadSource(): Observable<void>
Returns Observable<void>
Implementation of PlayerVideoTrack.loadSource
- Defined in src/player/player-video-track.ts:151

loadStart

loadStart(): void
Returns void
Implementation of PlayerVideoTrack.loadStart
Inherited from BasePlayerTrack.loadStart
- Defined in src/player/player-track.ts:102

loadSuccess

loadSuccess(): void
Returns void
Implementation of PlayerVideoTrack.loadSuccess
Inherited from BasePlayerTrack.loadSuccess
- Defined in src/player/player-track.ts:112

setActive

setActive(active: boolean): void
Parameters
- active: boolean
Returns void
Implementation of PlayerVideoTrack.setActive
- Defined in src/player/player-video-track.ts:138

setTrackState

setTrackState(trackState: MediaContainerTrackState): void
Parameters
- trackState: MediaContainerTrackState
Returns void
Implementation of PlayerVideoTrack.setTrackState
Overrides BasePlayerTrack.setTrackState
- Defined in src/player/player-video-track.ts:170

Class PlayerSidecarVideoTrack

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PlayerSidecarVideoTrack

Accessors

active

Returns boolean

loadStage

Returns OpStage

onEvent$

Returns Observable<PlayerTrackEvent>

state

Returns S

trackState

Returns T

videoTrackController

Returns SidecarTrackController

Methods

destroy

Returns void

loadError

Parameters

Returns void

loadSource

Returns Observable<void>

loadStart

Returns void

loadSuccess

Returns void

setActive

Parameters

Returns void

setTrackState

Parameters

Returns void

Settings

On This Page