Package com.opentok.android

Enum Publisher.CameraCaptureFrameRate

java.lang.Object

java.lang.Enum<Publisher.CameraCaptureFrameRate>

com.opentok.android.Publisher.CameraCaptureFrameRate

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Publisher.CameraCaptureFrameRate>

Enclosing class:

Publisher

public static enum Publisher.CameraCaptureFrameRate
extends java.lang.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.)

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

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static Publisher.CameraCaptureFrameRate[] 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 (Publisher.CameraCaptureFrameRate c : Publisher.CameraCaptureFrameRate.values())
    System.out.println(c);

Returns:

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

valueOf

public static Publisher.CameraCaptureFrameRate valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null