docs/gst/tmpl/gstprops.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstProps
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Properties
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GstProps is used to attach certain properties to a pad. Properties
  10 are usually used in conjunction with GstCaps.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15 #GstCaps
  16 </para>
  17
  18 <!-- ##### STRUCT GstProps ##### -->
  19 <para>
  20
  21 </para>
  22
  23 @refcount: a refcount for this struct
  24 @fixed: indicates that this props has no lists or ranges
  25 @properties: the properties
  26
  27 <!-- ##### STRUCT GstPropsEntry ##### -->
  28 <para>
  29
  30 </para>
  31
  32
  33 <!-- ##### ENUM GstPropsType ##### -->
  34 <para>
  35
  36 </para>
  37
  38 @GST_PROPS_END_TYPE:
  39 @GST_PROPS_INVALID_TYPE:
  40 @GST_PROPS_INT_TYPE:
  41 @GST_PROPS_FLOAT_TYPE:
  42 @GST_PROPS_FOURCC_TYPE:
  43 @GST_PROPS_BOOL_TYPE:
  44 @GST_PROPS_STRING_TYPE:
  45 @GST_PROPS_VAR_TYPE:
  46 @GST_PROPS_LIST_TYPE:
  47 @GST_PROPS_FLOAT_RANGE_TYPE:
  48 @GST_PROPS_INT_RANGE_TYPE:
  49 @GST_PROPS_LAST_TYPE:
  50
  51 <!-- ##### MACRO GST_TYPE_PROPS ##### -->
  52 <para>
  53 The GType of the props boxed type, for use in GValues.
  54 </para>
  55
  56
  57
  58 <!-- ##### MACRO GST_MAKE_FOURCC ##### -->
  59 <para>
  60 Create a FOURCC value that can easily be used to construct
  61 a fourcc property.
  62 <programlisting>
  63   ...
  64   "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('Y','U','Y','2')),
  65   ...
  66 </programlisting>
  67 </para>
  68
  69 @a: first fourcc byte
  70 @b: second fourcc byte
  71 @c: third fourcc byte
  72 @d: fourth fourcc byte
  73
  74
  75 <!-- ##### MACRO GST_STR_FOURCC ##### -->
  76 <para>
  77 Create a FOURCC value from a string. example:
  78 <programlisting>
  79   ...
  80   "format", GST_PROPS_FOURCC (GST_STR_FOURCC ("YUY2")),
  81   ...
  82 </programlisting>
  83 </para>
  84
  85 @f: the string describing the fourcc value.
  86
  87
  88 <!-- ##### MACRO GST_PROPS_LIST ##### -->
  89 <para>
  90 Create a list of properties.
  91 </para>
  92
  93 @a...: the list of GstProps
  94
  95
  96 <!-- ##### MACRO GST_PROPS_INT ##### -->
  97 <para>
  98 Create an integer property.
  99 </para>
 100
 101 @a: the integer property
 102
 103
 104 <!-- ##### MACRO GST_PROPS_INT_ANY ##### -->
 105 <para>
 106 Create an integer property that can hold any int.
 107 </para>
 108
 109
 110
 111 <!-- ##### MACRO GST_PROPS_INT_RANGE ##### -->
 112 <para>
 113 Create an integer range property.
 114 </para>
 115
 116 @a: the min value for the range
 117 @b: the max value for the range
 118
 119
 120 <!-- ##### MACRO GST_PROPS_INT_NEGATIVE ##### -->
 121 <para>
 122 Create an integer property that can hold negative ints.
 123 </para>
 124
 125
 126
 127 <!-- ##### MACRO GST_PROPS_FOURCC ##### -->
 128 <para>
 129 Construct a fourcc property out of four bytes.
 130 </para>
 131
 132 @a: a fourcc value usualy created with GST_FOURCC_MAKE ()
 133
 134
 135 <!-- ##### MACRO GST_PROPS_BOOLEAN ##### -->
 136 <para>
 137 Create a boolean property.
 138 </para>
 139
 140 @a: the boolean property
 141
 142
 143 <!-- ##### MACRO GST_PROPS_STRING ##### -->
 144 <para>
 145 Create a string value.
 146 </para>
 147
 148 @a: the string value.
 149
 150
 151 <!-- ##### MACRO GST_PROPS_FLOAT ##### -->
 152 <para>
 153 Create a floating point value.
 154 </para>
 155
 156 @a: the float value
 157
 158
 159 <!-- ##### MACRO GST_PROPS_FLOAT_RANGE ##### -->
 160 <para>
 161 Create a float range value.
 162 </para>
 163
 164 @a: lower float bounds
 165 @b: upper float bounds
 166
 167
 168 <!-- ##### MACRO GST_PROPS_INT_POSITIVE ##### -->
 169 <para>
 170 Create an integer property that can hold positive ints.
 171 </para>
 172
 173
 174
 175 <!-- ##### FUNCTION gst_props_new ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @firstname:
 181 @Varargs:
 182 @Returns:
 183
 184
 185 <!-- ##### FUNCTION gst_props_newv ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @firstname:
 191 @var_args:
 192 @Returns:
 193
 194
 195 <!-- ##### FUNCTION gst_props_merge ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @props:
 201 @tomerge:
 202 @Returns:
 203
 204
 205 <!-- ##### FUNCTION gst_props_copy ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @props:
 211 @Returns:
 212
 213
 214 <!-- ##### FUNCTION gst_props_copy_on_write ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @props:
 220 @Returns:
 221
 222
 223 <!-- ##### FUNCTION gst_props_destroy ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @props:
 229
 230
 231 <!-- ##### FUNCTION gst_props_ref ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @props:
 237
 238
 239 <!-- ##### FUNCTION gst_props_unref ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @props:
 245
 246
 247 <!-- ##### FUNCTION gst_props_check_compatibility ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @fromprops:
 253 @toprops:
 254 @Returns:
 255 <!-- # Unused Parameters # -->
 256 @props1:
 257 @props2:
 258
 259
 260 <!-- ##### FUNCTION gst_props_has_property ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @props:
 266 @name:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION gst_props_normalize ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @props:
 276 @Returns:
 277
 278
 279 <!-- ##### FUNCTION gst_props_set ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @props:
 285 @name:
 286 @Varargs:
 287 @Returns:
 288 <!-- # Unused Parameters # -->
 289 @entry:
 290 @value:
 291
 292
 293 <!-- ##### FUNCTION gst_props_get ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @props:
 299 @first_name:
 300 @Varargs:
 301 @Returns:
 302
 303
 304 <!-- ##### FUNCTION gst_props_has_fixed_property ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @props:
 310 @name:
 311 @Returns:
 312
 313
 314 <!-- ##### FUNCTION gst_props_has_property_typed ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @props:
 320 @name:
 321 @type:
 322 @Returns:
 323
 324
 325 <!-- ##### FUNCTION gst_props_intersect ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @props1:
 331 @props2:
 332 @Returns:
 333
 334
 335 <!-- ##### FUNCTION gst_props_debug ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @props:
 341
 342
 343 <!-- ##### FUNCTION gst_props_save_thyself ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @props:
 349 @parent:
 350 @Returns:
 351
 352
 353 <!-- ##### FUNCTION gst_props_load_thyself ##### -->
 354 <para>
 355
 356 </para>
 357
 358 @parent:
 359 @Returns:
 360
 361
 362 <!-- ##### FUNCTION gst_props_get_entry ##### -->
 363 <para>
 364
 365 </para>
 366
 367 @props:
 368 @name:
 369 @Returns:
 370
 371
 372 <!-- ##### FUNCTION gst_props_entry_get ##### -->
 373 <para>
 374
 375 </para>
 376
 377 @entry:
 378 @Varargs:
 379 @Returns:
 380 <!-- # Unused Parameters # -->
 381 @props:
 382
 383
 384 <!-- ##### FUNCTION gst_props_entry_get_boolean ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @entry:
 390 @val:
 391 @Returns:
 392
 393
 394 <!-- ##### FUNCTION gst_props_entry_get_float ##### -->
 395 <para>
 396
 397 </para>
 398
 399 @entry:
 400 @val:
 401 @Returns:
 402
 403
 404 <!-- ##### FUNCTION gst_props_entry_get_float_range ##### -->
 405 <para>
 406
 407 </para>
 408
 409 @entry:
 410 @min:
 411 @max:
 412 @Returns:
 413
 414
 415 <!-- ##### FUNCTION gst_props_entry_get_fourcc_int ##### -->
 416 <para>
 417
 418 </para>
 419
 420 @entry:
 421 @val:
 422 @Returns:
 423
 424
 425 <!-- ##### FUNCTION gst_props_entry_get_int ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @entry:
 431 @val:
 432 @Returns:
 433
 434
 435 <!-- ##### FUNCTION gst_props_entry_get_int_range ##### -->
 436 <para>
 437
 438 </para>
 439
 440 @entry:
 441 @min:
 442 @max:
 443 @Returns:
 444
 445
 446 <!-- ##### FUNCTION gst_props_entry_get_list ##### -->
 447 <para>
 448
 449 </para>
 450
 451 @entry:
 452 @val:
 453 @Returns:
 454
 455
 456 <!-- ##### FUNCTION gst_props_entry_get_name ##### -->
 457 <para>
 458
 459 </para>
 460
 461 @entry:
 462 @Returns:
 463
 464
 465 <!-- ##### FUNCTION gst_props_entry_get_string ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @entry:
 471 @val:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gst_props_entry_get_type ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @entry:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION gst_props_entry_is_fixed ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @entry:
 490 @Returns:
 491
 492