Interface DrmController

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

interface DrmController {
    error: null | Error;
    closeSessions(): void;
    configure(options: Maybe<Partial<DrmOptions>>): void;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof DrmControllerEventMap): boolean;
    initializeForPlayback(
        drmInfo: null | MediaFormatMetadata,
        abort?: ReadonlyAbort,
    ): void;
    isEmeSupported(): boolean;
    isSupported(drmInfo: MediaFormatMetadata): Promise<DrmKeySystemSupport>;
    on<K extends keyof DrmControllerEventMap>(
        type: K,
        handler: EventHandler<DrmControllerEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
    reset(): void;
    setBufferingDrmInfo(
        drmInfo: null | MediaFormatMetadata,
        abort?: ReadonlyAbort,
    ): void;
}

Hierarchy (View Summary)

ReadonlyEventHost<DrmControllerEventMap>
- DrmController

Implemented by

DrmControllerImpl

Index

Properties

Methods

closeSessions configure hasAnyListeners hasListeners initializeForPlayback isEmeSupported isSupported on reset setBufferingDrmInfo

Properties

`Readonly`error

error: null | Error

The last error emitted. Use reset to reset error state.

Methods

closeSessions

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

Returns void
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:87

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
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:52

hasAnyListeners

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

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:30

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
Inherited from ReadonlyEventHost.hasListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:34

initializeForPlayback

initializeForPlayback(
drmInfo: null | MediaFormatMetadata,
abort?: ReadonlyAbort,
): 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: null | MediaFormatMetadata
  Format metadata for the representation. May contain content protections.
- Optionalabort: ReadonlyAbort
  If aborted, the created session will be closed.
Returns void
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:73

isEmeSupported

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

Returns boolean
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:56

isSupported

isSupported(drmInfo: MediaFormatMetadata): Promise<DrmKeySystemSupport>
Resolves to true if the given encryption metadata is supported.
Parameters
- drmInfo: MediaFormatMetadata
Returns Promise<DrmKeySystemSupport>
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:61

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.
Inherited from ReadonlyEventHost.on
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:26

reset

reset(): void
Resets the error state.

Returns void
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:91

setBufferingDrmInfo

setBufferingDrmInfo(
drmInfo: null | MediaFormatMetadata,
abort?: ReadonlyAbort,
): 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: null | MediaFormatMetadata
  Format metadata for the representation. May contain content protections.
- Optionalabort: ReadonlyAbort
  If aborted, the created session from an 'encrypted' event will be closed.
Returns void
- Defined in vinyl/dist/types/current/drm/DrmController.d.ts:82