docs/gst/tmpl/gstpad.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstPad
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The link between 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 <!-- ##### MACRO GST_PAD_NAME ##### -->
  61 <para>
  62 Gets the name of the pad.
  63 </para>
  64
  65 @pad: a #GstPad to get the name of.
  66 @Returns: the pad's name.
  67
  68
  69 <!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
  70 <para>
  71 Gets the private data set by the element that owns the pad.
  72 </para>
  73
  74 @pad: a #GstPad to get the private data of.
  75 #Returns: a gpointer to the private data.
  76
  77
  78 <!-- ##### MACRO GST_PAD_PARENT ##### -->
  79 <para>
  80 Gets the parent element of this pad.
  81 </para>
  82
  83 @pad: a #GstPad to get the parent of.
  84 @Returns: the parent #GstElement of this pad.
  85
  86
  87 <!-- ##### MACRO GST_PAD_PAD_TEMPLATE ##### -->
  88 <para>
  89 Gets the pad template that was used to create this pad.
  90 </para>
  91
  92 @pad: a #GstPad to get the pad template of.
  93 #Returns: the #GstPadTemplate used to create the pad, or NULL if none was
  94 used.
  95
  96
  97 <!-- ##### MACRO GST_PAD_REALIZE ##### -->
  98 <para>
  99 Returns the real pad of this pad.
 100 </para>
 101
 102 @pad: a #GstPad to realize.
 103 @Returns: the actual #GstPad.
 104
 105
 106 <!-- ##### MACRO GST_PAD_DIRECTION ##### -->
 107 <para>
 108 Gets the pad's direction.
 109 </para>
 110
 111 @pad: a #GstPad to get the direction of.
 112 @Returns: the #GstPadDirection of the pad.
 113
 114
 115 <!-- ##### MACRO GST_PAD_CAPS ##### -->
 116 <para>
 117 Gets the capabilities of a pad.
 118 </para>
 119
 120 @pad: a #GstPad to get the capabilities of.
 121 @Returns: the #GstCaps of the pad.
 122
 123
 124 <!-- ##### MACRO GST_PAD_PEER ##### -->
 125 <para>
 126 Gets the peer pad of this pad.  The peer pad is the pad on to which the parent
 127 element is linked through this pad.
 128 </para>
 129
 130 @pad: a #GstPad to get the peer pad of.
 131 @Returns: the peer #GstPad.
 132
 133
 134 <!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
 135 <para>
 136 Checks if buffers can be pulled from this buffer.
 137 </para>
 138
 139 @pad: a #GstPad to check on if a buffer can be pulled from it.
 140
 141
 142 <!-- ##### MACRO GST_PAD_IS_SINK ##### -->
 143 <para>
 144 Checks if the pad is a sink pad.
 145 </para>
 146
 147 @pad: a #GstPad to check.
 148
 149
 150 <!-- ##### MACRO GST_PAD_IS_SRC ##### -->
 151 <para>
 152 Checks if the pad is a source pad.
 153 </para>
 154
 155 @pad: a #GstPad to check.
 156
 157
 158 <!-- ##### MACRO GST_PAD_IS_LINKED ##### -->
 159 <para>
 160 Checks if the pad is linked.
 161 </para>
 162
 163 @pad: a #GstPad to check.
 164
 165
 166 <!-- ##### MACRO GST_PAD_IS_ACTIVE ##### -->
 167 <para>
 168 Checks if the pad is active.
 169 </para>
 170
 171 @pad: a #GstPad to check
 172
 173
 174 <!-- ##### MACRO GST_PAD_IS_USABLE ##### -->
 175 <para>
 176 Checks if a pad is usable. A usable pad is both linked and active.
 177 </para>
 178
 179 @pad: a #GstPad to check
 180
 181
 182 <!-- ##### STRUCT GstPad ##### -->
 183 <para>
 184 The GstPad object
 185 </para>
 186
 187
 188 <!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
 189 <para>
 190 A function that will be called when chaining buffers.
 191 </para>
 192
 193 @pad: the #GstPad that performed the chain.
 194 @data:
 195 <!-- # Unused Parameters # -->
 196 @buf: the #GstBuffer that is chained.
 197
 198
 199 <!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
 200 <para>
 201 A function that will be called when pulling a buffer.
 202 </para>
 203
 204 @pad: the #GstPad to get a buffer from.
 205 @Returns: the #GstBuffer pulled.
 206
 207
 208 <!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
 209 <para>
 210 Returns the capabilities of the specified pad. By default this function
 211 will return the pad template capabilities, but can optionally be overridden.
 212 </para>
 213
 214 @pad: the #GstPad to get the capabilities of.
 215 @Returns: the #GstCaps of the pad.
 216 <!-- # Unused Parameters # -->
 217 @caps: the peer's #GstCaps, can be used to filter the capabilities.
 218
 219
 220 <!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
 221 <para>
 222 Function signature to handle an event for the pad.
 223 </para>
 224
 225 @pad: the #GstPad to handle the event.
 226 @event: the #GstEvent to handle.
 227 @Returns: TRUE if the pad could handle the event.
 228
 229
 230 <!-- ##### USER_FUNCTION GstPadLinkFunction ##### -->
 231 <para>
 232 Function signature to handle a new link on the pad.
 233 </para>
 234
 235 @pad: the #GstPad that is linked.
 236 @caps: the peer's #GstCaps.
 237 @Returns: the result of the link with the specified caps.
 238
 239
 240 <!-- ##### ENUM GstPadLinkReturn ##### -->
 241 <para>
 242 The result of a pad link.
 243 </para>
 244
 245 @GST_PAD_LINK_REFUSED: the link was refused.
 246 @GST_PAD_LINK_DELAYED: the link was delayed, probably because the
 247                        element needs more specific pad capabilitiess.
 248 @GST_PAD_LINK_OK:      the link succeeded.
 249 @GST_PAD_LINK_DONE:    the link succeeded,
 250                        any more attempts are not needed.
 251
 252 <!-- ##### USER_FUNCTION GstPadConvertFunction ##### -->
 253 <para>
 254 The signature of a convert function.
 255 </para>
 256
 257 @pad: the #GstPad to perform the convert on.
 258 @src_format: the source #GstFormat of the conversion.
 259 @src_value: the source value of the conversion.
 260 @dest_format: a pointer to the destination #GstFormat.
 261 @dest_value: a pointer to the destination value.
 262 @Returns: TRUE if the conversion could be performed.
 263
 264
 265 <!-- ##### USER_FUNCTION GstPadDispatcherFunction ##### -->
 266 <para>
 267 A dispatcher function is called for all internally linked pads, see
 268 gst_pad_dispatcher().
 269 </para>
 270
 271 @pad: the #GstPad that is dispatched.
 272 @data: the gpointer to optional user data.
 273 @Returns: TRUE if the dispatching procedure has to be stopped.
 274
 275
 276 <!-- ##### USER_FUNCTION GstPadIntLinkFunction ##### -->
 277 <para>
 278 The signature of the internal pad link function.
 279 </para>
 280
 281 @pad: The #GstPad to query.
 282 @Returns: a newly allocated #GList of pads that are linked to
 283           the given pad on the inside of the parent element.
 284           The caller must call g_list_free() on it after use.
 285
 286
 287 <!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
 288 <para>
 289 The signature of the query function.
 290 </para>
 291
 292 @pad: the #GstPad to query.
 293 @type: the #GstPadQueryType.
 294 @format: a pointer to the target #GstFormat.
 295 @value: a pointer to the target value.
 296 @Returns: TRUE if the query could be performed.
 297
 298
 299 <!-- ##### USER_FUNCTION GstPadEventMaskFunction ##### -->
 300 <para>
 301 The signature of the eventmask function.
 302 </para>
 303
 304 @pad: the #GstPad to query
 305 @Returns: an array of event masks
 306
 307
 308 <!-- ##### USER_FUNCTION GstPadFormatsFunction ##### -->
 309 <para>
 310 The signature of the formats function.
 311 </para>
 312
 313 @pad: a #GstPad to query
 314 @Returns: an array of formats
 315
 316
 317 <!-- ##### USER_FUNCTION GstPadQueryTypeFunction ##### -->
 318 <para>
 319 The signature of the query types function.
 320 </para>
 321
 322 @pad: a #GstPad to query
 323 @Returns: an array of query types
 324
 325
 326 <!-- ##### MACRO GST_PAD_QUERY_TYPE_FUNCTION ##### -->
 327 <para>
 328 A convenience macro to construct query type functions
 329 </para>
 330
 331 @functionname: the name of the function
 332 @...: query types, 0 to mark the last element
 333
 334
 335 <!-- ##### MACRO GST_PAD_FORMATS_FUNCTION ##### -->
 336 <para>
 337 Convenience function to define an array of formats that can be used
 338 as #GstPadGetFormatsFunction.
 339 </para>
 340
 341 @functionname: The name of the function
 342 @...: comma separated list of formats, 0 to mark the end
 343
 344
 345 <!-- ##### MACRO GST_PAD_EVENT_MASK_FUNCTION ##### -->
 346 <para>
 347 Convenience function to define an array of event masks that can be used
 348 as #GstPadGetEventMaskFunction.
 349 </para>
 350
 351 @functionname: The name of the function
 352 @...: comma separated list of event maks, { 0, } to mark the end
 353
 354
 355 <!-- ##### ENUM GstPadDirection ##### -->
 356 <para>
 357 The direction of a pad.
 358 </para>
 359
 360 @GST_PAD_UNKNOWN: direction is unknown.
 361 @GST_PAD_SRC: the pad is a source pad.
 362 @GST_PAD_SINK: the pad is a sink pad.
 363
 364 <!-- ##### ENUM GstPadFlags ##### -->
 365 <para>
 366 Flags for the pad.
 367 </para>
 368
 369 @GST_PAD_DISABLED: the pad is disabled.
 370 @GST_PAD_NEGOTIATING:
 371 @GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags.
 372
 373 <!-- ##### FUNCTION gst_pad_new ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @name:
 379 @direction:
 380 @Returns:
 381
 382
 383 <!-- ##### FUNCTION gst_pad_custom_new ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @type:
 389 @name:
 390 @direction:
 391 @Returns:
 392
 393
 394 <!-- ##### FUNCTION gst_pad_custom_new_from_template ##### -->
 395 <para>
 396
 397 </para>
 398
 399 @type:
 400 @templ:
 401 @name:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION gst_pad_new_from_template ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @templ:
 411 @name:
 412 @Returns:
 413
 414
 415 <!-- ##### FUNCTION gst_pad_get_direction ##### -->
 416 <para>
 417
 418 </para>
 419
 420 @pad:
 421 @Returns:
 422
 423
 424 <!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @pad:
 430 @chain:
 431
 432
 433 <!-- ##### FUNCTION gst_pad_set_get_function ##### -->
 434 <para>
 435
 436 </para>
 437
 438 @pad:
 439 @get:
 440
 441
 442 <!-- ##### FUNCTION gst_pad_set_link_function ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @pad:
 448 @link:
 449
 450
 451 <!-- ##### FUNCTION gst_pad_set_getcaps_function ##### -->
 452 <para>
 453
 454 </para>
 455
 456 @pad:
 457 @getcaps:
 458
 459
 460 <!-- ##### FUNCTION gst_pad_try_set_caps ##### -->
 461 <para>
 462
 463 </para>
 464
 465 @pad:
 466 @caps:
 467 @Returns:
 468
 469
 470 <!-- ##### FUNCTION gst_pad_get_caps ##### -->
 471 <para>
 472
 473 </para>
 474
 475 @pad:
 476 @Returns:
 477
 478
 479 <!-- ##### FUNCTION gst_pad_check_compatibility ##### -->
 480 <para>
 481
 482 </para>
 483
 484 @srcpad:
 485 @sinkpad:
 486 @Returns:
 487
 488
 489 <!-- ##### FUNCTION gst_pad_set_name ##### -->
 490 <para>
 491
 492 </para>
 493
 494 @pad:
 495 @name:
 496
 497
 498 <!-- ##### FUNCTION gst_pad_get_name ##### -->
 499 <para>
 500
 501 </para>
 502
 503 @pad:
 504 @Returns:
 505
 506
 507 <!-- ##### FUNCTION gst_pad_set_element_private ##### -->
 508 <para>
 509
 510 </para>
 511
 512 @pad:
 513 @priv:
 514
 515
 516 <!-- ##### FUNCTION gst_pad_get_element_private ##### -->
 517 <para>
 518
 519 </para>
 520
 521 @pad:
 522 @Returns:
 523
 524
 525 <!-- ##### FUNCTION gst_pad_set_parent ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @pad:
 531 @parent:
 532
 533
 534 <!-- ##### FUNCTION gst_pad_get_parent ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @pad:
 540 @Returns:
 541
 542
 543 <!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @pad:
 549 @Returns:
 550
 551
 552 <!-- ##### FUNCTION gst_pad_add_ghost_pad ##### -->
 553 <para>
 554
 555 </para>
 556
 557 @pad:
 558 @ghostpad:
 559
 560
 561 <!-- ##### FUNCTION gst_pad_remove_ghost_pad ##### -->
 562 <para>
 563
 564 </para>
 565
 566 @pad:
 567 @ghostpad:
 568
 569
 570 <!-- ##### FUNCTION gst_pad_get_ghost_pad_list ##### -->
 571 <para>
 572
 573 </para>
 574
 575 @pad:
 576 @Returns:
 577
 578
 579 <!-- ##### FUNCTION gst_pad_get_peer ##### -->
 580 <para>
 581
 582 </para>
 583
 584 @pad:
 585 @Returns:
 586
 587
 588 <!-- ##### FUNCTION gst_pad_link ##### -->
 589 <para>
 590
 591 </para>
 592
 593 @srcpad:
 594 @sinkpad:
 595 @Returns:
 596
 597
 598 <!-- ##### FUNCTION gst_pad_link_filtered ##### -->
 599 <para>
 600
 601 </para>
 602
 603 @srcpad:
 604 @sinkpad:
 605 @filtercaps:
 606 @Returns:
 607
 608
 609 <!-- ##### FUNCTION gst_pad_relink_filtered ##### -->
 610 <para>
 611
 612 </para>
 613
 614 @srcpad:
 615 @sinkpad:
 616 @filtercaps:
 617 @Returns:
 618
 619
 620 <!-- ##### FUNCTION gst_pad_try_relink_filtered ##### -->
 621 <para>
 622
 623 </para>
 624
 625 @srcpad:
 626 @sinkpad:
 627 @filtercaps:
 628 @Returns:
 629
 630
 631 <!-- ##### FUNCTION gst_pad_unlink ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @srcpad:
 637 @sinkpad:
 638
 639
 640 <!-- ##### FUNCTION gst_pad_can_link ##### -->
 641 <para>
 642
 643 </para>
 644
 645 @srcpad:
 646 @sinkpad:
 647 @Returns:
 648
 649
 650 <!-- ##### FUNCTION gst_pad_can_link_filtered ##### -->
 651 <para>
 652
 653 </para>
 654
 655 @srcpad:
 656 @sinkpad:
 657 @filtercaps:
 658 @Returns:
 659
 660
 661 <!-- ##### FUNCTION gst_pad_push ##### -->
 662 <para>
 663
 664 </para>
 665
 666 @pad:
 667 @data:
 668 <!-- # Unused Parameters # -->
 669 @buf:
 670
 671
 672 <!-- ##### FUNCTION gst_pad_pull ##### -->
 673 <para>
 674
 675 </para>
 676
 677 @pad:
 678 @Returns:
 679
 680
 681 <!-- ##### FUNCTION gst_pad_load_and_link ##### -->
 682 <para>
 683
 684 </para>
 685
 686 @self:
 687 @parent:
 688
 689
 690 <!-- ##### FUNCTION gst_pad_proxy_link ##### -->
 691 <para>
 692
 693 </para>
 694
 695 @pad:
 696 @caps:
 697 @Returns:
 698
 699
 700 <!-- ##### FUNCTION gst_pad_get_pad_template ##### -->
 701 <para>
 702
 703 </para>
 704
 705 @pad:
 706 @Returns:
 707
 708
 709 <!-- ##### FUNCTION gst_pad_get_pad_template_caps ##### -->
 710 <para>
 711
 712 </para>
 713
 714 @pad:
 715 @Returns:
 716
 717
 718 <!-- ##### FUNCTION gst_pad_get_allowed_caps ##### -->
 719 <para>
 720
 721 </para>
 722
 723 @pad:
 724 @Returns:
 725
 726
 727 <!-- ##### FUNCTION gst_pad_perform_negotiate ##### -->
 728 <para>
 729
 730 </para>
 731
 732 @srcpad:
 733 @sinkpad:
 734 @Returns:
 735
 736
 737 <!-- ##### FUNCTION gst_ghost_pad_save_thyself ##### -->
 738 <para>
 739
 740 </para>
 741
 742 @pad:
 743 @parent:
 744 @Returns:
 745
 746
 747 <!-- ##### FUNCTION gst_pad_select ##### -->
 748 <para>
 749
 750 </para>
 751
 752 @pad:
 753 @Varargs:
 754 @Returns:
 755 <!-- # Unused Parameters # -->
 756 @padlist:
 757
 758
 759 <!-- ##### FUNCTION gst_pad_selectv ##### -->
 760 <para>
 761
 762 </para>
 763
 764 @padlist:
 765 @Returns:
 766 <!-- # Unused Parameters # -->
 767 @pad:
 768 @Varargs:
 769
 770
 771 <!-- ##### FUNCTION gst_pad_dispatcher ##### -->
 772 <para>
 773
 774 </para>
 775
 776 @pad:
 777 @dispatch:
 778 @data:
 779 @Returns:
 780
 781
 782 <!-- ##### FUNCTION gst_pad_send_event ##### -->
 783 <para>
 784
 785 </para>
 786
 787 @pad:
 788 @event:
 789 @Returns:
 790
 791
 792 <!-- ##### FUNCTION gst_pad_event_default ##### -->
 793 <para>
 794
 795 </para>
 796
 797 @pad:
 798 @event:
 799 @Returns:
 800
 801
 802 <!-- ##### FUNCTION gst_pad_set_event_function ##### -->
 803 <para>
 804
 805 </para>
 806
 807 @pad:
 808 @event:
 809
 810
 811 <!-- ##### FUNCTION gst_pad_get_event_masks ##### -->
 812 <para>
 813
 814 </para>
 815
 816 @pad:
 817 @Returns:
 818
 819
 820 <!-- ##### FUNCTION gst_pad_get_event_masks_default ##### -->
 821 <para>
 822
 823 </para>
 824
 825 @pad:
 826 @Returns:
 827
 828
 829 <!-- ##### FUNCTION gst_pad_set_event_mask_function ##### -->
 830 <para>
 831
 832 </para>
 833
 834 @pad:
 835 @mask_func:
 836
 837
 838 <!-- ##### FUNCTION gst_pad_set_convert_function ##### -->
 839 <para>
 840
 841 </para>
 842
 843 @pad:
 844 @convert:
 845
 846
 847 <!-- ##### FUNCTION gst_pad_convert ##### -->
 848 <para>
 849
 850 </para>
 851
 852 @pad:
 853 @src_format:
 854 @src_value:
 855 @dest_format:
 856 @dest_value:
 857 @Returns:
 858
 859
 860 <!-- ##### FUNCTION gst_pad_convert_default ##### -->
 861 <para>
 862
 863 </para>
 864
 865 @pad:
 866 @src_format:
 867 @src_value:
 868 @dest_format:
 869 @dest_value:
 870 @Returns:
 871
 872
 873 <!-- ##### FUNCTION gst_pad_get_formats ##### -->
 874 <para>
 875
 876 </para>
 877
 878 @pad:
 879 @Returns:
 880
 881
 882 <!-- ##### FUNCTION gst_pad_get_formats_default ##### -->
 883 <para>
 884
 885 </para>
 886
 887 @pad:
 888 @Returns:
 889
 890
 891 <!-- ##### FUNCTION gst_pad_set_formats_function ##### -->
 892 <para>
 893
 894 </para>
 895
 896 @pad:
 897 @formats:
 898
 899
 900 <!-- ##### FUNCTION gst_pad_get_internal_links ##### -->
 901 <para>
 902
 903 </para>
 904
 905 @pad:
 906 @Returns:
 907
 908
 909 <!-- ##### FUNCTION gst_pad_get_internal_links_default ##### -->
 910 <para>
 911
 912 </para>
 913
 914 @pad:
 915 @Returns:
 916
 917
 918 <!-- ##### FUNCTION gst_pad_set_internal_link_function ##### -->
 919 <para>
 920
 921 </para>
 922
 923 @pad:
 924 @intlink:
 925
 926
 927 <!-- ##### FUNCTION gst_pad_set_query_function ##### -->
 928 <para>
 929
 930 </para>
 931
 932 @pad:
 933 @query:
 934
 935
 936 <!-- ##### FUNCTION gst_pad_query ##### -->
 937 <para>
 938
 939 </para>
 940
 941 @pad:
 942 @type:
 943 @format:
 944 @value:
 945 @Returns:
 946
 947
 948 <!-- ##### FUNCTION gst_pad_query_default ##### -->
 949 <para>
 950
 951 </para>
 952
 953 @pad:
 954 @type:
 955 @format:
 956 @value:
 957 @Returns:
 958
 959
 960 <!-- ##### FUNCTION gst_pad_get_query_types ##### -->
 961 <para>
 962
 963 </para>
 964
 965 @pad:
 966 @Returns:
 967
 968
 969 <!-- ##### FUNCTION gst_pad_get_query_types_default ##### -->
 970 <para>
 971
 972 </para>
 973
 974 @pad:
 975 @Returns:
 976
 977
 978 <!-- ##### FUNCTION gst_pad_set_query_type_function ##### -->
 979 <para>
 980
 981 </para>
 982
 983 @pad:
 984 @type_func:
 985
 986
 987 <!-- ##### MACRO gst_pad_add_probe ##### -->
 988 <para>
 989 Adds the probe to the given pad
 990 </para>
 991
 992 @pad: The pad to add the probe to
 993 @probe: The probe to add to the pad
 994
 995
 996 <!-- ##### MACRO gst_pad_remove_probe ##### -->
 997 <para>
 998 Remove the probe from the pad
 999 </para>
