SourceBuffer: appendBuffer() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Note: This feature is available in Dedicated Web Workers.
The appendBuffer() method of the
SourceBuffer interface appends media segment data from an
ArrayBuffer, a TypedArray or a DataView object
to the SourceBuffer.
Syntax
appendBuffer(source)
Parameters
source-
Either an
ArrayBuffer, aTypedArrayor aDataViewobject that contains the media segment data you want to add to theSourceBuffer.
Return value
None (undefined).
Exceptions
InvalidStateErrorDOMException-
Thrown in one of the following cases:
- The
SourceBufferobject'supdatingattribute istrue. You must wait for any previous append, update, or remove operations to complete (indicated by theupdateendevent) before callingappendBuffer()again. - The
SourceBufferhas been removed from thesourceBuffersattribute of the parent media source. - The
HTMLMediaElement'serrorattribute is notnull.
- The
QuotaExceededError-
The buffer is full, and no more data can be appended. This might occur if the
SourceBufferhas reached a browser-defined limit on the amount of buffered data.
Additionally, errors can occur after the updatestart event has been fired and the appendBuffer() method has returned: for example, because the buffer contained bytes that were incorrectly formatted. In this situation the error event will be fired on this SourceBuffer instance.
Examples
>Basic usage
This example demonstrates adding video data to a video element for playback. The MediaSource provides the video data, and the SourceBuffer adds that data. The example fetches video segment data, appends it to the SourceBuffer, and ends the stream when finished.
const mediaSource = new MediaSource();
const video = document.querySelector("video");
video.src = URL.createObjectURL(mediaSource);
mediaSource.addEventListener("sourceopen", async () => {
const sourceBuffer = mediaSource.addSourceBuffer(
'video/mp4; codecs="avc1.42E01E, mp4a.40.2"',
);
const buffer = await fetch("/my-video-segment.mp4").then((res) =>
res.arrayBuffer(),
);
sourceBuffer.appendBuffer(buffer);
sourceBuffer.addEventListener("updateend", () => {
if (mediaSource.readyState === "open") {
mediaSource.endOfStream();
}
});
});
Handling errors
This example demonstrates how to handle errors that may occur when calling appendBuffer().
It calls appendBuffer() inside a try...catch block to catch and handle the exceptions that the method synchronously throws. It also listens for the error event to handle errors that occur after appendBuffer() has returned, while the buffer is being asynchronously updated.
sourceBuffer.addEventListener("error", (e) => {
console.error("Error appending buffer:", e);
// Handle the error appropriately, e.g., show a message to the user,
// try a different source, or stop playback.
});
try {
sourceBuffer.appendBuffer(data);
} catch (e) {
if (e.name === "InvalidStateError") {
console.error(
"InvalidStateError: The SourceBuffer is in an invalid state.",
);
} else if (e.name === "QuotaExceededError") {
console.error("QuotaExceededError: The buffer is full.");
} else {
console.error("An unexpected error occurred:", e);
}
}
Specifications
| Specification |
|---|
| Media Source Extensions™> # dom-sourcebuffer-appendbuffer> |
Browser compatibility
Loading…