java.lang.Enum<BaseVideoCapturer.VideoContentHint>
com.opentok.android.BaseVideoCapturer.VideoContentHint
All Implemented Interfaces:
: Serializable, Comparable<BaseVideoCapturer.VideoContentHint>, Constable
Enclosing class:
: BaseVideoCapturer
public static enum BaseVideoCapturer.VideoContentHint extends 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()
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
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
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
int
getValue()
static BaseVideoCapturer.VideoContentHint
valueOf(int hintValue)
Returns the enum constant of this class with the specified name.
static BaseVideoCapturer.VideoContentHint
valueOf(String name)
Returns the enum constant of this class with the specified name.
static BaseVideoCapturer.VideoContentHint[]
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
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 setting for a stream that contains text content.
Method Details
values
public static BaseVideoCapturer.VideoContentHint[] 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 BaseVideoCapturer.VideoContentHint 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
valueOf
public static BaseVideoCapturer.VideoContentHint valueOf(int hintValue)
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:
: hintValue - 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
getValue
public int getValue()