org.freedesktop.gstreamer

Enum Format

java.lang.Object

java.lang.Enum<Format>

org.freedesktop.gstreamer.Format

All Implemented Interfaces:

Serializable, Comparable<Format>, NativeEnum<Format>

public enum Format
extends Enum<Format>
implements NativeEnum<Format>

Standard predefined formats.

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/gstreamer-GstFormat.html#GstFormat

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUFFERS Buffers (few, if any, elements implement this as of May 2009)
BYTES Bytes
DEFAULT The default format of the pad/element.
PERCENT Percentage of stream (few, if any, elements implement this as of May 2009)
TIME Time in nanoseconds
UNDEFINED Undefined format

Method Summary

Modifier and Type	Method and Description
int	intValue()
static Format	valueOf(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

Methods inherited from interface org.freedesktop.gstreamer.glib.NativeEnum

fromInt, fromInt

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 (some, but not all, elements support this; use TIME if you don't have a good reason to query for samples/frames)

BYTES

public static final Format BYTES

Bytes

TIME

public static final Format TIME

Time in nanoseconds

BUFFERS

public static final Format BUFFERS

Buffers (few, if any, elements implement this as of May 2009)

PERCENT

public static final Format PERCENT

Percentage of stream (few, if any, elements implement this as of May 2009)

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

intValue

public int intValue()

Specified by:

intValue in interface NativeEnum<Format>