akasha.media

Class MediaRecorder

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.media.MediaRecorder

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="MediaRecorder")
public class MediaRecorder
extends EventTarget

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

See Also:

MediaRecorder - MDN, # mediarecorder-api

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	ondataavailable The MediaRecorder.ondataavailable event handler (part of the MediaStream Recording API) handles the dataavailable event, letting you run code in response to Blob data being made available for use.
@JsNullable MediaRecorderErrorEventHandler	onerror The MediaRecorder interface's onerror event handler is called by the MediaStream Recording API when an error occurs.
@JsNullable EventHandler	onpause The MediaRecorder.onpause event handler (part of the MediaRecorder API) handles the pause event, allowing you to run code in response to the media recording being paused.
@JsNullable EventHandler	onresume The MediaRecorder.onresume event handler (part of the MediaRecorder API) handles the resume event, allowing you to run code in response to the media recording being resumed after pausing.
@JsNullable EventHandler	onstart The MediaRecorder.onstartevent handler (part of the MediaRecorder API) handles the start event, allowing you to run code in response to media recording being started by a MediaRecorder.
@JsNullable EventHandler	onstop The MediaRecorder.onstop event handler (part of the MediaRecorder API) handles the stop event, allowing you to run code in response to media recording via a MediaRecorder being stopped.

Constructor Summary

Constructors

Constructor and Description
MediaRecorder(MediaStream stream) The MediaRecorder() constructor creates a new MediaRecorder object that will record a specified MediaStream.
MediaRecorder(MediaStream stream, MediaRecorderOptions options) The MediaRecorder() constructor creates a new MediaRecorder object that will record a specified MediaStream.

Method Summary

Modifier and Type	Method and Description
void	addErrorListener(MediaRecorderErrorEventListener callback)
void	addErrorListener(MediaRecorderErrorEventListener callback, AddEventListenerOptions options)
void	addErrorListener(MediaRecorderErrorEventListener callback, boolean useCapture)
java.lang.String	audioBitrateMode()
int	audioBitsPerSecond() The audioBitsPerSecond read-only property of the MediaRecorder interface returns the audio encoding bit rate in use.
static boolean	isTypeSupported(java.lang.String type) The MediaRecorder.isTypeSupported() static method returns a Boolean which is true if the MIME type specified is one the user agent should be able to successfully record.
java.lang.String	mimeType() The mimeType read-only property returns the MIME media type that was specified when creating the MediaRecorder object, or, if none was specified, which was chosen by the browser.
void	pause() The Media.pause() method (part of the MediaRecorder API) is used to pause recording of media streams.
void	removeErrorListener(MediaRecorderErrorEventListener callback)
void	removeErrorListener(MediaRecorderErrorEventListener callback, boolean useCapture)
void	removeErrorListener(MediaRecorderErrorEventListener callback, EventListenerOptions options)
void	requestData() The MediaRecorder.requestData() method (part of the MediaRecorder API) is used to raise a dataavailable event containing a Blob object of the captured media as it was when the method was called.
void	resume() The MediaRecorder.resume() method (part of the MediaRecorder API) is used to resume media recording when it has been previously paused.
void	start() The MediaRecorder method start(), which is part of the MediaStream Recording API, begins recording media into one or more Blob objects.
void	start(int timeslice) The MediaRecorder method start(), which is part of the MediaStream Recording API, begins recording media into one or more Blob objects.
java.lang.String	state() The MediaRecorder.state read-only property returns the current state of the current MediaRecorder object.
void	stop() The MediaRecorder.stop() method (part of the MediaRecorder API) is used to stop media capture.
MediaStream	stream() The MediaRecorder.stream read-only property returns the stream that was passed into the MediaRecorder() constructor when the MediaRecorder was created.
int	videoBitsPerSecond() The videoBitsPerSecond read-only property of the MediaRecorder interface returns the video encoding bit rate in use.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ondataavailable

public @JsNullable EventHandler ondataavailable

The MediaRecorder.ondataavailable event handler (part of the MediaStream Recording API) handles the dataavailable event, letting you run code in response to Blob data being made available for use.

See Also:

MediaRecorder.ondataavailable - MDN, MediaRecorder.ondataavailable - MediaStream Recording

onerror

public @JsNullable MediaRecorderErrorEventHandler onerror

The MediaRecorder interface's onerror event handler is called by the MediaStream Recording API when an error occurs. You can provide an event handler to deal with errors that occur while creating or using a media recorder

See Also:

MediaRecorder.onerror - MDN, MediaRecorder.onerror - MediaStream Recording

onpause

public @JsNullable EventHandler onpause

The MediaRecorder.onpause event handler (part of the MediaRecorder API) handles the pause event, allowing you to run code in response to the media recording being paused.

See Also:

