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 #GstElement are connected to each other via "pads", which are extremely light-weight generic
  10 connections. After two pad are retrieved from an element with gst_element_get_pad(), the pads
  11 can be connected with gst_pad_connect().
  12 </para>
  13 <para>
  14 PedTemplates are use to describe the runtime behaviour of an element and what pads it
  15 will have during its lifetime. Pads are typically created from a padtemplate with
  16 GST_PADTEMPLATE_NEW() or with the factory macro GST_PADTEMPLATE_FACTORY().
  17 </para>
  18 <para>
  19 Pad and PadTemplates have #GstCaps attached to it to describe the media type they
  20 are capable of dealing with. gst_pad_get_caps() and gst_pad_set_caps() are used to
  21 manipulate the caps of the pads. gst_padtemplate_get_caps() is used to get the
  22 caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
  23 creation. The following code example shows the code to create a pad from a padtemplate.
  24 <programlisting>
  25 GST_PADTEMPLATE_FACTORY (my_factory,
  26   "sink",               /* the name of the pad */
  27   GST_PAD_SINK,         /* the direction of the pad */
  28   GST_PAD_ALWAYS,       /* when this pad will be present */
  29   GST_CAPS_NEW (        /* the capabilities of the padtemplate */
  30     "my_caps",
  31     "audio/raw",
  32       "format",         GST_PROPS_STRING ("int"),
  33       "channels",       GST_PROPS_INT_RANGE (1, 6)
  34   )
  35 )
  36
  37 void
  38 my_method (void)
  39 {
  40   GstPad *pad;
  41
  42   pad = gst_pad_new_from_template (GST_PADTEMPLATE_GET (my_factory), "sink");
  43   ...
  44 }
  45 </programlisting>
  46 Pads created from a padtemplate cannot set capabilities that are incompatible with
  47 the padtemplates capabilities.
  48 </para>
  49 <para>
  50 Pads without padtemplates can be created with gst_pad_new() which takes a direction and
  51 a name as an argument.
  52 </para>
  53 <para>
  54 gst_pad_get_parent() will retrieve the GstElement that owns the pad.
  55 </para>
  56 <para>
  57 GstElements creating a pad will typicilally use the various gst_pad_set_*_function() calls
  58 to register callbacks for various events on the pads.
  59 </para>
  60 <para>
  61 GstElements will use gst_pad_push() and gst_pad_pull() to push out or pull a buffer in. The
  62 gst_pad_pullregion() function can be used to request for a buffer with a specific offset (in
  63 time or in bytes).
  64 </para>
  65
  66 <!-- ##### SECTION See_Also ##### -->
  67 <para>
  68 #GstCaps, #GstElement
  69 </para>
  70
  71 <!-- ##### MACRO GST_PAD_NAME ##### -->
  72 <para>
  73 Get the name of the pad.
  74 </para>
  75
  76 @pad: the pad to query
  77
  78
  79 <!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
  80 <para>
  81 Get the private data set by the element that owns the pad.
  82 </para>
  83
  84 @pad: the pad to query
  85
  86
  87 <!-- ##### MACRO GST_PAD_PARENT ##### -->
  88 <para>
  89 Get the parent element of this pad.
  90 </para>
  91
  92 @pad: the pad to query
  93
  94
  95 <!-- ##### MACRO GST_PAD_PADTEMPLATE ##### -->
  96 <para>
  97 Get the padtemplate that was used to create this pad. NULL if no padtemplate
  98 was used.
  99 </para>
 100
 101 @pad: the pad to query
 102
 103
 104 <!-- ##### MACRO GST_PAD_REALIZE ##### -->
 105 <para>
 106 Return the real pad of this pad.
 107 </para>
 108
 109 @pad: the pad to query
 110
 111
 112 <!-- ##### MACRO GST_PAD_DIRECTION ##### -->
 113 <para>
 114 Get the pad direction.
 115 </para>
 116
 117 @pad: the pad to query
 118
 119
 120 <!-- ##### MACRO GST_PAD_CAPS ##### -->
 121 <para>
 122 Get the capabilities of a pad.
 123 </para>
 124
 125 @pad: the pad to query
 126
 127
 128 <!-- ##### MACRO GST_PAD_PEER ##### -->
 129 <para>
 130 Get the peerpad of this pad.
 131 </para>
 132
 133 @pad: the pad to query
 134
 135
 136 <!-- ##### MACRO GST_PAD_CONNECTED ##### -->
 137 <para>
 138 Is this pad connected.
 139 </para>
 140
 141 @pad: the pad to check
 142
 143
 144 <!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
 145 <para>
 146 Can this pad be used to pull a buffer.
 147 </para>
 148
 149 @pad: the pad to check
 150
 151
 152 <!-- ##### STRUCT GstPad ##### -->
 153 <para>
 154
 155 </para>
 156
 157
 158 <!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
 159 <para>
 160 The function that will be called when chaining buffers.
 161 </para>
 162
 163 @pad: the pad that performed the chain
 164 @buf: the buffer that is chained
 165
 166
 167 <!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
 168 <para>
 169 The function that will be called when pulling a buffer.
 170 </para>
 171
 172 @pad: the pad to get a buffer from
 173 @Returns: a #GstBuffer
 174
 175
 176 <!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
 177 <para>
 178 The function that will be called when pulling a region buffer.
 179 You can specify which buffer to get using an offset/length pair or
 180 a start/stop timecode pair.
 181 </para>
 182
 183 @pad: the pad to get a buffer from
 184 @type: the type of region to get (time or offset based)
 185 @offset: the offset of the region to get
 186 @len: the length of the region to get
 187 @Returns: a #GstBuffer
 188
 189
 190 <!-- ##### USER_FUNCTION GstPadNewCapsFunction ##### -->
 191 <para>
 192 The function that will be called when the caps of the pad has
 193 changed.
 194 </para>
 195
 196 @pad: The pad that has its caps changed
 197 @caps: the new caps of the pad
 198
 199
 200 <!-- ##### USER_FUNCTION GstPadBufferPoolFunction ##### -->
 201 <para>
 202 The function that will be called when a bufferpool is requested
 203 from this pad.
 204 </para>
 205
 206 @pad: the pad with the bufferpool
 207 @Returns: the GstBufferPool associated with this pad.
 208
 209
 210 <!-- ##### ENUM GstPadNegotiateReturn ##### -->
 211 <para>
 212 The possible results from padnegotiation.
 213 </para>
 214
 215 @GST_PAD_NEGOTIATE_FAIL: The pads could not agree about the media type.
 216 @GST_PAD_NEGOTIATE_AGREE: The pads agreed about the media type.
 217 @GST_PAD_NEGOTIATE_TRY: The pad did not agree and suggests another media type.
 218
 219 <!-- ##### USER_FUNCTION GstPadNegotiateFunction ##### -->
 220 <para>
 221 The function that will be called when negotiating.
 222 </para>
 223
 224 @pad: The pad that is being negotiated
 225 @caps: The current caps that are being negotiated
 226 @data: A generic gpointer that can be used to store user_data
 227 @Returns: The result of the negotiation process
 228
 229
 230 <!-- ##### ENUM GstRegionType ##### -->
 231 <para>
 232 the region types for #gst_pad_pullregion.
 233 </para>
 234
 235 @GST_REGION_VOID:
 236 @GST_REGION_OFFSET_LEN: an offet/length pair
 237 @GST_REGION_TIME_LEN: a time start/length pair
 238
 239 <!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
 240 <para>
 241 The function that will be called when pulling a region buffer.
 242 You can specify which buffer to get using an offset/length pair or
 243 a start/stop timecode pair.
 244 </para>
 245
 246 @pad: the pad to get a buffer from
 247 @type: the type of region to get (time or offset based)
 248 @offset: the offset of the region to get
 249 @len: the length of the region to get
 250 @Returns: a #GstBuffer
 251
 252
 253 <!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @pad:
 259 @event:
 260 @Returns:
 261
 262
 263 <!-- ##### ENUM GstPadDirection ##### -->
 264 <para>
 265 The direction this pad is.
 266 </para>
 267
 268 @GST_PAD_UNKNOWN: direction is unknown
 269 @GST_PAD_SRC: this is a source pad
 270 @GST_PAD_SINK: this is a sink pad
 271
 272 <!-- ##### ENUM GstPadFlags ##### -->
 273 <para>
 274 Flags for the pad.
 275 </para>
 276
 277 @GST_PAD_DISABLED: the pad is disabled
 278 @GST_PAD_EOS: the pad is in end of stream state
 279 @GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags
 280
 281 <!-- ##### FUNCTION gst_pad_new ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @name:
 287 @direction:
 288 @Returns:
 289
 290
 291 <!-- ##### MACRO gst_pad_destroy ##### -->
 292 <para>
 293 Destroy the pad.
 294 </para>
 295
 296 @pad: the pad to destroy
 297
 298
 299 <!-- ##### FUNCTION gst_pad_new_from_template ##### -->
 300 <para>
 301
 302 </para>
 303
 304 @templ:
 305 @name:
 306 @Returns:
 307 <!-- # Unused Parameters # -->
 308 @temp:
 309
 310
 311 <!-- ##### FUNCTION gst_pad_get_direction ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @pad:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @pad:
 326 @chain:
 327
 328
 329 <!-- ##### FUNCTION gst_pad_set_get_function ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @pad:
 335 @get:
 336
 337
 338 <!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @pad:
 344 @getregion:
 345
 346
 347 <!-- ##### FUNCTION gst_pad_set_negotiate_function ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @pad:
 353 @nego:
 354
 355
 356 <!-- ##### FUNCTION gst_pad_set_newcaps_function ##### -->
 357 <para>
 358
 359 </para>
 360
 361 @pad:
 362 @newcaps:
 363
 364
 365 <!-- ##### FUNCTION gst_pad_set_bufferpool_function ##### -->
 366 <para>
 367
 368 </para>
 369
 370 @pad:
 371 @bufpool:
 372
 373
 374 <!-- ##### FUNCTION gst_pad_set_caps ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @pad:
 380 @caps:
 381 @Returns:
 382
 383
 384 <!-- ##### FUNCTION gst_pad_get_caps ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @pad:
 390 @Returns:
 391
 392
 393 <!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
 394 <para>
 395
 396 </para>
 397
 398 @srcpad:
 399 @sinkpad:
 400 @Returns:
 401
 402
 403 <!-- ##### FUNCTION gst_pad_set_name ##### -->
 404 <para>
 405
 406 </para>
 407
 408 @pad:
 409 @name:
 410
 411
 412 <!-- ##### FUNCTION gst_pad_get_name ##### -->
 413 <para>
 414
 415 </para>
 416
 417 @pad:
 418 @Returns:
 419
 420
 421 <!-- ##### FUNCTION gst_pad_set_element_private ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @pad:
 427 @priv:
 428
 429
 430 <!-- ##### FUNCTION gst_pad_get_element_private ##### -->
 431 <para>
 432
 433 </para>
 434
 435 @pad:
 436 @Returns:
 437
 438
 439 <!-- ##### FUNCTION gst_pad_set_parent ##### -->
 440 <para>
 441
 442 </para>
 443
 444 @pad:
 445 @parent:
 446
 447
 448 <!-- ##### FUNCTION gst_pad_get_parent ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @pad:
 454 @Returns:
 455
 456
 457 <!-- ##### FUNCTION gst_pad_get_sched ##### -->
 458 <para>
 459
 460 </para>
 461
 462 @pad:
 463 @Returns:
 464
 465
 466 <!-- ##### FUNCTION gst_pad_set_sched ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @pad:
 472 @sched:
 473
 474
 475 <!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @pad:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION gst_pad_add_ghost_pad ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @pad:
 490 @ghostpad:
 491
 492
 493 <!-- ##### FUNCTION gst_pad_remove_ghost_pad ##### -->
 494 <para>
 495
 496 </para>
 497
 498 @pad:
 499 @ghostpad:
 500
 501
 502 <!-- ##### FUNCTION gst_pad_get_ghost_pad_list ##### -->
 503 <para>
 504
 505 </para>
 506
 507 @pad:
 508 @Returns:
 509
 510
 511 <!-- ##### FUNCTION gst_pad_get_peer ##### -->
 512 <para>
 513
 514 </para>
 515
 516 @pad:
 517 @Returns:
 518
 519
 520 <!-- ##### FUNCTION gst_pad_connect ##### -->
 521 <para>
 522
 523 </para>
 524
 525 @srcpad:
 526 @sinkpad:
 527 <!-- # Unused Parameters # -->
 528 @Returns:
 529
 530
 531 <!-- ##### FUNCTION gst_pad_try_connect ##### -->
 532 <para>
 533
 534 </para>
 535
 536 @srcpad:
 537 @sinkpad:
 538 @Returns:
 539
 540
 541 <!-- ##### FUNCTION gst_pad_disconnect ##### -->
 542 <para>
 543
 544 </para>
 545
 546 @srcpad:
 547 @sinkpad:
 548
 549
 550 <!-- ##### FUNCTION gst_pad_push ##### -->
 551 <para>
 552
 553 </para>
 554
 555 @pad:
 556 @buf:
 557 <!-- # Unused Parameters # -->
 558 @buffer:
 559
 560
 561 <!-- ##### FUNCTION gst_pad_pull ##### -->
 562 <para>
 563
 564 </para>
 565
 566 @pad:
 567 @Returns:
 568
 569
 570 <!-- ##### FUNCTION gst_pad_pullregion ##### -->
 571 <para>
 572
 573 </para>
 574
 575 @pad:
 576 @type:
 577 @offset:
 578 @len:
 579 @Returns:
 580 <!-- # Unused Parameters # -->
 581 @size:
 582
 583
 584 <!-- ##### FUNCTION gst_pad_get_bufferpool ##### -->
 585 <para>
 586
 587 </para>
 588
 589 @pad:
 590 @Returns:
 591
 592
 593 <!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
 594 <para>
 595
 596 </para>
 597
 598 @self:
 599 @parent:
 600 <!-- # Unused Parameters # -->
 601 @element:
 602 @elements:
 603
 604
 605 <!-- ##### FUNCTION gst_pad_negotiate_proxy ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @srcpad:
 611 @destpad:
 612 @caps:
 613 @Returns:
 614 <!-- # Unused Parameters # -->
 615 @counter:
 616 @count:
 617
 618
 619 <!-- ##### FUNCTION gst_pad_renegotiate ##### -->
 620 <para>
 621
 622 </para>
 623
 624 @pad:
 625 @Returns:
 626
 627
 628 <!-- ##### FUNCTION gst_pad_get_padtemplate ##### -->
 629 <para>
 630
 631 </para>
 632
 633 @pad:
 634 @Returns:
 635
 636
 637 <!-- ##### FUNCTION gst_pad_get_padtemplate_caps ##### -->
 638 <para>
 639
 640 </para>
 641
 642 @pad:
 643 @Returns:
 644
 645
 646 <!-- ##### FUNCTION gst_pad_event ##### -->
 647 <para>
 648
 649 </para>
 650
 651 @pad:
 652 @event:
 653 @timestamp:
 654 @data:
 655 @Returns:
 656
 657
 658 <!-- ##### FUNCTION gst_pad_ghost_save_thyself ##### -->
 659 <para>
 660
 661 </para>
 662
 663 @pad:
 664 @bin:
 665 @parent:
 666 @Returns:
 667
 668
 669 <!-- ##### FUNCTION gst_pad_peek ##### -->
 670 <para>
 671
 672 </para>
 673
 674 @pad:
 675 @Returns:
 676
 677
 678 <!-- ##### FUNCTION gst_pad_select ##### -->
 679 <para>
 680
 681 </para>
 682
 683 @padlist:
 684 @Returns:
 685
 686
 687 <!-- ##### FUNCTION gst_pad_selectv ##### -->
 688 <para>
 689
 690 </para>
 691
 692 @pad:
 693 @Varargs:
 694 @Returns:
 695
 696
 697 <!-- ##### FUNCTION gst_pad_send_event ##### -->
 698 <para>
 699
 700 </para>
 701
 702 @pad:
 703 @event:
 704 @Returns:
 705
 706
 707 <!-- ##### FUNCTION gst_pad_set_event_function ##### -->
 708 <para>
 709
 710 </para>
 711
 712 @pad:
 713 @event:
 714
 715
 716 <!-- ##### STRUCT GstRealPad ##### -->
 717 <para>
 718
 719 </para>
 720
 721 @pad:
 722 @caps:
 723 @direction:
 724 @threadstate:
 725 @peer:
 726 @bufpen:
 727 @regiontype:
 728 @offset:
 729 @len:
 730 @sched:
 731 @chainfunc:
 732 @chainhandler:
 733 @getfunc:
 734 @gethandler:
 735 @eventfunc:
 736 @eventhandler:
 737 @getregionfunc:
 738 @pullregionfunc:
 739 @negotiatefunc:
 740 @newcapsfunc:
 741 @bufferpoolfunc:
 742 @ghostpads:
 743
 744 <!-- ##### MACRO GST_RPAD_LEN ##### -->
 745 <para>
 746 Get the length of the region that is being pulled.
 747 </para>
 748
 749 @pad: the real pad to query.
 750
 751
 752 <!-- ##### MACRO GST_RPAD_OFFSET ##### -->
 753 <para>
 754 Get the offset of the region that is being pulled.
 755 </para>
 756
 757 @pad: the real pad to query.
 758
 759
 760 <!-- ##### MACRO GST_RPAD_SCHED ##### -->
 761 <para>
 762 Get the scheduler of this real pad.
 763 </para>
 764
 765 @pad: the real pad to query.
 766
 767
 768 <!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
 769 <para>
 770 Get the type of the region that is being pulled.
 771 </para>
 772
 773 @pad: the real pad to query.
 774
 775
 776 <!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
 777 <para>
 778 Get the direction of the real pad.
 779 </para>
 780
 781 @pad: the realpad to query.
 782
 783
 784 <!-- ##### MACRO GST_RPAD_CAPS ##### -->
 785 <para>
 786 Get the caps of the real pad.
 787 </para>
 788
 789 @pad: the real pad to query.
 790
 791
 792 <!-- ##### MACRO GST_RPAD_PEER ##### -->
 793 <para>
 794 Get the peer element of the real pad.
 795 </para>
 796
 797 @pad: the real pad to query.
 798
 799
 800 <!-- ##### MACRO GST_RPAD_BUFPEN ##### -->
 801 <para>
 802 Get the bufpen of the real pad.
 803 </para>
 804
 805 @pad: the real pad to query.
 806
 807
 808 <!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
 809 <para>
 810 Get the chain function of the real pad.
 811 </para>
 812
 813 @pad: the real pad to query.
 814
 815
 816 <!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
 817 <para>
 818 Get get getfunction of the real pad.
 819 </para>
 820
 821 @pad: the real pad to query.
 822
 823
 824 <!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
 825 <para>
 826 Get the getregion function of the real pad.
 827 </para>
 828
 829 @pad: the real pad to query.
 830
 831
 832 <!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
 833 <para>
 834 Get the pullregion function of the real pad.
 835 </para>
 836
 837 @pad: the real pad to query.
 838
 839
 840 <!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### -->
 841 <para>
 842 Get the negotiate function from the real pad.
 843 </para>
 844
 845 @pad: the real pad to query.
 846
 847
 848 <!-- ##### MACRO GST_RPAD_NEWCAPSFUNC ##### -->
 849 <para>
 850 Get the newcaps function from the real pad.
 851 </para>
 852
 853 @pad: the real pad to query.
 854
 855
 856 <!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### -->
 857 <para>
 858 Get the bufferpoolfunction from the real pad.
 859 </para>
 860
 861 @pad: the real pad to query.
 862
 863
 864 <!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
 865 <para>
 866 Get the eventhandler function from the real pad.
 867 </para>
 868
 869 @pad: the real pad to query.
 870
 871
 872 <!-- ##### MACRO GST_RPAD_EVENTFUNC ##### -->
 873 <para>
 874 Get the event function of this real pad.
 875 </para>
 876
 877 @pad: the real pad to query.
 878
 879
 880 <!-- ##### MACRO GST_RPAD_EVENTHANDLER ##### -->
 881 <para>
 882 Get the eventhandler function of this real pad.
 883 </para>
 884
 885 @pad: the real pad to query.
 886
 887
 888 <!-- ##### MACRO GST_RPAD_GETHANDLER ##### -->
 889 <para>
 890 Get the gethandler function of this real pad.
 891 </para>
 892
 893 @pad: the real pad to query.
 894
 895
 896 <!-- ##### MACRO GST_GPAD_REALPAD ##### -->
 897 <para>
 898 Get the real pad of this ghost pad.
 899 </para>
 900
 901 @pad: the real pad to query.
 902
 903
 904 <!-- ##### STRUCT GstGhostPad ##### -->
 905 <para>
 906
 907 </para>
 908
 909 @pad:
 910 @realpad:
 911
 912 <!-- ##### FUNCTION gst_ghost_pad_new ##### -->
 913 <para>
 914
 915 </para>
 916
 917 @name:
 918 @pad:
 919 @Returns:
 920
 921
 922 <!-- ##### ENUM GstPadPresence ##### -->
 923 <para>
 924 Indicates when this pad will become available.
 925 </para>
 926
 927 @GST_PAD_ALWAYS: the pad is always available
 928 @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
 929 @GST_PAD_REQUEST: th pad is only available on request with
 930 gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
 931
 932 <!-- ##### STRUCT GstPadTemplate ##### -->
 933 <para>
 934
 935 </para>
 936
 937 @object:
 938 @name_template:
 939 @direction:
 940 @presence:
 941 @caps:
 942
 943 <!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### -->
 944 <para>
 945 Get a handle to the padtemplate #GstCaps
 946 </para>
 947
 948 @templ: the template to query
 949
 950
 951 <!-- ##### MACRO GST_PADTEMPLATE_DIRECTION ##### -->
 952 <para>
 953 Get the direction of the padtemplate.
 954 </para>
 955
 956 @templ: the template to query
 957
 958
 959 <!-- ##### MACRO GST_PADTEMPLATE_NAME_TEMPLATE ##### -->
 960 <para>
 961 Get the nametemplate of the padtemplate.
 962 </para>
 963
 964 @templ: the template to query
 965
 966
 967 <!-- ##### MACRO GST_PADTEMPLATE_PRESENCE ##### -->
 968 <para>
 969 Get the presence of the padtemplate.
 970 </para>
 971
 972 @templ: the template to query
 973
 974
 975 <!-- ##### MACRO GST_PADTEMPLATE_NEW ##### -->
 976 <para>
 977 Create a new padtemplate.
 978 </para>
 979
 980 @padname: the nametemplate for the pads that will be created with this template
 981 @dir: the direction of the pads.
 982 @pres: the presence of the pads.
 983 @a...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
 984
 985
 986 <!-- ##### MACRO GST_PADTEMPLATE_FACTORY ##### -->
 987 <para>
 988 Create a factory for a padtemplate. This can be used if you only want one instance
 989 of the padtemplate. Use GST_PADTEMPLATE_GET() to get the unique padtemplate.
 990 </para>
 991
 992 @name: th name of the factory
 993 @padname: the nametemplate of the pads
 994 @dir: the direction of the pads.
 995 @pres: the presence of the pads.
 996 @a...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
 997
 998
 999 <!-- ##### MACRO GST_PADTEMPLATE_GET ##### -->
1000 <para>
1001 Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY()
1002 </para>
1003
1004 @fact: the factory name to get the padtemplate from.
1005
1006
1007 <!-- ##### FUNCTION gst_padtemplate_new ##### -->
1008 <para>
1009
1010 </para>
1011
1012 @name_template:
1013 @direction:
1014 @presence:
1015 @caps:
1016 @Varargs:
1017 @Returns:
1018
1019
1020 <!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
1021 <para>
1022
1023 </para>
1024
1025 @parent:
1026 @Returns:
1027
1028
1029 <!-- ##### FUNCTION gst_padtemplate_save_thyself ##### -->
1030 <para>
1031
1032 </para>
1033
1034 @templ:
1035 @parent:
1036 @Returns:
1037
1038
1039 <!-- ##### FUNCTION gst_padtemplate_get_caps ##### -->
1040 <para>
1041
1042 </para>
1043
1044 @templ:
1045 @Returns:
1046
1047
1048 <!-- ##### FUNCTION gst_padtemplate_get_caps_by_name ##### -->
1049 <para>
1050
1051 </para>
1052
1053 @templ:
1054 @name:
1055 @Returns:
1056
1057