io.openvidu.java.client

Class RecordingProperties.Builder

java.lang.Object

io.openvidu.java.client.RecordingProperties.Builder

Enclosing class:

RecordingProperties

public static class RecordingProperties.Builder
extends Object

Builder for RecordingProperties

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RecordingProperties	build() Builder for RecordingProperties
RecordingProperties.Builder	customLayout(String path) If setting recordingLayout(RecordingLayout) to RecordingLayout.CUSTOM you can call this method to set the relative path to the specific custom layout you want to use. Will only have effect if Builder.outputMode() has been called with value OutputMode.COMPOSED or OutputMode.COMPOSED_QUICK_START. See Custom recording layouts to learn more
RecordingProperties.Builder	hasAudio(boolean hasAudio) Call this method to specify whether to record audio or not.
RecordingProperties.Builder	hasVideo(boolean hasVideo) Call this method to specify whether to record video or not.
RecordingProperties.Builder	name(String name) Call this method to set the name of the video file.
RecordingProperties.Builder	outputMode(Recording.OutputMode outputMode) Call this method to set the mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream
RecordingProperties.Builder	recordingLayout(RecordingLayout layout) Call this method to set the layout to be used in the recording.
RecordingProperties.Builder	resolution(String resolution) Call this method to specify the recording resolution.
RecordingProperties.Builder	shmSize(long shmSize) If COMPOSED recording, call this method to specify 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

Constructor Detail

Builder

public Builder()

Method Detail

build

public RecordingProperties build()

Builder for RecordingProperties

name

public RecordingProperties.Builder name(String name)

Call this method to set the name of the video file. You can access this same value in your clients on recording events (recordingStarted, recordingStopped)

outputMode

public RecordingProperties.Builder outputMode(Recording.OutputMode outputMode)

Call this method to set the mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream

recordingLayout

public RecordingProperties.Builder recordingLayout(RecordingLayout layout)

Call this method to set the layout to be used in the recording. Will only have effect if outputMode(Recording.OutputMode) has been called with value Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START

customLayout

public RecordingProperties.Builder customLayout(String path)

If setting recordingLayout(RecordingLayout) to RecordingLayout.CUSTOM you can call this method to set the relative path to the specific custom layout you want to use.
Will only have effect if Builder.outputMode() has been called with value OutputMode.COMPOSED or OutputMode.COMPOSED_QUICK_START.
See Custom recording layouts to learn more

resolution

public RecordingProperties.Builder resolution(String resolution)

Call this method to specify the recording resolution. Must be a string with format "WIDTHxHEIGHT", being both WIDTH and HEIGHT the number of pixels between 100 and 1999.
Will only have effect if Builder.outputMode() has been called with value OutputMode.COMPOSED or OutputMode.COMPOSED_QUICK_START. For OutputMode.INDIVIDUAL all individual video files will have the native resolution of the published stream

hasAudio

public RecordingProperties.Builder hasAudio(boolean hasAudio)

Call this method to specify whether to record audio or not. Cannot be set to false at the same time as hasVideo(boolean)

hasVideo

public RecordingProperties.Builder hasVideo(boolean hasVideo)

Call this method to specify whether to record video or not. Cannot be set to false at the same time as hasAudio(boolean)

shmSize

public RecordingProperties.Builder shmSize(long shmSize)

If COMPOSED recording, call this method to specify the amount of shared memory reserved for the recording process in bytes. Minimum 134217728 (128 MB). Property ignored if INDIVIDUAL recording