Module one.jpro.platform.media

Package one.jpro.platform.media.recorder

Interface MediaRecorder

All Superinterfaces:

javafx.event.EventTarget, MediaEngine

All Known Implementing Classes:

FXMediaRecorder, WebMediaRecorder

public interface MediaRecorder
extends MediaEngine, javafx.event.EventTarget

The MediaRecorder provides functionality to easily record media, both on desktop/mobile and web platforms.

This class provides the controls for recording media. MediaRecorder does not contain any visual elements so must be used in combination with the MediaView class to view the video stream from the camera device. After the recording is complete, use then the MediaSource class to retrieve the recorded media.

MediaRecorder provides the start(), pause(), and stop() controls as recording functionalities. Use enable() to request access to the camera device and enable the recording controls.

All operations of a MediaRecorder are inherently asynchronous. Use the setOnReady(EventHandler) to get notified when the MediaRecorder is ready to record. Other event handlers like setOnStart(EventHandler), setOnPaused(EventHandler), setOnResume(EventHandler), setOnStopped(EventHandler) and setOnDataAvailable(EventHandler) can be used to get notified of the corresponding events.

Author:

Besmir Beqiri

See Also:

• MediaSource
• MediaView

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>	duration	The current duration of the recording since it started.
javafx.beans.property.ReadOnlyObjectProperty<MediaRecorderException>	error	Observable property set to a MediaRecorderException if an error occurs.
javafx.beans.property.ReadOnlyObjectProperty<MediaSource>	mediaSource	The current media source for this recorder.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onDataAvailable	Event handler invoked when this recorder delivers media data to the application for its use.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onError	Event handler invoked when an error occurs.
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.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onReady	Event handler invoked when the status changes to READY.
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.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStart	Event handler invoked when the recording started.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStopped	Event handler invoked when recording stopped and the status changes to MediaRecorder.Status.INACTIVE.
javafx.beans.property.ReadOnlyObjectProperty<MediaRecorder.Status>	status	Recorder status hold the internal state for this recorder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MediaRecorder.Status	Media recorder status.

Method Summary

