docs/gst/tmpl/gstevent.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstEvent
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Event definitions.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The event classes are used to construct and query events.
  10 </para>
  11
  12 <para>
  13 Events are usually created with gst_event_new() which takes the event type as an argument.
  14 properties specific to the event can be set afterwards with the provided macros.
  15 The event is freed with gst_event_free().
  16 </para>
  17 <para>
  18 gst_event_new_seek() is a usually used to create a seek event and it takes the
  19 needed parameters for a seek event.
  20 </para>
  21 <para>
  22 gst_event_new_flush() creates a new flush event.
  23 </para>
  24
  25 <!-- ##### SECTION See_Also ##### -->
  26 <para>
  27 #GstPad
  28 </para>
  29
  30 <!-- ##### ENUM GstEventType ##### -->
  31 <para>
  32 The different major types of events.
  33 </para>
  34
  35 @GST_EVENT_UNKNOWN: unknown event.
  36 @GST_EVENT_EOS: an end-of-stream event.
  37 @GST_EVENT_FLUSH: a flush event.
  38 @GST_EVENT_EMPTY: an empty event.
  39 @GST_EVENT_SEEK: a seek event.
  40 @GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
  41 @GST_EVENT_INFO: an informational event
  42 @GST_EVENT_ERROR: an error event
  43
  44 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
  45 <para>
  46 Get the event type.
  47 </para>
  48
  49 @event: The event to query.
  50
  51
  52 <!-- ##### MACRO GST_EVENT_SRC ##### -->
  53 <para>
  54 The source object that generated this event
  55 </para>
  56
  57 @event: The event to query
  58
  59
  60 <!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
  61 <para>
  62 Get the timestamp of the event.
  63 </para>
  64
  65 @event: The event to query.
  66
  67
  68 <!-- ##### ENUM GstSeekType ##### -->
  69 <para>
  70 The different types of seek events.
  71 </para>
  72
  73 @GST_SEEK_ANY: the seek is performed anyway.
  74 @GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset
  75 @GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset
  76
  77 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
  78 <para>
  79 Get the seektype of the GST_EVENT_SEEK.
  80 </para>
  81
  82 @event: The event to query.
  83
  84
  85 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
  86 <para>
  87 Get the offset of the seek event.
  88 </para>
  89
  90 @event: The event to query.
  91
  92
  93 <!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
  94 <para>
  95 Qeury wether the seek event also needs a flush.
  96 </para>
  97
  98 @event: The event to query.
  99
 100
 101 <!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
 102 <para>
 103 The properties of the info event
 104 </para>
 105
 106 @event: The event to query
 107
 108
 109 <!-- ##### STRUCT GstEvent ##### -->
 110 <para>
 111 The event data structure.
 112 </para>
 113
 114 @data: The parent data type.
 115 @type: The event type.
 116 @timestamp: The event timestamp.
 117 @src:
 118
 119 <!-- ##### FUNCTION gst_event_new ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @type:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION gst_event_free ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @event:
 134
 135
 136 <!-- ##### FUNCTION gst_event_new_seek ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @type:
 142 @offset:
 143 @flush:
 144 @Returns:
 145
 146
 147 <!-- ##### MACRO gst_event_new_flush ##### -->
 148 <para>
 149 Create a new flush event.
 150 </para>
 151
 152
 153
 154 <!-- ##### FUNCTION gst_event_new_info ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @firstname:
 160 @Varargs:
 161 @Returns:
 162
 163