org.gstreamer
Enum Format

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

public enum Format
extends java.lang.Enum<Format>
implements IntegerEnum

Standard predefined formats.


Enum Constant Summary
__UNKNOWN_NATIVE_VALUE
          The default enum value used when no other value matches the native value
BUFFERS
          Buffers
BYTES
          bytes
DEFAULT
          The default format of the pad/element.
PERCENT
          Percentage of stream
TIME
          Time in nanoseconds
UNDEFINED
          Undefined format
 
Field Summary
 int value
           
 
Method Summary
 int intValue()
          Gets the integer value of the enum.
static Format valueOf(int format)
          Returns the enum constant of this type with the specified integer value.
static Format valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Format[] 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

UNDEFINED

public static final Format UNDEFINED
Undefined format


DEFAULT

public static final Format DEFAULT
The default format of the pad/element. This can be samples for raw audio, frames/fields for raw video.


BYTES

public static final Format BYTES
bytes


TIME

public static final Format TIME
Time in nanoseconds


BUFFERS

public static final Format BUFFERS
Buffers


PERCENT

public static final Format PERCENT
Percentage of stream


__UNKNOWN_NATIVE_VALUE

public static final Format __UNKNOWN_NATIVE_VALUE
The default enum value used when no other value matches the native value

Field Detail

value

public final int value
Method Detail

values

public static Format[] 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 (Format c : Format.values())
    System.out.println(c);

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

valueOf

public static Format 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

intValue

public final int intValue()
Gets the integer value of the enum.

Specified by:
intValue in interface IntegerEnum
Returns:
The integer value for this enum.

valueOf

public static final Format valueOf(int format)
Returns the enum constant of this type with the specified integer value.

Parameters:
format - integer value.
Returns:
Enum constant.