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