docs/gst/tmpl/gstvalue.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstValue
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 GValue implementations specific to GStreamer
   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_MAKE_FOURCC ##### -->
  21 <para>
  22 will transform four characters into a host-endiannness guint32 fourcc:
  23 <informalexample>
  24 <programlisting>
  25 guint32 fourcc = GST_MAKE_FOURCC ('M','J','P','G');
  26 </programlisting>
  27 </informalexample>
  28 </para>
  29
  30 @a: the first component
  31 @b: the second component
  32 @c: the third component
  33 @d: the fourth component
  34
  35
  36 <!-- ##### MACRO GST_STR_FOURCC ##### -->
  37 <para>
  38 Creates a fourcc from an input string. The input string should consisnt
  39 of at least four characters (this is not checked for!).
  40 <informalexample>
  41 <programlisting>
  42 guint32 fourcc = GST_STR_FOURCC("MJPG");
  43 </programlisting>
  44 </informalexample>
  45 </para>
  46
  47 @f: a string with four characters
  48
  49
  50 <!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
  51 <para>
  52 Can be used to properly output a fourcc (a guint32) value in a
  53 printf()-style text message.
  54 <informalexample>
  55 <programlisting>
  56 printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
  57 </programlisting>
  58 </informalexample>
  59 </para>
  60
  61
  62
  63 <!-- ##### MACRO GST_FOURCC_ARGS ##### -->
  64 <para>
  65 Can be used to properly output a fourcc (a guint32) value in a
  66 printf()-style text message.
  67 <informalexample>
  68 <programlisting>
  69 printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
  70 </programlisting>
  71 </informalexample>
  72 </para>
  73
  74 @fourcc: the fourcc value to print
  75
  76
  77 <!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
  78 <para>
  79 Checks if the give GValue contains a FOURCC value.
  80 </para>
  81
  82 @x: the #GValue to check
  83
  84
  85 <!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
  86 <para>
  87 Checks if the give GValue contains a INT_RANGE value.
  88 </para>
  89
  90 @x: the #GValue to check
  91
  92
  93 <!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
  94 <para>
  95 Checks if the give GValue contains a DOUBLE_RANGE value.
  96 </para>
  97
  98 @x: the #GValue to check
  99
 100
 101 <!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
 102 <para>
 103 Checks if the give GValue contains a LIST value.
 104 </para>
 105
 106 @x: the #GValue to check
 107
 108
 109 <!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
 110 <para>
 111 Checks if the give GValue contains a CAPS value.
 112 </para>
 113
 114 @x: the #GValue to check
 115
 116
 117 <!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
 118 <para>
 119 Checks if the give GValue contains a FRACTION value.
 120 </para>
 121
 122 @x: the #GValue to check
 123
 124
 125 <!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
 126 <para>
 127 Indicates that the first value provided to a comparison function
 128 (gst_value_compare()) is lesser than the second one.
 129 </para>
 130
 131
 132
 133 <!-- ##### MACRO GST_VALUE_EQUAL ##### -->
 134 <para>
 135 Indicates that the first value provided to a comparison function
 136 (gst_value_compare()) is equal to the second one.
 137 </para>
 138
 139
 140
 141 <!-- ##### MACRO GST_VALUE_GREATER_THAN ##### -->
 142 <para>
 143 Indicates that the first value provided to a comparison function
 144 (gst_value_compare()) is greater than the second one.
 145 </para>
 146
 147
 148
 149 <!-- ##### MACRO GST_VALUE_UNORDERED ##### -->
 150 <para>
 151 Indicates that the comparison function (gst_value_compare()) can not
 152 determine a order for the two provided values.
 153 </para>
 154
 155
 156
 157 <!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @value1:
 163 @value2:
 164 @Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL,
 165 GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
 166
 167
 168 <!-- ##### USER_FUNCTION GstValueSerializeFunc ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @value1:
 174 @Returns:
 175
 176
 177 <!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @dest:
 183 @s:
 184 @Returns:
 185
 186
 187 <!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @dest:
 193 @value1:
 194 @value2:
 195 @Returns:
 196
 197
 198 <!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @dest:
 204 @value1:
 205 @value2:
 206 @Returns:
 207
 208
 209 <!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @dest:
 215 @minuend:
 216 @subtrahend:
 217 @Returns:
 218
 219
 220 <!-- ##### STRUCT GstValueTable ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @type:
 226 @compare:
 227 @serialize:
 228 @deserialize:
 229
 230 <!-- ##### FUNCTION gst_value_is_fixed ##### -->
 231 <para>
 232
 233 </para>
 234
 235 @value:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION gst_value_register ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @table:
 245
 246
 247 <!-- ##### FUNCTION gst_value_init_and_copy ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @dest:
 253 @src:
 254
 255
 256 <!-- ##### FUNCTION gst_value_serialize ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @value:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION gst_value_deserialize ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @dest:
 271 @src:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION gst_value_list_append_value ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @value:
 281 @append_value:
 282
 283
 284 <!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @value:
 290 @prepend_value:
 291
 292
 293 <!-- ##### FUNCTION gst_value_list_concat ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @dest:
 299 @value1:
 300 @value2:
 301
 302
 303 <!-- ##### FUNCTION gst_value_list_get_size ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @value:
 309 @Returns:
 310
 311
 312 <!-- ##### FUNCTION gst_value_list_get_value ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @value:
 318 @index:
 319 @Returns:
 320
 321
 322 <!-- ##### FUNCTION gst_value_set_fourcc ##### -->
 323 <para>
 324
 325 </para>
 326
 327 @value:
 328 @fourcc:
 329
 330
 331 <!-- ##### FUNCTION gst_value_get_fourcc ##### -->
 332 <para>
 333
 334 </para>
 335
 336 @value:
 337 @Returns:
 338
 339
 340 <!-- ##### FUNCTION gst_value_set_int_range ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @value:
 346 @start:
 347 @end:
 348
 349
 350 <!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @value:
 356 @Returns:
 357
 358
 359 <!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @value:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION gst_value_set_double_range ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @value:
 374 @start:
 375 @end:
 376
 377
 378 <!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @value:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @value:
 393 @Returns:
 394
 395
 396 <!-- ##### FUNCTION gst_value_get_caps ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @value:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION gst_value_set_caps ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @value:
 411 @caps:
 412 <!-- # Unused Parameters # -->
 413 @calue:
 414
 415
 416 <!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
 417 <para>
 418
 419 </para>
 420
 421 @value:
 422 @Returns:
 423
 424
 425 <!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @value:
 431 @Returns:
 432
 433
 434 <!-- ##### FUNCTION gst_value_set_fraction ##### -->
 435 <para>
 436
 437 </para>
 438
 439 @value:
 440 @numerator:
 441 @denominator:
 442
 443
 444 <!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
 445 <para>
 446
 447 </para>
 448
 449 @product:
 450 @factor1:
 451 @factor2:
 452 @Returns:
 453
 454
 455 <!-- ##### FUNCTION gst_value_compare ##### -->
 456 <para>
 457
 458 </para>
 459
 460 @value1:
 461 @value2:
 462 @Returns:
 463
 464
 465 <!-- ##### FUNCTION gst_value_can_compare ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @value1:
 471 @value2:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gst_value_union ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @dest:
 481 @value1:
 482 @value2:
 483 @Returns:
 484
 485
 486 <!-- ##### FUNCTION gst_value_can_union ##### -->
 487 <para>
 488
 489 </para>
 490
 491 @value1:
 492 @value2:
 493 @Returns:
 494
 495
 496 <!-- ##### FUNCTION gst_value_register_union_func ##### -->
 497 <para>
 498
 499 </para>
 500
 501 @type1:
 502 @type2:
 503 @func:
 504
 505
 506 <!-- ##### FUNCTION gst_value_subtract ##### -->
 507 <para>
 508
 509 </para>
 510
 511 @dest:
 512 @minuend:
 513 @subtrahend:
 514 @Returns:
 515
 516
 517 <!-- ##### FUNCTION gst_value_can_subtract ##### -->
 518 <para>
 519
 520 </para>
 521
 522 @minuend:
 523 @subtrahend:
 524 @Returns:
 525
 526
 527 <!-- ##### FUNCTION gst_value_register_subtract_func ##### -->
 528 <para>
 529
 530 </para>
 531
 532 @minuend_type:
 533 @subtrahend_type:
 534 @func:
 535
 536
 537 <!-- ##### FUNCTION gst_value_intersect ##### -->
 538 <para>
 539
 540 </para>
 541
 542 @dest:
 543 @value1:
 544 @value2:
 545 @Returns:
 546
 547
 548 <!-- ##### FUNCTION gst_value_can_intersect ##### -->
 549 <para>
 550
 551 </para>
 552
 553 @value1:
 554 @value2:
 555 @Returns:
 556
 557
 558 <!-- ##### FUNCTION gst_value_register_intersect_func ##### -->
 559 <para>
 560
 561 </para>
 562
 563 @type1:
 564 @type2:
 565 @func:
 566
 567