:right-sidebar: True

EventType
===================================================================

.. currentmodule:: gi.repository.Gst





.. class:: EventType
   :no-contents-entry:






:obj:`~gi.repository.Gst.EventType` 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
:obj:`~gi.repository.Gst.Structure`.
Specific custom events are distinguished by the name of the structure.





Methods
-------

.. rst-class:: interim-class

.. class:: EventType
   :no-index:


   .. method:: get_flags(type: ~gi.repository.Gst.EventType) -> ~gi.repository.Gst.EventTypeFlags

      Gets the :obj:`~gi.repository.Gst.EventTypeFlags` associated with ``type``.







      :param type: a :obj:`~gi.repository.Gst.EventType`





   .. method:: get_name(type: ~gi.repository.Gst.EventType) -> str

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







      :param type: the event type





   .. method:: to_quark(type: ~gi.repository.Gst.EventType) -> int

      Get the unique quark for the given event type.







      :param type: the event type





   .. method:: to_sticky_ordering(type: ~gi.repository.Gst.EventType) -> int

      Converts the :obj:`~gi.repository.Gst.EventType` to an unsigned integer that
      represents the ordering of sticky events when re-sending them.
      A lower value represents a higher-priority event.



      .. versionadded:: 1.22





      :param type: a :obj:`~gi.repository.Gst.EventType`















Fields
------

.. rst-class:: interim-class

.. class:: EventType
   :no-index:
   

   .. attribute:: BUFFERSIZE

      Notification of buffering requirements. Currently not
      used yet.







   .. attribute:: CAPS

      :obj:`~gi.repository.Gst.Caps` event. Notify the pad of a new media type.







   .. attribute:: CUSTOM_BOTH

      Custom upstream or downstream event.
      In-band when travelling downstream.







   .. attribute:: CUSTOM_BOTH_OOB

      Custom upstream or downstream out-of-band event.







   .. attribute:: CUSTOM_DOWNSTREAM

      Downstream custom event that travels in the
      data flow.







   .. attribute:: CUSTOM_DOWNSTREAM_OOB

      Custom out-of-band downstream event.







   .. attribute:: CUSTOM_DOWNSTREAM_STICKY

      Custom sticky downstream event.







   .. attribute:: CUSTOM_UPSTREAM

      Upstream custom event







   .. attribute:: 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.







   .. attribute:: FLUSH_START

      Start a flush operation. This event clears all data
      from the pipeline and unblock all streaming threads.







   .. attribute:: FLUSH_STOP

      Stop a flush operation. This event resets the
      running-time of the pipeline.







   .. attribute:: GAP

      Marks a gap in the datastream.







   .. attribute:: INSTANT_RATE_CHANGE

      Notify downstream that a playback rate override
      should be applied as soon as possible. (Since: 1.18)







   .. attribute:: 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)







   .. attribute:: LATENCY

      Notification of new latency adjustment. Sinks will use
      the latency information to adjust their synchronisation.







   .. attribute:: NAVIGATION

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







   .. attribute:: PROTECTION

      An event which indicates that new or updated
      encryption information has been found in the stream.







   .. attribute:: QOS

      A quality message. Used to indicate to upstream elements
      that the downstream elements should adjust their processing
      rate.







   .. attribute:: RECONFIGURE

      A request for upstream renegotiating caps and reconfiguring.







   .. attribute:: SEEK

      A request for a new playback position and rate.







   .. attribute:: 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.







   .. attribute:: SEGMENT_DONE

      Marks the end of a segment playback.







   .. attribute:: SELECT_STREAMS

      A request to select one or more streams (Since: 1.10)







   .. attribute:: SINK_MESSAGE

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







   .. attribute:: STEP

      A request for stepping through the media. Sinks will usually
      execute the step operation.







   .. attribute:: STREAM_COLLECTION

      A new :obj:`~gi.repository.Gst.StreamCollection` is available (Since: 1.10)







   .. attribute:: 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)







   .. attribute:: 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.







   .. attribute:: TAG

      A new set of metadata tags has been found in the stream.







   .. attribute:: TOC

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







   .. attribute:: TOC_SELECT

      A request for a new playback position based on TOC
      entry's UID.







   .. attribute:: UNKNOWN

      Unknown event.