Package io.openvidu.java.client

Class RecordingProperties

java.lang.Object

io.openvidu.java.client.RecordingProperties

public class RecordingProperties
extends Object

See OpenVidu.startRecording(String, RecordingProperties)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecordingProperties.Builder	Builder for RecordingProperties
static class	RecordingProperties.DefaultValues

Method Summary

Modifier and Type	Method	Description
String	customLayout()	If recordingLayout() is set to RecordingLayout.CUSTOM, this property defines the relative path to the specific custom layout you want to use. See Custom recording layouts to learn more
Integer	frameRate()	Defines the frame rate of the recorded video. Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true.
Boolean	hasAudio()	Defines whether to record audio or not.
Boolean	hasVideo()	Defines whether to record video or not.
Boolean	ignoreFailedStreams()	Defines whether to ignore failed streams or not when starting the recording.
String	mediaNode()	PRO The Media Node where to host the recording.
String	name()	Defines the name you want to give to the video file
Recording.OutputMode	outputMode()	Defines the mode of recording: Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START for a single archive in a grid layout or Recording.OutputMode.INDIVIDUAL for one archive for each stream. Default to OutputMode.COMPOSED
RecordingLayout	recordingLayout()	Defines the layout to be used in the recording. Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true.
String	resolution()	Defines the resolution of the recorded video. Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true.
Long	shmSize()	The amount of shared memory reserved for the recording process in bytes.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Defines the name you want to give to the video file

hasAudio

public Boolean hasAudio()

Defines whether to record audio or not. Cannot be set to false at the same time as hasVideo().

Default to true

hasVideo

public Boolean hasVideo()

Defines whether to record video or not. Cannot be set to false at the same time as hasAudio().

Default to true

outputMode

public Recording.OutputMode outputMode()

Defines the mode of recording: Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START for a single archive in a grid layout or Recording.OutputMode.INDIVIDUAL for one archive for each stream.

Default to OutputMode.COMPOSED

recordingLayout

public RecordingLayout recordingLayout()

Defines the layout to be used in the recording.
Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true. Property ignored for INDIVIDUAL recordings and audio-only recordings

Default to RecordingLayout.BEST_FIT

resolution

public String resolution()

Defines the resolution of the recorded video.
Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true. Property ignored for INDIVIDUAL recordings and audio-only recordings. For Recording.OutputMode.INDIVIDUAL all individual video files will have the native resolution of the published stream.

Default to "1280x720"

frameRate

public Integer frameRate()

Defines the frame rate of the recorded video.
Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true. Property ignored for INDIVIDUAL recordings and audio-only recordings. For Recording.OutputMode.INDIVIDUAL all individual video files will have the native frame rate of the published stream.

Default to 25

shmSize

public Long shmSize()

The amount of shared memory reserved for the recording process in bytes. Minimum 134217728 (128MB).
Will only have effect for Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START recordings with hasVideo() to true. Property ignored for INDIVIDUAL recordings and audio-only recordings

Default to 536870912 (512 MB)

customLayout

public String customLayout()

If recordingLayout() is set to RecordingLayout.CUSTOM, this property defines the relative path to the specific custom layout you want to use.
See Custom recording layouts to learn more

ignoreFailedStreams

public Boolean ignoreFailedStreams()

Defines whether to ignore failed streams or not when starting the recording. This property only applies to Recording.OutputMode.INDIVIDUAL recordings. For this type of recordings, when calling OpenVidu.startRecording(String, RecordingProperties) by default all the streams available at the moment the recording process starts must be healthy and properly sending media. If some stream that should be sending media is broken, then the recording process fails after a 10s timeout. In this way your application is notified that some stream is not being recorded, so it can retry the process again. But you can disable this rollback behavior and simply ignore any failed stream, which will be susceptible to be recorded in the future if media starts flowing as expected at any point. The downside of this behavior is that you will have no guarantee that all streams present at the beginning of a recording are actually being recorded.

Default to false

mediaNode

public String mediaNode()

PRO The Media Node where to host the recording. The default option if this property is not defined is the same Media Node hosting the Session to record. This property only applies to COMPOSED or COMPOSED_QUICK_START recordings with hasVideo() to true and is ignored for INDIVIDUAL recordings and audio-only recordings