docs/gst/tmpl/gstpad.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstPad
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Object contained by elements that allows links to other elements
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GstElement is linked to other elements via "pads", which are extremely
  10 light-weight generic link points.
  11 After two pads are retrieved from an element with gst_element_get_pad(),
  12 the pads can be link with gst_pad_link(). (For quick links,
  13 you can also use gst_element_link(), which will make the obvious
  14 link for you if it's straightforward.)
  15 </para>
  16 <para>
  17 Pads are typically created from a #GstPadTemplate with
  18 gst_pad_new_from_template().
  19 </para>
  20 <para>
  21 Pads have #GstCaps attached to it to describe the media type they
  22 are capable of dealing with.
  23 gst_pad_get_caps() and gst_pad_try_set_caps() are used to
  24 manipulate the caps of the pads.
  25 Pads created from a pad template cannot set capabilities that are
  26 incompatible with the pad template capabilities.
  27 </para>
  28 <para>
  29 Pads without pad templates can be created with gst_pad_new(),
  30 which takes a direction and a name as an argument.  If the name is NULL,
  31 then a guaranteed unique name will be assigned to it.
  32 </para>
  33 <para>
  34 gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
  35 </para>
  36 <para>
  37 A #GstElement creating a pad will typically use the various
  38 gst_pad_set_*_function() calls to register callbacks for various events
  39 on the pads.
  40 </para>
  41 <para>
  42 GstElements will use gst_pad_push() and gst_pad_pull() to push out
  43 or pull in a buffer.
  44 gst_pad_select() and gst_pad_selectv() are used by plugins to wait for the
  45 first incoming buffer or event on any of the given set of pads.
  46 </para>
  47 <para>
  48 To send a #GstEvent on a pad, use gst_pad_send_event().
  49 </para>
  50
  51 <para>
  52 Last reviewed on December 13th, 2002 (0.5.0.1)
  53 </para>
  54
  55 <!-- ##### SECTION See_Also ##### -->
  56 <para>
  57 #GstPadTemplate, #GstElement, #GstEvent
  58 </para>
  59
  60 <!-- ##### STRUCT GstPad ##### -->
  61 <para>
  62
  63 </para>
  64
  65
  66 <!-- ##### STRUCT GstPadClass ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @parent_class:
  72 @_gst_reserved:
  73
  74 <!-- ##### STRUCT GstRealPad ##### -->
  75 <para>
  76
  77 </para>
  78
  79
  80 <!-- ##### STRUCT GstGhostPad ##### -->
  81 <para>
  82
  83 </para>
  84
  85
  86 <!-- ##### ARG GstGhostPad:real-pad ##### -->
  87 <para>
  88
  89 </para>
  90
  91 <!-- ##### STRUCT GstRealPadClass ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @parent_class:
  97 @caps_nego_failed:
  98 @linked:
  99 @unlinked:
 100 @appfixatefunc:
 101 @_gst_reserved:
 102
 103 <!-- ##### STRUCT GstGhostPadClass ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @parent_class:
 109 @_gst_reserved:
 110
 111 <!-- ##### MACRO GST_IS_PAD_FAST ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @obj:
 117
 118
 119 <!-- ##### MACRO GST_PAD_CLASS ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @klass:
 125
 126
 127 <!-- ##### MACRO GST_TYPE_REAL_PAD ##### -->
 128 <para>
 129
 130 </para>
 131
 132
 133
 134 <!-- ##### MACRO GST_IS_REAL_PAD ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @obj:
 140
 141
 142 <!-- ##### MACRO GST_IS_REAL_PAD_FAST ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @obj:
 148
 149
 150 <!-- ##### MACRO GST_IS_REAL_PAD_CLASS ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @klass:
 156 <!-- # Unused Parameters # -->
 157 @obj:
 158
 159
 160 <!-- ##### MACRO GST_REAL_PAD ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @obj:
 166
 167
 168 <!-- ##### MACRO GST_REAL_PAD_CLASS ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @klass:
 174
 175
 176 <!-- ##### MACRO GST_TYPE_GHOST_PAD ##### -->
 177 <para>
 178
 179 </para>
 180
 181
 182
 183 <!-- ##### MACRO GST_IS_GHOST_PAD ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @obj:
 189
 190
 191 <!-- ##### MACRO GST_IS_GHOST_PAD_FAST ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @obj:
 197
 198
 199 <!-- ##### MACRO GST_IS_GHOST_PAD_CLASS ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @klass:
 205 <!-- # Unused Parameters # -->
 206 @obj:
 207
 208
 209 <!-- ##### MACRO GST_GHOST_PAD ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @obj:
 215
 216
 217 <!-- ##### MACRO GST_GHOST_PAD_CLASS ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @klass:
 223
 224
 225 <!-- ##### STRUCT GstStaticPadTemplate ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @name_template:
 231 @direction:
 232 @presence:
 233 @static_caps:
 234
 235 <!-- ##### STRUCT GstPadLink ##### -->
 236 <para>
 237
 238 </para>
 239
 240
 241 <!-- ##### ENUM GstPadLinkReturn ##### -->
 242 <para>
 243 The result of a pad link.
 244 </para>
 245
 246 @GST_PAD_LINK_REFUSED: the link was refused.
 247 @GST_PAD_LINK_DELAYED: the link was delayed, probably because the
 248                        element needs more specific pad capabilitiess.
 249 @GST_PAD_LINK_OK:      the link succeeded.
 250 @GST_PAD_LINK_DONE:    the link succeeded,
 251                        any more attempts are not needed.
 252
 253 <!-- ##### MACRO GST_PAD_LINK_FAILED ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @ret:
 259
 260
 261 <!-- ##### MACRO GST_PAD_LINK_SUCCESSFUL ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @ret:
 267
 268
 269 <!-- ##### MACRO GST_PAD_QUERY_TYPE_FUNCTION ##### -->
 270 <para>
 271 A convenience macro to construct query type functions
 272 </para>
 273
 274 @functionname: the name of the function
 275 @...: query types, 0 to mark the last element
 276
 277
 278 <!-- ##### MACRO GST_PAD_FORMATS_FUNCTION ##### -->
 279 <para>
 280 Convenience function to define an array of formats that can be used
 281 as #GstPadGetFormatsFunction.
 282 </para>
 283
 284 @functionname: The name of the function
 285 @...: comma separated list of formats, 0 to mark the end
 286
 287
 288 <!-- ##### MACRO GST_PAD_EVENT_MASK_FUNCTION ##### -->
 289 <para>
 290 Convenience function to define an array of event masks that can be used
 291 as #GstPadGetEventMaskFunction.
 292 </para>
 293
 294 @functionname: The name of the function
 295 @...: comma separated list of event maks, { 0, } to mark the end
 296
 297
 298 <!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
 299 <para>
 300 A function that will be called when chaining buffers.
 301 </para>
 302
 303 @pad: the #GstPad that performed the chain.
 304 @data:
 305 <!-- # Unused Parameters # -->
 306 @buf: the #GstBuffer that is chained.
 307
 308
 309 <!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
 310 <para>
 311 A function that will be called when pulling a buffer.
 312 </para>
 313
 314 @pad: the #GstPad to get a buffer from.
 315 @Returns: the #GstBuffer pulled.
 316
 317
 318 <!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
 319 <para>
 320 Function signature to handle an event for the pad.
 321 </para>
 322
 323 @pad: the #GstPad to handle the event.
 324 @event: the #GstEvent to handle.
 325 @Returns: TRUE if the pad could handle the event.
 326
 327
 328 <!-- ##### USER_FUNCTION GstPadConvertFunction ##### -->
 329 <para>
 330 The signature of a convert function.
 331 </para>
 332
 333 @pad: the #GstPad to perform the convert on.
 334 @src_format: the source #GstFormat of the conversion.
 335 @src_value: the source value of the conversion.
 336 @dest_format: a pointer to the destination #GstFormat.
 337 @dest_value: a pointer to the destination value.
 338 @Returns: TRUE if the conversion could be performed.
 339
 340
 341 <!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
 342 <para>
 343 The signature of the query function.
 344 </para>
 345
 346 @pad: the #GstPad to query.
 347 @type: the #GstPadQueryType.
 348 @format: a pointer to the target #GstFormat.
 349 @value: a pointer to the target value.
 350 @Returns: TRUE if the query could be performed.
 351
 352
 353 <!-- ##### USER_FUNCTION GstPadIntLinkFunction ##### -->
 354 <para>
 355 The signature of the internal pad link function.
 356 </para>
 357
 358 @pad: The #GstPad to query.
 359 @Returns: a newly allocated #GList of pads that are linked to
 360           the given pad on the inside of the parent element.
 361           The caller must call g_list_free() on it after use.
 362
 363
 364 <!-- ##### USER_FUNCTION GstPadFormatsFunction ##### -->
 365 <para>
 366 The signature of the formats function.
 367 </para>
 368
 369 @pad: a #GstPad to query
 370 @Returns: an array of formats
 371
 372
 373 <!-- ##### USER_FUNCTION GstPadEventMaskFunction ##### -->
 374 <para>
 375 The signature of the eventmask function.
 376 </para>
 377
 378 @pad: the #GstPad to query
 379 @Returns: an array of event masks
 380
 381
 382 <!-- ##### USER_FUNCTION GstPadQueryTypeFunction ##### -->
 383 <para>
 384 The signature of the query types function.
 385 </para>
 386
 387 @pad: a #GstPad to query
 388 @Returns: an array of query types
 389
 390
 391 <!-- ##### USER_FUNCTION GstPadLinkFunction ##### -->
 392 <para>
 393 Function signature to handle a new link on the pad.
 394 </para>
 395
 396 @pad: the #GstPad that is linked.
 397 @caps: the peer's #GstCaps.
 398 @Returns: the result of the link with the specified caps.
 399
 400
 401 <!-- ##### USER_FUNCTION GstPadUnlinkFunction ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @pad:
 407
 408
 409 <!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
 410 <para>
 411 Returns a copy of the capabilities of the specified pad. By default this
 412 function will return the pad template capabilities, but can optionally
 413 be overridden.
 414 </para>
 415
 416 @pad: the #GstPad to get the capabilities of.
 417 @Returns: a newly allocated copy #GstCaps of the pad.
 418 <!-- # Unused Parameters # -->
 419 @caps: the peer's #GstCaps, can be used to filter the capabilities.
 420
 421
 422 <!-- ##### USER_FUNCTION GstPadFixateFunction ##### -->
 423 <para>
 424
 425 </para>
 426
 427 @pad:
 428 @caps:
 429 @Returns:
 430
 431
 432 <!-- ##### USER_FUNCTION GstPadBufferAllocFunction ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @pad:
 438 @offset:
 439 @size:
 440 @Returns:
 441
 442
 443 <!-- ##### USER_FUNCTION GstPadDispatcherFunction ##### -->
 444 <para>
 445 A dispatcher function is called for all internally linked pads, see
 446 gst_pad_dispatcher().
 447 </para>
 448
 449 @pad: the #GstPad that is dispatched.
 450 @data: the gpointer to optional user data.
 451 @Returns: TRUE if the dispatching procedure has to be stopped.
 452
 453
 454 <!-- ##### ENUM GstPadDirection ##### -->
 455 <para>
 456 The direction of a pad.
 457 </para>
 458
 459 @GST_PAD_UNKNOWN: direction is unknown.
 460 @GST_PAD_SRC: the pad is a source pad.
 461 @GST_PAD_SINK: the pad is a sink pad.
 462
 463 <!-- ##### ENUM GstPadFlags ##### -->
 464 <para>
 465 Flags for the pad.
 466 </para>
 467
 468 @GST_PAD_DISABLED: the pad is disabled.
 469 @GST_PAD_NEGOTIATING:
 470 @GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags.
 471
 472 <!-- ##### MACRO GST_PAD_NAME ##### -->
 473 <para>
 474 Gets the name of the pad.
 475 </para>
 476
 477 @pad: a #GstPad to get the name of.
 478 @Returns: the pad's name.
 479
 480
 481 <!-- ##### MACRO GST_PAD_PARENT ##### -->
 482 <para>
 483 Gets the parent element of this pad.
 484 </para>
 485
 486 @pad: a #GstPad to get the parent of.
 487 @Returns: the parent #GstElement of this pad.
 488
 489
 490 <!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
 491 <para>
 492 Gets the private data set by the element that owns the pad.
 493 </para>
 494
 495 @pad: a #GstPad to get the private data of.
 496 #Returns: a gpointer to the private data.
 497
 498
 499 <!-- ##### MACRO GST_PAD_PAD_TEMPLATE ##### -->
 500 <para>
 501 Gets the pad template that was used to create this pad.
 502 </para>
 503
 504 @pad: a #GstPad to get the pad template of.
 505 #Returns: the #GstPadTemplate used to create the pad, or NULL if none was
 506 used.
 507
 508
 509 <!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
 510 <para>
 511 Get the direction of the real pad.
 512 </para>
 513
 514 @pad: the realpad to query.
 515
 516
 517 <!-- ##### MACRO GST_RPAD_CAPS ##### -->
 518 <para>
 519 Get the caps of the real pad.
 520 </para>
 521
 522 @pad: the real pad to query.
 523
 524
 525 <!-- ##### MACRO GST_RPAD_APPFILTER ##### -->
 526 <para>
 527 Get the application filter for this pad
 528 </para>
 529
 530 @pad: the pad to query
 531
 532
 533 <!-- ##### MACRO GST_RPAD_PEER ##### -->
 534 <para>
 535 Get the peer element of the real pad.
 536 </para>
 537
 538 @pad: the real pad to query.
 539
 540
 541 <!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
 542 <para>
 543 Get the chain function of the real pad.
 544 </para>
 545
 546 @pad: the real pad to query.
 547
 548
 549 <!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
 550 <para>
 551 Get the eventhandler function from the real pad.
 552 </para>
 553
 554 @pad: the real pad to query.
 555
 556
 557 <!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
 558 <para>
 559 Get get getfunction of the real pad.
 560 </para>
 561
 562 @pad: the real pad to query.
 563
 564
 565 <!-- ##### MACRO GST_RPAD_GETHANDLER ##### -->
 566 <para>
 567 Get the gethandler function of this real pad.
 568 </para>
 569
 570 @pad: the real pad to query.
 571
 572
 573 <!-- ##### MACRO GST_RPAD_EVENTFUNC ##### -->
 574 <para>
 575 Get the event function of this real pad.
 576 </para>
 577
 578 @pad: the real pad to query.
 579
 580
 581 <!-- ##### MACRO GST_RPAD_EVENTHANDLER ##### -->
 582 <para>
 583 Get the eventhandler function of this real pad.
 584 </para>
 585
 586 @pad: the real pad to query.
 587
 588
 589 <!-- ##### MACRO GST_RPAD_CONVERTFUNC ##### -->
 590 <para>
 591 Get the convert function of this pad
 592 </para>
 593
 594 @pad: the pad to query
 595
 596
 597 <!-- ##### MACRO GST_RPAD_QUERYFUNC ##### -->
 598 <para>
 599 Get the query function of this pad
 600 </para>
 601
 602 @pad: the pad to query
 603
 604
 605 <!-- ##### MACRO GST_RPAD_INTLINKFUNC ##### -->
 606 <para>
 607 Get the internal link function of this pad
 608 </para>
 609
 610 @pad: the pad to query
 611
 612
 613 <!-- ##### MACRO GST_RPAD_FORMATSFUNC ##### -->
 614 <para>
 615 Get the formats function of this pad
 616 </para>
 617
 618 @pad: the pad to query
 619
 620
 621 <!-- ##### MACRO GST_RPAD_QUERYTYPEFUNC ##### -->
 622 <para>
 623 Get the query types function of this pad
 624 </para>
 625
 626 @pad: the pad to query
 627
 628
 629 <!-- ##### MACRO GST_RPAD_EVENTMASKFUNC ##### -->
 630 <para>
 631 Get the event mask function of this pad
 632 </para>
 633
 634 @pad: the pad to query
 635
 636
 637 <!-- ##### MACRO GST_RPAD_LINKFUNC ##### -->
 638 <para>
 639 Get the link function of the pad
 640 </para>
 641
 642 @pad: the pad to query
 643
 644
 645 <!-- ##### MACRO GST_RPAD_UNLINKFUNC ##### -->
 646 <para>
 647
 648 </para>
 649
 650 @pad:
 651
 652
 653 <!-- ##### MACRO GST_RPAD_GETCAPSFUNC ##### -->
 654 <para>
 655 Get the getcaps function of this pad
 656 </para>
 657
 658 @pad: the pad to query
 659
 660
 661 <!-- ##### MACRO GST_RPAD_FIXATEFUNC ##### -->
 662 <para>
 663
 664 </para>
 665
 666 @pad:
 667
 668
 669 <!-- ##### MACRO GST_RPAD_BUFFERALLOCFUNC ##### -->
 670 <para>
 671
 672 </para>
 673
 674 @pad:
 675
 676
 677 <!-- ##### MACRO GST_RPAD_LINK ##### -->
 678 <para>
 679
 680 </para>
 681
 682 @pad:
 683
 684
 685 <!-- ##### MACRO GST_RPAD_EXPLICIT_CAPS ##### -->
 686 <para>
 687
 688 </para>
 689
 690 @pad:
 691
 692
 693 <!-- ##### MACRO GST_GPAD_REALPAD ##### -->
 694 <para>
 695 Get the real pad of this ghost pad.
 696 </para>
 697
 698 @pad: the real pad to query.
 699
 700
 701 <!-- ##### MACRO GST_PAD_REALIZE ##### -->
 702 <para>
 703 Returns the real pad of this pad.
 704 </para>
 705
 706 @pad: a #GstPad to realize.
 707 @Returns: the actual #GstPad.
 708
 709
 710 <!-- ##### MACRO GST_PAD_DIRECTION ##### -->
 711 <para>
 712 Gets the pad's direction.
 713 </para>
 714
 715 @pad: a #GstPad to get the direction of.
 716 @Returns: the #GstPadDirection of the pad.
 717
 718
 719 <!-- ##### MACRO GST_PAD_CAPS ##### -->
 720 <para>
 721 Gets the capabilities of a pad.
 722 </para>
 723
 724 @pad: a #GstPad to get the capabilities of.
 725 @Returns: the #GstCaps of the pad.
 726
 727
 728 <!-- ##### MACRO GST_PAD_PEER ##### -->
 729 <para>
 730 Gets the peer pad of this pad.  The peer pad is the pad on to which the parent
 731 element is linked through this pad.
 732 </para>
 733
 734 @pad: a #GstPad to get the peer pad of.
 735 @Returns: the peer #GstPad.
 736
 737
 738 <!-- ##### MACRO GST_PAD_IS_LINKED ##### -->
 739 <para>
 740 Checks if the pad is linked.
 741 </para>
 742
 743 @pad: a #GstPad to check.
 744
 745
 746 <!-- ##### MACRO GST_PAD_IS_ACTIVE ##### -->
 747 <para>
 748 Checks if the pad is active.
 749 </para>
 750
 751 @pad: a #GstPad to check
 752
 753
 754 <!-- ##### MACRO GST_PAD_IS_NEGOTIATING ##### -->
 755 <para>
 756
 757 </para>
 758
 759 @pad:
 760
 761
 762 <!-- ##### MACRO GST_PAD_IS_USABLE ##### -->
 763 <para>
 764 Checks if a pad is usable. A usable pad is both linked and active.
 765 </para>
 766
 767 @pad: a #GstPad to check
 768
 769
 770 <!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
 771 <para>
 772 Checks if buffers can be pulled from this buffer.
 773 </para>
 774
 775 @pad: a #GstPad to check on if a buffer can be pulled from it.
 776
 777
 778 <!-- ##### MACRO GST_PAD_IS_SRC ##### -->
 779 <para>
 780 Checks if the pad is a source pad.
 781 </para>
 782
 783 @pad: a #GstPad to check.
 784
 785
 786 <!-- ##### MACRO GST_PAD_IS_SINK ##### -->
 787 <para>
 788 Checks if the pad is a sink pad.
 789 </para>
 790
 791 @pad: a #GstPad to check.
 792
 793
 794 <!-- ##### MACRO GST_TYPE_PAD_TEMPLATE ##### -->
 795 <para>
 796
 797 </para>
 798
 799
 800
 801 <!-- ##### MACRO GST_PAD_TEMPLATE ##### -->
 802 <para>
 803
 804 </para>
 805
 806 @obj:
 807
 808
 809 <!-- ##### MACRO GST_PAD_TEMPLATE_CLASS ##### -->
 810 <para>
 811
 812 </para>
 813
 814 @klass:
 815
 816
 817 <!-- ##### MACRO GST_IS_PAD_TEMPLATE ##### -->
 818 <para>
 819
 820 </para>
 821
 822 @obj:
 823
 824
 825 <!-- ##### MACRO GST_IS_PAD_TEMPLATE_CLASS ##### -->
 826 <para>
 827
 828 </para>
 829
 830 @klass:
 831 <!-- # Unused Parameters # -->
 832 @obj:
 833
 834
 835 <!-- ##### ENUM GstPadPresence ##### -->
 836 <para>
 837 Indicates when this pad will become available.
 838 </para>
 839
 840 @GST_PAD_ALWAYS: the pad is always available
 841 @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
 842 @GST_PAD_REQUEST: th pad is only available on request with
 843 gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
 844
 845 <!-- ##### MACRO GST_PAD_TEMPLATE_NAME_TEMPLATE ##### -->
 846 <para>
 847 Get the nametemplate of the padtemplate.
 848 </para>
 849
 850 @templ: the template to query
 851
 852
 853 <!-- ##### MACRO GST_PAD_TEMPLATE_DIRECTION ##### -->
 854 <para>
 855 Get the direction of the padtemplate.
 856 </para>
 857
 858 @templ: the template to query
 859
 860
 861 <!-- ##### MACRO GST_PAD_TEMPLATE_PRESENCE ##### -->
 862 <para>
 863 Get the presence of the padtemplate.
 864 </para>
 865
 866 @templ: the template to query
 867
 868
 869 <!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
 870 <para>
 871 Get a handle to the padtemplate #GstCaps
 872 </para>
 873
 874 @templ: the template to query
 875
 876
 877 <!-- ##### ENUM GstPadTemplateFlags ##### -->
 878 <para>
 879 Flags for the padtemplate
 880 </para>
 881
 882 @GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
 883 @GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
 884
 885 <!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
 886 <para>
 887 Check if the properties of the padtemplate are fixed
 888 </para>
 889
 890 @templ: the template to query
 891
 892
 893 <!-- ##### MACRO GST_STATIC_PAD_TEMPLATE ##### -->
 894 <para>
 895
 896 </para>
 897
 898 @padname:
 899 @dir:
 900 @pres:
 901 @caps:
 902
 903
 904 <!-- ##### FUNCTION gst_real_pad_get_type ##### -->
 905 <para>
 906
 907 </para>
 908
 909 @Returns:
 910
 911
 912 <!-- ##### FUNCTION gst_ghost_pad_get_type ##### -->
 913 <para>
 914
 915 </para>
 916
 917 @Returns:
 918
 919
 920 <!-- ##### FUNCTION gst_pad_new ##### -->
 921 <para>
 922
 923 </para>
 924
 925 @name:
 926 @direction:
 927 @Returns:
 928
 929
 930 <!-- ##### FUNCTION gst_pad_new_from_template ##### -->
 931 <para>
 932
 933 </para>
 934
 935 @templ:
 936 @name:
 937 @Returns:
 938
 939
 940 <!-- ##### FUNCTION gst_pad_custom_new ##### -->
 941 <para>
 942
 943 </para>
 944
 945 @type:
 946 @name:
 947 @direction:
 948 @Returns:
 949
 950
 951 <!-- ##### FUNCTION gst_pad_custom_new_from_template ##### -->
 952 <para>
 953
 954 </para>
 955
 956 @type:
 957 @templ:
 958 @name:
 959 @Returns:
 960
 961
 962 <!-- ##### FUNCTION gst_pad_set_name ##### -->
 963 <para>
 964
 965 </para>
 966
 967 @pad:
 968 @name:
 969
 970
 971 <!-- ##### FUNCTION gst_pad_get_name ##### -->
 972 <para>
 973
 974 </para>
 975
 976 @pad:
 977 @Returns:
 978
 979
 980 <!-- ##### FUNCTION gst_pad_get_direction ##### -->
 981 <para>
 982
 983 </para>
 984
 985 @pad:
 986 @Returns:
 987
 988
 989 <!-- ##### FUNCTION gst_pad_set_active ##### -->
 990 <para>
 991
 992 </para>
 993
 994 @pad:
 995 @active:
 996
 997
 998 <!-- ##### FUNCTION gst_pad_is_active ##### -->
 999 <para>
1000
1001 </para>
1002
1003 @pad:
1004 @Returns:
1005
1006
1007 <!-- ##### FUNCTION gst_pad_set_element_private ##### -->
1008 <para>
1009
1010 </para>
1011
1012 @pad:
1013 @priv:
1014
1015
1016 <!-- ##### FUNCTION gst_pad_get_element_private ##### -->
1017 <para>
1018
1019 </para>
1020
1021 @pad:
1022 @Returns:
1023
1024
1025 <!-- ##### FUNCTION gst_pad_set_parent ##### -->
1026 <para>
1027
1028 </para>
1029
1030 @pad:
1031 @parent:
1032
1033
1034 <!-- ##### FUNCTION gst_pad_get_parent ##### -->
1035 <para>
1036
1037 </para>
1038
1039 @pad:
1040 @Returns:
1041
1042
1043 <!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
1044 <para>
1045
1046 </para>
1047
1048 @pad:
1049 @Returns:
1050
1051
1052 <!-- ##### FUNCTION gst_pad_get_scheduler ##### -->
1053 <para>
1054
1055 </para>
1056
1057 @pad:
1058 @Returns:
1059
1060
1061 <!-- ##### FUNCTION gst_pad_add_ghost_pad ##### -->
1062 <para>
1063
1064 </para>
1065
1066 @pad:
1067 @ghostpad:
1068
1069
1070 <!-- ##### FUNCTION gst_pad_remove_ghost_pad ##### -->
1071 <para>
1072
1073 </para>
1074
1075 @pad:
1076 @ghostpad:
1077
1078
1079 <!-- ##### FUNCTION gst_pad_get_ghost_pad_list ##### -->
1080 <para>
1081
1082 </para>
1083
1084 @pad:
1085 @Returns:
1086
1087
1088 <!-- ##### FUNCTION gst_pad_get_pad_template ##### -->
1089 <para>
1090
1091 </para>
1092
1093 @pad:
1094 @Returns:
1095
1096
1097 <!-- ##### FUNCTION gst_pad_set_bufferalloc_function ##### -->
1098 <para>
1099
1100 </para>
1101
1102 @pad:
1103 @bufalloc:
1104 <!-- # Unused Parameters # -->
1105 @bufferalloc:
1106
1107
1108 <!-- ##### FUNCTION gst_pad_alloc_buffer ##### -->
1109 <para>
1110
1111 </para>
1112
1113 @pad:
1114 @offset:
1115 @size:
1116 @Returns:
1117
1118
1119 <!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
1120 <para>
1121
1122 </para>
1123
1124 @pad:
1125 @chain:
1126
1127
1128 <!-- ##### FUNCTION gst_pad_set_get_function ##### -->
1129 <para>
1130
1131 </para>
1132
1133 @pad:
1134 @get:
1135
1136
1137 <!-- ##### FUNCTION gst_pad_set_event_function ##### -->
1138 <para>
1139
1140 </para>
1141
1142 @pad:
1143 @event:
1144
1145
1146 <!-- ##### FUNCTION gst_pad_set_event_mask_function ##### -->
1147 <para>
1148
1149 </para>
1150
1151 @pad:
1152 @mask_func:
1153
1154
1155 <!-- ##### FUNCTION gst_pad_get_event_masks ##### -->
1156 <para>
1157
1158 </para>
1159
1160 @pad:
1161 @Returns:
1162
1163
1164 <!-- ##### FUNCTION gst_pad_get_event_masks_default ##### -->
1165 <para>
1166
1167 </para>
1168
1169 @pad:
1170 @Returns:
1171
1172
1173 <!-- ##### FUNCTION gst_pad_set_link_function ##### -->
1174 <para>
1175
1176 </para>
1177
1178 @pad:
1179 @link:
1180
1181
1182 <!-- ##### FUNCTION gst_pad_can_link ##### -->
1183 <para>
1184
1185 </para>
1186
1187 @srcpad:
1188 @sinkpad:
1189 @Returns:
1190
1191
1192 <!-- ##### FUNCTION gst_pad_can_link_filtered ##### -->
1193 <para>
1194
1195 </para>
1196
1197 @srcpad:
1198 @sinkpad:
1199 @filtercaps:
1200 @Returns:
1201
1202
1203 <!-- ##### FUNCTION gst_pad_set_unlink_function ##### -->
1204 <para>
1205
1206 </para>
1207
1208 @pad:
1209 @unlink:
1210
1211
1212 <!-- ##### FUNCTION gst_pad_link ##### -->
1213 <para>
1214
1215 </para>
1216
1217 @srcpad:
1218 @sinkpad:
1219 @Returns:
1220
1221
1222 <!-- ##### FUNCTION gst_pad_link_filtered ##### -->
1223 <para>
1224
1225 </para>
1226
1227 @srcpad:
1228 @sinkpad:
1229 @filtercaps:
1230 @Returns:
1231
1232
1233 <!-- ##### FUNCTION gst_pad_unlink ##### -->
1234 <para>
1235
1236 </para>
1237
1238 @srcpad:
1239 @sinkpad:
1240
1241
1242 <!-- ##### FUNCTION gst_pad_is_linked ##### -->
1243 <para>
1244
1245 </para>
1246
1247 @pad:
1248 @Returns:
1249
1250
1251 <!-- ##### FUNCTION gst_pad_get_peer ##### -->
1252 <para>
1253
1254 </para>
1255
1256 @pad:
1257 @Returns:
1258
1259
1260 <!-- ##### FUNCTION gst_pad_get_negotiated_caps ##### -->
1261 <para>
1262
1263 </para>
1264
1265 @pad:
1266 @Returns:
1267
1268
1269 <!-- ##### FUNCTION gst_pad_is_negotiated ##### -->
1270 <para>
1271
1272 </para>
1273
1274 @pad:
1275 @Returns:
1276
1277
1278 <!-- ##### FUNCTION gst_pad_get_caps ##### -->
1279 <para>
1280
1281 </para>
1282
1283 @pad:
1284 @Returns:
1285
1286
1287 <!-- ##### FUNCTION gst_pad_get_pad_template_caps ##### -->
1288 <para>
1289
1290 </para>
1291
1292 @pad:
1293 @Returns:
1294
1295
1296 <!-- ##### FUNCTION gst_pad_try_set_caps ##### -->
1297 <para>
1298
1299 </para>
1300
1301 @pad:
1302 @caps:
1303 @Returns:
1304
1305
1306 <!-- ##### FUNCTION gst_pad_try_set_caps_nonfixed ##### -->
1307 <para>
1308
1309 </para>
1310
1311 @pad:
1312 @caps:
1313 @Returns:
1314
1315
1316 <!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
1317 <para>
1318
1319 </para>
1320
1321 @srcpad:
1322 @sinkpad:
1323 @Returns:
1324
1325
1326 <!-- ##### FUNCTION gst_pad_set_getcaps_function ##### -->
1327 <para>
1328
1329 </para>
1330
1331 @pad:
1332 @getcaps:
1333
1334
1335 <!-- ##### FUNCTION gst_pad_set_fixate_function ##### -->
1336 <para>
1337
1338 </para>
1339
1340 @pad:
1341 @fixate:
1342
1343
1344 <!-- ##### FUNCTION gst_pad_proxy_getcaps ##### -->
1345 <para>
1346
1347 </para>
1348
1349 @pad:
1350 @Returns:
1351
1352
1353 <!-- ##### FUNCTION gst_pad_proxy_pad_link ##### -->
1354 <para>
1355
1356 </para>
1357
1358 @pad:
1359 @caps:
1360 @Returns:
1361
1362
1363 <!-- ##### FUNCTION gst_pad_proxy_fixate ##### -->
1364 <para>
1365
1366 </para>
1367
1368 @pad:
1369 @caps:
1370 @Returns:
1371
1372
1373 <!-- ##### FUNCTION gst_pad_proxy_link ##### -->
1374 <para>
1375
1376 </para>
1377
1378 @pad:
1379 @caps:
1380 @Returns:
1381
1382
1383 <!-- ##### FUNCTION gst_pad_set_explicit_caps ##### -->
1384 <para>
1385
1386 </para>
1387
1388 @pad:
1389 @caps:
1390 @Returns:
1391
1392
1393 <!-- ##### FUNCTION gst_pad_use_explicit_caps ##### -->
1394 <para>
1395
1396 </para>
1397
1398 @pad:
1399
1400
1401 <!-- ##### FUNCTION gst_pad_relink_filtered ##### -->
1402 <para>
1403
1404 </para>
1405
1406 @srcpad:
1407 @sinkpad:
1408 @filtercaps:
1409 @Returns:
1410
1411
1412 <!-- ##### FUNCTION gst_pad_perform_negotiate ##### -->
1413 <para>
1414
1415 </para>
1416
1417 @srcpad:
1418 @sinkpad:
1419 @Returns:
1420
1421
1422 <!-- ##### FUNCTION gst_pad_renegotiate ##### -->
1423 <para>
1424
1425 </para>
1426
1427 @pad:
1428 @Returns:
1429
1430
1431 <!-- ##### FUNCTION gst_pad_unnegotiate ##### -->
1432 <para>
1433
1434 </para>
1435
1436 @pad:
1437
1438
1439 <!-- ##### FUNCTION gst_pad_try_relink_filtered ##### -->
1440 <para>
1441
1442 </para>
1443
1444 @srcpad:
1445 @sinkpad:
1446 @filtercaps:
1447 @Returns:
1448
1449
1450 <!-- ##### FUNCTION gst_pad_get_allowed_caps ##### -->
1451 <para>
1452
1453 </para>
1454
1455 @pad:
1456 @Returns:
1457
1458
1459 <!-- ##### FUNCTION gst_pad_caps_change_notify ##### -->
1460 <para>
1461
1462 </para>
1463
1464 @pad:
1465
1466
1467 <!-- ##### FUNCTION gst_pad_recover_caps_error ##### -->
1468 <para>
1469
1470 </para>
1471
1472 @pad:
1473 @allowed:
1474 @Returns:
1475
1476
1477 <!-- ##### FUNCTION gst_pad_push ##### -->
1478 <para>
1479
1480 </para>
1481
1482 @pad:
1483 @data:
1484 <!-- # Unused Parameters # -->
1485 @buf:
1486
1487
1488 <!-- ##### FUNCTION gst_pad_pull ##### -->
1489 <para>
1490
1491 </para>
1492
1493 @pad:
1494 @Returns:
1495
1496
1497 <!-- ##### FUNCTION gst_pad_send_event ##### -->
1498 <para>
1499
1500 </para>
1501
1502 @pad:
1503 @event:
1504 @Returns:
1505
1506
1507 <!-- ##### FUNCTION gst_pad_event_default ##### -->
1508 <para>
1509
1510 </para>
1511
1512 @pad:
1513 @event:
1514 @Returns:
1515
1516
1517 <!-- ##### FUNCTION gst_pad_select ##### -->
1518 <para>
1519
1520 </para>
1521
1522 @pad:
1523 @Varargs:
1524 @Returns:
1525 <!-- # Unused Parameters # -->
1526 @padlist:
1527
1528
1529 <!-- ##### FUNCTION gst_pad_selectv ##### -->
1530 <para>
1531
1532 </para>
1533
1534 @padlist:
1535 @Returns:
1536 <!-- # Unused Parameters # -->
1537 @pad:
1538 @Varargs:
1539
1540
1541 <!-- ##### FUNCTION gst_pad_select_valist ##### -->
1542 <para>
1543
1544 </para>
1545
1546 @pad:
1547 @varargs:
1548 @Returns:
1549
1550
1551 <!-- ##### FUNCTION gst_pad_collect ##### -->
1552 <para>
1553
1554 </para>
1555
1556 @selected:
1557 @pad:
1558 @Varargs:
1559 @Returns:
1560
1561
1562 <!-- ##### FUNCTION gst_pad_collectv ##### -->
1563 <para>
1564
1565 </para>
1566
1567 @selected:
1568 @padlist:
1569 @Returns:
1570
1571
1572 <!-- ##### FUNCTION gst_pad_collect_valist ##### -->
1573 <para>
1574
1575 </para>
1576
1577 @selected:
1578 @pad:
1579 @varargs:
1580 @Returns:
1581
1582
1583 <!-- ##### FUNCTION gst_pad_set_formats_function ##### -->
1584 <para>
1585
1586 </para>
1587
1588 @pad:
1589 @formats:
1590
1591
1592 <!-- ##### FUNCTION gst_pad_get_formats ##### -->
1593 <para>
1594
1595 </para>
1596
1597 @pad:
1598 @Returns:
1599
1600
1601 <!-- ##### FUNCTION gst_pad_get_formats_default ##### -->
1602 <para>
1603
1604 </para>
1605
1606 @pad:
1607 @Returns:
1608
1609
1610 <!-- ##### FUNCTION gst_pad_set_convert_function ##### -->
1611 <para>
1612
1613 </para>
1614
1615 @pad:
1616 @convert:
1617
1618
1619 <!-- ##### FUNCTION gst_pad_convert ##### -->
1620 <para>
1621
1622 </para>
1623
1624 @pad:
1625 @src_format:
1626 @src_value:
1627 @dest_format:
1628 @dest_value:
1629 @Returns:
1630
1631
1632 <!-- ##### FUNCTION gst_pad_convert_default ##### -->
1633 <para>
1634
1635 </para>
1636
1637 @pad:
1638 @src_format:
1639 @src_value:
1640 @dest_format:
1641 @dest_value:
1642 @Returns:
1643
1644
1645 <!-- ##### FUNCTION gst_pad_set_query_function ##### -->
1646 <para>
1647
1648 </para>
1649
1650 @pad:
1651 @query:
1652
1653
1654 <!-- ##### FUNCTION gst_pad_set_query_type_function ##### -->
1655 <para>
1656
1657 </para>
1658
1659 @pad:
1660 @type_func:
1661
1662
1663 <!-- ##### FUNCTION gst_pad_get_query_types ##### -->
1664 <para>
1665
1666 </para>
1667
1668 @pad:
1669 @Returns:
1670
1671
1672 <!-- ##### FUNCTION gst_pad_get_query_types_default ##### -->
1673 <para>
1674
1675 </para>
1676
1677 @pad:
1678 @Returns:
1679
1680
1681 <!-- ##### FUNCTION gst_pad_query ##### -->
1682 <para>
1683
1684 </para>
1685
1686 @pad:
1687 @type:
1688 @format:
1689 @value:
1690 @Returns:
1691
1692
1693 <!-- ##### FUNCTION gst_pad_query_default ##### -->
1694 <para>
1695
1696 </para>
1697
1698 @pad:
1699 @type:
1700 @format:
1701 @value:
1702 @Returns:
1703
1704
1705 <!-- ##### FUNCTION gst_pad_set_internal_link_function ##### -->
1706 <para>
1707
1708 </para>
1709
1710 @pad:
1711 @intlink:
1712
1713
1714 <!-- ##### FUNCTION gst_pad_get_internal_links ##### -->
1715 <para>
1716
1717 </para>
1718
1719 @pad:
1720 @Returns:
1721
1722
1723 <!-- ##### FUNCTION gst_pad_get_internal_links_default ##### -->
1724 <para>
1725
1726 </para>
1727
1728 @pad:
1729 @Returns:
1730
1731
1732 <!-- ##### FUNCTION gst_pad_dispatcher ##### -->
1733 <para>
1734
1735 </para>
1736
1737 @pad:
1738 @dispatch:
1739 @data:
1740 @Returns:
1741
1742
1743 <!-- ##### MACRO gst_pad_add_probe ##### -->
1744 <para>
1745 Adds the probe to the given pad
1746 </para>
1747
1748 @pad: The pad to add the probe to
1749 @probe: The probe to add to the pad
1750
1751
1752 <!-- ##### MACRO gst_pad_remove_probe ##### -->
1753 <para>
1754 Remove the probe from the pad
1755 </para>
1756
1757 @pad: The pad to remove the probe of
1758 @probe: The probe to remove
1759
1760
1761 <!-- ##### FUNCTION gst_pad_load_and_link ##### -->
1762 <para>
1763
1764 </para>
1765
1766 @self:
1767 @parent:
1768
1769
1770 <!-- ##### FUNCTION gst_ghost_pad_new ##### -->
1771 <para>
1772
1773 </para>
1774
1775 @name:
1776 @pad:
1777 @Returns:
1778
1779
1780 <!-- ##### FUNCTION gst_pad_template_get_type ##### -->
1781 <para>
1782
1783 </para>
1784
1785 @Returns:
1786
1787
1788 <!-- ##### FUNCTION gst_pad_template_new ##### -->
1789 <para>
1790
1791 </para>
1792
1793 @name_template:
1794 @direction:
1795 @presence:
1796 @caps:
1797 @Returns:
1798 <!-- # Unused Parameters # -->
1799 @Varargs:
1800
1801
1802 <!-- ##### FUNCTION gst_static_pad_template_get ##### -->
1803 <para>
1804
1805 </para>
1806
1807 @pad_template:
1808 @Returns:
1809 <!-- # Unused Parameters # -->
1810 @templ:
1811
1812
1813 <!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
1814 <para>
1815
1816 </para>
1817
1818 @templ:
1819 @Returns:
1820
1821
1822 <!-- ##### FUNCTION gst_pad_template_get_caps_by_name ##### -->
1823 <para>
1824
1825 </para>
1826
1827 @templ:
1828 @name:
1829 @Returns:
1830
1831
1832 <!-- ##### FUNCTION gst_ghost_pad_save_thyself ##### -->
1833 <para>
1834
1835 </para>
1836
1837 @pad:
1838 @parent:
1839 @Returns:
1840
1841