GstEvent

Name

GstEvent -- Event definitions.

Synopsis


#include <gst/gst.h>


enum        GstEventType;
#define     GST_EVENT_TYPE                  (event)
#define     GST_EVENT_SRC                   (event)
#define     GST_EVENT_TIMESTAMP             (event)
enum        GstSeekType;
#define     GST_EVENT_SEEK_TYPE             (event)
#define     GST_EVENT_SEEK_OFFSET           (event)
#define     GST_EVENT_SEEK_FLUSH            (event)
#define     GST_EVENT_INFO_PROPS            (event)
struct      GstEvent;
GstEvent*   gst_event_new                   (GstEventType type);
void        gst_event_free                  (GstEvent *event);
GstEvent*   gst_event_new_seek              (GstSeekType type,
                                             gint64 offset,
                                             gboolean flush);
#define     gst_event_new_flush             ()
GstEvent*   gst_event_new_info              (const gchar *firstname,
                                             ...);

Description

The event classes are used to construct and query events.

Events are usually created with gst_event_new() which takes the event type as an argument. properties specific to the event can be set afterwards with the provided macros. The event is freed with gst_event_free().

gst_event_new_seek() is a usually used to create a seek event and it takes the needed parameters for a seek event.

gst_event_new_flush() creates a new flush event.

Details

enum GstEventType

typedef enum {
  GST_EVENT_UNKNOWN,
  /* horizontal events */
  GST_EVENT_EOS,
  GST_EVENT_FLUSH,
  GST_EVENT_EMPTY,
  GST_EVENT_SEEK,
  GST_EVENT_DISCONTINUOUS,
  GST_EVENT_NEW_MEDIA,
  /* vertical events */
  GST_EVENT_INFO,
  GST_EVENT_ERROR,
} GstEventType;

The different major types of events.

GST_EVENT_UNKNOWNunknown event.
GST_EVENT_EOSan end-of-stream event.
GST_EVENT_FLUSHa flush event.
GST_EVENT_EMPTYan empty event.
GST_EVENT_SEEKa seek event.
GST_EVENT_DISCONTINUOUSa discontinuous event to indicate the stream has a discontinuity.
GST_EVENT_NEW_MEDIA 
GST_EVENT_INFOan informational event
GST_EVENT_ERRORan error event


GST_EVENT_TYPE()

#define GST_EVENT_TYPE(event)		(GST_EVENT(event)->type)

Get the event type.

event :The event to query.


GST_EVENT_SRC()

#define GST_EVENT_SRC(event)		(GST_EVENT(event)->src)

The source object that generated this event

event :The event to query


GST_EVENT_TIMESTAMP()

#define GST_EVENT_TIMESTAMP(event)	(GST_EVENT(event)->timestamp)

Get the timestamp of the event.

event :The event to query.


enum GstSeekType

typedef enum {
  GST_SEEK_ANY,
  GST_SEEK_TIMEOFFSET_SET,
  GST_SEEK_BYTEOFFSET_SET,
  GST_SEEK_BYTEOFFSET_CUR,
  GST_SEEK_BYTEOFFSET_END,
} GstSeekType;

The different types of seek events.

GST_SEEK_ANYthe seek is performed anyway.
GST_SEEK_TIMEOFFSET_SET 
GST_SEEK_BYTEOFFSET_SET 
GST_SEEK_BYTEOFFSET_CUR 
GST_SEEK_BYTEOFFSET_END 


GST_EVENT_SEEK_TYPE()

#define GST_EVENT_SEEK_TYPE(event)	(GST_EVENT(event)->event_data.seek.type)

Get the seektype of the GST_EVENT_SEEK.

event :The event to query.


GST_EVENT_SEEK_OFFSET()

#define GST_EVENT_SEEK_OFFSET(event)	(GST_EVENT(event)->event_data.seek.offset)

Get the offset of the seek event.

event :The event to query.


GST_EVENT_SEEK_FLUSH()

#define GST_EVENT_SEEK_FLUSH(event)	(GST_EVENT(event)->event_data.seek.flush)

Qeury wether the seek event also needs a flush.

event :The event to query.


GST_EVENT_INFO_PROPS()

#define GST_EVENT_INFO_PROPS(event)	(GST_EVENT(event)->event_data.info.props)

The properties of the info event

event :The event to query


struct GstEvent

struct GstEvent {
  GstData data;

  GstEventType  type;
  guint64	timestamp;
  GstObject	*src;

  union {
    struct {
      GstSeekType type;
      gint64      offset;
      gboolean	  flush;
    } seek;
    struct {
      GstProps *props;
    } info;
    struct {
      GstElementState old_state;
      GstElementState new_state;
    } state;
  } event_data;
};

The event data structure.

GstData dataThe parent data type.
GstEventType typeThe event type.
guint64 timestampThe event timestamp.
GstObject *src 


gst_event_new ()

GstEvent*   gst_event_new                   (GstEventType type);

Allocate a new event of the given type.

type : The type of the new event
Returns : A new event.


gst_event_free ()

void        gst_event_free                  (GstEvent *event);

Free the given element.

event : The event to free


gst_event_new_seek ()

GstEvent*   gst_event_new_seek              (GstSeekType type,
                                             gint64 offset,
                                             gboolean flush);

Allocate a new seek event with the given parameters.

type : The type of the seek event
offset : The offset of the seek
flush : A boolean indicating a flush has to be performed as well
Returns : A new seek event.


gst_event_new_flush()

#define		gst_event_new_flush()	gst_event_new(GST_EVENT_FLUSH)

Create a new flush event.


gst_event_new_info ()

GstEvent*   gst_event_new_info              (const gchar *firstname,
                                             ...);

Allocate a new info event with the given props.

firstname : the first property name
... : properties
Returns : A new info event.

See Also

GstPad