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:
  42 @GST_EVENT_ERROR:
  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_TIMESTAMP ##### -->
  53 <para>
  54 Get the timestamp of the event.
  55 </para>
  56
  57 @event: The event to query.
  58
  59
  60 <!-- ##### ENUM GstSeekType ##### -->
  61 <para>
  62 The different types of seek events.
  63 </para>
  64
  65 @GST_SEEK_ANY: the seek is performed anyway.
  66 @GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset
  67 @GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset
  68
  69 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
  70 <para>
  71 Get the seektype of the GST_EVENT_SEEK.
  72 </para>
  73
  74 @event: The event to query.
  75
  76
  77 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
  78 <para>
  79 Get the offset of the seek event.
  80 </para>
  81
  82 @event: The event to query.
  83
  84
  85 <!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
  86 <para>
  87 Qeury wether the seek event also needs a flush.
  88 </para>
  89
  90 @event: The event to query.
  91
  92
  93 <!-- ##### STRUCT GstEvent ##### -->
  94 <para>
  95 The event data structure.
  96 </para>
  97
  98 @data: The parent data type.
  99 @type: The event type.
 100 @timestamp: The event timestamp.
 101 @src:
 102
 103 <!-- ##### FUNCTION gst_event_new ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @type:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gst_event_free ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @event:
 118
 119
 120 <!-- ##### FUNCTION gst_event_new_seek ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @type:
 126 @offset:
 127 @flush:
 128 @Returns:
 129
 130
 131 <!-- ##### MACRO gst_event_new_flush ##### -->
 132 <para>
 133 Create a new flush event.
 134 </para>
 135
 136
 137