docs/libs/tmpl/gstringbuffer.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 gstringbuffer
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 an implementation of an audio ringbuffer
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### STRUCT GstRingBuffer ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @cond:
  23 @acquired:
  24 @data:
  25 @spec:
  26 @segstate:
  27 @samples_per_seg:
  28 @empty_seg:
  29 @state:
  30 @segplayed:
  31 @waiting:
  32
  33 <!-- ##### STRUCT GstRingBufferClass ##### -->
  34 <para>
  35
  36 </para>
  37
  38 @parent_class:
  39 @acquire:
  40 @release:
  41 @play:
  42 @pause:
  43 @resume:
  44 @stop:
  45 @delay:
  46
  47 <!-- ##### FUNCTION gst_ringbuffer_set_callback ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @buf:
  53 @cb:
  54 @user_data:
  55
  56
  57 <!-- ##### FUNCTION gst_ringbuffer_acquire ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @buf:
  63 @spec:
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION gst_ringbuffer_release ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @buf:
  73 @Returns:
  74
  75
  76 <!-- ##### FUNCTION gst_ringbuffer_is_acquired ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @buf:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION gst_ringbuffer_play ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @buf:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION gst_ringbuffer_pause ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @buf:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gst_ringbuffer_stop ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @buf:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gst_ringbuffer_delay ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @buf:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION gst_ringbuffer_played_samples ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @buf:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION gst_ringbuffer_set_sample ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @buf:
 136 @sample:
 137
 138
 139 <!-- ##### FUNCTION gst_ringbuffer_commit ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @buf:
 145 @sample:
 146 @data:
 147 @len:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION gst_ringbuffer_prepare_read ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @buf:
 157 @segment:
 158 @readptr:
 159 @len:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION gst_ringbuffer_clear ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @buf:
 169 @segment:
 170
 171
 172 <!-- ##### FUNCTION gst_ringbuffer_advance ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @buf:
 178 @advance:
 179
 180