Draft
This page is not complete.
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The abort() method of the SourceBuffer interface aborts the current segment and resets the segment parser.
Syntax
sourceBuffer.abort();
Parameters
None.
Returns
Void.
Errors
The following errors may be thrown when calling this method.
| Error | Explanation |
|---|---|
InvalidStateError |
The MediaSource.readyState property of the parent media source is not equal to open, or this SourceBuffer has been removed from the MediaSource. |
Example
The spec description of abort() is somewhat confusing — consider for example step 1 of reset parser state. The MSE API is fully asynchronous, but this step seems to suggest a synchronous (blocking) operation, which doesn't make sense.
Saying that, current implementations can be useful in certain situations, when you want to stop the current append (or whatever) operation occuring on a sourcebuffer, and then immediately start performing operations on it again. For example, consider this code:
sourceBuffer.addEventListener('updateend', function (_) {
...
});
sourceBuffer.appendBuffer(buf);
Let's say that after the call to appendBuffer BUT before the updateend event fires (i.e. a buffer is being appended but the operation has not yet completed) a user "scrubs" the video seeking to a new point in time. In this case you would want to manually call abort() on the source buffer to stop the decoding of the current buffer, then fetch and append the newly requested segment that relates to the current new position of the video.
You can see something similar in action in Nick Desaulnier's bufferWhenNeeded demo — in line 48, an event listener is added to the playing video so a function called seek() is run when the seeking event fires. In lines 92-101, the seek() function is defined — note that abort() is called if MediaSource.readyState is set to open, which means that it is ready to receive new source buffers — at this point it is worth aborting the current segment and just getting the one for the new seek position (see checkBuffer() and getCurrentSegment().)
Specifications
| Specification | Status | Comment |
|---|---|---|
| Media Source Extensions The definition of 'abort()' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
| Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|---|
| Basic support | 23 | (Yes) | 25.0 (25.0)[1] 42.0 (42.0) |
11[2] | 15 | 8 |
| Feature | Android | Edge | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|---|
| Basic support | 4.4.4 | (Yes) |
No support |
No support | 11 | 30 | No support |
[1] Available after switching the about:config preference media.mediasource.enabled to true. In addition, support was limited to a whitelist of sites, for example YouTube, Netflix, and other popular streaming sites. The whitelist was removed and Media Source Extensions was enabled by default in 42+ for all sites.
[2] Only works on Windows 8+.