Package limn.video

Enum Class VideoStreamSource.Read

java.lang.Object

java.lang.Enum<VideoStreamSource.Read>

limn.video.VideoStreamSource.Read

All Implemented Interfaces:

Serializable, Comparable<VideoStreamSource.Read>, Constable

Enclosing interface:

VideoStreamSource

public static enum VideoStreamSource.Read
extends Enum<VideoStreamSource.Read>

The outcome of a VideoStreamSource.readFrame() call.

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
END	No more pictures will ever arrive.
FRAME	A new picture is ready in VideoStreamSource.frame() and is held by the caller until released.
PENDING	No picture right now, but more are coming; retry later, and never treat this as the end.

Method Summary

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

FRAME

public static final VideoStreamSource.Read FRAME

A new picture is ready in VideoStreamSource.frame() and is held by the caller until released.

PENDING

public static final VideoStreamSource.Read PENDING

No picture right now, but more are coming; retry later, and never treat this as the end. Two things produce it: a source that has not finished producing one, and a source all of whose pooled slots are currently held by the consumer. Both are answered the same way, by releasing what is held and asking again. It must be cheap and must not spin.

END

public static final VideoStreamSource.Read END

No more pictures will ever arrive. Calling again keeps returning this.

Method Details

values

public static VideoStreamSource.Read[] 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 VideoStreamSource.Read 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