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