Class SlatePlayerController

Plays slate, virtual main media of provided duration.

Hierarchy (View Summary)

BaseVirtualPlayerController<SlatePlayerControllerConfig>
- SlatePlayerController

Constructors

constructor

new SlatePlayerController(
playerDomController: PlayerDomController,
config?: Partial<SlatePlayerControllerConfig>,
): SlatePlayerController
Parameters
- playerDomController: PlayerDomController
- Optionalconfig: Partial<SlatePlayerControllerConfig>
Returns SlatePlayerController
Overrides BaseVirtualPlayerController<SlatePlayerControllerConfig>.constructor
- Defined in src/slate/slate-player-controller.ts:52

Accessors

createMediaElementSourceEnabled

get createMediaElementSourceEnabled(): boolean
Returns boolean
Inherited from BaseVirtualPlayerController.createMediaElementSourceEnabled
- Defined in src/virtual/base-virtual-player-controller.ts:546

mediaElementPlayback

get mediaElementPlayback(): MediaElementPlayback | undefined
Returns MediaElementPlayback | undefined
Inherited from BaseVirtualPlayerController.mediaElementPlayback
- Defined in src/virtual/base-virtual-player-controller.ts:614

mediaRotation

get mediaRotation(): MediaRotationValue
Returns MediaRotationValue
Inherited from BaseVirtualPlayerController.mediaRotation
- Defined in src/virtual/base-virtual-player-controller.ts:540

mediaTemporalConverter

get mediaTemporalConverter(): MediaTemporalConverter | undefined
Returns MediaTemporalConverter | undefined
Inherited from BaseVirtualPlayerController.mediaTemporalConverter
- Defined in src/virtual/base-virtual-player-controller.ts:618

onEvent$

get onEvent$(): Observable<PlayerControllerEvent>
Returns Observable<PlayerControllerEvent>
Inherited from BaseVirtualPlayerController.onEvent$
- Defined in src/virtual/base-virtual-player-controller.ts:125

playbackRate

get playbackRate(): number
Returns number
Inherited from BaseVirtualPlayerController.playbackRate
- Defined in src/virtual/base-virtual-player-controller.ts:502

seekStepPlayback

get seekStepPlayback(): boolean
Virtual main media plays at every playback rate, its time always runs on its own clock.

Returns boolean
Inherited from BaseVirtualPlayerController.seekStepPlayback
- Defined in src/virtual/base-virtual-player-controller.ts:507

sidecarVideosElement

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

Returns HTMLElement
Inherited from BaseVirtualPlayerController.sidecarVideosElement
- Defined in src/virtual/base-virtual-player-controller.ts:634

textImscElement

get textImscElement(): HTMLElement
Returns HTMLElement
Inherited from BaseVirtualPlayerController.textImscElement
- Defined in src/virtual/base-virtual-player-controller.ts:630

textMediaCaptionsElement

get textMediaCaptionsElement(): HTMLElement
Returns HTMLElement
Inherited from BaseVirtualPlayerController.textMediaCaptionsElement
- Defined in src/virtual/base-virtual-player-controller.ts:626

textTracksDisplayed

get textTracksDisplayed(): boolean
Returns boolean
Inherited from BaseVirtualPlayerController.textTracksDisplayed
- Defined in src/virtual/base-virtual-player-controller.ts:589

videoElement

get videoElement(): HTMLVideoElement | undefined
Undefined for controllers that play virtual media without media element (ie. slate)

Returns HTMLVideoElement | undefined
Inherited from BaseVirtualPlayerController.videoElement
- Defined in src/virtual/base-virtual-player-controller.ts:622

Methods

resolveLiveState

resolveLiveState(): PlayerLiveState | undefined
Synchronously resolves the current live state, independent of the PlayerControllerEventType.PLAYER_CONTROLLER_LIVE_STATE_UPDATE event stream. Callers that start listening to onEvent$ after the controller has already resolved (and possibly emitted) a live state - e.g. right after wireEvents - need this to avoid missing that first, already-emitted state. Returns undefined for VOD or before any playlist/manifest details are available.

Returns PlayerLiveState | undefined
Inherited from BaseVirtualPlayerController.resolveLiveState
- Defined in src/virtual/base-virtual-player-controller.ts:139

resolveTextTrackIdentifier

resolveTextTrackIdentifier(track: TextTrackState): any
Parameters
- track: TextTrackState
Returns any
Inherited from BaseVirtualPlayerController.resolveTextTrackIdentifier
- Defined in src/virtual/base-virtual-player-controller.ts:595

restoreMainMediaSession

restoreMainMediaSession(args: RestoreMainMediaSessionArgsType): Observable<void>
Parameters
- args: RestoreMainMediaSessionArgsType
Returns Observable<void>
Inherited from BaseVirtualPlayerController.restoreMainMediaSession
- Defined in src/virtual/base-virtual-player-controller.ts:287

seekFromCurrentTime

seekFromCurrentTime(
value: string | number,
format?: MediaTemporalFormat,
): Observable<boolean>
Parameters
- value: string | number
- format: MediaTemporalFormat = MediaTemporalFormat.SECONDS
Returns Observable<boolean>
Inherited from BaseVirtualPlayerController.seekFromCurrentTime
- Defined in src/virtual/base-virtual-player-controller.ts:419

