Interface SourceBuffer

A chunk of media to be passed into an HTMLMediaElement and played, via a MediaSource object. This can be made up of one or several media segments.

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

Properties

appendWindowEnd appendWindowStart buffered mode onabort onerror onupdate onupdateend onupdatestart timestampOffset updating

Methods

abort addEventListener appendBuffer changeType dispatchEvent remove removeEventListener

Properties

appendWindowEnd

appendWindowEnd: number

MDN Reference

appendWindowStart

appendWindowStart: number

MDN Reference

Readonlybuffered

buffered: TimeRanges

MDN Reference

mode

mode: AppendMode

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

MDN Reference

Readonlyupdating

updating: boolean

MDN Reference

Methods

abort

  • abort(): void

  • MDN Reference

    Returns void

addEventListener

  • addEventListener<K extends keyof SourceBufferEventMap>(
        type: K,
        listener: (this: SourceBuffer, ev: SourceBufferEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    Returns void

appendBuffer

changeType

  • changeType(type: string): void

  • MDN Reference

    Parameters

    • type: string

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

remove

  • remove(start: number, end: number): void

  • MDN Reference

    Parameters

    • start: number
    • end: number

    Returns void

removeEventListener

Settings

Member Visibility

On This Page

Properties
Methods