org.gstreamer
Enum MessageType

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

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

The different message types that are available.


Enum Constant Summary
ANY
           
APPLICATION
          Message posted by the application, possibly via an application-specific element.
ASYNC_DONE
          Posted by elements when they complete an ASYNC state change.
ASYNC_START
          Posted by elements when they start an ASYNC state change.
BUFFERING
          The pipeline is buffering.
CLOCK_LOST
          The current clock as selected by the pipeline became unusable.
CLOCK_PROVIDE
          an element notifies its capability of providing a clock.
DURATION
          The duration of a pipeline changed.
ELEMENT
          Element specific message, see the specific element's documentation
EOS
          end-of-stream reached in a pipeline.
ERROR
          An error occured.
INFO
          An info message occured.
LATENCY
          Posted by elements when their latency changes.
NEW_CLOCK
          A new clock was selected in the pipeline.
QOS
          A buffer was dropped or an element changed its processing strategy for Quality of Service reasons.
REQUEST_STATE
          Posted by elements when they want the pipeline to change state.
SEGMENT_DONE
          Pipeline completed playback of a segment.
SEGMENT_START
          Pipeline started playback of a segment.
STATE_CHANGED
          A state change happened
STATE_DIRTY
          an element changed state in a streaming thread.
STEP_DONE
          a framestep finished.
STEP_START
          A stepping operation was started.
STREAM_STATUS
          Status about a stream, emitted when it starts, stops, errors, etc..
STRUCTURE_CHANGE
          The structure of the pipeline changed.
TAG
          A tag was found.
UNKNOWN
          An undefined message
WARNING
          A warning occured.
 
Method Summary
static MessageType forName(java.lang.String name)
          Gets a MessageType that corresponds to the name
 java.lang.String getName()
          Gets the name of this message type.
 int intValue()
          Gets the native integer value for this type.
static MessageType valueOf(int type)
          Gets a MessageType that corresponds to the native integer value.
static MessageType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MessageType[] 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 MessageType UNKNOWN
An undefined message


EOS

public static final MessageType EOS
end-of-stream reached in a pipeline. The application will only receive this message in the PLAYING state and every time it sets a pipeline to PLAYING that is in the EOS state. The application can perform a flushing seek in the pipeline, which will undo the EOS state again.


ERROR

public static final MessageType ERROR
An error occured. Whe the application receives an error message it should stop playback of the pipeline and not assume that more data will be played.


WARNING

public static final MessageType WARNING
A warning occured.


INFO

public static final MessageType INFO
An info message occured.


TAG

public static final MessageType TAG
A tag was found.


BUFFERING

public static final MessageType BUFFERING
The pipeline is buffering. When the application receives a buffering message in the PLAYING state for a non-live pipeline it must PAUSE the pipeline until the buffering completes, when the percentage field in the message is 100%. For live pipelines, no action must be performed and the buffering percentage can be used to inform the user about the progress.


STATE_CHANGED

public static final MessageType STATE_CHANGED
A state change happened


STATE_DIRTY

public static final MessageType STATE_DIRTY
an element changed state in a streaming thread. This message is deprecated.


STEP_DONE

public static final MessageType STEP_DONE
a framestep finished. This message is not yet implemented.


CLOCK_PROVIDE

public static final MessageType CLOCK_PROVIDE
an element notifies its capability of providing a clock. This message is used internally and never forwarded to the application.


CLOCK_LOST

public static final MessageType CLOCK_LOST
The current clock as selected by the pipeline became unusable. The pipeline will select a new clock on the next PLAYING state change.


NEW_CLOCK

public static final MessageType NEW_CLOCK
A new clock was selected in the pipeline.


STRUCTURE_CHANGE

public static final MessageType STRUCTURE_CHANGE
The structure of the pipeline changed. Not implemented yet.


STREAM_STATUS

public static final MessageType STREAM_STATUS
Status about a stream, emitted when it starts, stops, errors, etc.. Not implemented yet.


APPLICATION

public static final MessageType APPLICATION
Message posted by the application, possibly via an application-specific element.


ELEMENT

public static final MessageType ELEMENT
Element specific message, see the specific element's documentation


SEGMENT_START

public static final MessageType SEGMENT_START
Pipeline started playback of a segment. This message is used internally and never forwarded to the application.


SEGMENT_DONE

public static final MessageType SEGMENT_DONE
Pipeline completed playback of a segment. This message is forwarded to the application after all elements that posted SEGMENT_START have posted a SEGMENT_DONE message.


DURATION

public static final MessageType DURATION
The duration of a pipeline changed. The application can get the new duration with a duration query.


LATENCY

public static final MessageType LATENCY
Posted by elements when their latency changes. The pipeline will calculate and distribute a new latency. Since: 0.10.12


ASYNC_START

public static final MessageType ASYNC_START
Posted by elements when they start an ASYNC state change. This message is not forwarded to the application but is used internally. Since: 0.10.13.


ASYNC_DONE

public static final MessageType ASYNC_DONE
Posted by elements when they complete an ASYNC state change. The application will only receive this message from the toplevel pipeline. Since: 0.10.13


REQUEST_STATE

public static final MessageType REQUEST_STATE
Posted by elements when they want the pipeline to change state. This message is a suggestion to the application which can decide to perform the state change on (part of) the pipeline. Since: 0.10.23.


STEP_START

public static final MessageType STEP_START
A stepping operation was started.


QOS

public static final MessageType QOS
A buffer was dropped or an element changed its processing strategy for Quality of Service reasons.


ANY

public static final MessageType ANY
Method Detail

values

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

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

valueOf

public static MessageType 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 integer value for this type.

Specified by:
intValue in interface IntegerEnum
Returns:
the native gstreamer value.

getName

public java.lang.String getName()
Gets the name of this message type.

Returns:
the name of the message type.

valueOf

public static final MessageType valueOf(int type)
Gets a MessageType that corresponds to the native integer value.

Parameters:
type - the native value of the type.
Returns:
a MessageType.

forName

public static final MessageType forName(java.lang.String name)
Gets a MessageType that corresponds to the name

Parameters:
name - the gstreamer name of the type.
Returns:
a MessageType.