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