java.lang.Enum<Publisher.CameraCaptureFrameRate>
com.opentok.android.Publisher.CameraCaptureFrameRate
All Implemented Interfaces:
: Serializable, Comparable<Publisher.CameraCaptureFrameRate>, Constable
Enclosing class:
: Publisher
public static enum Publisher.CameraCaptureFrameRate extends Enum<Publisher.CameraCaptureFrameRate>
Defines values for the frameRate parameter of the
Publisher.Builder.frameRate(Publisher.CameraCaptureFrameRate frameRate) method.
Note that in sessions that use the OpenTok Media Router (sessions with the media mode set to routed), lowering the frame rate proportionally reduces the bandwidth the stream uses. However, in sessions that have the media mode set to relayed, lowering the frame rate does not reduce the stream's bandwidth. (See The OpenTok Media Router and media modes.)
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
FPS_1
1 frame per second.
FPS_15
15 frames per second.
FPS_30
30 frames per second.
FPS_7
7 frames per second.
Method Summary
All MethodsStatic MethodsConcrete Methods
Modifier and Type
Method
Description
static Publisher.CameraCaptureFrameRate
valueOf(String name)
Returns the enum constant of this class with the specified name.
static Publisher.CameraCaptureFrameRate[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
Enum Constant Details
FPS_30
public static final Publisher.CameraCaptureFrameRate FPS_30
30 frames per second.
FPS_15
public static final Publisher.CameraCaptureFrameRate FPS_15
15 frames per second.
FPS_7
public static final Publisher.CameraCaptureFrameRate FPS_7
7 frames per second.
FPS_1
public static final Publisher.CameraCaptureFrameRate FPS_1
1 frame per second.
Method Details
values
public static Publisher.CameraCaptureFrameRate[] 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 Publisher.CameraCaptureFrameRate 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