kotlin-browser/web.mediasource/SourceBuffer

SourceBuffer

open class SourceBuffer : EventTarget(source)

The SourceBuffer interface represents 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

Properties

appendWindowEnd

var appendWindowEnd: Double

The appendWindowEnd property of the SourceBuffer interface controls the timestamp for the end of the append window, a timestamp range that can be used to filter what media data is appended to the SourceBuffer. Coded media frames with timestamps within this range will be appended, whereas those outside the range will be filtered out.

appendWindowStart

var appendWindowStart: Double

The appendWindowStart property of the SourceBuffer interface controls the timestamp for the start of the append window, a timestamp range that can be used to filter what media data is appended to the SourceBuffer. Coded media frames with timestamps within this range will be appended, whereas those outside the range will be filtered out.

buffered

val buffered: TimeRanges

The buffered read-only property of the SourceBuffer interface returns the time ranges that are currently buffered in the SourceBuffer as a normalized TimeRanges object.

mode

var 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.

onabort

var onabort: EventHandler<Event, SourceBuffer, SourceBuffer>?

MDN Reference

onerror

var onerror: EventHandler<Event, SourceBuffer, SourceBuffer>?

MDN Reference

onupdate

var onupdate: EventHandler<Event, SourceBuffer, SourceBuffer>?

MDN Reference

onupdateend

var onupdateend: EventHandler<Event, SourceBuffer, SourceBuffer>?

MDN Reference

onupdatestart

var onupdatestart: EventHandler<Event, SourceBuffer, SourceBuffer>?

MDN Reference

timestampOffset

var timestampOffset: Double

The timestampOffset property of the SourceBuffer interface controls the offset applied to timestamps inside media segments that are appended to the SourceBuffer.

updating

val updating: Boolean

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

Functions

abort

fun abort()

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

appendBuffer

fun appendBuffer(data: BufferSource)

The appendBuffer() method of the SourceBuffer interface appends media segment data from an ArrayBuffer, a TypedArray or a DataView object to the SourceBuffer.

changeType

fun changeType(type: String)

The changeType() method of the SourceBuffer interface sets the MIME type that future calls to appendBuffer() should expect the new media data to conform to. This makes it possible to change codecs or container type mid-stream.

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

remove

fun remove(start: Double, end: Double)

The remove() method of the SourceBuffer interface removes media segments within a specific time range from the SourceBuffer. This method can only be called when SourceBuffer.updating equals false. If SourceBuffer.updating is not equal to false, call SourceBuffer.abort().

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>