org.gstreamer
Enum StateChangeReturn

java.lang.Object
  extended by java.lang.Enum<StateChangeReturn>
      extended by org.gstreamer.StateChangeReturn
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StateChangeReturn>

public enum StateChangeReturn
extends java.lang.Enum<StateChangeReturn>

The possible return values from a state change function.

Only FAILURE is a real failure.


Enum Constant Summary
ASYNC
          The state change will happen asynchronously.
FAILURE
          The state change failed.
NO_PREROLL
          The state change succeeded but the Element cannot produce data in State.PAUSED.
SUCCESS
          The state change succeeded.
 
Method Summary
static StateChangeReturn valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static StateChangeReturn[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FAILURE

public static final StateChangeReturn FAILURE
The state change failed.


SUCCESS

public static final StateChangeReturn SUCCESS
The state change succeeded.


ASYNC

public static final StateChangeReturn ASYNC
The state change will happen asynchronously.


NO_PREROLL

public static final StateChangeReturn NO_PREROLL
The state change succeeded but the Element cannot produce data in State.PAUSED. This typically happens with live sources.

Method Detail

values

public static StateChangeReturn[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (StateChangeReturn c : StateChangeReturn.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static StateChangeReturn valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null