Package edu.wpi.first.cscore

Enum Class VideoSource.ConnectionStrategy

java.lang.Object

java.lang.Enum<VideoSource.ConnectionStrategy>

edu.wpi.first.cscore.VideoSource.ConnectionStrategy

All Implemented Interfaces:

Serializable, Comparable<VideoSource.ConnectionStrategy>, Constable

Enclosing class:

VideoSource

public static enum VideoSource.ConnectionStrategy
extends Enum<VideoSource.ConnectionStrategy>

Connection strategy.

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
kAutoManage	Automatically connect or disconnect based on whether any sinks are connected to this source.
kForceClose	Never open the connection.
kKeepOpen	Try to keep the connection open regardless of whether any sinks are connected.

Method Summary

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

kAutoManage

public static final VideoSource.ConnectionStrategy kAutoManage

Automatically connect or disconnect based on whether any sinks are connected to this source. This is the default behavior.

kKeepOpen

public static final VideoSource.ConnectionStrategy kKeepOpen

Try to keep the connection open regardless of whether any sinks are connected.

kForceClose

public static final VideoSource.ConnectionStrategy kForceClose

Never open the connection. If this is set when the connection is open, close the connection.

Method Details

values

public static VideoSource.ConnectionStrategy[] 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 VideoSource.ConnectionStrategy 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

getValue

public int getValue()

Returns the ConnectionStrategy value.

Returns:

The ConnectionStrategy value.