java.lang.Enum<PublisherKit.DegradationPreference>
com.opentok.android.PublisherKit.DegradationPreference
All Implemented Interfaces:
: Serializable, Comparable<PublisherKit.DegradationPreference>, Constable
Enclosing class:
: PublisherKit
public static enum PublisherKit.DegradationPreference extends Enum<PublisherKit.DegradationPreference>
Describes the policy that the video engine will try to follow when adapting frame rate and resolution to limited bandwidth and CPU. This is a best effort policy. There are no guarantees on the frame rate and some frames can still be skipped for other reasons. For details, see Degradation Preference.
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
DegradationPreferenceBalanced
The video engine will try to reach a balance between reducing resolution and frame rate when necessary.
DegradationPreferenceMaintainFrameRate
The video engine will try to keep the frame rate steady but might reduce resolution if necessary.
DegradationPreferenceMaintainFrameRateAndResolution
The video engine will not reduce the resolution and will try to keep the frame rate steady.
DegradationPreferenceMaintainResolution
The video engine will not reduce the resolution but might reduce the frame rate if necessary.
DegradationPreferenceNotSet
Default value.
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
int
get()
static PublisherKit.DegradationPreference
valueOf(String name)
Returns the enum constant of this class with the specified name.
static PublisherKit.DegradationPreference[]
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
DegradationPreferenceNotSet
public static final PublisherKit.DegradationPreference DegradationPreferenceNotSet
Default value. The video engine will decide the optimal degradation preference.
DegradationPreferenceMaintainFrameRateAndResolution
public static final PublisherKit.DegradationPreference DegradationPreferenceMaintainFrameRateAndResolution
The video engine will not reduce the resolution and will try to keep the frame rate steady. In some versions of the standard this option is referred to as "DISABLED", meaning that no degradation will be applied at all when under limited resources.
DegradationPreferenceMaintainFrameRate
public static final PublisherKit.DegradationPreference DegradationPreferenceMaintainFrameRate
The video engine will try to keep the frame rate steady but might reduce resolution if necessary.
DegradationPreferenceMaintainResolution
public static final PublisherKit.DegradationPreference DegradationPreferenceMaintainResolution
The video engine will not reduce the resolution but might reduce the frame rate if necessary.
DegradationPreferenceBalanced
public static final PublisherKit.DegradationPreference DegradationPreferenceBalanced
The video engine will try to reach a balance between reducing resolution and frame rate when necessary.
Method Details
values
public static PublisherKit.DegradationPreference[] 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 PublisherKit.DegradationPreference 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
get
public int get()