Package com.opentok.android

Enum BaseVideoCapturer.VideoContentHint

java.lang.Object

java.lang.Enum<BaseVideoCapturer.VideoContentHint>

com.opentok.android.BaseVideoCapturer.VideoContentHint

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseVideoCapturer.VideoContentHint>

Enclosing class:

BaseVideoCapturer

public static enum BaseVideoCapturer.VideoContentHint
extends java.lang.Enum<BaseVideoCapturer.VideoContentHint>

Defines the content hint settings for a video capturer.

You can read more about these options in the W3C Working Draft.

See Also:

BaseVideoCapturer.setVideoContentHint(VideoContentHint contentHint), BaseVideoCapturer.getVideoContentHint()

Enum Constant Summary

Enum Constants

Enum Constant	Description
DETAIL	The track should be treated as if video details are extra important.
MOTION	The track should be treated as if it contains video where motion is important.
NONE	No hint is provided (the default).
TEXT	The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently.

Method Summary

Modifier and Type	Method	Description
int	getValue()
static BaseVideoCapturer.VideoContentHint	valueOf(int hintValue)	Returns the enum constant of this type with the specified name.
static BaseVideoCapturer.VideoContentHint	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static BaseVideoCapturer.VideoContentHint[]	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

NONE

public static final BaseVideoCapturer.VideoContentHint NONE

No hint is provided (the default).

MOTION

public static final BaseVideoCapturer.VideoContentHint MOTION

The track should be treated as if it contains video where motion is important.

DETAIL

public static final BaseVideoCapturer.VideoContentHint DETAIL

The track should be treated as if video details are extra important. For example, you may use this setting for a stream that contains text content, painting, or line art.

TEXT

public static final BaseVideoCapturer.VideoContentHint TEXT

The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently. For example, you may use this settting for a stream that contains text content.

Method Detail

values

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

Returns:

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

valueOf

public static BaseVideoCapturer.VideoContentHint 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

valueOf

public static BaseVideoCapturer.VideoContentHint valueOf(int hintValue)

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:

hintValue - 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

getValue

public int getValue()