Class DrmControllerImpl

DrmController manages media keys and sessions, provides tracks a way to declare their content protections.

Hierarchy (View Summary)

EventHostImpl<DrmControllerEventMap>
- DrmControllerImpl

Implements

DrmController

Index

Constructors

constructor

new DrmControllerImpl(
deps: DrmControllerImplDeps,
options?: Maybe<Partial<DrmOptions>>,
): DrmControllerImpl
Parameters
- deps: DrmControllerImplDeps
- Optionaloptions: Maybe<Partial<DrmOptions>>
Returns DrmControllerImpl
Overrides EventHostImpl.constructor
- Defined in vinyl/src/drm/DrmControllerImpl.ts:163

Properties

`Readonly`logPrefix

logPrefix: string = ...

A string prefix for all log statements made by this target.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides EventHostImpl.[toStringTag]
- Defined in vinyl/src/drm/DrmControllerImpl.ts:138

activeSessions

get activeSessions(): number
Returns the number of currently active sessions.

Returns number
- Defined in vinyl/src/drm/DrmControllerImpl.ts:761

disposed

get disposed(): boolean
Returns boolean
- Defined in vinyl/src/drm/DrmControllerImpl.ts:809

error

get error(): Error | null
The last error emitted. Use reset to reset error state.

Returns Error | null
Implementation of DrmController.error
- Defined in vinyl/src/drm/DrmControllerImpl.ts:196

Methods

`Protected`abortIfDisposed

abortIfDisposed(): void
Returns void
- Defined in vinyl/src/drm/DrmControllerImpl.ts:778

closeSessions

closeSessions(): void
Closes all active DRM sessions. This should not be called unless the audio source has been cleared.

Returns void
Implementation of DrmController.closeSessions
- Defined in vinyl/src/drm/DrmControllerImpl.ts:726

configure

configure(options: Maybe<Partial<DrmOptions>>): void
Configures this DrmController for the current track. This will override any player-level configuration.
Parameters
- options: Maybe<Partial<DrmOptions>>
Returns void
Implementation of DrmController.configure
- Defined in vinyl/src/drm/DrmControllerImpl.ts:181

dispatch

dispatch<K extends keyof DrmControllerEventMap>(
type: K,
event: DrmControllerEventMap[K],
): void
Dispatches an event.
Type Parameters
- K extends keyof DrmControllerEventMap
Parameters
- type: K
  The key of the event within EventMap
- event: DrmControllerEventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHostImpl.dispatch
- Defined in vinyl-util/src/event/EventHost.ts:108

dispose

dispose(): void
Returns void
Overrides EventHostImpl.dispose
- Defined in vinyl/src/drm/DrmControllerImpl.ts:813

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Implementation of DrmController.hasAnyListeners

Inherited from EventHostImpl.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:88

hasListeners

hasListeners(type: keyof DrmControllerEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof DrmControllerEventMap
Returns boolean
Implementation of DrmController.hasListeners

Inherited from EventHostImpl.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:95

initializeForPlayback

initializeForPlayback(
drmInfo: MediaFormatMetadata | null,
options?: DrmPlaybackOptions,
): void
Initializes media keys if they have not yet been created and attached, creates a key session if the selected DrmProtection contains PSSH data.

The first supported key system will be used. Once a key system has been set, it cannot be changed, all future content protections will be expected to contain the supported key system.
Parameters
- drmInfo: MediaFormatMetadata | null
  Format metadata for the representation. May contain content protections.
- Optionaloptions: DrmPlaybackOptions
  Playback options (DrmPlaybackOptions).
Returns void
Implementation of DrmController.initializeForPlayback
- Defined in vinyl/src/drm/DrmControllerImpl.ts:423

isEmeSupported

isEmeSupported(): boolean
Returns true if Encrypted Media Extensions are supported.

Returns boolean
Implementation of DrmController.isEmeSupported
- Defined in vinyl/src/drm/DrmControllerImpl.ts:200

isSupported

isSupported(drmInfo: MediaFormatMetadata): Promise<DrmKeySystemSupport>
Resolves to true if the given encryption metadata is supported.
Parameters
- drmInfo: MediaFormatMetadata
Returns Promise<DrmKeySystemSupport>
Implementation of DrmController.isSupported
- Defined in vinyl/src/drm/DrmControllerImpl.ts:204

on

on<K extends keyof DrmControllerEventMap>(
    type: K,
    handler: EventHandler<DrmControllerEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof DrmControllerEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<DrmControllerEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Implementation of DrmController.on

Inherited from EventHostImpl.on
- Defined in vinyl-util/src/event/EventHost.ts:99

reset

reset(): void
Resets the error state.

Returns void
Implementation of DrmController.reset
- Defined in vinyl/src/drm/DrmControllerImpl.ts:782

setBufferingDrmInfo

setBufferingDrmInfo(
drmInfo: MediaFormatMetadata | null,
options?: DrmPlaybackOptions,
): void
Sets content protection data on drm controller for the currently buffering media.

The key session will be created on the 'encrypted' event when the decoder has been initialized.
Parameters
- drmInfo: MediaFormatMetadata | null
  Format metadata for the representation. May contain content protections.
- Optionaloptions: DrmPlaybackOptions
  Buffering options (DrmPlaybackOptions).
Returns void
Implementation of DrmController.setBufferingDrmInfo
- Defined in vinyl/src/drm/DrmControllerImpl.ts:445

Class DrmControllerImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DrmControllerImpl

Properties

ReadonlylogPrefix

Accessors

[toStringTag]

Returns string

activeSessions

Returns number

disposed

Returns boolean

error

Returns Error | null

Methods

ProtectedabortIfDisposed

Returns void

closeSessions

Returns void

configure

Parameters

Returns void

dispatch

Type Parameters

Parameters

Returns void

dispose

Returns void

hasAnyListeners

Returns boolean

hasListeners

Parameters

Returns boolean

initializeForPlayback

Parameters

Returns void

isEmeSupported

Returns boolean

isSupported

Parameters

Returns Promise<DrmKeySystemSupport>

on

Type Parameters

Parameters

Returns Unsubscribe

reset

Returns void

setBufferingDrmInfo

Parameters

Returns void

Settings

On This Page

`Readonly`logPrefix

`Protected`abortIfDisposed