Modifier and Type	Method	Description
static MediaRecorder	create(javafx.stage.Stage stage)	Creates a media recorder.
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.
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.
MediaRecorderException	getError()	Retrieve the value of the error property or null if there is no error.
MediaSource	getMediaSource()	Retrieves the current media source.
javafx.event.EventHandler<MediaRecorderEvent>	getOnDataAvailable()	Retrieves the event handler when the recording has started and media data is delivered to the application.
javafx.event.EventHandler<MediaRecorderEvent>	getOnError()	Retrieves the event handler for errors.
javafx.event.EventHandler<MediaRecorderEvent>	getOnPaused()	Retrieves the event handler when the recording has paused and status is set to MediaRecorder.Status.PAUSED.
javafx.event.EventHandler<MediaRecorderEvent>	getOnReady()	Retrieves the MediaRecorder.Status.READY event handler.
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.
javafx.event.EventHandler<MediaRecorderEvent>	getOnStart()	Retrieves the event handler when the recording has started and status is set to MediaRecorder.Status.RECORDING.
javafx.event.EventHandler<MediaRecorderEvent>	getOnStopped()	Retrieves the event handler when recording is stopped and status changes to MediaRecorder.Status.INACTIVE.
MediaRecorder.Status	getStatus()	Retrieves the current recorder status.
javafx.beans.property.ReadOnlyObjectProperty<MediaSource>	mediaSourceProperty()	The current media source for this recorder.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onDataAvailableProperty()	Event handler invoked when this recorder delivers media data to the application for its use.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onErrorProperty()	Event handler invoked when an error occurs.
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.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onReadyProperty()	Event handler invoked when the status changes to READY.
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.
javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaRecorderEvent>>	onStartProperty()	Event handler invoked when the recording started.
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.
void	setOnDataAvailable(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when the recording has started and media data is delivered to the application.
void	setOnError(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler to be called when an error occurs.
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.
void	setOnReady(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the MediaRecorder.Status.READY event handler.
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.
void	setOnStart(javafx.event.EventHandler<MediaRecorderEvent> value)	Sets the event handler when the recording has started and status is set to MediaRecorder.Status.RECORDING.
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.
javafx.beans.property.ReadOnlyObjectProperty<MediaRecorder.Status>	statusProperty()	Recorder status hold the internal state for this recorder.
void	stop()	Stops the recording of media.

Methods inherited from interface javafx.event.EventTarget

buildEventDispatchChain

Property Details

mediaSource

javafx.beans.property.ReadOnlyObjectProperty<MediaSource> mediaSourceProperty

The current media source for this recorder.

See Also:

• getMediaSource()
• mediaSourceProperty()

status

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

Recorder status hold the internal state for this recorder.

See Also:

• getStatus()
• statusProperty()

duration

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

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

See Also:

• getDuration()
• durationProperty()

onReady

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

Event handler invoked when the status changes to READY.

See Also:

• getOnReady()
• setOnReady(EventHandler)
• onReadyProperty()

onDataAvailable

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

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

See Also:

• getOnDataAvailable()
• setOnDataAvailable(EventHandler)
• onDataAvailableProperty()

onStart

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

Event handler invoked when the recording started.

See Also:

• getOnStart()
• setOnStart(EventHandler)
• onStartProperty()

onPaused

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.

See Also:

• getOnPaused()
• setOnPaused(EventHandler)
• onPausedProperty()

onResume

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.

See Also:

• getOnResume()
• setOnResume(EventHandler)
• onResumeProperty()

onStopped

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

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

See Also:

• getOnStopped()
• setOnStopped(EventHandler)
• onStoppedProperty()

onError

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

Event handler invoked when an error occurs.

See Also:

• getOnError()
• setOnError(EventHandler)
• onErrorProperty()

error

javafx.beans.property.ReadOnlyObjectProperty<MediaRecorderException> errorProperty

Observable property set to a MediaRecorderException if an error occurs.

See Also:

• getError()
• errorProperty()

Method Details

create

static MediaRecorder create(javafx.stage.Stage stage)

Creates a media recorder. If the application is running in a browser via JPro server, then a web version of MediaRecorder is returned. If the application is not running inside the browser than a desktop/mobile version of the media recorder is returned.

Parameters:

stage - the application stage

Returns:

a MediaRecorder object.

getMediaSource

MediaSource getMediaSource()

Retrieves the current media source.

Returns:

MediaSource object

mediaSourceProperty

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

The current media source for this recorder.

Returns:

the mediaSource property

See Also:

• getMediaSource()

getStatus

MediaRecorder.Status getStatus()

Retrieves the current recorder status.

Returns:

the recorder status

statusProperty

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

Recorder status hold the internal state for this recorder.

Returns:

the status property

See Also:

• getStatus()

getDuration

javafx.util.Duration getDuration()

Gets the current duration for the recording since it started.

durationProperty

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

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

Returns:

the duration of the media

See Also:

• getDuration()

getOnReady

javafx.event.EventHandler<MediaRecorderEvent> getOnReady()

Retrieves the MediaRecorder.Status.READY event handler.

Returns:

the event handler or null.

setOnReady

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

Sets the MediaRecorder.Status.READY event handler.

Parameters:

value - the event handler or null.

onReadyProperty

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

Event handler invoked when the status changes to READY.

Returns:

the onReady property

See Also:

• getOnReady()
• setOnReady(EventHandler)

getOnDataAvailable

javafx.event.EventHandler<MediaRecorderEvent> getOnDataAvailable()

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

Returns:

the event handler or null.

setOnDataAvailable

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

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

Parameters:

value - the event handler or null.

onDataAvailableProperty

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

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

Returns:

the onDataAvailable property

See Also:

• getOnDataAvailable()
• setOnDataAvailable(EventHandler)

getOnStart

javafx.event.EventHandler<MediaRecorderEvent> getOnStart()

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

Returns:

the event handler or null.

setOnStart

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

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

Parameters:

value - the event handler or null.

onStartProperty

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

Event handler invoked when the recording started.

Returns:

the onStart property

See Also:

• getOnStart()
• setOnStart(EventHandler)

getOnPaused

javafx.event.EventHandler<MediaRecorderEvent> getOnPaused()

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

Returns:

the event handler or null.

setOnPaused

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.

Parameters:

value - the event handler or null.

onPausedProperty

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.

Returns:

the onPaused property

See Also:

• getOnPaused()
• setOnPaused(EventHandler)

getOnResume

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.

Returns:

the event handler or null.

setOnResume

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.

Parameters:

value - the event handler or null.

onResumeProperty

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.

Returns:

the onResume property

See Also:

• getOnResume()
• setOnResume(EventHandler)

getOnStopped

javafx.event.EventHandler<MediaRecorderEvent> getOnStopped()

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

Returns:

the event handler or null.

setOnStopped

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

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

Parameters:

value - the event handler or null.

onStoppedProperty

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

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

Returns:

the onStopped property

See Also:

• getOnStopped()
• setOnStopped(EventHandler)

getOnError

javafx.event.EventHandler<MediaRecorderEvent> getOnError()

Retrieves the event handler for errors.

Returns:

the event handler.

setOnError

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

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

Parameters:

value - the event handler or null.

onErrorProperty

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

Event handler invoked when an error occurs.

Returns:

the onError property

See Also:

• getOnError()
• setOnError(EventHandler)

getError

MediaRecorderException getError()

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

Returns:

a MediaRecorderException or null.

errorProperty

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

Observable property set to a MediaRecorderException if an error occurs.

Returns:

the error property

See Also:

• getError()

enable

void enable()

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.

start

void start()

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

pause

void pause()

Pauses the recording of media.

stop

void stop()

Stops the recording of media.