Class SidecarVideoTrackControllerImpl

Plays sidecar video in its own SidecarVideoDomController, synced with main media, see BaseSidecarTrackController.

Sidecar:

before warm-up, holds the frame warm-up starts at, so its playback starts without seeking
in warm-up, right before time window, warms up - plays hidden and muted, to pre-buffer and sync ahead of its cut. Warm-up is limited by sidecar media before SidecarTimeWindow.cutStartTime, cut starting at sidecar time 0 has no warm-up
inside time window, if active, plays with its own muted state and is shown. Main media waits while sidecar is buffering. If inactive, keeps warming up, so it can be activated without seeking
after time window, holds the frame at SidecarTimeWindow.cutEndTime

Sidecar video drifting from main media is corrected by adjusting its playback rate, or by seeking when drift is too large.

Video element can't play backwards nor faster than SEEK_STEP_PLAYBACK_DEFAULTS.maxNativePlaybackRate. At such main media playback rates sidecar is paused and seeked to sidecar time at main media time in steps, see SeekStepper. Main media doesn't wait for these seeks.

Hierarchy (View Summary)

BaseSidecarTrackController<SidecarVideoDomController>
- SidecarVideoTrackControllerImpl

Implements

SidecarVideoTrackController

Index

Constructors

constructor

new SidecarVideoTrackControllerImpl(
    trackState: MediaContainerTrackState,
    playerController: PlayerController,
    domController: SidecarVideoDomController,
    config?: Partial<SidecarVideoTrackControllerConfig>,
): SidecarVideoTrackControllerImpl
Parameters
- trackState: MediaContainerTrackState
- playerController: PlayerController
- domController: SidecarVideoDomController
- Optionalconfig: Partial<SidecarVideoTrackControllerConfig>
Returns SidecarVideoTrackControllerImpl
Overrides BaseSidecarTrackController<SidecarVideoDomController>.constructor
- Defined in src/video/sidecar-video-track-controller.ts:63

Accessors

active

get active(): boolean
Whether sidecar is active. Only active sidecar is shown, inactive sidecar only warms up.

Returns boolean
Implementation of SidecarVideoTrackController.active
Inherited from BaseSidecarTrackController.active
- Defined in src/video/sidecar-track-controller.ts:193

domController

get domController(): D
Returns D
Implementation of SidecarVideoTrackController.domController
Inherited from BaseSidecarTrackController.domController
- Defined in src/video/sidecar-track-controller.ts:213

duration

get duration(): number | undefined
Sidecar duration in seconds, available once loaded.

Returns number | undefined
Implementation of SidecarVideoTrackController.duration
Inherited from BaseSidecarTrackController.duration
- Defined in src/video/sidecar-track-controller.ts:221

onBufferingRequired$

get onBufferingRequired$(): Observable<boolean>
Returns Observable<boolean>
Implementation of SidecarVideoTrackController.onBufferingRequired$
Inherited from BaseSidecarTrackController.onBufferingRequired$
- Defined in src/video/sidecar-track-controller.ts:189

onEvent$

get onEvent$(): Observable<E>
Returns Observable<E>
Implementation of SidecarVideoTrackController.onEvent$
Inherited from BaseSidecarTrackController.onEvent$
- Defined in src/player/track-controller.ts:72

onShown$

get onShown$(): Observable<boolean>
Emits whether sidecar should be shown, see shown.

Returns Observable<boolean>
Implementation of SidecarVideoTrackController.onShown$
Inherited from BaseSidecarTrackController.onShown$
- Defined in src/video/sidecar-track-controller.ts:197

residency

get residency(): SidecarVideoResidency
Whether sidecar element has its source attached, see SidecarVideoResidency.

Returns SidecarVideoResidency
Implementation of SidecarVideoTrackController.residency
Inherited from BaseSidecarTrackController.residency
- Defined in src/video/sidecar-track-controller.ts:209

shown

get shown(): boolean
Whether sidecar should be shown, sidecar is active and main media time is inside its time window.

Returns boolean
Implementation of SidecarVideoTrackController.shown
Inherited from BaseSidecarTrackController.shown
- Defined in src/video/sidecar-track-controller.ts:201

timeWindow

get timeWindow(): SidecarTimeWindow | undefined
Resolved time window, available once loaded.

Returns SidecarTimeWindow | undefined
Implementation of SidecarVideoTrackController.timeWindow
Inherited from BaseSidecarTrackController.timeWindow
- Defined in src/video/sidecar-track-controller.ts:217

warmingUp

get warmingUp(): boolean
Whether sidecar is warming up hidden, ahead of its time window, or inside it while inactive.

Returns boolean
Implementation of SidecarVideoTrackController.warmingUp
Inherited from BaseSidecarTrackController.warmingUp
- Defined in src/video/sidecar-track-controller.ts:205

Methods

awakePriority

awakePriority(): number
Awake priority is distance in seconds of main media time from sidecar warm-up and time window, active sidecar inside its time window comes first. Warm-up is on the side main media enters time window from, see SidecarTimeWindow.warmUpIn.

Returns number
Inherited from BaseSidecarTrackController.awakePriority
- Defined in src/video/sidecar-track-controller.ts:509

destroy

destroy(): void
Returns void
Implementation of SidecarVideoTrackController.destroy
Overrides BaseSidecarTrackController.destroy
- Defined in src/video/sidecar-video-track-controller.ts:347

loadSource

loadSource(): Observable<void>
Returns Observable<void>
Implementation of SidecarVideoTrackController.loadSource
Inherited from BaseSidecarTrackController.loadSource
- Defined in src/video/sidecar-track-controller.ts:318

retryAwake

retryAwake(): void
Called when slot became free, waiting candidate may try to acquire it again.

Returns void
Inherited from BaseSidecarTrackController.retryAwake
- Defined in src/video/sidecar-track-controller.ts:533

setActive

setActive(active: boolean): void
Activates or deactivates sidecar, sidecar is re-synced with main media.
Parameters
- active: boolean
Returns void
Implementation of SidecarVideoTrackController.setActive
Inherited from BaseSidecarTrackController.setActive
- Defined in src/video/sidecar-track-controller.ts:419

setTrackState

setTrackState(trackState: MediaContainerTrackState): void
Updates track state, time window is re-resolved and sidecar is re-synced with main media.
Parameters
- trackState: MediaContainerTrackState
Returns void
Implementation of SidecarVideoTrackController.setTrackState
Inherited from BaseSidecarTrackController.setTrackState
- Defined in src/video/sidecar-track-controller.ts:410

yieldAwake

yieldAwake(): void
Called when candidate lost its awake slot to more important one, candidate releases its source and waits for a free slot.

Returns void
Inherited from BaseSidecarTrackController.yieldAwake
- Defined in src/video/sidecar-track-controller.ts:527

Class SidecarVideoTrackControllerImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SidecarVideoTrackControllerImpl

Accessors

active

Returns boolean

domController

Returns D

duration

Returns number | undefined

onBufferingRequired$

Returns Observable<boolean>

onEvent$

Returns Observable<E>

onShown$

Returns Observable<boolean>

residency

Returns SidecarVideoResidency

shown

Returns boolean

timeWindow

Returns SidecarTimeWindow | undefined

warmingUp

Returns boolean

Methods

awakePriority

Returns number

destroy

Returns void

loadSource

Returns Observable<void>

retryAwake

Returns void

setActive

Parameters

Returns void

setTrackState

Parameters

Returns void

yieldAwake

Returns void

Settings

On This Page