Class MediaSourceControllerImpl

Provides the logging prefix for all logs made by this target.

Hierarchy (View Summary)

EventHostImpl<MediaSourceControllerEventMap>
- MediaSourceControllerImpl

Implements

Index

Constructors

constructor

new MediaSourceControllerImpl(
deps: MediaSourceControllerImplDeps,
options?: Maybe<MediaSourceControllerImplOptions>,
): MediaSourceControllerImpl
Parameters
- deps: MediaSourceControllerImplDeps
- Optionaloptions: Maybe<MediaSourceControllerImplOptions>
Returns MediaSourceControllerImpl
Overrides EventHostImpl.constructor
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:87

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/dist/types/current/streaming/buffering/MediaSourceController.d.ts:82

duration

get duration(): number
Sets/gets the media source's duration.

Returns number
Implementation of MediaSourceController.duration
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:89
set duration(value: number): void
Sets/gets the media source's duration.
Parameters
- value: number
Returns void
Implementation of MediaSourceController.duration
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:90

readyState

get readyState(): ReadyState
Returns the parent media source ready state.

Returns ReadyState
Implementation of MediaSourceController.readyState
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:91

readyToAppend

get readyToAppend(): boolean
True if all source buffers have been created and data may be appended.

Returns boolean
Implementation of MediaSourceController.readyToAppend
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:99

Methods

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
Implementation of MediaSourceController.createSourceBuffer
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:92

createUrl

createUrl(): string
Creates an Object URL to use as the source for this stream.

Returns string
Implementation of MediaSourceController.createUrl
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:98

dispatch

dispatch<K extends keyof MediaSourceControllerEventMap>(
type: K,
event: MediaSourceControllerEventMap[K],
): void
Dispatches an event.
Type Parameters
- K extends keyof MediaSourceControllerEventMap
Parameters
- type: K
  The key of the event within EventMap
- event: MediaSourceControllerEventMap[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/dist/types/current/event/EventHost.d.ts:65

dispose

dispose(): void
Returns void
Overrides EventHostImpl.dispose
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:100

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
Implementation of MediaSourceController.endOfStream
- Defined in vinyl/dist/types/current/streaming/buffering/MediaSourceController.d.ts:97

hasAnyListeners

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

Returns boolean
Implementation of MediaSourceController.hasAnyListeners
Inherited from EventHostImpl.hasAnyListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:62

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
Implementation of MediaSourceController.hasListeners
Inherited from EventHostImpl.hasListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:63

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.
Implementation of MediaSourceController.on
Inherited from EventHostImpl.on
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:64

Class MediaSourceControllerImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MediaSourceControllerImpl

Properties

ReadonlylogPrefix

Accessors

[toStringTag]

Returns string

duration

Returns number

Parameters

Returns void

readyState

Returns ReadyState

readyToAppend

Returns boolean

Methods

createSourceBuffer

Parameters

Returns SourceBufferRef

createUrl

Returns string

dispatch

Type Parameters

Parameters

Returns void

dispose

Returns void

endOfStream

Parameters

Returns void

hasAnyListeners

Returns boolean

hasListeners

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns Unsubscribe

Settings

On This Page

`Readonly`logPrefix