MediaRecorder.onpause - MDN, MediaRecorder.onpause - MediaStream Recording

onresume

public @JsNullable EventHandler onresume

The MediaRecorder.onresume event handler (part of the MediaRecorder API) handles the resume event, allowing you to run code in response to the media recording being resumed after pausing.

See Also:

MediaRecorder.onresume - MDN, MediaRecorder.onresume - MediaStream Recording

onstart

public @JsNullable EventHandler onstart

The MediaRecorder.onstartevent handler (part of the MediaRecorder API) handles the start event, allowing you to run code in response to media recording being started by a MediaRecorder.

See Also:

MediaRecorder.onstart - MDN, MediaRecorder.onstart - MediaStream Recording

onstop

public @JsNullable EventHandler onstop

The MediaRecorder.onstop event handler (part of the MediaRecorder API) handles the stop event, allowing you to run code in response to media recording via a MediaRecorder being stopped.

See Also:

MediaRecorder.onstop - MDN, MediaRecorder.onstop - MediaStream Recording

Constructor Detail

MediaRecorder

public MediaRecorder(@Nonnull
                     MediaStream stream,
                     @Nonnull
                     MediaRecorderOptions options)

The MediaRecorder() constructor creates a new MediaRecorder object that will record a specified MediaStream.

See Also:

MediaRecorder.MediaRecorder - MDN, MediaStream Recording

MediaRecorder

public MediaRecorder(@Nonnull
                     MediaStream stream)

The MediaRecorder() constructor creates a new MediaRecorder object that will record a specified MediaStream.

See Also:

MediaRecorder.MediaRecorder - MDN, MediaStream Recording

Method Detail

audioBitrateMode

@JsProperty(name="audioBitrateMode")
 @Nonnull
 @BitrateMode
public java.lang.String audioBitrateMode()

audioBitsPerSecond

@JsProperty(name="audioBitsPerSecond")
public int audioBitsPerSecond()

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

See Also:

MediaRecorder.audioBitsPerSecond - MDN, audioBitsPerSecond - MediaStream Recording

mimeType

@JsProperty(name="mimeType")
 @Nonnull
public java.lang.String mimeType()

The mimeType read-only property returns the MIME media type that was specified when creating the MediaRecorder object, or, if none was specified, which was chosen by the browser.

See Also:

MediaRecorder.mimeType - MDN, MediaRecorder.mimeType - MediaStream Recording

state

@JsProperty(name="state")
 @Nonnull
 @RecordingState
public java.lang.String state()

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

See Also:

MediaRecorder.state - MDN, MediaRecorder.state - MediaStream Recording

stream

@JsProperty(name="stream")
 @Nonnull
public MediaStream stream()

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

See Also:

MediaRecorder.stream - MDN, MediaRecorder.stream - MediaStream Recording

videoBitsPerSecond

@JsProperty(name="videoBitsPerSecond")
public int videoBitsPerSecond()

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

See Also:

MediaRecorder.videoBitsPerSecond - MDN, videoBitsPerSecond - MediaStream Recording

isTypeSupported

public static boolean isTypeSupported(@Nonnull
                                      java.lang.String type)

The MediaRecorder.isTypeSupported() static method returns a Boolean which is true if the MIME type specified is one the user agent should be able to successfully record.

See Also:

MediaRecorder.isTypeSupported - MDN, isTypeSupported() - MediaStream Recording

pause

public void pause()

The Media.pause() method (part of the MediaRecorder API) is used to pause recording of media streams.

See Also:

MediaRecorder.pause - MDN, MediaRecorder.pause() - MediaStream Recording

requestData

public void requestData()

The MediaRecorder.requestData() method (part of the MediaRecorder API) is used to raise a dataavailable event containing a Blob object of the captured media as it was when the method was called.

See Also:

MediaRecorder.requestData - MDN, MediaRecorder.requestData() - MediaStream Recording

resume

public void resume()

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

See Also:

MediaRecorder.resume - MDN, MediaRecorder.resume() - MediaStream Recording

start

public void start(int timeslice)

The MediaRecorder method start(), which is part of the MediaStream Recording API, begins recording media into one or more Blob objects.

See Also:

MediaRecorder.start - MDN, MediaRecorder.start() - MediaStream Recording

start

public void start()

The MediaRecorder method start(), which is part of the MediaStream Recording API, begins recording media into one or more Blob objects.

See Also:

MediaRecorder.start - MDN, MediaRecorder.start() - MediaStream Recording

stop

public void stop()

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

See Also:

MediaRecorder.stop - MDN, MediaRecorder.stop() - MediaStream Recording

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              MediaRecorderErrorEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              MediaRecorderErrorEventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              MediaRecorderErrorEventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 MediaRecorderErrorEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 MediaRecorderErrorEventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 MediaRecorderErrorEventListener callback)