docs/gst/tmpl/gstpad.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstPad
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The connection between Elements
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Elements are connected to each other via "pads", which are extremely light-weight generic
  10 connections.
  11
  12 </para>
  13
  14 <!-- ##### SECTION See_Also ##### -->
  15 <para>
  16
  17 </para>
  18
  19 <!-- ##### MACRO GST_PAD_CONNECTED ##### -->
  20 <para>
  21 is this pad connected
  22 </para>
  23
  24 @pad: the pad to check
  25
  26
  27 <!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
  28 <para>
  29 can this pad be used to pull a buffer
  30 </para>
  31
  32 @pad: the pad to check
  33
  34
  35 <!-- ##### STRUCT GstPad ##### -->
  36 <para>
  37
  38 </para>
  39
  40
  41 <!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
  42 <para>
  43 The function that will be called when chaining buffers.
  44 </para>
  45
  46 @pad: the pad that performed the chain
  47 @buf: the buffer that is chained
  48
  49
  50 <!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
  51 <para>
  52 The function that will be called when pulling a buffer.
  53 </para>
  54
  55 @pad: the pad to get a buffer from
  56 @Returns: a GstBuffer
  57
  58
  59 <!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
  60 <para>
  61 The function that will be called when pulling a region buffer.
  62 </para>
  63
  64 @pad: the pad to get a buffer from
  65 @offset: the offset of the region to get
  66 @size: the size of the region to get
  67 @Returns: a GstBuffer
  68
  69
  70 <!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
  71 <para>
  72 the function that will be called when a QoS message is sent.
  73 </para>
  74
  75 @pad: the pad that sent the QoS message
  76 @qos_message: the message
  77
  78
  79 <!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @pad:
  85 @Returns:
  86
  87
  88 <!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
  89 <para>
  90
  91 The function that will be called when pushing a buffers.
  92 </para>
  93
  94 @pad: the pad to push
  95 @buf: a GstBuffer to push
  96
  97
  98 <!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
  99 <para>
 100 The function that will be called when pulling buffers.
 101 </para>
 102
 103 @pad: the pad to pull
 104 @Returns: a GstBuffer
 105
 106
 107 <!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
 108 <para>
 109 The function that will be called when pulling a region buffer.
 110 </para>
 111
 112 @pad: the pad to pull
 113 @offset: the offset of the region to pull
 114 @size: the size of the region to pull
 115 @Returns: a GstBuffer
 116
 117
 118 <!-- ##### ENUM GstPadDirection ##### -->
 119 <para>
 120 The direction this pad is
 121 </para>
 122
 123 @GST_PAD_UNKNOWN: direction is unknown
 124 @GST_PAD_SRC: this is a source pad
 125 @GST_PAD_SINK: this is a sink pad
 126
 127 <!-- ##### ENUM GstPadFlags ##### -->
 128 <para>
 129 Flags for the pad
 130 </para>
 131
 132 @GST_PAD_DISABLED: the pad is disabled
 133 @GST_PAD_EOS: the pad is in end of stream state
 134 @GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags
 135
 136 <!-- ##### FUNCTION gst_pad_new ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @name:
 142 @direction:
 143 @Returns:
 144
 145
 146 <!-- ##### MACRO gst_pad_destroy ##### -->
 147 <para>
 148 Destroy the pad
 149 </para>
 150
 151 @pad: the pad to destroy
 152
 153
 154 <!-- ##### FUNCTION gst_pad_new_from_template ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @temp:
 160 @name:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION gst_pad_get_direction ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @pad:
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @pad:
 179 @chain:
 180
 181
 182 <!-- ##### FUNCTION gst_pad_set_get_function ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @pad:
 188 @get:
 189
 190
 191 <!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @pad:
 197 @getregion:
 198
 199
 200 <!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @pad:
 206 @qos:
 207
 208
 209 <!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @pad:
 215 @eos:
 216
 217
 218 <!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @pad:
 224 @caps:
 225
 226
 227 <!-- ##### FUNCTION gst_pad_get_caps_list ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @pad:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION gst_pad_get_caps_by_name ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @pad:
 242 @name:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @srcpad:
 252 @sinkpad:
 253 @Returns:
 254
 255
 256 <!-- ##### FUNCTION gst_pad_set_name ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @pad:
 262 @name:
 263
 264
 265 <!-- ##### FUNCTION gst_pad_get_name ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @pad:
 271 @Returns:
 272
 273
 274 <!-- ##### FUNCTION gst_pad_set_parent ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @pad:
 280 @parent:
 281
 282
 283 <!-- ##### FUNCTION gst_pad_get_parent ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @pad:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION gst_pad_add_ghost_parent ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @pad:
 298 @parent:
 299
 300
 301 <!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @pad:
 307 @parent:
 308
 309
 310 <!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @pad:
 316 @Returns:
 317
 318
 319 <!-- ##### FUNCTION gst_pad_get_peer ##### -->
 320 <para>
 321
 322 </para>
 323
 324 @pad:
 325 @Returns:
 326
 327
 328 <!-- ##### FUNCTION gst_pad_connect ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @srcpad:
 334 @sinkpad:
 335
 336
 337 <!-- ##### FUNCTION gst_pad_disconnect ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @srcpad:
 343 @sinkpad:
 344
 345
 346 <!-- ##### FUNCTION gst_pad_push ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @pad:
 352 @buffer:
 353
 354
 355 <!-- ##### FUNCTION gst_pad_pull ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @pad:
 361 @Returns:
 362
 363
 364 <!-- ##### FUNCTION gst_pad_pull_region ##### -->
 365 <para>
 366
 367 </para>
 368
 369 @pad:
 370 @offset:
 371 @size:
 372 @Returns:
 373
 374
 375 <!-- ##### MACRO gst_pad_pullregion ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @pad:
 381 @offset:
 382 @size:
 383
 384
 385 <!-- ##### FUNCTION gst_pad_handle_qos ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @pad:
 391 @qos_message:
 392
 393
 394 <!-- ##### FUNCTION gst_pad_set_eos ##### -->
 395 <para>
 396
 397 </para>
 398
 399 @pad:
 400 @Returns:
 401
 402
 403 <!-- ##### MACRO gst_pad_eos ##### -->
 404 <para>
 405
 406 </para>
 407
 408 @pad:
 409
 410
 411 <!-- ##### FUNCTION gst_pad_save_thyself ##### -->
 412 <para>
 413
 414 </para>
 415
 416 @pad:
 417 @parent:
 418 @Returns:
 419
 420
 421 <!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @parent:
 427 @element:
 428 @elements:
 429
 430
 431 <!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
 432 <para>
 433 Defines an entry for a padfactory
 434 </para>
 435
 436
 437 <!-- ##### TYPEDEF GstPadFactory[] ##### -->
 438 <para>
 439 The padfactory
 440 </para>
 441
 442
 443 <!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
 444 <para>
 445 Indicate that this pad will become available depending
 446 on the media type. Use this in the factory definition
 447 </para>
 448
 449
 450
 451 <!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
 452 <para>
 453 Indicate that this pad will always be available.
 454 Use this in the factory definition
 455 </para>
 456
 457
 458
 459 <!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
 460 <para>
 461 Indicates a sinkpad for the padfactory.
 462 </para>
 463
 464
 465
 466 <!-- ##### MACRO GST_PAD_FACTORY_SRC ##### -->
 467 <para>
 468 Indicates a srcpad for the padfactory.
 469 </para>
 470
 471
 472
 473 <!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### -->
 474 <para>
 475 Starts the declaration of a the capabilities for this padtemplate
 476 </para>
 477
 478 @a...: a capability factory
 479
 480
 481 <!-- ##### ENUM GstPadPresence ##### -->
 482 <para>
 483 Indicates when this pad will become available
 484 </para>
 485
 486 @GST_PAD_ALWAYS: the pad is always available
 487 @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
 488
 489 <!-- ##### STRUCT GstPadTemplate ##### -->
 490 <para>
 491
 492 </para>
 493
 494 @object:
 495 @name_template:
 496 @direction:
 497 @presence:
 498 @caps:
 499
 500 <!-- ##### FUNCTION gst_padtemplate_new ##### -->
 501 <para>
 502
 503 </para>
 504
 505 @factory:
 506 @Returns:
 507
 508
 509 <!-- ##### FUNCTION gst_padtemplate_create ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @name_template:
 515 @direction:
 516 @presence:
 517 @caps:
 518 @Returns:
 519
 520
 521 <!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
 522 <para>
 523
 524 </para>
 525
 526 @parent:
 527 @Returns:
 528
 529
 530 <!-- ##### FUNCTION gst_padtemplate_save_thyself ##### -->
 531 <para>
 532
 533 </para>
 534
 535 @pad:
 536 @parent:
 537 @Returns:
 538
 539