Package org.freedesktop.gstreamer.gst

Enum Class MessageType

java.lang.Object

java.lang.Enum<MessageType>

org.freedesktop.gstreamer.gst.MessageType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MessageType>, Constable

@Generated("io.github.jwharm.JavaGI")
public enum MessageType
extends Enum<MessageType>
implements Enumeration

The different message types that are available.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	mask for all of the above messages.
APPLICATION	message posted by the application, possibly via an application-specific element.
ASYNC_DONE	Posted by elements when they complete an ASYNC GstStateChange.
ASYNC_START	Posted by elements when they start an ASYNC GstStateChange.
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.
DEVICE_ADDED	Message indicating a GstDevice was added to a GstDeviceProvider (Since: 1.4)
DEVICE_CHANGED	Message indicating a GstDevice was changed a GstDeviceProvider (Since: 1.16)
DEVICE_REMOVED	Message indicating a GstDevice was removed from a GstDeviceProvider (Since: 1.4)
DURATION_CHANGED	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 occurred.
EXTENDED	Message is an extended message type (see below).
HAVE_CONTEXT	Message indicating that an element created a context (Since: 1.2)
INFO	an info message occurred
INSTANT_RATE_REQUEST	Message sent by elements to request the running time from the pipeline when an instant rate change should be applied (which may be in the past when the answer arrives).
LATENCY	Posted by elements when their latency changes.
NEED_CONTEXT	Message indicating that an element wants a specific context (Since: 1.2)
NEW_CLOCK	a new clock was selected in the pipeline.
PROGRESS	A progress message.
PROPERTY_NOTIFY	Message indicating a GObject property has changed (Since: 1.10)
QOS	A buffer was dropped or an element changed its processing strategy for Quality of Service reasons.
REDIRECT	Message indicating to request the application to try to play the given URL(s).
REQUEST_STATE	Posted by elements when they want the pipeline to change state.
RESET_TIME	Message to request resetting the pipeline's running time from the pipeline.
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 stepping operation finished.
STEP_START	A stepping operation was started.
STREAM_COLLECTION	Message indicating a new GstStreamCollection is available (Since: 1.10)
STREAM_START	Message indicating start of a new stream.
STREAM_STATUS	status about a stream, emitted when it starts, stops, errors, etc..
STREAMS_SELECTED	Message indicating the active selection of GstStreams has changed (Since: 1.10)
STRUCTURE_CHANGE	the structure of the pipeline changed.
TAG	a tag was found.
TOC	A new table of contents (TOC) was found or previously found TOC was updated.
UNKNOWN	an undefined message
WARNING	a warning occurred.

Method Summary

Modifier and Type	Method	Description
String	getName()	Get a printable name for the given message type.
static Type	getType()	Get the GType of the MessageType class
int	getValue()	Get the numeric value of this enum
static MessageType	of(int value)	Create a new MessageType for the provided value
Quark	toQuark()	Get the unique quark for the given message type.
static MessageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 occurred. When the application receives an error message it should stop playback of the pipeline and not assume that more data will be played. It is possible to specify a redirection url to the error messages by setting a redirect-location field into the error message, application or high level bins might use the information as required.

WARNING

public static final MessageType WARNING

a warning occurred.

INFO

public static final MessageType INFO

an info message occurred

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 stepping operation finished.

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. The application should set the pipeline to PAUSED and back to PLAYING when this message is received.

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. This message is used internally and never forwarded to the application.

STREAM_STATUS

public static final MessageType STREAM_STATUS

status about a stream, emitted when it starts, stops, errors, etc..

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 GSTMESSAGESEGMENTSTART posted a GST_MESSAGE_SEGMENT_DONE message.

DURATION_CHANGED

public static final MessageType DURATION_CHANGED

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 application should recalculate and distribute a new latency.

ASYNC_START

public static final MessageType ASYNC_START

Posted by elements when they start an ASYNC GstStateChange. This message is not forwarded to the application but is used internally.

ASYNC_DONE

public static final MessageType ASYNC_DONE

Posted by elements when they complete an ASYNC GstStateChange. The application will only receive this message from the toplevel pipeline.

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.

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.

PROGRESS

public static final MessageType PROGRESS

A progress message.

TOC

public static final MessageType TOC

A new table of contents (TOC) was found or previously found TOC was updated.

RESET_TIME

public static final MessageType RESET_TIME

Message to request resetting the pipeline's running time from the pipeline. This is an internal message which applications will likely never receive.

STREAM_START

public static final MessageType STREAM_START

Message indicating start of a new stream. Useful e.g. when using playbin in gapless playback mode, to get notified when the next title actually starts playing (which will be some time after the URI for the next title has been set).

NEED_CONTEXT

public static final MessageType NEED_CONTEXT

Message indicating that an element wants a specific context (Since: 1.2)

HAVE_CONTEXT

public static final MessageType HAVE_CONTEXT

Message indicating that an element created a context (Since: 1.2)

EXTENDED

public static final MessageType EXTENDED

Message is an extended message type (see below). These extended message IDs can't be used directly with mask-based API like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still filter for GST_MESSAGE_EXTENDED and then check the result for the specific type. (Since: 1.4)

DEVICE_ADDED

public static final MessageType DEVICE_ADDED

Message indicating a GstDevice was added to a GstDeviceProvider (Since: 1.4)

DEVICE_REMOVED

public static final MessageType DEVICE_REMOVED

Message indicating a GstDevice was removed from a GstDeviceProvider (Since: 1.4)

PROPERTY_NOTIFY

public static final MessageType PROPERTY_NOTIFY

Message indicating a GObject property has changed (Since: 1.10)

STREAM_COLLECTION

public static final MessageType STREAM_COLLECTION

Message indicating a new GstStreamCollection is available (Since: 1.10)

STREAMS_SELECTED

public static final MessageType STREAMS_SELECTED

Message indicating the active selection of GstStreams has changed (Since: 1.10)

REDIRECT

public static final MessageType REDIRECT

Message indicating to request the application to try to play the given URL(s). Useful if for example a HTTP 302/303 response is received with a non-HTTP URL inside. (Since: 1.10)

DEVICE_CHANGED

public static final MessageType DEVICE_CHANGED

Message indicating a GstDevice was changed a GstDeviceProvider (Since: 1.16)

INSTANT_RATE_REQUEST

public static final MessageType INSTANT_RATE_REQUEST

Message sent by elements to request the running time from the pipeline when an instant rate change should be applied (which may be in the past when the answer arrives). (Since: 1.18)

ANY

public static final MessageType ANY

mask for all of the above messages.

Method Details

values

public static MessageType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MessageType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

of

public static MessageType of(int value)

Create a new MessageType for the provided value

Parameters:

value - the bitfield value

Returns:

the bitfield for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

getType

public static Type getType()

Get the GType of the MessageType class

Returns:

the GType

getName

public String getName()

Get a printable name for the given message type. Do not modify or free.

Returns:

a reference to the static name of the message.

toQuark

public Quark toQuark()

Get the unique quark for the given message type.

Returns:

the quark associated with the message type