Package com.twilio.video

Enum Class ClientTrackSwitchOffControl

java.lang.Object

java.lang.Enum<ClientTrackSwitchOffControl>

com.twilio.video.ClientTrackSwitchOffControl

All Implemented Interfaces:

Serializable, Comparable<ClientTrackSwitchOffControl>, Constable

public enum ClientTrackSwitchOffControl
extends Enum<ClientTrackSwitchOffControl>

Configures the mode for switching off/on subscribed RemoteVideoTracks based on the subscriber's rendering environment. Switching off a RemoteVideoTrack means no media is sent by the media server to the client for that track even though it has been subscribed to by the client. This feature helps in conserving network bandwidth and CPU resources by avoiding unnecessary transmission and decoding of remote tracks. This feature supersedes the `maxTracks` parameter. Attempting to set `clientTrackSwitchOffControl` when `maxTracks` is already set will throw an exception.

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
AUTO	In this mode, the SDK determines whether RemoteVideoTracks should be switched off based on VideoSink attachment and View visibility.
MANUAL	In this mode, the application requests that specific RemoteVideoTracks be switched off or on using the RemoteVideoTrack.switchOff()/RemoteVideoTrack.switchOn() methods on the RemoteVideoTrack.

Method Summary

Modifier and Type	Method	Description
static ClientTrackSwitchOffControl	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ClientTrackSwitchOffControl[]	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

AUTO

public static final ClientTrackSwitchOffControl AUTO

In this mode, the SDK determines whether RemoteVideoTracks should be switched off based on VideoSink attachment and View visibility. Only VideoTextureViews and VideoViews are supported. If a custom VideoSinks is added to the RemoteVideoTrack, then this mode will be disabled and the track will remain switched on until the sink is removed from the track.

MANUAL

public static final ClientTrackSwitchOffControl MANUAL

In this mode, the application requests that specific RemoteVideoTracks be switched off or on using the RemoteVideoTrack.switchOff()/RemoteVideoTrack.switchOn() methods on the RemoteVideoTrack.

Method Details

values

public static ClientTrackSwitchOffControl[] 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 ClientTrackSwitchOffControl 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