1000
1001 @pad: The pad to remove the probe of
1002 @probe: The probe to remove
1003
1004
1005 <!-- ##### FUNCTION gst_pad_is_active ##### -->
1006 <para>
1007
1008 </para>
1009
1010 @pad:
1011 @Returns:
1012
1013
1014 <!-- ##### FUNCTION gst_pad_set_active ##### -->
1015 <para>
1016
1017 </para>
1018
1019 @pad:
1020 @active:
1021
1022
1023 <!-- ##### FUNCTION gst_pad_get_scheduler ##### -->
1024 <para>
1025
1026 </para>
1027
1028 @pad:
1029 @Returns:
1030
1031
1032 <!-- ##### STRUCT GstRealPad ##### -->
1033 <para>
1034 The realpad object
1035 </para>
1036
1037 @pad:
1038 @caps:
1039 @appfixatefunc:
1040 @appfilter:
1041 @getcapsfunc:
1042 @fixatefunc:
1043 @direction:
1044 @linkfunc:
1045 @unlinkfunc:
1046 @peer:
1047 @sched_private:
1048 @chainfunc:
1049 @chainhandler:
1050 @getfunc:
1051 @gethandler:
1052 @eventfunc:
1053 @eventhandler:
1054 @eventmaskfunc:
1055 @ghostpads:
1056 @convertfunc:
1057 @queryfunc:
1058 @formatsfunc:
1059 @querytypefunc:
1060 @intlinkfunc:
1061 @bufferallocfunc:
1062 @probedisp:
1063 @link:
1064 @explicit_caps:
1065 @_gst_reserved:
1066
1067 <!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
1068 <para>
1069 Get the direction of the real pad.
1070 </para>
1071
1072 @pad: the realpad to query.
1073
1074
1075 <!-- ##### MACRO GST_RPAD_CAPS ##### -->
1076 <para>
1077 Get the caps of the real pad.
1078 </para>
1079
1080 @pad: the real pad to query.
1081
1082
1083 <!-- ##### MACRO GST_RPAD_PEER ##### -->
1084 <para>
1085 Get the peer element of the real pad.
1086 </para>
1087
1088 @pad: the real pad to query.
1089
1090
1091 <!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
1092 <para>
1093 Get the chain function of the real pad.
1094 </para>
1095
1096 @pad: the real pad to query.
1097
1098
1099 <!-- ##### MACRO GST_RPAD_APPFILTER ##### -->
1100 <para>
1101 Get the application filter for this pad
1102 </para>
1103
1104 @pad: the pad to query
1105
1106
1107 <!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
1108 <para>
1109 Get get getfunction of the real pad.
1110 </para>
1111
1112 @pad: the real pad to query.
1113
1114
1115 <!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
1116 <para>
1117 Get the eventhandler function from the real pad.
1118 </para>
1119
1120 @pad: the real pad to query.
1121
1122
1123 <!-- ##### MACRO GST_RPAD_EVENTFUNC ##### -->
1124 <para>
1125 Get the event function of this real pad.
1126 </para>
1127
1128 @pad: the real pad to query.
1129
1130
1131 <!-- ##### MACRO GST_RPAD_EVENTHANDLER ##### -->
1132 <para>
1133 Get the eventhandler function of this real pad.
1134 </para>
1135
1136 @pad: the real pad to query.
1137
1138
1139 <!-- ##### MACRO GST_RPAD_GETHANDLER ##### -->
1140 <para>
1141 Get the gethandler function of this real pad.
1142 </para>
1143
1144 @pad: the real pad to query.
1145
1146
1147 <!-- ##### MACRO GST_RPAD_LINKFUNC ##### -->
1148 <para>
1149 Get the link function of the pad
1150 </para>
1151
1152 @pad: the pad to query
1153
1154
1155 <!-- ##### MACRO GST_RPAD_GETCAPSFUNC ##### -->
1156 <para>
1157 Get the getcaps function of this pad
1158 </para>
1159
1160 @pad: the pad to query
1161
1162
1163 <!-- ##### MACRO GST_RPAD_CONVERTFUNC ##### -->
1164 <para>
1165 Get the convert function of this pad
1166 </para>
1167
1168 @pad: the pad to query
1169
1170
1171 <!-- ##### MACRO GST_RPAD_INTLINKFUNC ##### -->
1172 <para>
1173 Get the internal link function of this pad
1174 </para>
1175
1176 @pad: the pad to query
1177
1178
1179 <!-- ##### MACRO GST_RPAD_QUERYFUNC ##### -->
1180 <para>
1181 Get the query function of this pad
1182 </para>
1183
1184 @pad: the pad to query
1185
1186
1187 <!-- ##### MACRO GST_RPAD_EVENTMASKFUNC ##### -->
1188 <para>
1189 Get the event mask function of this pad
1190 </para>
1191
1192 @pad: the pad to query
1193
1194
1195 <!-- ##### MACRO GST_RPAD_FORMATSFUNC ##### -->
1196 <para>
1197 Get the formats function of this pad
1198 </para>
1199
1200 @pad: the pad to query
1201
1202
1203 <!-- ##### MACRO GST_RPAD_QUERYTYPEFUNC ##### -->
1204 <para>
1205 Get the query types function of this pad
1206 </para>
1207
1208 @pad: the pad to query
1209
1210
1211 <!-- ##### MACRO GST_GPAD_REALPAD ##### -->
1212 <para>
1213 Get the real pad of this ghost pad.
1214 </para>
1215
1216 @pad: the real pad to query.
1217
1218
1219 <!-- ##### STRUCT GstGhostPad ##### -->
1220 <para>
1221 The Ghostpad object
1222 </para>
1223
1224
1225 <!-- ##### FUNCTION gst_ghost_pad_new ##### -->
1226 <para>
1227
1228 </para>
1229
1230 @name:
1231 @pad:
1232 @Returns:
1233
1234