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 and Description
static class	RecordingProperties.Builder Builder for RecordingProperties

Method Summary

Modifier and Type	Method and 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
boolean	hasAudio() Defines whether to record audio or not.
boolean	hasVideo() Defines whether to record video or not.
String	name() Defines the name you want to give to the video file.
Recording.OutputMode	outputMode() Defines the mode of recording: Recording.OutputMode.COMPOSED for a single archive in a grid layout or Recording.OutputMode.INDIVIDUAL for one archive for each stream. Default to Recording.OutputMode.COMPOSED
RecordingLayout	recordingLayout() Defines the layout to be used in the recording. Will only have effect if RecordingProperties.Builder.outputMode(Recording.OutputMode) has been called with value Recording.OutputMode.COMPOSED. Default to RecordingLayout.BEST_FIT
String	resolution() Defines the resolution of the recorded video. Will only have effect if RecordingProperties.Builder.outputMode(Recording.OutputMode) has been called with value Recording.OutputMode.COMPOSED.

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. You can access this same value in your clients on recording events (recordingStarted, recordingStopped)

outputMode

public Recording.OutputMode outputMode()

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

Default to Recording.OutputMode.COMPOSED

recordingLayout

public RecordingLayout recordingLayout()

Defines the layout to be used in the recording.
Will only have effect if RecordingProperties.Builder.outputMode(Recording.OutputMode) has been called with value Recording.OutputMode.COMPOSED.

Default to RecordingLayout.BEST_FIT

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

resolution

public String resolution()

Defines the resolution of the recorded video.
Will only have effect if RecordingProperties.Builder.outputMode(Recording.OutputMode) has been called with value Recording.OutputMode.COMPOSED. For Recording.OutputMode.INDIVIDUAL all individual video files will have the native resolution of the published stream.

Default to "1920x1080"

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