kotlin-browser/web.mediarecorder/MediaRecorder

MediaRecorder

open class MediaRecorder(val stream: MediaStream, options: MediaRecorderOptions = definedExternally) : EventTarget(source)

The MediaRecorder interface of the MediaStream Recording API provides functionality to easily record media. It is created using the MediaRecorder() constructor.

MDN Reference

Constructors

MediaRecorder

constructor(stream: MediaStream, options: MediaRecorderOptions = definedExternally)

Types

Companion

object Companion

Properties

audioBitsPerSecond

val audioBitsPerSecond: Int

The audioBitsPerSecond read-only property of the MediaRecorder interface returns the audio encoding bit rate in use.

mimeType

val mimeType: String

The mimeType read-only property of the MediaRecorder interface returns the MIME media type that was specified when creating the MediaRecorder object, or, if none was specified, which was chosen by the browser. This is the file format of the file that would result from writing all of the recorded data to disk.

ondataavailable

var ondataavailable: EventHandler<BlobEvent, MediaRecorder, MediaRecorder>?

MDN Reference

onerror

var onerror: EventHandler<ErrorEvent, MediaRecorder, MediaRecorder>?

MDN Reference

onpause

var onpause: EventHandler<Event, MediaRecorder, MediaRecorder>?

MDN Reference

onresume

var onresume: EventHandler<Event, MediaRecorder, MediaRecorder>?

MDN Reference

onstart

var onstart: EventHandler<Event, MediaRecorder, MediaRecorder>?

MDN Reference

onstop

var onstop: EventHandler<Event, MediaRecorder, MediaRecorder>?

MDN Reference

state

val state: RecordingState

The state read-only property of the MediaRecorder interface returns the current state of the current MediaRecorder object.

stream

val stream: MediaStream

The stream read-only property of the MediaRecorder interface returns the stream that was passed into the MediaRecorder() constructor when the MediaRecorder was created.

videoBitsPerSecond

val videoBitsPerSecond: Int

The videoBitsPerSecond read-only property of the MediaRecorder interface returns the video encoding bit rate in use.

Functions

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

pause

fun pause()

The pause() method of the MediaRecorder interface is used to pause recording of media streams.

requestData

fun requestData()

The requestData() method of the MediaRecorder interface is used to raise a dataavailable event containing a Blob object of the captured media as it was when the method was called. This can then be grabbed and manipulated as you wish.

resume

fun resume()

The resume() method of the MediaRecorder interface is used to resume media recording when it has been previously paused.

start

fun start(timeslice: Int = definedExternally)

The start() method of the MediaRecorder interface begins recording media into one or more Blob objects.

stop

fun stop()

The stop() method of the MediaRecorder interface is used to stop media capture.

when

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