Enum Class EventType

java.lang.Object
java.lang.Enum<EventType>
org.freedesktop.gstreamer.gst.EventType
All Implemented Interfaces:
Serializable, Comparable<EventType>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum EventType extends Enum<EventType> implements Enumeration

GstEventType lists 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 GstStructure. Specific custom events are distinguished by the name of the structure.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BUFFERSIZE
    Notification of buffering requirements.
    CAPS
    GstCaps event.
    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_DOWNSTREAM_STICKY
    Custom sticky downstream event.
    CUSTOM_UPSTREAM
    Upstream custom event
    EOS
    End-Of-Stream.
    FLUSH_START
    Start a flush operation.
    FLUSH_STOP
    Stop a flush operation.
    GAP
    Marks a gap in the datastream.
    INSTANT_RATE_CHANGE
    Notify downstream that a playback rate override should be applied as soon as possible.
    INSTANT_RATE_SYNC_TIME
    Sent by the pipeline to notify elements that handle the instant-rate-change event about the running-time when the rate multiplier should be applied (or was applied).
    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.
    PROTECTION
    An event which indicates that new or updated encryption information has been found in the stream.
    QOS
    A quality message.
    RECONFIGURE
    A request for upstream renegotiating caps and reconfiguring.
    SEEK
    A request for a new playback position and rate.
    SEGMENT
    A new media segment follows in the dataflow.
    SEGMENT_DONE
    Marks the end of a segment playback.
    SELECT_STREAMS
    A request to select one or more streams (Since: 1.10)
    SINK_MESSAGE
    An event that sinks turn into a message.
    STEP
    A request for stepping through the media.
    STREAM_COLLECTION
    A new GstStreamCollection is available (Since: 1.10)
    STREAM_GROUP_DONE
    Indicates that there is no more data for the stream group ID in the message.
    STREAM_START
    Event to mark the start of a new stream.
    TAG
    A new set of metadata tags has been found in the stream.
    TOC
    An event which indicates that a new table of contents (TOC) was found or updated.
    TOC_SELECT
    A request for a new playback position based on TOC entry's UID.
    UNKNOWN
    unknown event.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<EventTypeFlags>
    getFlags()
    Gets the GstEventTypeFlags associated with type.
    String
    getName()
    Get a printable name for the given event type.
    static @Nullable Type
    getType()
    Get the GType of the EventType class.
    int
    getValue()
    Get the numeric value of this enum
    static EventType
    of(int value)
    Create a new EventType for the provided value
    static EventType
    of(MemorySegment address)
    Create a new EventType for the value in the provided memory address.
    Quark
    toQuark()
    Get the unique quark for the given event type.
    int
    toStickyOrdering()
    Converts the GstEventType to an unsigned integer that represents the ordering of sticky events when re-sending them.
    static EventType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static EventType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final EventType UNKNOWN
      unknown event.

    • FLUSH_START

      public static final EventType FLUSH_START
      Start a flush operation. This event clears all data from the pipeline and unblock all streaming threads.

    • FLUSH_STOP

      public static final EventType FLUSH_STOP
      Stop a flush operation. This event resets the running-time of the pipeline.

    • STREAM_START

      public static final EventType STREAM_START
      Event to mark the start of a new stream. Sent before any other serialized event and only sent at the start of a new stream, not after flushing seeks.

    • CAPS

      public static final EventType CAPS
      GstCaps event. Notify the pad of a new media type.

    • SEGMENT

      public static final EventType SEGMENT
      A new media segment follows in the dataflow. The segment events contains information for clipping buffers and converting buffer timestamps to running-time and stream-time.

    • STREAM_COLLECTION

      public static final EventType STREAM_COLLECTION
      A new GstStreamCollection is available (Since: 1.10)

    • 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. Currently not used yet.

    • SINK_MESSAGE

      public static final EventType SINK_MESSAGE
      An event that sinks turn into a message. Used to send messages that should be emitted in sync with rendering.

    • STREAM_GROUP_DONE

      public static final EventType STREAM_GROUP_DONE
      Indicates that there is no more data for the stream group ID in the message. Sent before EOS in some instances and should be handled mostly the same. (Since: 1.10)

    • EOS

      public static final EventType EOS
      End-Of-Stream. No more data is to be expected to follow without either a STREAM_START event, or a FLUSH_STOP and a SEGMENT event.

    • TOC

      public static final EventType TOC
      An event which indicates that a new table of contents (TOC) was found or updated.

    • PROTECTION

      public static final EventType PROTECTION
      An event which indicates that new or updated encryption information has been found in the stream.

    • SEGMENT_DONE

      public static final EventType SEGMENT_DONE
      Marks the end of a segment playback.

    • GAP

      public static final EventType GAP
      Marks a gap in the datastream.

    • INSTANT_RATE_CHANGE

      public static final EventType INSTANT_RATE_CHANGE
      Notify downstream that a playback rate override should be applied as soon as possible. (Since: 1.18)

    • QOS

      public static final EventType QOS
      A quality message. Used to indicate to upstream elements that the downstream elements should adjust their processing rate.

    • SEEK

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

    • LATENCY

      public static final EventType LATENCY
      Notification of new latency adjustment. Sinks will use the latency information to adjust their synchronisation.

    • STEP

      public static final EventType STEP
      A request for stepping through the media. Sinks will usually execute the step operation.

    • RECONFIGURE

      public static final EventType RECONFIGURE
      A request for upstream renegotiating caps and reconfiguring.

    • TOC_SELECT

      public static final EventType TOC_SELECT
      A request for a new playback position based on TOC entry's UID.

    • SELECT_STREAMS

      public static final EventType SELECT_STREAMS
      A request to select one or more streams (Since: 1.10)

    • INSTANT_RATE_SYNC_TIME

      public static final EventType INSTANT_RATE_SYNC_TIME
      Sent by the pipeline to notify elements that handle the instant-rate-change event about the running-time when the rate multiplier should be applied (or was applied). (Since: 1.18)

    • 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_DOWNSTREAM_STICKY

      public static final EventType CUSTOM_DOWNSTREAM_STICKY
      Custom sticky 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 Details

    • values

      public static EventType[] 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 EventType 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 EventType of(int value)
      Create a new EventType for the provided value
      Parameters:
      value - the enum value
      Returns:
      the enum 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

    • of

      public static EventType of(MemorySegment address)
      Create a new EventType for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the EventType class.
      Returns:
      the GType

    • getFlags

      public Set<EventTypeFlags> getFlags()
      Gets the GstEventTypeFlags associated with type.
      Returns:
      a GstEventTypeFlags.

    • getName

      public String getName()
      Get a printable name for the given event type. Do not modify or free.
      Returns:
      a reference to the static name of the event.

    • toQuark

      public Quark toQuark()
      Get the unique quark for the given event type.
      Returns:
      the quark associated with the event type

    • toStickyOrdering

      public int toStickyOrdering()
      Converts the GstEventType to an unsigned integer that represents the ordering of sticky events when re-sending them. A lower value represents a higher-priority event.
      Returns:
      an unsigned integer
      Since:
      1.22