Class Mp4SidecarVideoDomController

Sidecar video DOM controller for MP4 files, source is set directly on video element.

Hierarchy (View Summary)

BaseSidecarVideoDomController
- Mp4SidecarVideoDomController

Index

Constructors

Accessors

bufferedTimeRanges videoElement visible

Methods

destroy loadDuration loadSource release

Constructors

constructor

new Mp4SidecarVideoDomController(
config: SidecarVideoDomControllerConfig,
): Mp4SidecarVideoDomController
Parameters
- config: SidecarVideoDomControllerConfig
Returns Mp4SidecarVideoDomController
Overrides BaseSidecarVideoDomController.constructor
- Defined in src/video/sidecar-video-dom-controller.ts:163

Accessors

bufferedTimeRanges

get bufferedTimeRanges(): BufferedTimeRange[]
Returns BufferedTimeRange[]
Inherited from BaseSidecarVideoDomController.bufferedTimeRanges
- Defined in src/video/sidecar-video-dom-controller.ts:141

videoElement

get videoElement(): HTMLVideoElement
Returns HTMLVideoElement
Inherited from BaseSidecarVideoDomController.videoElement
- Defined in src/video/sidecar-video-dom-controller.ts:137

visible

get visible(): boolean
Sidecar video element visibility. Hidden element keeps its layout box, so it's not painted but keeps its size (hls.js level capping relies on it) and becomes visible without re-layout.

Returns boolean
Inherited from BaseSidecarVideoDomController.visible
- Defined in src/video/sidecar-video-dom-controller.ts:145
set visible(visible: boolean): void
Sidecar video element visibility. Hidden element keeps its layout box, so it's not painted but keeps its size (hls.js level capping relies on it) and becomes visible without re-layout.
Parameters
- visible: boolean
Returns void
Inherited from BaseSidecarVideoDomController.visible
- Defined in src/video/sidecar-video-dom-controller.ts:149

Methods

destroy

destroy(): void
Returns void
Inherited from BaseSidecarVideoDomController.destroy
- Defined in src/video/sidecar-video-dom-controller.ts:153

loadDuration

loadDuration(url: string | undefined): Observable<number>
Resolves source duration without loading media data, so no frame is decoded. Video element is left without source.
- MP4 - only metadata is loaded
- HLS - only playlists are fetched, duration is sum of media playlist segment durations
Parameters
- url: string | undefined
  Source url
Returns Observable<number>
Overrides BaseSidecarVideoDomController.loadDuration
- Defined in src/video/sidecar-video-dom-controller.ts:175

loadSource

loadSource(url: string | undefined, startTime?: number): Observable<void>
Loads source into sidecar video element, completes when media data and metadata are loaded.
Parameters
- url: string | undefined
  Source url
- OptionalstartTime: number
  Sidecar time loading should start from, so the first fetched data is the one that will be played. Defaults to 0.
Returns Observable<void>
Overrides BaseSidecarVideoDomController.loadSource
- Defined in src/video/sidecar-video-dom-controller.ts:167

release

release(): void
Releases media resources - detaches source, so decoder, network and buffered data are freed. Element stays mounted with its layout box. Source is attached again with loadSource.

Returns void
Overrides BaseSidecarVideoDomController.release
- Defined in src/video/sidecar-video-dom-controller.ts:216