seekTo

seekTo(
value: string | number,
format?: MediaTemporalFormat,
): Observable<boolean>
Parameters
- value: string | number
- format: MediaTemporalFormat = MediaTemporalFormat.SECONDS
Returns Observable<boolean>
Inherited from BaseVirtualPlayerController.seekTo
- Defined in src/virtual/base-virtual-player-controller.ts:403

seekToLive

seekToLive(): Observable<boolean>
Returns Observable<boolean>
Inherited from BaseVirtualPlayerController.seekToLive
- Defined in src/virtual/base-virtual-player-controller.ts:494

setPlaybackRate

setPlaybackRate(playbackRate: number): Observable<void>
Parameters
- playbackRate: number
Returns Observable<void>
Inherited from BaseVirtualPlayerController.setPlaybackRate
- Defined in src/virtual/base-virtual-player-controller.ts:522

setSeekStepPlaybackEnabled

setSeekStepPlaybackEnabled(_enabled: boolean): void
Virtual main media plays backwards on its own clock, its supported playback rates don't depend on trick track, see isPlaybackRateSupported.
Parameters
- _enabled: boolean
Returns void
Inherited from BaseVirtualPlayerController.setSeekStepPlaybackEnabled
- Defined in src/virtual/base-virtual-player-controller.ts:512

setTextTracksDisplayed

setTextTracksDisplayed(textTracksDisplayed: boolean): void
Parameters
- textTracksDisplayed: boolean
Returns void
Inherited from BaseVirtualPlayerController.setTextTracksDisplayed
- Defined in src/virtual/base-virtual-player-controller.ts:593

setWaitingForSyncedMedia

setWaitingForSyncedMedia(syncedMediaWaiting: boolean): void
Parameters
- syncedMediaWaiting: boolean
Returns void
Inherited from BaseVirtualPlayerController.setWaitingForSyncedMedia
- Defined in src/virtual/base-virtual-player-controller.ts:567

switchAudioTrack

switchAudioTrack(track: AudioState, activate: boolean): Observable<void>
Parameters
- track: AudioState
- activate: boolean
Returns Observable<void>
Inherited from BaseVirtualPlayerController.switchAudioTrack
- Defined in src/virtual/base-virtual-player-controller.ts:562

switchTextTrack

switchTextTrack(track: TextTrackState, activate: boolean): Observable<void>
Parameters
- track: TextTrackState
- activate: boolean
Returns Observable<void>
Inherited from BaseVirtualPlayerController.switchTextTrack
- Defined in src/virtual/base-virtual-player-controller.ts:607

unwireEvents

unwireEvents(): void
Returns void
Inherited from BaseVirtualPlayerController.unwireEvents
- Defined in src/virtual/base-virtual-player-controller.ts:181

wireEvents

wireEvents(mainMediaState: MainMediaState): void
Sets up media time converters and wires onEvent$ events
Parameters
- mainMediaState: MainMediaState
Returns void
Inherited from BaseVirtualPlayerController.wireEvents
- Defined in src/virtual/base-virtual-player-controller.ts:143

`Static`createMounted

createMounted(
playerDomController: PlayerDomController,
config?: Partial<SlatePlayerControllerConfig>,
): SlatePlayerController
Creates controller that renders slate in place of provided dom controller's video element, ie. inside chroming
Parameters
- playerDomController: PlayerDomController
- Optionalconfig: Partial<SlatePlayerControllerConfig>
Returns SlatePlayerController
- Defined in src/slate/slate-player-controller.ts:44

Class SlatePlayerController

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SlatePlayerController

Accessors

createMediaElementSourceEnabled

Returns boolean

mediaElementPlayback

Returns MediaElementPlayback | undefined

mediaRotation

Returns MediaRotationValue

mediaTemporalConverter

Returns MediaTemporalConverter | undefined

onEvent$

Returns Observable<PlayerControllerEvent>

playbackRate

Returns number

seekStepPlayback

Returns boolean

sidecarVideosElement

Returns HTMLElement

textImscElement

Returns HTMLElement

textMediaCaptionsElement

Returns HTMLElement

textTracksDisplayed

Returns boolean

videoElement

Returns HTMLVideoElement | undefined

Methods

convertTime

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[D]

destroy

Returns void

extractVideoKeyframe

Parameters

Returns Observable<VideoKeyframe>

getCurrentTime

Returns number

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[F]

getDuration

Returns number

Type Parameters

Parameters

Returns MediaTemporalFormatValueMap[F]

isAudioTrackActive

Parameters

Returns boolean

isTextTrackActive

Parameters

Returns boolean

loadMainMedia

Parameters

Returns Observable<boolean>

pause

Returns Observable<void>

play

Returns Observable<void>

resolveActiveAudioTracks

Parameters

Returns AudioState[]

resolveActiveTextTracks

Parameters

Returns TextTrackState[]

resolveAudioTrackIdentifier

Parameters

Returns any

resolveLiveState

Returns PlayerLiveState | undefined

resolveTextTrackIdentifier

`Static`createMounted