Interface SourceBuffer

The SourceBuffer interface represents a chunk of media to be passed into an HTMLMediaElement and played, via a MediaSource object.

MDN Reference

interface SourceBuffer {
    appendWindowEnd: number;
    appendWindowStart: number;
    buffered: TimeRanges;
    mode: AppendMode;
    onabort: null | ((this: SourceBuffer, ev: Event) => any);
    onerror: null | ((this: SourceBuffer, ev: Event) => any);
    onupdate: null | ((this: SourceBuffer, ev: Event) => any);
    onupdateend: null | ((this: SourceBuffer, ev: Event) => any);
    onupdatestart: null | ((this: SourceBuffer, ev: Event) => any);
    timestampOffset: number;
    updating: boolean;
    abort(): void;
    addEventListener<K extends keyof SourceBufferEventMap>(
        type: K,
        listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    appendBuffer(data: BufferSource): void;
    changeType(type: string): void;
    dispatchEvent(event: Event): boolean;
    remove(start: number, end: number): void;
    removeEventListener<K extends keyof SourceBufferEventMap>(
        type: K,
        listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
}

Hierarchy

EventTarget
- SourceBuffer

Index

Properties

appendWindowEnd appendWindowStart buffered mode onabort onerror onupdate onupdateend onupdatestart timestampOffset updating

Methods

abort addEventListener appendBuffer changeType dispatchEvent remove removeEventListener

Properties

appendWindowEnd

appendWindowEnd: number

The appendWindowEnd property of the timestamp range that can be used to filter what media data is appended to the SourceBuffer.

MDN Reference

appendWindowStart

appendWindowStart: number

The appendWindowStart property of the timestamp range that can be used to filter what media data is appended to the SourceBuffer.

MDN Reference

`Readonly`buffered

buffered: TimeRanges

The buffered read-only property of the buffered in the SourceBuffer as a normalized TimeRanges object.

MDN Reference

mode

mode: AppendMode

The mode property of the SourceBuffer interface controls whether media segments can be appended to the SourceBuffer in any order, or in a strict sequence.

MDN Reference

onabort

onabort: null | ((this: SourceBuffer, ev: Event) => any)

onerror

onerror: null | ((this: SourceBuffer, ev: Event) => any)

onupdate

onupdate: null | ((this: SourceBuffer, ev: Event) => any)

onupdateend

onupdateend: null | ((this: SourceBuffer, ev: Event) => any)

onupdatestart

onupdatestart: null | ((this: SourceBuffer, ev: Event) => any)

timestampOffset

timestampOffset: number

The timestampOffset property of the media segments that are appended to the SourceBuffer.

MDN Reference

`Readonly`updating

updating: boolean

The updating read-only property of the currently being updated — i.e., whether an SourceBuffer.appendBuffer() or SourceBuffer.remove() operation is currently in progress.

MDN Reference

Methods

abort

abort(): void
The abort() method of the SourceBuffer interface aborts the current segment and resets the segment parser.

MDN Reference

Returns void

addEventListener

addEventListener<K extends keyof SourceBufferEventMap>(
    type: K,
    listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Type Parameters
- K extends keyof SourceBufferEventMap
Parameters
- type: K
- listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener

appendBuffer

appendBuffer(data: BufferSource): void
The appendBuffer() method of the to the SourceBuffer.

MDN Reference
Parameters
- data: BufferSource
Returns void

changeType

changeType(type: string): void
The changeType() method of the data to conform to.

MDN Reference
Parameters
- type: string
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent

remove

remove(start: number, end: number): void
The remove() method of the SourceBuffer interface removes media segments within a specific time range from the SourceBuffer.

MDN Reference
Parameters
- start: number
- end: number
Returns void

removeEventListener

removeEventListener<K extends keyof SourceBufferEventMap>(
    type: K,
    listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Type Parameters
- K extends keyof SourceBufferEventMap
Parameters
- type: K
- listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener

Interface SourceBuffer

Hierarchy

Index

Properties

Methods

Properties

appendWindowEnd

appendWindowStart

Readonlybuffered

mode

onabort

onerror

onupdate

onupdateend

onupdatestart

timestampOffset

Readonlyupdating

Methods

abort

Returns void

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

appendBuffer

Parameters

Returns void

changeType

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

remove

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Readonly`buffered

`Readonly`updating