docs/gst/tmpl/gstutils.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstUtils
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 various utility functions
   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 <!-- ##### MACRO GST_BOILERPLATE_WITH_INTERFACE ##### -->
  21 <para>
  22
  23 </para>
  24
  25 @type:
  26 @type_as_function:
  27 @parent_type:
  28 @\
  29     parent_type_as_macro:
  30 @\
  31     parent_type_as_macro:
  32 @\
  33     parent_type_as_macro:
  34 @\
  35     parent_type_as_macro:
  36 @\
  37     parent_type_as_macro:
  38 @\
  39     parent_type_as_macro:
  40 @\
  41     parent_type_as_macro:
  42 @\
  43     parent_type_as_macro:
  44 @\
  45     parent_type_as_macro:
  46 @\
  47     parent_type_as_macro:
  48 @\
  49     parent_type_as_macro:
  50 @\
  51     parent_type_as_macro:
  52 @\
  53     parent_type_as_macro:
  54 @\
  55     parent_type_as_macro:
  56 @\
  57     parent_type_as_macro:
  58 @\
  59     parent_type_as_macro:
  60 @\
  61     parent_type_as_macro:
  62 @interface_type:
  63 @interface_type_as_macro:
  64 @\
  65     interface_as_function:
  66 @\
  67     interface_as_function:
  68 @\
  69     interface_as_function:
  70 @\
  71     interface_as_function:
  72 @\
  73     interface_as_function:
  74 @\
  75     interface_as_function:
  76 @\
  77     interface_as_function:
  78 @\
  79     interface_as_function:
  80 @\
  81     interface_as_function:
  82 @\
  83     interface_as_function:
  84 @\
  85     interface_as_function:
  86 @\
  87     interface_as_function:
  88 @\
  89     interface_as_function:
  90 @\
  91     interface_as_function:
  92 @\
  93     interface_as_function:
  94 @\
  95     interface_as_function:
  96 @\
  97     interface_as_function:
  98
  99
 100 <!-- ##### MACRO GST_BOILERPLATE_FULL ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @type:
 106 @type_as_function:
 107 @parent_type:
 108 @parent_type_macro:
 109 @additional_initializations:
 110
 111
 112 <!-- ##### MACRO GST_BOILERPLATE ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @type:
 118 @type_as_function:
 119 @parent_type:
 120 @parent_type_macro:
 121
 122
 123 <!-- ##### MACRO GST_CALL_PARENT ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @parent_class_cast:
 129 @name:
 130 @args:
 131
 132
 133 <!-- ##### MACRO GST_CALL_PARENT_WITH_DEFAULT ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @parent_class_cast:
 139 @name:
 140 @args:
 141 @def_return:
 142
 143
 144 <!-- ##### MACRO GST_READ_UINT8 ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @data:
 150
 151
 152 <!-- ##### MACRO GST_READ_UINT16_LE ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @data:
 158
 159
 160 <!-- ##### MACRO GST_READ_UINT16_BE ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @data:
 166
 167
 168 <!-- ##### MACRO GST_READ_UINT32_LE ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @data:
 174
 175
 176 <!-- ##### MACRO GST_READ_UINT32_BE ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @data:
 182
 183
 184 <!-- ##### MACRO GST_READ_UINT64_LE ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @data:
 190
 191
 192 <!-- ##### MACRO GST_READ_UINT64_BE ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @data:
 198
 199
 200 <!-- ##### MACRO GST_WRITE_UINT8 ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @data:
 206 @num:
 207
 208
 209 <!-- ##### MACRO GST_WRITE_UINT16_LE ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @data:
 215 @num:
 216
 217
 218 <!-- ##### MACRO GST_WRITE_UINT16_BE ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @data:
 224 @num:
 225
 226
 227 <!-- ##### MACRO GST_WRITE_UINT32_LE ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @data:
 233 @num:
 234
 235
 236 <!-- ##### MACRO GST_WRITE_UINT32_BE ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @data:
 242 @num:
 243
 244
 245 <!-- ##### MACRO GST_WRITE_UINT64_LE ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @data:
 251 @num:
 252
 253
 254 <!-- ##### MACRO GST_WRITE_UINT64_BE ##### -->
 255 <para>
 256
 257 </para>
 258
 259 @data:
 260 @num:
 261
 262
 263 <!-- ##### MACRO GST_ROUND_UP_2 ##### -->
 264 <para>
 265
 266 </para>
 267
 268 @num:
 269
 270
 271 <!-- ##### MACRO GST_ROUND_UP_4 ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @num:
 277
 278
 279 <!-- ##### MACRO GST_ROUND_UP_8 ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @num:
 285
 286
 287 <!-- ##### MACRO GST_ROUND_UP_16 ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @num:
 293
 294
 295 <!-- ##### MACRO GST_ROUND_UP_32 ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @num:
 301
 302
 303 <!-- ##### MACRO GST_ROUND_UP_64 ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @num:
 309
 310
 311 <!-- ##### FUNCTION gst_atomic_int_set ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @atomic_int:
 317 @value:
 318
 319
 320 <!-- ##### FUNCTION gst_bin_watch_for_state_change ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @bin:
 326
 327
 328 <!-- ##### FUNCTION gst_flow_get_name ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @ret:
 334 @Returns:
 335
 336
 337 <!-- ##### FUNCTION gst_print_element_args ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @buf:
 343 @indent:
 344 @element:
 345
 346
 347 <!-- ##### FUNCTION gst_print_pad_caps ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @buf:
 353 @indent:
 354 @pad:
 355
 356
 357 <!-- ##### FUNCTION gst_util_dump_mem ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @mem:
 363 @size:
 364
 365
 366 <!-- ##### FUNCTION gst_util_set_object_arg ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @object:
 372 @name:
 373 @value:
 374
 375
 376 <!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
 377 <para>
 378
 379 </para>
 380
 381 @value:
 382 @value_str:
 383
 384