Module one.jpro.platform.media

Package one.jpro.platform.media.recorder.impl

Class WebMediaRecorder

java.lang.Object

one.jpro.platform.media.recorder.impl.WebMediaRecorder

All Implemented Interfaces:

javafx.event.EventTarget, MediaEngine, MediaRecorder, WebMediaEngine

public final class WebMediaRecorder
extends Object
implements WebMediaEngine

MediaRecorder implementation for the web.

Author:

Besmir Beqiri

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>	duration	The current duration of the recording since it started.
final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorderException>	error	Observable property set to a MediaRecorderException if an error occurs.
final javafx.beans.property.ReadOnlyObjectProperty<MediaSource>	mediaSource	The current media source for this recorder.
javafx.beans.property.ReadOnlyStringProperty	mimeType
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onDataAvailable	Event handler invoked when this recorder delivers media data to the application for its use.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onError	Event handler invoked when an error occurs.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onPaused	Event handler invoked when the recorder has paused, and status is set to MediaRecorder.Status.PAUSED.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onReady	Event handler invoked when the status changes to READY.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onResume	Event handler invoked when recording has resumed and the status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStart	Event handler invoked when the recording started.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStopped	Event handler invoked when recording stopped and the status changes to MediaRecorder.Status.INACTIVE.
final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorder.Status>	status	The current status of the MediaRecorder object (inactive, recording, or paused.)

Nested Class Summary

Nested classes/interfaces inherited from interface one.jpro.platform.media.recorder.MediaRecorder

MediaRecorder.Status

Constructor Summary

Constructors

Constructor	Description
WebMediaRecorder(com.jpro.webapi.WebAPI webAPI)	Creates a new MediaRecorder object.

Method Summary

