Class Event

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.gst.Event
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class Event extends ProxyInstance

The event class provides factory methods to construct events for sending and functions to query (parse) received events.

Events are usually created with gst_event_new_*() which takes event-type specific parameters as arguments. To send an event application will usually use gst_element_send_event() and elements will use gst_pad_send_event() or gst_pad_push_event(). The event should be unreffed with gst_event_unref() if it has not been sent.

Events that have been received can be parsed with their respective gst_event_parse_*() functions. It is valid to pass null for unwanted details.

Events are passed between elements in parallel to the data stream. Some events are serialized with buffers, others are not. Some events only travel downstream, others only upstream. Some events can travel both upstream and downstream.

The events are used to signal special conditions in the datastream such as EOS (end of stream) or the start of a new stream-segment. Events are also used to flush the pipeline of any pending data.

Most of the event API is used inside plugins. Applications usually only construct and use seek events. To do that gst_event_new_seek() is used to create a seek event. It takes the needed parameters to specify seeking time and mode.

  GstEvent *event;
  gboolean result;
  ...
  // construct a seek event to play the media from second 2 to 5, flush
  // the pipeline to decrease latency.
  event = gst_event_new_seek (1.0,
     GST_FORMAT_TIME,
     GST_SEEK_FLAG_FLUSH,
     GST_SEEK_TYPE_SET, 2 * GST_SECOND,
     GST_SEEK_TYPE_SET, 5 * GST_SECOND);
  ...
  result = gst_element_send_event (pipeline, event);
  if (!result)
    g_warning ("seek failed");
  ...

  • Constructor Details

    • Event

      public Event(MemorySegment address)
      Create a Event proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • Event

      public Event(Arena arena)
      Allocate a new Event.
      Parameters:
      arena - to control the memory allocation scope

    • Event

      public Event()
      Allocate a new Event. The memory is allocated with Arena.ofAuto().

    • Event

      public Event(MiniObject miniObject, EventType type, long timestamp, int seqnum, Arena arena)
      Allocate a new Event with the fields set to the provided values.
      Parameters:
      miniObject - value for the field miniObject
      type - value for the field type
      timestamp - value for the field timestamp
      seqnum - value for the field seqnum
      arena - to control the memory allocation scope

    • Event

      public Event(MiniObject miniObject, EventType type, long timestamp, int seqnum)
      Allocate a new Event with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      miniObject - value for the field miniObject
      type - value for the field type
      timestamp - value for the field timestamp
      seqnum - value for the field seqnum

  • Method Details

    • getType

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

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • readMiniObject

      public @Nullable MiniObject readMiniObject()
      Read the value of the field mini_object.
      Returns:
      The value of the field mini_object

    • writeMiniObject

      public void writeMiniObject(@Nullable MiniObject miniObject)
      Write a value in the field mini_object.
      Parameters:
      miniObject - The new value for the field mini_object

    • readType

      public EventType readType()
      Read the value of the field type.
      Returns:
      The value of the field type

    • writeType

      public void writeType(EventType type)
      Write a value in the field type.
      Parameters:
      type - The new value for the field type

    • readTimestamp

      public long readTimestamp()
      Read the value of the field timestamp.
      Returns:
      The value of the field timestamp

    • writeTimestamp

      public void writeTimestamp(long timestamp)
      Write a value in the field timestamp.
      Parameters:
      timestamp - The new value for the field timestamp

    • readSeqnum

      public int readSeqnum()
      Read the value of the field seqnum.
      Returns:
      The value of the field seqnum

    • writeSeqnum

      public void writeSeqnum(int seqnum)
      Write a value in the field seqnum.
      Parameters:
      seqnum - The new value for the field seqnum

    • bufferSize

      public static Event bufferSize(Format format, long minsize, long maxsize, boolean async)

      Create a new buffersize event. The event is sent downstream and notifies elements that they should provide a buffer of the specified dimensions.

      When the async flag is set, a thread boundary is preferred.

      Parameters:
      format - buffer format
      minsize - minimum buffer size
      maxsize - maximum buffer size
      async - thread behavior
      Returns:
      a new GstEvent

    • caps

      public static Event caps(Caps caps)
      Create a new CAPS event for caps. The caps event can only travel downstream synchronized with the buffer flow and contains the format of the buffers that will follow after the event.
      Parameters:
      caps - a GstCaps
      Returns:
      the new CAPS event.

    • custom

      public static Event custom(EventType type, Structure structure)

      Create a new custom-typed event. This can be used for anything not handled by other event-specific functions to pass an event to another element.

      Make sure to allocate an event type with the GST_EVENT_MAKE_TYPE macro, assigning a free number and filling in the correct direction and serialization flags.

      New custom events can also be created by subclassing the event type if needed.

      Parameters:
      type - The type of the new event
      structure - the structure for the event. The event will take ownership of the structure.
      Returns:
      the new custom event.

    • eos

      public static Event eos()

      Create a new EOS event. The eos event can only travel downstream synchronized with the buffer flow. Elements that receive the EOS event on a pad can return GST_FLOW_EOS as a GstFlowReturn when data after the EOS event arrives.

      The EOS event will travel down to the sink elements in the pipeline which will then post the GST_MESSAGE_EOS on the bus after they have finished playing any buffered data.

      When all sinks have posted an EOS message, an EOS message is forwarded to the application.

      The EOS event itself will not cause any state transitions of the pipeline.

      Returns:
      the new EOS event.

    • flushStart

      public static Event flushStart()

      Allocate a new flush start event. The flush start event can be sent upstream and downstream and travels out-of-bounds with the dataflow.

      It marks pads as being flushing and will make them return GST_FLOW_FLUSHING when used for data flow with gst_pad_push(), gst_pad_chain(), gst_pad_get_range() and gst_pad_pull_range(). Any event (except a GST_EVENT_FLUSH_STOP) received on a flushing pad will return false immediately.

      Elements should unlock any blocking functions and exit their streaming functions as fast as possible when this event is received.

      This event is typically generated after a seek to flush out all queued data in the pipeline so that the new media is played as soon as possible.

      Returns:
      a new flush start event.

    • flushStop

      public static Event flushStop(boolean resetTime)

      Allocate a new flush stop event. The flush stop event can be sent upstream and downstream and travels serialized with the dataflow. It is typically sent after sending a FLUSH_START event to make the pads accept data again.

      Elements can process this event synchronized with the dataflow since the preceding FLUSH_START event stopped the dataflow.

      This event is typically generated to complete a seek and to resume dataflow.

      Parameters:
      resetTime - if time should be reset
      Returns:
      a new flush stop event.

    • gap

      public static Event gap(ClockTime timestamp, ClockTime duration)
      Create a new GAP event. A gap event can be thought of as conceptually equivalent to a buffer to signal that there is no data for a certain amount of time. This is useful to signal a gap to downstream elements which may wait for data, such as muxers or mixers or overlays, especially for sparse streams such as subtitle streams.
      Parameters:
      timestamp - the start time (pts) of the gap
      duration - the duration of the gap
      Returns:
      the new GAP event.

    • instantRateChange

      public static Event instantRateChange(double rateMultiplier, Set<SegmentFlags> newFlags)

      Create a new instant-rate-change event. This event is sent by seek handlers (e.g. demuxers) when receiving a seek with the SeekFlags.INSTANT_RATE_CHANGE and signals to downstream elements that the playback rate in the existing segment should be immediately multiplied by the rateMultiplier factor.

      The flags provided replace any flags in the existing segment, for the flags within the GST_SEGMENT_INSTANT_FLAGS set. Other GstSegmentFlags are ignored and not transferred in the event.

      Parameters:
      rateMultiplier - the multiplier to be applied to the playback rate
      newFlags - A new subset of segment flags to replace in segments
      Returns:
      the new instant-rate-change event.
      Since:
      1.18

    • instantRateChange

      public static Event instantRateChange(double rateMultiplier, SegmentFlags... newFlags)

      Create a new instant-rate-change event. This event is sent by seek handlers (e.g. demuxers) when receiving a seek with the SeekFlags.INSTANT_RATE_CHANGE and signals to downstream elements that the playback rate in the existing segment should be immediately multiplied by the rateMultiplier factor.

      The flags provided replace any flags in the existing segment, for the flags within the GST_SEGMENT_INSTANT_FLAGS set. Other GstSegmentFlags are ignored and not transferred in the event.

      Parameters:
      rateMultiplier - the multiplier to be applied to the playback rate
      newFlags - A new subset of segment flags to replace in segments
      Returns:
      the new instant-rate-change event.
      Since:
      1.18

    • instantRateSyncTime

      public static Event instantRateSyncTime(double rateMultiplier, ClockTime runningTime, ClockTime upstreamRunningTime)

      Create a new instant-rate-sync-time event. This event is sent by the pipeline to notify elements handling the instant-rate-change event about the running-time when the new rate should be applied. The running time may be in the past when elements handle this event, which can lead to switching artifacts. The magnitude of those depends on the exact timing of event delivery to each element and the magnitude of the change in playback rate being applied.

      The runningTime and upstreamRunningTime are the same if this is the first instant-rate adjustment, but will differ for later ones to compensate for the accumulated offset due to playing at a rate different to the one indicated in the playback segments.

      Parameters:
      rateMultiplier - the new playback rate multiplier to be applied
      runningTime - Running time when the rate change should be applied
      upstreamRunningTime - The upstream-centric running-time when the rate change should be applied.
      Returns:
      the new instant-rate-sync-time event.
      Since:
      1.18

    • latency

      public static Event latency(ClockTime latency)

      Create a new latency event. The event is sent upstream from the sinks and notifies elements that they should add an additional latency to the running time before synchronising against the clock.

      The latency is mostly used in live sinks and is always expressed in the time format.

      Parameters:
      latency - the new latency value
      Returns:
      a new GstEvent

    • protection

      public static Event protection(String systemId, Buffer data, String origin)

      Creates a new event containing information specific to a particular protection system (uniquely identified by systemId), by which that protection system can acquire key(s) to decrypt a protected stream.

      In order for a decryption element to decrypt media protected using a specific system, it first needs all the protection system specific information necessary to acquire the decryption key(s) for that stream. The functions defined here enable this information to be passed in events from elements that extract it (e.g., ISOBMFF demuxers, MPEG DASH demuxers) to protection decrypter elements that use it.

      Events containing protection system specific information are created using gst_event_new_protection, and they can be parsed by downstream elements using gst_event_parse_protection.

      In Common Encryption, protection system specific information may be located within ISOBMFF files, both in movie (moov) boxes and movie fragment (moof) boxes; it may also be contained in ContentProtection elements within MPEG DASH MPDs. The events created by gst_event_new_protection contain data identifying from which of these locations the encapsulated protection system specific information originated. This origin information is required as some protection systems use different encodings depending upon where the information originates.

      The events returned by gst_event_new_protection() are implemented in such a way as to ensure that the most recently-pushed protection info event of a particular origin and systemId will be stuck to the output pad of the sending element.

      Parameters:
      systemId - a string holding a UUID that uniquely identifies a protection system.
      data - a GstBuffer holding protection system specific information. The reference count of the buffer will be incremented by one.
      origin - a string indicating where the protection information carried in the event was extracted from. The allowed values of this string will depend upon the protection scheme.
      Returns:
      a GST_EVENT_PROTECTION event.
      Since:
      1.6

    • qos

      public static Event qos(QOSType type, double proportion, ClockTimeDiff diff, ClockTime timestamp)

      Allocate a new qos event with the given values. The QOS event is generated in an element that wants an upstream element to either reduce or increase its rate because of high/low CPU load or other resource usage such as network performance or throttling. Typically sinks generate these events for each buffer they receive.

      type indicates the reason for the QoS event. GST_QOS_TYPE_OVERFLOW is used when a buffer arrived in time or when the sink cannot keep up with the upstream datarate. GST_QOS_TYPE_UNDERFLOW is when the sink is not receiving buffers fast enough and thus has to drop late buffers. GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited by the application, for example to reduce power consumption.

      proportion indicates the real-time performance of the streaming in the element that generated the QoS event (usually the sink). The value is generally computed based on more long term statistics about the streams timestamps compared to the clock. A value < 1.0 indicates that the upstream element is producing data faster than real-time. A value > 1.0 indicates that the upstream element is not producing data fast enough. 1.0 is the ideal proportion value. The proportion value can safely be used to lower or increase the quality of the element.

      diff is the difference against the clock in running time of the last buffer that caused the element to generate the QOS event. A negative value means that the buffer with timestamp arrived in time. A positive value indicates how late the buffer with timestamp was. When throttling is enabled, diff will be set to the requested throttling interval.

      timestamp is the timestamp of the last buffer that cause the element to generate the QOS event. It is expressed in running time and thus an ever increasing value.

      The upstream element can use the diff and timestamp values to decide whether to process more buffers. For positive diff, all buffers with timestamp <= timestamp + diff will certainly arrive late in the sink as well. A (negative) diff value so that timestamp + diff would yield a result smaller than 0 is not allowed.

      The application can use general event probes to intercept the QoS event and implement custom application specific QoS handling.

      Parameters:
      type - the QoS type
      proportion - the proportion of the qos message
      diff - The time difference of the last Clock sync
      timestamp - The timestamp of the buffer
      Returns:
      a new QOS event.

    • reconfigure

      public static Event reconfigure()
      Create a new reconfigure event. The purpose of the reconfigure event is to travel upstream and make elements renegotiate their caps or reconfigure their buffer pools. This is useful when changing properties on elements or changing the topology of the pipeline.
      Returns:
      a new GstEvent

    • seek

      public static Event seek(double rate, Format format, Set<SeekFlags> flags, SeekType startType, long start, SeekType stopType, long stop)

      Allocate a new seek event with the given parameters.

      The seek event configures playback of the pipeline between start to stop at the speed given in rate, also called a playback segment. The start and stop values are expressed in format.

      A rate of 1.0 means normal playback rate, 2.0 means double speed. Negatives values means backwards playback. A value of 0.0 for the rate is not allowed and should be accomplished instead by PAUSING the pipeline.

      A pipeline has a default playback segment configured with a start position of 0, a stop position of -1 and a rate of 1.0. The currently configured playback segment can be queried with GST_QUERY_SEGMENT.

      startType and stopType specify how to adjust the currently configured start and stop fields in playback segment. Adjustments can be made relative or absolute to the last configured values. A type of GST_SEEK_TYPE_NONE means that the position should not be updated.

      When the rate is positive and start has been updated, playback will start from the newly configured start position.

      For negative rates, playback will start from the newly configured stop position (if any). If the stop position is updated, it must be different from -1 (GST_CLOCK_TIME_NONE) for negative rates.

      It is not possible to seek relative to the current playback position, to do this, PAUSE the pipeline, query the current playback position with GST_QUERY_POSITION and update the playback segment current position with a GST_SEEK_TYPE_SET to the desired position.

      Parameters:
      rate - The new playback rate
      format - The format of the seek values
      flags - The optional seek flags
      startType - The type and flags for the new start position
      start - The value of the new start position
      stopType - The type and flags for the new stop position
      stop - The value of the new stop position
      Returns:
      a new seek event.

    • seek

      public static Event seek(double rate, Format format, SeekFlags flags, SeekType startType, long start, SeekType stopType, long stop)

      Allocate a new seek event with the given parameters.

      The seek event configures playback of the pipeline between start to stop at the speed given in rate, also called a playback segment. The start and stop values are expressed in format.

      A rate of 1.0 means normal playback rate, 2.0 means double speed. Negatives values means backwards playback. A value of 0.0 for the rate is not allowed and should be accomplished instead by PAUSING the pipeline.

      A pipeline has a default playback segment configured with a start position of 0, a stop position of -1 and a rate of 1.0. The currently configured playback segment can be queried with GST_QUERY_SEGMENT.

      startType and stopType specify how to adjust the currently configured start and stop fields in playback segment. Adjustments can be made relative or absolute to the last configured values. A type of GST_SEEK_TYPE_NONE means that the position should not be updated.

      When the rate is positive and start has been updated, playback will start from the newly configured start position.

      For negative rates, playback will start from the newly configured stop position (if any). If the stop position is updated, it must be different from -1 (GST_CLOCK_TIME_NONE) for negative rates.

      It is not possible to seek relative to the current playback position, to do this, PAUSE the pipeline, query the current playback position with GST_QUERY_POSITION and update the playback segment current position with a GST_SEEK_TYPE_SET to the desired position.

      Parameters:
      rate - The new playback rate
      format - The format of the seek values
      flags - The optional seek flags
      startType - The type and flags for the new start position
      start - The value of the new start position
      stopType - The type and flags for the new stop position
      stop - The value of the new stop position
      Returns:
      a new seek event.

    • segment

      public static Event segment(Segment segment)

      Create a new SEGMENT event for segment. The segment event can only travel downstream synchronized with the buffer flow and contains timing information and playback properties for the buffers that will follow.

      The segment event marks the range of buffers to be processed. All data not within the segment range is not to be processed. This can be used intelligently by plugins to apply more efficient methods of skipping unneeded data. The valid range is expressed with the start and stop values.

      The time value of the segment is used in conjunction with the start value to convert the buffer timestamps into the stream time. This is usually done in sinks to report the current stream_time. time represents the stream_time of a buffer carrying a timestamp of start. time cannot be -1.

      start cannot be -1, stop can be -1. If there is a valid stop given, it must be greater or equal the start, including when the indicated playback rate is < 0.

      The appliedRate value provides information about any rate adjustment that has already been made to the timestamps and content on the buffers of the stream. (rate * appliedRate) should always equal the rate that has been requested for playback. For example, if an element has an input segment with intended playback rate of 2.0 and applied_rate of 1.0, it can adjust incoming timestamps and buffer content by half and output a segment event with rate of 1.0 and appliedRate of 2.0

      After a segment event, the buffer stream time is calculated with:

      time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)

      Parameters:
      segment - a GstSegment
      Returns:
      the new SEGMENT event.

    • segmentDone

      public static Event segmentDone(Format format, long position)
      Create a new segment-done event. This event is sent by elements that finish playback of a segment as a result of a segment seek.
      Parameters:
      format - The format of the position being done
      position - The position of the segment being done
      Returns:
      a new GstEvent

    • selectStreams

      public static Event selectStreams(List<String> streams)

      Allocate a new select-streams event.

      The select-streams event requests the specified streams to be activated.

      The list of streams corresponds to the "Stream ID" of each stream to be activated. Those ID can be obtained via the GstStream objects present in GST_EVENT_STREAM_START, GST_EVENT_STREAM_COLLECTION or GST_MESSAGE_STREAM_COLLECTION.

      Note: The list of streams can not be empty.

      Parameters:
      streams - the list of streams to activate
      Returns:
      a new select-streams event.
      Since:
      1.10

    • sinkMessage

      public static Event sinkMessage(String name, Message msg)

      Create a new sink-message event. The purpose of the sink-message event is to instruct a sink to post the message contained in the event synchronized with the stream.

      name is used to store multiple sticky events on one pad.

      Parameters:
      name - a name for the event
      msg - the GstMessage to be posted
      Returns:
      a new GstEvent

    • step

      public static Event step(Format format, long amount, double rate, boolean flush, boolean intermediate)

      Create a new step event. The purpose of the step event is to instruct a sink to skip amount (expressed in format) of media. It can be used to implement stepping through the video frame by frame or for doing fast trick modes.

      A rate of <= 0.0 is not allowed. Pause the pipeline, for the effect of rate = 0.0 or first reverse the direction of playback using a seek event to get the same effect as rate < 0.0.

      The flush flag will clear any pending data in the pipeline before starting the step operation.

      The intermediate flag instructs the pipeline that this step operation is part of a larger step operation.

      Parameters:
      format - the format of amount
      amount - the amount of data to step
      rate - the step rate
      flush - flushing steps
      intermediate - intermediate steps
      Returns:
      a new GstEvent

    • streamCollection

      public static Event streamCollection(StreamCollection collection)

      Create a new STREAM_COLLECTION event. The stream collection event can only travel downstream synchronized with the buffer flow.

      Source elements, demuxers and other elements that manage collections of streams and post GstStreamCollection messages on the bus also send this event downstream on each pad involved in the collection, so that activation of a new collection can be tracked through the downstream data flow.

      Parameters:
      collection - Active collection for this data flow
      Returns:
      the new STREAM_COLLECTION event.
      Since:
      1.10

    • streamGroupDone

      public static Event streamGroupDone(int groupId)

      Create a new Stream Group Done event. The stream-group-done event can only travel downstream synchronized with the buffer flow. Elements that receive the event on a pad should handle it mostly like EOS, and emit any data or pending buffers that would depend on more data arriving and unblock, since there won't be any more data.

      This event is followed by EOS at some point in the future, and is generally used when switching pads - to unblock downstream so that new pads can be exposed before sending EOS on the existing pads.

      Parameters:
      groupId - the group id of the stream group which is ending
      Returns:
      the new stream-group-done event.
      Since:
      1.10

    • streamStart

      public static Event streamStart(String streamId)

      Create a new STREAM_START event. The stream start event can only travel downstream synchronized with the buffer flow. It is expected to be the first event that is sent for a new stream.

      Source elements, demuxers and other elements that create new streams are supposed to send this event as the first event of a new stream. It should not be sent after a flushing seek or in similar situations and is used to mark the beginning of a new logical stream. Elements combining multiple streams must ensure that this event is only forwarded downstream once and not for every single input stream.

      The streamId should be a unique string that consists of the upstream stream-id, / as separator and a unique stream-id for this specific stream. A new stream-id should only be created for a stream if the upstream stream is split into (potentially) multiple new streams, e.g. in a demuxer, but not for every single element in the pipeline. gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be used to create a stream-id. There are no particular semantics for the stream-id, though it should be deterministic (to support stream matching) and it might be used to order streams (besides any information conveyed by stream flags).

      Parameters:
      streamId - Identifier for this stream
      Returns:
      the new STREAM_START event.

    • tag

      public static Event tag(TagList taglist)

      Generates a metadata tag event from the given taglist.

      The scope of the taglist specifies if the taglist applies to the complete medium or only to this specific stream. As the tag event is a sticky event, elements should merge tags received from upstream with a given scope with their own tags with the same scope and create a new tag event from it.

      Parameters:
      taglist - metadata list. The event will take ownership of the taglist.
      Returns:
      a new GstEvent

    • toc

      public static Event toc(Toc toc, boolean updated)
      Generate a TOC event from the given toc. The purpose of the TOC event is to inform elements that some kind of the TOC was found.
      Parameters:
      toc - GstToc structure.
      updated - whether toc was updated or not.
      Returns:
      a new GstEvent.

    • tocSelect

      public static Event tocSelect(String uid)
      Generate a TOC select event with the given uid. The purpose of the TOC select event is to start playback based on the TOC's entry with the given uid.
      Parameters:
      uid - UID in the TOC to start playback from.
      Returns:
      a new GstEvent.

    • replace

      public static boolean replace(@Nullable Out<Event> oldEvent, @Nullable Event newEvent)

      Modifies a pointer to a GstEvent to point to a different GstEvent. The modification is done atomically (so this is useful for ensuring thread safety in some cases), and the reference counts are updated appropriately (the old event is unreffed, the new one is reffed).

      Either newEvent or the GstEvent pointed to by oldEvent may be null.

      Parameters:
      oldEvent - pointer to a pointer to a GstEvent to be replaced.
      newEvent - pointer to a GstEvent that will replace the event pointed to by oldEvent.
      Returns:
      true if newEvent was different from oldEvent

    • steal

      public static Event steal(@Nullable Out<Event> oldEvent)
      Atomically replace the GstEvent pointed to by oldEvent with null and return the original event.
      Parameters:
      oldEvent - pointer to a pointer to a GstEvent to be stolen.
      Returns:
      the GstEvent that was in oldEvent

    • take

      public static boolean take(@Nullable Out<Event> oldEvent, @Nullable Event newEvent)

      Modifies a pointer to a GstEvent to point to a different GstEvent. This function is similar to gst_event_replace() except that it takes ownership of newEvent.

      Either newEvent or the GstEvent pointed to by oldEvent may be null.

      Parameters:
      oldEvent - pointer to a pointer to a GstEvent to be stolen.
      newEvent - pointer to a GstEvent that will replace the event pointed to by oldEvent.
      Returns:
      true if newEvent was different from oldEvent

    • copy

      public Event copy()
      Copy the event using the event specific copy function.
      Returns:
      the new event

    • copySegment

      public void copySegment(Segment segment)
      Parses a segment this Event and copies the GstSegment into the location given by segment.
      Parameters:
      segment - a pointer to a GstSegment

    • getRunningTimeOffset

      public long getRunningTimeOffset()

      Retrieve the accumulated running time offset of the event.

      Events passing through GstPads that have a running time offset set via gst_pad_set_offset() will get their offset adjusted according to the pad's offset.

      If the event contains any information that related to the running time, this information will need to be updated before usage with this offset.

      Returns:

      The event's running time offset

      MT safe.

      Since:
      1.4

    • getSeqnum

      public int getSeqnum()

      Retrieve the sequence number of a event.

      Events have ever-incrementing sequence numbers, which may also be set explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to indicate that a event corresponds to some other set of events or messages, for example an EOS event corresponding to a SEEK event. It is considered good practice to make this correspondence when possible, though it is not required.

      Note that events and messages share the same sequence number incrementor; two events or messages will never have the same sequence number unless that correspondence was made explicitly.

      Returns:

      The event's sequence number.

      MT safe.

    • getStructure

      public @Nullable Structure getStructure()
      Access the structure of the event.
      Returns:

      The structure of the event. The structure is still owned by the event, which means that you should not free it and that the pointer becomes invalid when you free the event.

      MT safe.

    • hasName

      public boolean hasName(String name)
      Checks if this Event has the given name. This function is usually used to check the name of a custom event.
      Parameters:
      name - name to check
      Returns:
      true if name matches the name of the event structure.

    • hasNameId

      @Deprecated public boolean hasNameId(Quark name)
      Deprecated.
      Use gst_event_has_name().
      Checks if this Event has the given name. This function is usually used to check the name of a custom event.
      Parameters:
      name - name to check as a GQuark
      Returns:
      true if name matches the name of the event structure.
      Since:
      1.18

    • parseBufferSize

      public void parseBufferSize(@Nullable Out<Format> format, @Nullable Out<Long> minsize, @Nullable Out<Long> maxsize, @Nullable Out<Boolean> async)
      Get the format, minsize, maxsize and async-flag in the buffersize event.
      Parameters:
      format - A pointer to store the format in
      minsize - A pointer to store the minsize in
      maxsize - A pointer to store the maxsize in
      async - A pointer to store the async-flag in

    • parseCaps

      public void parseCaps(@Nullable Out<Caps> caps)
      Get the caps from event. The caps remains valid as long as this Event remains valid.
      Parameters:
      caps - A pointer to the caps

    • parseFlushStop

      public void parseFlushStop(@Nullable Out<Boolean> resetTime)
      Parse the FLUSH_STOP event and retrieve the resetTime member.
      Parameters:
      resetTime - if time should be reset

    • parseGap

      public void parseGap(@Nullable ClockTime timestamp, @Nullable ClockTime duration)
      Extract timestamp and duration from a new GAP event.
      Parameters:
      timestamp - location where to store the start time (pts) of the gap, or null
      duration - location where to store the duration of the gap, or null

    • parseGapFlags

      public void parseGapFlags(@Nullable Out<Set<GapFlags>> flags)
      Retrieve the gap flags that may have been set on a gap event with gst_event_set_gap_flags().
      Parameters:
      flags - a GstGapFlags or null
      Since:
      1.20

    • parseGroupId

      public boolean parseGroupId(@Nullable Out<Integer> groupId)

    • parseInstantRateChange

      public void parseInstantRateChange(@Nullable Out<Double> rateMultiplier, @Nullable Out<Set<SegmentFlags>> newFlags)
      Extract rate and flags from an instant-rate-change event.
      Parameters:
      rateMultiplier - location in which to store the rate multiplier of the instant-rate-change event, or null
      newFlags - location in which to store the new segment flags of the instant-rate-change event, or null
      Since:
      1.18

    • parseInstantRateSyncTime

      public void parseInstantRateSyncTime(@Nullable Out<Double> rateMultiplier, @Nullable ClockTime runningTime, @Nullable ClockTime upstreamRunningTime)
      Extract the rate multiplier and running times from an instant-rate-sync-time event.
      Parameters:
      rateMultiplier - location where to store the rate of the instant-rate-sync-time event, or null
      runningTime - location in which to store the running time of the instant-rate-sync-time event, or null
      upstreamRunningTime - location in which to store the upstream running time of the instant-rate-sync-time event, or null
      Since:
      1.18

    • parseLatency

      public void parseLatency(@Nullable ClockTime latency)
      Get the latency in the latency event.
      Parameters:
      latency - A pointer to store the latency in.

    • parseProtection

      public void parseProtection(@Nullable Out<String> systemId, @Nullable Out<Buffer> data, @Nullable Out<String> origin)
      Parses an event containing protection system specific information and stores the results in systemId, data and origin. The data stored in systemId, origin and data are valid until this Event is released.
      Parameters:
      systemId - pointer to store the UUID string uniquely identifying a content protection system.
      data - pointer to store a GstBuffer holding protection system specific information.
      origin - pointer to store a value that indicates where the protection information carried by this Event was extracted from.
      Since:
      1.6

    • parseQos

      public void parseQos(@Nullable Out<QOSType> type, @Nullable Out<Double> proportion, @Nullable ClockTimeDiff diff, @Nullable ClockTime timestamp)

      Get the type, proportion, diff and timestamp in the qos event. See gst_event_new_qos() for more information about the different QoS values.

      timestamp will be adjusted for any pad offsets of pads it was passing through.

      Parameters:
      type - A pointer to store the QoS type in
      proportion - A pointer to store the proportion in
      diff - A pointer to store the diff in
      timestamp - A pointer to store the timestamp in

    • parseSeek

      public void parseSeek(@Nullable Out<Double> rate, @Nullable Out<Format> format, @Nullable Out<Set<SeekFlags>> flags, @Nullable Out<SeekType> startType, @Nullable Out<Long> start, @Nullable Out<SeekType> stopType, @Nullable Out<Long> stop)
      Parses a seek this Event and stores the results in the given result locations.
      Parameters:
      rate - result location for the rate
      format - result location for the stream format
      flags - result location for the GstSeekFlags
      startType - result location for the GstSeekType of the start position
      start - result location for the start position expressed in format
      stopType - result location for the GstSeekType of the stop position
      stop - result location for the stop position expressed in format

    • parseSeekTrickmodeInterval

      public void parseSeekTrickmodeInterval(@Nullable ClockTime interval)
      Retrieve the trickmode interval that may have been set on a seek event with gst_event_set_seek_trickmode_interval().
      Parameters:
      interval - interval
      Since:
      1.16

    • parseSegment

      public void parseSegment(@Nullable Out<Segment> segment)
      Parses a segment this Event and stores the result in the given segment location. segment remains valid only until the this Event is freed. Don't modify the segment and make a copy if you want to modify it or store it for later use.
      Parameters:
      segment - a pointer to a GstSegment

    • parseSegmentDone

      public void parseSegmentDone(@Nullable Out<Format> format, @Nullable Out<Long> position)
      Extracts the position and format from the segment done message.
      Parameters:
      format - Result location for the format, or null
      position - Result location for the position, or null

    • parseSelectStreams

      public void parseSelectStreams(@Nullable Out<List<String>> streams)
      Parse the SELECT_STREAMS event and retrieve the contained streams.
      Parameters:
      streams - the streams
      Since:
      1.10

    • parseSinkMessage

      public void parseSinkMessage(@Nullable Out<Message> msg)
      Parse the sink-message event. Unref msg after usage.
      Parameters:
      msg - a pointer to store the GstMessage in.

    • parseStep

      public void parseStep(@Nullable Out<Format> format, @Nullable Out<Long> amount, @Nullable Out<Double> rate, @Nullable Out<Boolean> flush, @Nullable Out<Boolean> intermediate)
      Parse the step event.
      Parameters:
      format - a pointer to store the format in
      amount - a pointer to store the amount in
      rate - a pointer to store the rate in
      flush - a pointer to store the flush boolean in
      intermediate - a pointer to store the intermediate boolean in

    • parseStream

      public void parseStream(@Nullable Out<Stream> stream)
      Parse a stream-start this Event and extract the GstStream from it.
      Parameters:
      stream - address of variable to store the stream
      Since:
      1.10

    • parseStreamCollection

      public void parseStreamCollection(@Nullable Out<StreamCollection> collection)
      Retrieve new GstStreamCollection from STREAM_COLLECTION event event.
      Parameters:
      collection - pointer to store the collection.
      Since:
      1.10

    • parseStreamFlags

      public void parseStreamFlags(@Nullable Out<Set<StreamFlags>> flags)

    • parseStreamGroupDone

      public void parseStreamGroupDone(@Nullable Out<Integer> groupId)
      Parse a stream-group-done this Event and store the result in the given groupId location.
      Parameters:
      groupId - address of variable to store the group id into
      Since:
      1.10

    • parseStreamStart

      public void parseStreamStart(@Nullable Out<String> streamId)
      Parse a stream-id this Event and store the result in the given streamId location. The string stored in streamId must not be modified and will remain valid only until this Event gets freed. Make a copy if you want to modify it or store it for later use.
      Parameters:
      streamId - pointer to store the stream-id

    • parseTag

      public void parseTag(@Nullable Out<TagList> taglist)
      Parses a tag this Event and stores the results in the given taglist location. No reference to the taglist will be returned, it remains valid only until the this Event is freed. Don't modify or free the taglist, make a copy if you want to modify it or store it for later use.
      Parameters:
      taglist - pointer to metadata list

    • parseToc

      public void parseToc(@Nullable Out<Toc> toc, @Nullable Out<Boolean> updated)
      Parse a TOC this Event and store the results in the given toc and updated locations.
      Parameters:
      toc - pointer to GstToc structure.
      updated - pointer to store TOC updated flag.

    • parseTocSelect

      public void parseTocSelect(@Nullable Out<String> uid)
      Parse a TOC select this Event and store the results in the given uid location.
      Parameters:
      uid - storage for the selection UID.

    • ref

      public Event ref()
      Increase the refcount of this event.
      Returns:
      this Event (for convenience when doing assignments)

    • setGapFlags

      public void setGapFlags(Set<GapFlags> flags)
      Sets flags on this Event to give additional information about the reason for the GST_EVENT_GAP.
      Parameters:
      flags - a GstGapFlags
      Since:
      1.20

    • setGapFlags

      public void setGapFlags(GapFlags... flags)
      Sets flags on this Event to give additional information about the reason for the GST_EVENT_GAP.
      Parameters:
      flags - a GstGapFlags
      Since:
      1.20

    • setGroupId

      public void setGroupId(int groupId)

      All streams that have the same group id are supposed to be played together, i.e. all streams inside a container file should have the same group id but different stream ids. The group id should change each time the stream is started, resulting in different group ids each time a file is played for example.

      Use gst_util_group_id_next() to get a new group id.

      Parameters:
      groupId - the group id to set
      Since:
      1.2

    • setRunningTimeOffset

      public void setRunningTimeOffset(long offset)

      Set the running time offset of a event. See gst_event_get_running_time_offset() for more information.

      MT safe.

      Parameters:
      offset - A the new running time offset
      Since:
      1.4

    • setSeekTrickmodeInterval

      public void setSeekTrickmodeInterval(ClockTime interval)
      Sets a trickmode interval on a (writable) seek event. Elements that support TRICKMODE_KEY_UNITS seeks SHOULD use this as the minimal interval between each frame they may output.
      Since:
      1.16

    • setSeqnum

      public void setSeqnum(int seqnum)

      Set the sequence number of a event.

      This function might be called by the creator of a event to indicate that the event relates to other events or messages. See gst_event_get_seqnum() for more information.

      MT safe.

      Parameters:
      seqnum - A sequence number.

    • setStream

      public void setStream(Stream stream)
      Set the stream on the stream-start this Event
      Parameters:
      stream - the stream object to set
      Since:
      1.10

    • setStreamFlags

      public void setStreamFlags(Set<StreamFlags> flags)

    • setStreamFlags

      public void setStreamFlags(StreamFlags... flags)

    • unref

      public void unref()
      Decrease the refcount of an event, freeing it if the refcount reaches 0.

    • writableStructure

      public Structure writableStructure()
      Get a writable version of the structure.
      Returns:

      The structure of the event. The structure is still owned by the event, which means that you should not free it and that the pointer becomes invalid when you free the event. This function ensures that this Event is writable, and if so, will never return null.

      MT safe.