org.gstreamer
Enum EventType

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

public enum EventType
extends java.lang.Enum<EventType>
implements org.gstreamer.lowlevel.IntegerEnum

The standard event types that can be sent in a pipeline.

The custom event types can be used for private messages between elements that can't be expressed using normal GStreamer buffer passing semantics.

Custom events carry an arbitrary Structure. Specific custom events are distinguished by the name of the structure.


Enum Constant Summary
BUFFERSIZE
          Notification of buffering requirements
CUSTOM_BOTH
          Custom upstream or downstream event.
CUSTOM_BOTH_OOB
          Custom upstream or downstream out-of-band event.
CUSTOM_DOWNSTREAM
          Downstream custom event that travels in the data flow.
CUSTOM_DOWNSTREAM_OOB
          Custom out-of-band downstream event.
CUSTOM_UPSTREAM
          Upstream custom event
EOS
          End-Of-Stream.
FLUSH_START
          Start a flush operation
FLUSH_STOP
          Stop a flush operation
LATENCY
          Notification of new latency adjustment
NAVIGATION
          Navigation events are usually used for communicating user requests, such as mouse or keyboard movements, to upstream elements.
NEWSEGMENT
          A new media segment follows in the dataflow
QOS
          A quality message.
SEEK
          A request for a new playback position and rate.
TAG
          A new set of metadata tags has been found in the stream
UNKNOWN
          Unknown event
 
Method Summary
 java.lang.String getName()
          Gets a human-readable name for this value
 int intValue()
          Gets the native value of this enum
static EventType valueOf(int type)
          Gets the Enum for a native value
static EventType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static EventType[] 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

UNKNOWN

public static final EventType UNKNOWN
Unknown event


FLUSH_START

public static final EventType FLUSH_START
Start a flush operation


FLUSH_STOP

public static final EventType FLUSH_STOP
Stop a flush operation


EOS

public static final EventType EOS
End-Of-Stream. No more data is to be expected to follow without a NEWSEGMENT event.


NEWSEGMENT

public static final EventType NEWSEGMENT
A new media segment follows in the dataflow


TAG

public static final EventType TAG
A new set of metadata tags has been found in the stream


BUFFERSIZE

public static final EventType BUFFERSIZE
Notification of buffering requirements


QOS

public static final EventType QOS
A quality message. Used to indicate to upstream elements that the downstream elements are being starved of or flooded with data.


SEEK

public static final EventType SEEK
A request for a new playback position and rate.


NAVIGATION

public static final EventType NAVIGATION
Navigation events are usually used for communicating user requests, such as mouse or keyboard movements, to upstream elements.


LATENCY

public static final EventType LATENCY
Notification of new latency adjustment


CUSTOM_UPSTREAM

public static final EventType CUSTOM_UPSTREAM
Upstream custom event


CUSTOM_DOWNSTREAM

public static final EventType CUSTOM_DOWNSTREAM
Downstream custom event that travels in the data flow.


CUSTOM_DOWNSTREAM_OOB

public static final EventType CUSTOM_DOWNSTREAM_OOB
Custom out-of-band downstream event.


CUSTOM_BOTH

public static final EventType CUSTOM_BOTH
Custom upstream or downstream event. In-band when travelling downstream.


CUSTOM_BOTH_OOB

public static final EventType CUSTOM_BOTH_OOB
Custom upstream or downstream out-of-band event.

Method Detail

values

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

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

valueOf

public static EventType 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 int intValue()
Gets the native value of this enum

Specified by:
intValue in interface org.gstreamer.lowlevel.IntegerEnum

getName

public java.lang.String getName()
Gets a human-readable name for this value


valueOf

public static final EventType valueOf(int type)
Gets the Enum for a native value