io.openvidu.java.client

Enum RecordingLayout

java.lang.Object

java.lang.Enum<RecordingLayout>

io.openvidu.java.client.RecordingLayout

All Implemented Interfaces:

Serializable, Comparable<RecordingLayout>

public enum RecordingLayout
extends Enum<RecordingLayout>

See SessionProperties.Builder.defaultRecordingLayout(RecordingLayout) and RecordingProperties.Builder.recordingLayout(RecordingLayout)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEST_FIT All the videos are evenly distributed, taking up as much space as possible
CUSTOM Use your own custom recording layout.
HORIZONTAL_PRESENTATION (not available yet)
PICTURE_IN_PICTURE (not available yet)
VERTICAL_PRESENTATION (not available yet)

Method Summary

Modifier and Type	Method and Description
static RecordingLayout	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordingLayout[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BEST_FIT

public static final RecordingLayout BEST_FIT

All the videos are evenly distributed, taking up as much space as possible

PICTURE_IN_PICTURE

public static final RecordingLayout PICTURE_IN_PICTURE

(not available yet)

VERTICAL_PRESENTATION

public static final RecordingLayout VERTICAL_PRESENTATION

(not available yet)

HORIZONTAL_PRESENTATION

public static final RecordingLayout HORIZONTAL_PRESENTATION

(not available yet)

CUSTOM

public static final RecordingLayout CUSTOM

Use your own custom recording layout. See Custom recording layouts to learn more

Method Detail

values

public static RecordingLayout[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RecordingLayout c : RecordingLayout.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RecordingLayout valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null