java.lang.Object

java.lang.Enum<ScreenShareLayoutType>

com.opentok.ScreenShareLayoutType

All Implemented Interfaces: : Serializable, Comparable<ScreenShareLayoutType>, Constable


public enum ScreenShareLayoutType extends Enum<ScreenShareLayoutType>

Enumerates type values for the layout.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant

Description

BESTFIT

Represents the picture-in-picture (pip) layout type.

HORIZONTAL

Represents the horizontal presentation layout type.

PIP

Represents the picture-in-picture (pip) layout type.

VERTICAL

Represents the vertical presentation layout type.

Method Summary

All MethodsStatic MethodsInstance MethodsConcrete Methods

Modifier and Type

Method

Description

String

toString()

static ScreenShareLayoutType

valueOf(String name)

Returns the enum constant of this class with the specified name.

static ScreenShareLayoutType[]

values()

Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PIP

public static final ScreenShareLayoutType PIP

Represents the picture-in-picture (pip) layout type.

BESTFIT

public static final ScreenShareLayoutType BESTFIT

Represents the picture-in-picture (pip) layout type.

VERTICAL

public static final ScreenShareLayoutType VERTICAL

Represents the vertical presentation layout type.

HORIZONTAL

public static final ScreenShareLayoutType HORIZONTAL

Represents the horizontal presentation layout type.

Method Details

values

public static ScreenShareLayoutType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns: : an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScreenShareLayoutType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name : NullPointerException - if the argument is null

toString

public String toString()

Overrides: : toString in class Enum<ScreenShareLayoutType>