Class VirtualPlaybackDomController

PlayerDomController for virtual playback (playback without media element), backed by a single element.

Element exposes subset of HTMLMediaElement API backed by attached PlayerController, so media-chrome controls (ie. time range) observe and control virtual playback as any other media element.

Optional delegate PlayerDomController (ie. chroming) receives alerts, attach / detach and text rendering.

Hierarchy (View Summary)

VirtualPlaybackDomController
- SlateDomControllerImpl

Implements

PlayerDomController
Destroyable

Constructors

constructor

new VirtualPlaybackDomController(
parentElement: HTMLElement,
delegate?: PlayerDomController,
): VirtualPlaybackDomController
Parameters
- parentElement: HTMLElement
- Optionaldelegate: PlayerDomController
Returns VirtualPlaybackDomController
- Defined in src/virtual/virtual-playback-dom-controller.ts:96

Accessors

element

get element(): HTMLDivElement
Returns HTMLDivElement
- Defined in src/virtual/virtual-playback-dom-controller.ts:204

mainMediaVideoElement

get mainMediaVideoElement(): HTMLVideoElement
Returns HTMLVideoElement
Implementation of PlayerDomController.mainMediaVideoElement
- Defined in src/virtual/virtual-playback-dom-controller.ts:208

mediaRotation

get mediaRotation(): MediaRotationValue
Returns MediaRotationValue
Implementation of PlayerDomController.mediaRotation
- Defined in src/virtual/virtual-playback-dom-controller.ts:224
set mediaRotation(mediaRotation: MediaRotationValue): void
Parameters
- mediaRotation: MediaRotationValue
Returns void
Implementation of PlayerDomController.mediaRotation
- Defined in src/virtual/virtual-playback-dom-controller.ts:228

sidecarVideosElement

get sidecarVideosElement(): HTMLElement
Element sidecar videos without own host element are mounted into, layered over main media.

Returns HTMLElement
Implementation of PlayerDomController.sidecarVideosElement
- Defined in src/virtual/virtual-playback-dom-controller.ts:220

textImscElement

get textImscElement(): HTMLElement
Returns HTMLElement
Implementation of PlayerDomController.textImscElement
- Defined in src/virtual/virtual-playback-dom-controller.ts:216

textMediaCaptionsElement

get textMediaCaptionsElement(): HTMLElement
Returns HTMLElement
Implementation of PlayerDomController.textMediaCaptionsElement
- Defined in src/virtual/virtual-playback-dom-controller.ts:212

Methods

addAlert

addAlert(alert: Alert): void
Parameters
- alert: Alert
Returns void
Implementation of PlayerDomController.addAlert
- Defined in src/virtual/virtual-playback-dom-controller.ts:251

attachController

attachController(controller: PlayerController): void
Binds element to controller, controller events are dispatched as media element events
Parameters
- controller: PlayerController
Returns void
- Defined in src/virtual/virtual-playback-dom-controller.ts:178

destroy

destroy(): void
Returns void
Implementation of Destroyable.destroy
- Defined in src/virtual/virtual-playback-dom-controller.ts:267

detachController

detachController(): void
Returns void
- Defined in src/virtual/virtual-playback-dom-controller.ts:187

extractVideoKeyframe

extractVideoKeyframe(options?: VideoKeyframeOptions): Observable<VideoKeyframe>
Parameters
- Optionaloptions: VideoKeyframeOptions
Returns Observable<VideoKeyframe>
Implementation of PlayerDomController.extractVideoKeyframe
- Defined in src/virtual/virtual-playback-dom-controller.ts:263

prepareForAttaching

prepareForAttaching(hasMainMedia: boolean): void
Parameters
- hasMainMedia: boolean
Returns void
Implementation of PlayerDomController.prepareForAttaching
- Defined in src/virtual/virtual-playback-dom-controller.ts:235

prepareForDetaching

prepareForDetaching(): void
Returns void
Implementation of PlayerDomController.prepareForDetaching
- Defined in src/virtual/virtual-playback-dom-controller.ts:239

refreshMediaState

refreshMediaState(): void
Dispatches media element events for state that is resolved on wiring, ie. duration

Returns void
- Defined in src/virtual/virtual-playback-dom-controller.ts:168

removeAlert

removeAlert(alertId: string): void
Parameters
- alertId: string
Returns void
Implementation of PlayerDomController.removeAlert
- Defined in src/virtual/virtual-playback-dom-controller.ts:259

resetMainMediaVideoElement

resetMainMediaVideoElement(): void
Returns void
Implementation of PlayerDomController.resetMainMediaVideoElement
- Defined in src/virtual/virtual-playback-dom-controller.ts:233

setAttachDetachButtonEnabled

setAttachDetachButtonEnabled(enabled: true): void
Parameters
- enabled: true
Returns void
Implementation of PlayerDomController.setAttachDetachButtonEnabled
- Defined in src/virtual/virtual-playback-dom-controller.ts:243

setVideoPoster

setVideoPoster(poster: string): void
Parameters
- poster: string
Returns void
Implementation of PlayerDomController.setVideoPoster
- Defined in src/virtual/virtual-playback-dom-controller.ts:247

`Static`mountOver

mountOver<T extends VirtualPlaybackDomController>(
    this: new (
        parentElement: HTMLElement,
        delegate?: PlayerDomController,
    ) => T,
    playerDomController: PlayerDomController,
): T
Mounts virtual playback element in place of delegate's video element. Video element is hidden until destroyed.

Element is inserted before video element and takes its slot, so media-chrome's media-controller (which uses first element in media slot) observes it as media.
Type Parameters
- T extends VirtualPlaybackDomController
Parameters
- this: new (parentElement: HTMLElement, delegate?: PlayerDomController) => T
- playerDomController: PlayerDomController
Returns T
- Defined in src/virtual/virtual-playback-dom-controller.ts:79

Class VirtualPlaybackDomController

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns VirtualPlaybackDomController

Accessors

element

Returns HTMLDivElement

mainMediaVideoElement

Returns HTMLVideoElement

mediaRotation

Returns MediaRotationValue

Parameters

Returns void

sidecarVideosElement

Returns HTMLElement

textImscElement

Returns HTMLElement

textMediaCaptionsElement

Returns HTMLElement

Methods

addAlert

Parameters

Returns void

attachController

Parameters

Returns void

destroy

Returns void

detachController

Returns void

extractVideoKeyframe

Parameters

Returns Observable<VideoKeyframe>

prepareForAttaching

Parameters

Returns void

prepareForDetaching

Returns void

refreshMediaState

Returns void

removeAlert

Parameters

Returns void

resetMainMediaVideoElement

Returns void

setAttachDetachButtonEnabled

Parameters

Returns void

setVideoPoster

Parameters

Returns void

StaticmountOver

Type Parameters

Parameters

Returns T

Settings

On This Page

`Static`mountOver