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 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### ENUM GstEventType ##### -->
  18 <para>
  19 The different major types of events.
  20 </para>
  21
  22 @GST_EVENT_UNKNOWN: unknown event.
  23 @GST_EVENT_EOS: an end-of-stream event.
  24 @GST_EVENT_FLUSH: a flush event.
  25 @GST_EVENT_EMPTY: an empty event.
  26 @GST_EVENT_SEEK: a seek event.
  27 @GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
  28
  29 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
  30 <para>
  31 Get the event type.
  32 </para>
  33
  34 @event: The event to query.
  35
  36
  37 <!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
  38 <para>
  39 Get the timestamp of the event.
  40 </para>
  41
  42 @event: The event to query.
  43
  44
  45 <!-- ##### ENUM GstSeekType ##### -->
  46 <para>
  47 The different types of seek events.
  48 </para>
  49
  50 @GST_SEEK_ANY: the seek is performed anyway.
  51 @GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset
  52 @GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset
  53
  54 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
  55 <para>
  56 Get the seektype of the GST_EVENT_SEEK.
  57 </para>
  58
  59 @event: The event to query.
  60
  61
  62 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
  63 <para>
  64 Get the offset of the seek event.
  65 </para>
  66
  67 @event: The event to query.
  68
  69
  70 <!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
  71 <para>
  72 Qeury wether the seek event also needs a flush.
  73 </para>
  74
  75 @event: The event to query.
  76
  77
  78 <!-- ##### STRUCT GstEvent ##### -->
  79 <para>
  80 The event data structure.
  81 </para>
  82
  83 @data: The parent data type.
  84 @type: The event type.
  85 @timestamp: The event timestamp.
  86
  87 <!-- ##### FUNCTION gst_event_new ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @type:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION gst_event_free ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @event:
 102
 103
 104 <!-- ##### FUNCTION gst_event_new_seek ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @type:
 110 @offset:
 111 @flush:
 112 @Returns:
 113
 114
 115 <!-- ##### MACRO gst_event_new_flush ##### -->
 116 <para>
 117
 118 </para>
 119
 120
 121