Interface MediaSourceController

interface MediaSourceController {
    readyState: ReadyState;
    readyToAppend: boolean;
    activate(): string;
    createSourceBuffer(
        contentType: ContentType,
        mimeType: string,
    ): SourceBufferRef;
    deactivate(): void;
    endOfStream(error?: EndOfStreamError): void;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof MediaSourceControllerEventMap): boolean;
    on<K extends keyof MediaSourceControllerEventMap>(
        type: K,
        handler: EventHandler<MediaSourceControllerEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyMediaSourceController
- MediaSourceController

Implemented by

MediaSourceControllerImpl

Index

Properties

readyState readyToAppend

Methods

activate createSourceBuffer deactivate endOfStream hasAnyListeners hasListeners on

Properties

`Readonly`readyState

readyState: ReadyState

Returns the parent media source ready state.

`Readonly`readyToAppend

readyToAppend: boolean

True if all source buffers have been created and data may be appended.

Methods

activate

activate(): string
Creates the internal media source. Returns an Object URL to use as the source for this stream.

Implementation note: Only the first

Returns string
- Defined in vinyl/src/streaming/buffering/MediaSourceController.ts:112

createSourceBuffer

createSourceBuffer(contentType: ContentType, mimeType: string): SourceBufferRef
Constructs a new SourceBuffer with the given content type and mime type.
Parameters
- contentType: ContentType
- mimeType: string
Returns SourceBufferRef
- Defined in vinyl/src/streaming/buffering/MediaSourceController.ts:94

deactivate

deactivate(): void
Deactivates the controller, disposing underlying resources.

Returns void
- Defined in vinyl/src/streaming/buffering/MediaSourceController.ts:117

endOfStream

endOfStream(error?: EndOfStreamError): void
Signals the end of the stream.
Parameters
- Optionalerror: EndOfStreamError
  A string representing an error to throw when the end of the stream is reached.
Returns void
- Defined in vinyl/src/streaming/buffering/MediaSourceController.ts:103

hasAnyListeners

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

Returns boolean
Inherited from ReadonlyMediaSourceController.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:45

hasListeners

hasListeners(type: keyof MediaSourceControllerEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof MediaSourceControllerEventMap
Returns boolean
Inherited from ReadonlyMediaSourceController.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:50

on

on<K extends keyof MediaSourceControllerEventMap>(
    type: K,
    handler: EventHandler<MediaSourceControllerEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof MediaSourceControllerEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<MediaSourceControllerEventMap[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 ReadonlyMediaSourceController.on
- Defined in vinyl-util/src/event/EventHost.ts:36