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 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### STRUCT GstRingBuffer ##### -->
  21 <para>
  22
  23 </para>
  24
  25 @cond:
  26 @open:
  27 @acquired:
  28 @data:
  29 @spec:
  30 @segstate:
  31 @samples_per_seg:
  32 @empty_seg:
  33 @state:
  34 @segdone:
  35 @segbase:
  36 @waiting:
  37
  38 <!-- ##### STRUCT GstRingBufferSpec ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @caps:
  44 @type:
  45 @format:
  46 @sign:
  47 @bigend:
  48 @width:
  49 @depth:
  50 @rate:
  51 @channels:
  52 @latency_time:
  53 @buffer_time:
  54 @segsize:
  55 @segtotal:
  56 @bytes_per_sample:
  57 @silence_sample:
  58
  59 <!-- ##### STRUCT GstRingBufferClass ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @parent_class:
  65 @open_device:
  66 @acquire:
  67 @release:
  68 @close_device:
  69 @start:
  70 @pause:
  71 @resume:
  72 @stop:
  73 @delay:
  74
  75 <!-- ##### FUNCTION gst_ring_buffer_set_callback ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @buf:
  81 @cb:
  82 @user_data:
  83
  84
  85 <!-- ##### FUNCTION gst_ring_buffer_acquire ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @buf:
  91 @spec:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION gst_ring_buffer_release ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @buf:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION gst_ring_buffer_is_acquired ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @buf:
 110 @Returns:
 111
 112
 113 <!-- ##### FUNCTION gst_ring_buffer_start ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @buf:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gst_ring_buffer_pause ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @buf:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gst_ring_buffer_stop ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @buf:
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION gst_ring_buffer_delay ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @buf:
 146 @Returns:
 147
 148
 149 <!-- ##### FUNCTION gst_ring_buffer_samples_done ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @buf:
 155 @Returns:
 156
 157
 158 <!-- ##### FUNCTION gst_ring_buffer_set_sample ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @buf:
 164 @sample:
 165
 166
 167 <!-- ##### FUNCTION gst_ring_buffer_commit ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @buf:
 173 @sample:
 174 @data:
 175 @len:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION gst_ring_buffer_prepare_read ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @buf:
 185 @segment:
 186 @readptr:
 187 @len:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION gst_ring_buffer_clear ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @buf:
 197 @segment:
 198
 199
 200 <!-- ##### FUNCTION gst_ring_buffer_advance ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @buf:
 206 @advance:
 207
 208