Modifier and Type	Method	Description
final javafx.event.EventDispatchChain	buildEventDispatchChain(javafx.event.EventDispatchChain tail)
javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>	durationProperty()	The current duration of the recording since it started.
void	enable()	Enable camera stream from the device.
final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorderException>	errorProperty()	Observable property set to a MediaRecorderException if an error occurs.
javafx.util.Duration	getDuration()	Gets the current duration for the recording since it started.
final MediaRecorderException	getError()	Retrieve the value of the error property or null if there is no error.
final MediaSource	getMediaSource()	Retrieves the current media source.
String	getMimeType()	Gets the value of the mimeType property.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnDataAvailable()	Retrieves the event handler when the recording has started and media data is delivered to the application.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnError()	Retrieves the event handler for errors.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnPaused()	Retrieves the event handler when the recording has paused and status is set to MediaRecorder.Status.PAUSED.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnReady()	Retrieves the MediaRecorder.Status.READY event handler.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnResume()	Retrieves the event handler when recording has resumed and status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnStart()	Retrieves the event handler when the recording has started and status is set to MediaRecorder.Status.RECORDING.
final javafx.event.EventHandler<MediaRecorderEvent>	getOnStopped()	Retrieves the event handler when recording is stopped and status changes to MediaRecorder.Status.INACTIVE.
final MediaRecorder.Status	getStatus()	Retrieves the current recorder status.
com.jpro.webapi.JSVariable	getVideoElement()	Returns the video element used to both play and record media on the browser.
com.jpro.webapi.WebAPI	getWebAPI()	Returns the WebAPI instance.
boolean	isTypeSupported(String mimeType)	Returns a boolean which is true if the MIME type specified is one that this media recorder should be able to successfully record.
final javafx.beans.property.ReadOnlyObjectProperty<MediaSource>	mediaSourceProperty()	The current media source for this recorder.
javafx.beans.property.ReadOnlyStringProperty	mimeTypeProperty()
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onDataAvailableProperty()	Event handler invoked when this recorder delivers media data to the application for its use.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onErrorProperty()	Event handler invoked when an error occurs.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onPausedProperty()	Event handler invoked when the recorder has paused, and status is set to MediaRecorder.Status.PAUSED.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onReadyProperty()	Event handler invoked when the status changes to READY.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onResumeProperty()	Event handler invoked when recording has resumed and the status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStartProperty()	Event handler invoked when the recording started.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStoppedProperty()	Event handler invoked when recording stopped and the status changes to MediaRecorder.Status.INACTIVE.
void	pause()	Pauses the recording of media.
final void	setOnDataAvailable(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when the recording has started and media data is delivered to the application.
final void	setOnError(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler to be called when an error occurs.
final void	setOnPaused(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when the media recorder has paused and status is set to MediaRecorder.Status.PAUSED.
final void	setOnReady(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the MediaRecorder.Status.READY event handler.
final void	setOnResume(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when recording has resumed and status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.
final void	setOnStart(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when the recording has started and status is set to MediaRecorder.Status.RECORDING.
final void	setOnStopped(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when recording is stopped and status changes to MediaRecorder.Status.INACTIVE.
void	start()	Begins recording media or resumes recording of media after having been paused.
final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorder.Status>	statusProperty()	The current status of the MediaRecorder object (inactive, recording, or paused.)
void	stop()	Stops the recording of media.

Methods inherited from class java.lang.Object

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

Property Details

mimeType

public javafx.beans.property.ReadOnlyStringProperty mimeTypeProperty

See Also:

• getMimeType()
• mimeTypeProperty()

mediaSource

public final javafx.beans.property.ReadOnlyObjectProperty<MediaSource> mediaSourceProperty

Specified by:

mediaSourceProperty in interface MediaRecorder

Returns:

the mediaSource property

See Also:

• MediaRecorder.getMediaSource()
• MediaRecorder.mediaSourceProperty()

status

public final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorder.Status> statusProperty

The current status of the MediaRecorder object (inactive, recording, or paused.)

Specified by:

statusProperty in interface MediaRecorder

Returns:

the status property

See Also:

• MediaRecorder.getStatus()
• MediaRecorder.statusProperty()

duration

public javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration> durationProperty

Specified by:

durationProperty in interface MediaRecorder

Returns:

the duration of the media

See Also:

• MediaRecorder.getDuration()
• MediaRecorder.durationProperty()

onReady

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onReadyProperty

Specified by:

onReadyProperty in interface MediaRecorder

Returns:

the onReady property

See Also:

• MediaRecorder.getOnReady()
• MediaRecorder.setOnReady(EventHandler)
• MediaRecorder.onReadyProperty()

onDataAvailable

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onDataAvailableProperty

Specified by:

onDataAvailableProperty in interface MediaRecorder

Returns:

the onDataAvailable property

See Also:

• MediaRecorder.getOnDataAvailable()
• MediaRecorder.setOnDataAvailable(EventHandler)
• MediaRecorder.onDataAvailableProperty()

onStart

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onStartProperty

Specified by:

onStartProperty in interface MediaRecorder

Returns:

the onStart property

See Also:

• MediaRecorder.getOnStart()
• MediaRecorder.setOnStart(EventHandler)
• MediaRecorder.onStartProperty()

onPaused

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onPausedProperty

Specified by:

onPausedProperty in interface MediaRecorder

Returns:

the onPaused property

See Also:

• MediaRecorder.getOnPaused()
• MediaRecorder.setOnPaused(EventHandler)
• MediaRecorder.onPausedProperty()

onResume

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onResumeProperty

Specified by:

onResumeProperty in interface MediaRecorder

Returns:

the onResume property

See Also:

• MediaRecorder.getOnResume()
• MediaRecorder.setOnResume(EventHandler)
• MediaRecorder.onResumeProperty()

onStopped

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onStoppedProperty

Specified by:

onStoppedProperty in interface MediaRecorder

Returns:

the onStopped property

See Also:

• MediaRecorder.getOnStopped()
• MediaRecorder.setOnStopped(EventHandler)
• MediaRecorder.onStoppedProperty()

onError

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onErrorProperty

Specified by:

onErrorProperty in interface MediaRecorder

Returns:

the onError property

See Also:

• MediaRecorder.getOnError()
• MediaRecorder.setOnError(EventHandler)
• MediaRecorder.onErrorProperty()

error

public final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorderException> errorProperty

Specified by:

errorProperty in interface MediaRecorder

Returns:

the error property

See Also:

• MediaRecorder.getError()
• MediaRecorder.errorProperty()

Constructor Details

WebMediaRecorder

public WebMediaRecorder(com.jpro.webapi.WebAPI webAPI)

Creates a new MediaRecorder object.

Parameters:

webAPI - JPro WebAPI

Method Details

getWebAPI

public com.jpro.webapi.WebAPI getWebAPI()

Description copied from interface: WebMediaEngine

Returns the WebAPI instance.

Specified by:

getWebAPI in interface WebMediaEngine

Returns:

the WebAPI instance

getVideoElement

public com.jpro.webapi.JSVariable getVideoElement()

Description copied from interface: WebMediaEngine

Returns the video element used to both play and record media on the browser.

Specified by:

getVideoElement in interface WebMediaEngine

Returns:

the video element as a JSVariable

isTypeSupported

public boolean isTypeSupported(String mimeType)
                        throws Exception

Returns a boolean which is true if the MIME type specified is one that this media recorder should be able to successfully record.

Parameters:

mimeType - the MIME media type to check

Returns:

true if this MediaRecorder implementation is capable of recording Blob objects for the specified MIME type. Recording may still fail if there are insufficient resources to support the recording and encoding process. If the value is false, the user agent is incapable of recording the specified format.

Throws:

Exception

getMimeType

public String getMimeType()

Gets the value of the mimeType property.

Property description:

Returns:

the value of the mimeType property

See Also:

• mimeTypeProperty()

mimeTypeProperty

public javafx.beans.property.ReadOnlyStringProperty mimeTypeProperty()

Returns:

the mimeType property

See Also:

• getMimeType()

enable

public void enable()

Description copied from interface: MediaRecorder

Enable camera stream from the device. If this process is successful, then use the MediaView.create(MediaRecorder) method to create the camera view and show it.

Specified by:

enable in interface MediaRecorder

start

public void start()

Description copied from interface: MediaRecorder

Begins recording media or resumes recording of media after having been paused.

Specified by:

start in interface MediaRecorder

pause

public void pause()

Description copied from interface: MediaRecorder

Pauses the recording of media.

Specified by:

pause in interface MediaRecorder

stop

public void stop()

Description copied from interface: MediaRecorder

Stops the recording of media.

Specified by:

stop in interface MediaRecorder

getMediaSource

public final MediaSource getMediaSource()

Description copied from interface: MediaRecorder

Retrieves the current media source.

Specified by:

getMediaSource in interface MediaRecorder

Returns:

MediaSource object

mediaSourceProperty

public final javafx.beans.property.ReadOnlyObjectProperty<MediaSource> mediaSourceProperty()

Description copied from interface: MediaRecorder

The current media source for this recorder.

Specified by:

mediaSourceProperty in interface MediaRecorder

Returns:

the mediaSource property

See Also:

• MediaRecorder.getMediaSource()

getStatus

public final MediaRecorder.Status getStatus()

Description copied from interface: MediaRecorder

Retrieves the current recorder status.

Specified by:

getStatus in interface MediaRecorder

Returns:

the recorder status

statusProperty

public final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorder.Status> statusProperty()

The current status of the MediaRecorder object (inactive, recording, or paused.)

Specified by:

statusProperty in interface MediaRecorder

Returns:

the status property

See Also:

• MediaRecorder.getStatus()

getDuration

public javafx.util.Duration getDuration()

Description copied from interface: MediaRecorder

Gets the current duration for the recording since it started.

Specified by:

getDuration in interface MediaRecorder

durationProperty

public javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration> durationProperty()

Description copied from interface: MediaRecorder

The current duration of the recording since it started. The value will be reset to Duration.ZERO when the recording is stopped.

Specified by:

durationProperty in interface MediaRecorder

Returns:

the duration property

See Also:

• MediaRecorder.getDuration()

getOnReady

public final javafx.event.EventHandler<MediaRecorderEvent> getOnReady()

Description copied from interface: MediaRecorder

Retrieves the MediaRecorder.Status.READY event handler.

Specified by:

getOnReady in interface MediaRecorder

Returns:

the event handler or null.

setOnReady

public final void setOnReady(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the MediaRecorder.Status.READY event handler.

Specified by:

setOnReady in interface MediaRecorder

Parameters:

value - the event handler or null.

onReadyProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onReadyProperty()

Description copied from interface: MediaRecorder

Event handler invoked when the status changes to READY.

Specified by:

onReadyProperty in interface MediaRecorder

Returns:

the onReady property

See Also:

• MediaRecorder.getOnReady()
• MediaRecorder.setOnReady(EventHandler)

getOnDataAvailable

public final javafx.event.EventHandler<MediaRecorderEvent> getOnDataAvailable()

Description copied from interface: MediaRecorder

Retrieves the event handler when the recording has started and media data is delivered to the application.

Specified by:

getOnDataAvailable in interface MediaRecorder

Returns:

the event handler or null.

setOnDataAvailable

public final void setOnDataAvailable(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the event handler when the recording has started and media data is delivered to the application.

Specified by:

setOnDataAvailable in interface MediaRecorder

Parameters:

value - the event handler or null.

onDataAvailableProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onDataAvailableProperty()

Description copied from interface: MediaRecorder

Event handler invoked when this recorder delivers media data to the application for its use.

Specified by:

onDataAvailableProperty in interface MediaRecorder

Returns:

the onDataAvailable property

See Also:

• MediaRecorder.getOnDataAvailable()
• MediaRecorder.setOnDataAvailable(EventHandler)

getOnStart

public final javafx.event.EventHandler<MediaRecorderEvent> getOnStart()

Description copied from interface: MediaRecorder

Retrieves the event handler when the recording has started and status is set to MediaRecorder.Status.RECORDING.

Specified by:

getOnStart in interface MediaRecorder

Returns:

the event handler or null.

setOnStart

public final void setOnStart(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the event handler when the recording has started and status is set to MediaRecorder.Status.RECORDING.

Specified by:

setOnStart in interface MediaRecorder

Parameters:

value - the event handler or null.

onStartProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onStartProperty()

Description copied from interface: MediaRecorder

Event handler invoked when the recording started.

Specified by:

onStartProperty in interface MediaRecorder

Returns:

the onStart property

See Also:

• MediaRecorder.getOnStart()
• MediaRecorder.setOnStart(EventHandler)

getOnPaused

public final javafx.event.EventHandler<MediaRecorderEvent> getOnPaused()

Description copied from interface: MediaRecorder

Retrieves the event handler when the recording has paused and status is set to MediaRecorder.Status.PAUSED.

Specified by:

getOnPaused in interface MediaRecorder

Returns:

the event handler or null.

setOnPaused

public final void setOnPaused(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the event handler when the media recorder has paused and status is set to MediaRecorder.Status.PAUSED.

Specified by:

setOnPaused in interface MediaRecorder

Parameters:

value - the event handler or null.

onPausedProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onPausedProperty()

Description copied from interface: MediaRecorder

Event handler invoked when the recorder has paused, and status is set to MediaRecorder.Status.PAUSED.

Specified by:

onPausedProperty in interface MediaRecorder

Returns:

the onPaused property

See Also:

• MediaRecorder.getOnPaused()
• MediaRecorder.setOnPaused(EventHandler)

getOnResume

public final javafx.event.EventHandler<MediaRecorderEvent> getOnResume()

Description copied from interface: MediaRecorder

Retrieves the event handler when recording has resumed and status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.

Specified by:

getOnResume in interface MediaRecorder

Returns:

the event handler or null.

setOnResume

public final void setOnResume(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the event handler when recording has resumed and status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.

Specified by:

setOnResume in interface MediaRecorder

Parameters:

value - the event handler or null.

onResumeProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onResumeProperty()

Description copied from interface: MediaRecorder

Event handler invoked when recording has resumed and the status changes to MediaRecorder.Status.RECORDING after previously was set to MediaRecorder.Status.PAUSED.

Specified by:

onResumeProperty in interface MediaRecorder

Returns:

the onResume property

See Also:

• MediaRecorder.getOnResume()
• MediaRecorder.setOnResume(EventHandler)

getOnStopped

public final javafx.event.EventHandler<MediaRecorderEvent> getOnStopped()

Description copied from interface: MediaRecorder

Retrieves the event handler when recording is stopped and status changes to MediaRecorder.Status.INACTIVE.

Specified by:

getOnStopped in interface MediaRecorder

Returns:

the event handler or null.

setOnStopped

public final void setOnStopped(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the event handler when recording is stopped and status changes to MediaRecorder.Status.INACTIVE.

Specified by:

setOnStopped in interface MediaRecorder

Parameters:

value - the event handler or null.

onStoppedProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onStoppedProperty()

Description copied from interface: MediaRecorder

Event handler invoked when recording stopped and the status changes to MediaRecorder.Status.INACTIVE.

Specified by:

onStoppedProperty in interface MediaRecorder

Returns:

the onStopped property

See Also:

• MediaRecorder.getOnStopped()
• MediaRecorder.setOnStopped(EventHandler)

getOnError

public final javafx.event.EventHandler<MediaRecorderEvent> getOnError()

Description copied from interface: MediaRecorder

Retrieves the event handler for errors.

Specified by:

getOnError in interface MediaRecorder

Returns:

the event handler.

setOnError

public final void setOnError(javafx.event.EventHandler<MediaRecorderEvent> value)

Description copied from interface: MediaRecorder

Sets the event handler to be called when an error occurs.

Specified by:

setOnError in interface MediaRecorder

Parameters:

value - the event handler or null.

onErrorProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>> onErrorProperty()

Description copied from interface: MediaRecorder

Event handler invoked when an error occurs.

Specified by:

onErrorProperty in interface MediaRecorder

Returns:

the onError property

See Also:

• MediaRecorder.getOnError()
• MediaRecorder.setOnError(EventHandler)

getError

public final MediaRecorderException getError()

Description copied from interface: MediaRecorder

Retrieve the value of the error property or null if there is no error.

Specified by:

getError in interface MediaRecorder

Returns:

a MediaRecorderException or null.

errorProperty

public final javafx.beans.property.ReadOnlyObjectProperty<MediaRecorderException> errorProperty()

Description copied from interface: MediaRecorder

Observable property set to a MediaRecorderException if an error occurs.

Specified by:

errorProperty in interface MediaRecorder

Returns:

the error property

See Also:

• MediaRecorder.getError()

buildEventDispatchChain

public final javafx.event.EventDispatchChain buildEventDispatchChain(javafx.event.EventDispatchChain tail)

Specified by:

buildEventDispatchChain in interface javafx.event.EventTarget