notes on documenting elements and plugins
[platform/upstream/gstreamer.git] / docs / gst / tmpl / gstpad.sgml
1 <!-- ##### SECTION Title ##### -->
2 GstPad
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Object contained by elements that allows links to other elements
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 A #GstElement is linked to other elements via "pads", which are extremely 
10 light-weight generic link points. 
11 After two pads are retrieved from an element with gst_element_get_pad(), 
12 the pads can be link with gst_pad_link(). (For quick links,
13 you can also use gst_element_link(), which will make the obvious
14 link for you if it's straightforward.)
15 </para>
16 <para>
17 Pads are typically created from a #GstPadTemplate with 
18 gst_pad_new_from_template().
19 </para>
20 <para>
21 Pads have #GstCaps attached to it to describe the media type they
22 are capable of dealing with. 
23 gst_pad_get_caps() and gst_pad_try_set_caps() are used to
24 manipulate the caps of the pads. 
25 Pads created from a pad template cannot set capabilities that are 
26 incompatible with the pad template capabilities.
27 </para>
28 <para>
29 Pads without pad templates can be created with gst_pad_new(),
30 which takes a direction and a name as an argument.  If the name is NULL,
31 then a guaranteed unique name will be assigned to it.
32 </para>
33 <para>
34 gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
35 </para>
36 <para>
37 A #GstElement creating a pad will typically use the various 
38 gst_pad_set_*_function() calls to register callbacks for various events 
39 on the pads.
40 </para>
41 <para>
42 GstElements will use gst_pad_push() and gst_pad_pull() to push out 
43 or pull in a buffer. 
44 gst_pad_select() and gst_pad_selectv() are used by plugins to wait for the
45 first incoming buffer or event on any of the given set of pads.
46 </para>
47 <para>
48 To send a #GstEvent on a pad, use gst_pad_send_event().
49 </para>
50
51 <para>
52 Last reviewed on December 13th, 2002 (0.5.0.1)
53 </para>
54
55 <!-- ##### SECTION See_Also ##### -->
56 <para>
57 #GstPadTemplate, #GstElement, #GstEvent
58 </para>
59
60 <!-- ##### STRUCT GstPad ##### -->
61 <para>
62
63 </para>
64
65 @stream_rec_lock: 
66 @task: 
67 @preroll_lock: 
68 @preroll_cond: 
69 @block_cond: 
70 @block_callback: 
71 @block_data: 
72 @caps: 
73 @getcapsfunc: 
74 @setcapsfunc: 
75 @acceptcapsfunc: 
76 @fixatecapsfunc: 
77 @activatefunc: 
78 @activatepushfunc: 
79 @activatepullfunc: 
80 @linkfunc: 
81 @unlinkfunc: 
82 @peer: 
83 @sched_private: 
84 @chainfunc: 
85 @checkgetrangefunc: 
86 @getrangefunc: 
87 @eventfunc: 
88 @mode: 
89 @querytypefunc: 
90 @queryfunc: 
91 @intlinkfunc: 
92 @bufferallocfunc: 
93 @do_buffer_signals: 
94 @do_event_signals: 
95
96 <!-- ##### SIGNAL GstPad::have-data ##### -->
97 <para>
98
99 </para>
100
101 @gstpad: the object which received the signal.
102 @arg1: 
103 @Returns: 
104
105 <!-- ##### SIGNAL GstPad::linked ##### -->
106 <para>
107
108 </para>
109
110 @gstpad: the object which received the signal.
111 @arg1: 
112
113 <!-- ##### SIGNAL GstPad::request-link ##### -->
114 <para>
115
116 </para>
117
118 @gstpad: the object which received the signal.
119
120 <!-- ##### SIGNAL GstPad::unlinked ##### -->
121 <para>
122
123 </para>
124
125 @gstpad: the object which received the signal.
126 @arg1: 
127
128 <!-- ##### ARG GstPad:caps ##### -->
129 <para>
130
131 </para>
132
133 <!-- ##### ARG GstPad:direction ##### -->
134 <para>
135
136 </para>
137
138 <!-- ##### ARG GstPad:template ##### -->
139 <para>
140
141 </para>
142
143 <!-- ##### MACRO GST_PAD_LINK_FAILED ##### -->
144 <para>
145 Macro to test if the given #GstPadLinkReturn value indicates a
146 failed negotiation step (REFUSED/DELAYED).
147 </para>
148
149 @ret: the #GstPadLinkReturn value
150
151
152 <!-- ##### MACRO GST_PAD_LINK_SUCCESSFUL ##### -->
153 <para>
154 Macro to test if the given #GstPadLinkReturn value indicates a
155 successfull negotiation step (OK/DONE).
156 </para>
157
158 @ret: the #GstPadLinkReturn value
159
160
161 <!-- ##### USER_FUNCTION GstPadActivateFunction ##### -->
162 <para>
163
164 </para>
165
166 @pad: 
167 @Returns: 
168
169
170 <!-- ##### USER_FUNCTION GstPadActivateModeFunction ##### -->
171 <para>
172
173 </para>
174
175 @pad: 
176 @active: 
177 @Returns: 
178
179
180 <!-- ##### USER_FUNCTION GstPadBlockCallback ##### -->
181 <para>
182
183 </para>
184
185 @pad: 
186 @blocked: 
187 @user_data: 
188
189
190 <!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
191 <para>
192 A function that will be called when chaining buffers.
193 </para>
194
195 @pad: the #GstPad that performed the chain.
196 @buffer: 
197 @Returns: 
198 <!-- # Unused Parameters # -->
199 @data: 
200 @buf: the #GstBuffer that is chained.
201
202
203 <!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
204 <para>
205 Function signature to handle an event for the pad.
206 </para>
207
208 @pad: the #GstPad to handle the event.
209 @event: the #GstEvent to handle.
210 @Returns: TRUE if the pad could handle the event.
211
212
213 <!-- ##### USER_FUNCTION GstPadCheckGetRangeFunction ##### -->
214 <para>
215
216 </para>
217
218 @pad: 
219 @Returns: 
220
221
222 <!-- ##### USER_FUNCTION GstPadGetRangeFunction ##### -->
223 <para>
224
225 </para>
226
227 @pad: 
228 @offset: 
229 @length: 
230 @buffer: 
231 @Returns: 
232
233
234 <!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
235 <para>
236 The signature of the query function.
237 </para>
238
239 @pad: the #GstPad to query.
240 @query: 
241 @Returns: TRUE if the query could be performed.
242 <!-- # Unused Parameters # -->
243 @type: the #GstPadQueryType.
244 @format: a pointer to the target #GstFormat.
245 @value: a pointer to the target value.
246
247
248 <!-- ##### USER_FUNCTION GstPadIntLinkFunction ##### -->
249 <para>
250 The signature of the internal pad link function.
251 </para>
252
253 @pad: The #GstPad to query.
254 @Returns: a newly allocated #GList of pads that are linked to 
255           the given pad on the inside of the parent element.  
256           The caller must call g_list_free() on it after use.
257
258
259 <!-- ##### USER_FUNCTION GstPadQueryTypeFunction ##### -->
260 <para>
261 The signature of the query types function.
262 </para>
263
264 @pad: a #GstPad to query
265 @Returns: an array of query types
266
267
268 <!-- ##### USER_FUNCTION GstPadLinkFunction ##### -->
269 <para>
270 Function signature to handle a new link on the pad.
271 </para>
272
273 @pad: the #GstPad that is linked.
274 @peer: 
275 @Returns: the result of the link with the specified caps.
276 <!-- # Unused Parameters # -->
277 @caps: the peer's #GstCaps.
278
279
280 <!-- ##### USER_FUNCTION GstPadUnlinkFunction ##### -->
281 <para>
282
283 </para>
284
285 @pad: 
286
287
288 <!-- ##### USER_FUNCTION GstPadAcceptCapsFunction ##### -->
289 <para>
290
291 </para>
292
293 @pad: 
294 @caps: 
295 @Returns: 
296
297
298 <!-- ##### USER_FUNCTION GstPadFixateCapsFunction ##### -->
299 <para>
300
301 </para>
302
303 @pad: 
304 @caps: 
305
306
307 <!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
308 <para>
309 Returns a copy of the capabilities of the specified pad. By default this
310 function will return the pad template capabilities, but can optionally
311 be overridden.
312 </para>
313
314 @pad: the #GstPad to get the capabilities of.
315 @Returns: a newly allocated copy #GstCaps of the pad.
316 <!-- # Unused Parameters # -->
317 @caps: the peer's #GstCaps, can be used to filter the capabilities.
318
319
320 <!-- ##### USER_FUNCTION GstPadSetCapsFunction ##### -->
321 <para>
322
323 </para>
324
325 @pad: 
326 @caps: 
327 @Returns: 
328
329
330 <!-- ##### USER_FUNCTION GstPadBufferAllocFunction ##### -->
331 <para>
332
333 </para>
334
335 @pad: 
336 @offset: 
337 @size: 
338 @caps: 
339 @buf: 
340 @Returns: 
341
342
343 <!-- ##### USER_FUNCTION GstPadDispatcherFunction ##### -->
344 <para>
345 A dispatcher function is called for all internally linked pads, see 
346 gst_pad_dispatcher().
347 </para>
348
349 @pad: the #GstPad that is dispatched.
350 @data: the gpointer to optional user data.
351 @Returns: TRUE if the dispatching procedure has to be stopped.
352
353
354 <!-- ##### ENUM GstPadDirection ##### -->
355 <para>
356 The direction of a pad.
357 </para>
358
359 @GST_PAD_UNKNOWN: direction is unknown.
360 @GST_PAD_SRC: the pad is a source pad.
361 @GST_PAD_SINK: the pad is a sink pad.
362
363 <!-- ##### ENUM GstPadFlags ##### -->
364 <para>
365
366 </para>
367
368 @GST_PAD_BLOCKED: 
369 @GST_PAD_FLUSHING: 
370 @GST_PAD_IN_GETCAPS: 
371 @GST_PAD_IN_SETCAPS: 
372 @GST_PAD_FLAG_LAST: 
373
374 <!-- ##### ENUM GstPadLinkReturn ##### -->
375
376
377 @GST_PAD_LINK_OK: 
378 @GST_PAD_LINK_WRONG_HIERARCHY: 
379 @GST_PAD_LINK_WAS_LINKED: 
380 @GST_PAD_LINK_WRONG_DIRECTION: 
381 @GST_PAD_LINK_NOFORMAT: 
382 @GST_PAD_LINK_NOSCHED: 
383 @GST_PAD_LINK_REFUSED: 
384
385 <!-- ##### ENUM GstPadPresence ##### -->
386 <para>
387 Indicates when this pad will become available.
388 </para>
389
390 @GST_PAD_ALWAYS: the pad is always available
391 @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
392 @GST_PAD_REQUEST: the pad is only available on request with 
393 gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
394
395 <!-- ##### ENUM GstFlowReturn ##### -->
396 <para>
397
398 </para>
399
400 @GST_FLOW_RESEND: 
401 @GST_FLOW_OK: 
402 @GST_FLOW_NOT_LINKED: 
403 @GST_FLOW_WRONG_STATE: 
404 @GST_FLOW_UNEXPECTED: 
405 @GST_FLOW_NOT_NEGOTIATED: 
406 @GST_FLOW_ERROR: 
407 @GST_FLOW_NOT_SUPPORTED: 
408
409 <!-- ##### ENUM GstActivateMode ##### -->
410 <para>
411
412 </para>
413
414 @GST_ACTIVATE_NONE: 
415 @GST_ACTIVATE_PUSH: 
416 @GST_ACTIVATE_PULL: 
417
418 <!-- ##### MACRO GST_PREROLL_BROADCAST ##### -->
419 <para>
420
421 </para>
422
423 @pad: 
424
425
426 <!-- ##### MACRO GST_PREROLL_GET_COND ##### -->
427 <para>
428
429 </para>
430
431 @pad: 
432
433
434 <!-- ##### MACRO GST_PREROLL_GET_LOCK ##### -->
435 <para>
436
437 </para>
438
439 @pad: 
440
441
442 <!-- ##### MACRO GST_PREROLL_LOCK ##### -->
443 <para>
444
445 </para>
446
447 @pad: 
448
449
450 <!-- ##### MACRO GST_PREROLL_SIGNAL ##### -->
451 <para>
452
453 </para>
454
455 @pad: 
456
457
458 <!-- ##### MACRO GST_PREROLL_TIMED_WAIT ##### -->
459 <para>
460
461 </para>
462
463 @pad: 
464 @timeval: 
465
466
467 <!-- ##### MACRO GST_PREROLL_TRYLOCK ##### -->
468 <para>
469
470 </para>
471
472 @pad: 
473
474
475 <!-- ##### MACRO GST_PREROLL_UNLOCK ##### -->
476 <para>
477
478 </para>
479
480 @pad: 
481
482
483 <!-- ##### MACRO GST_PREROLL_WAIT ##### -->
484 <para>
485
486 </para>
487
488 @pad: 
489
490
491 <!-- ##### MACRO GST_STREAM_GET_LOCK ##### -->
492 <para>
493
494 </para>
495
496 @pad: 
497
498
499 <!-- ##### MACRO GST_STREAM_LOCK ##### -->
500 <para>
501
502 </para>
503
504 @pad: 
505
506
507 <!-- ##### MACRO GST_STREAM_LOCK_FULL ##### -->
508 <para>
509
510 </para>
511
512 @pad: 
513 @t: 
514
515
516 <!-- ##### MACRO GST_STREAM_TRYLOCK ##### -->
517 <para>
518
519 </para>
520
521 @pad: 
522
523
524 <!-- ##### MACRO GST_STREAM_UNLOCK ##### -->
525 <para>
526
527 </para>
528
529 @pad: 
530
531
532 <!-- ##### MACRO GST_STREAM_UNLOCK_FULL ##### -->
533 <para>
534
535 </para>
536
537 @pad: 
538
539
540 <!-- ##### MACRO GST_FLOW_IS_FATAL ##### -->
541 <para>
542
543 </para>
544
545 @ret: 
546
547
548 <!-- ##### FUNCTION gst_pad_new ##### -->
549 <para>
550
551 </para>
552
553 @name: 
554 @direction: 
555 @Returns: 
556
557
558 <!-- ##### FUNCTION gst_pad_new_from_template ##### -->
559 <para>
560
561 </para>
562
563 @templ: 
564 @name: 
565 @Returns: 
566
567
568 <!-- ##### MACRO gst_pad_get_name ##### -->
569 <para>
570
571 </para>
572
573 @pad: 
574 @Returns: 
575
576
577 <!-- ##### FUNCTION gst_pad_get_direction ##### -->
578 <para>
579
580 </para>
581
582 @pad: 
583 @Returns: 
584
585
586 <!-- ##### MACRO gst_pad_get_parent ##### -->
587 <para>
588
589 </para>
590
591 @pad: 
592 @Returns: 
593
594
595 <!-- ##### FUNCTION gst_pad_get_parent_element ##### -->
596 <para>
597
598 </para>
599
600 @pad: 
601 @Returns: 
602
603
604 <!-- ##### FUNCTION gst_pad_set_active ##### -->
605 <para>
606
607 </para>
608
609 @pad: 
610 @active: 
611 @Returns: 
612 <!-- # Unused Parameters # -->
613 @mode: 
614
615
616 <!-- ##### FUNCTION gst_pad_is_active ##### -->
617 <para>
618
619 </para>
620
621 @pad: 
622 @Returns: 
623
624
625 <!-- ##### FUNCTION gst_pad_set_blocked ##### -->
626 <para>
627
628 </para>
629
630 @pad: 
631 @blocked: 
632 @Returns: 
633
634
635 <!-- ##### FUNCTION gst_pad_set_blocked_async ##### -->
636 <para>
637
638 </para>
639
640 @pad: 
641 @blocked: 
642 @callback: 
643 @user_data: 
644 @Returns: 
645
646
647 <!-- ##### FUNCTION gst_pad_is_blocked ##### -->
648 <para>
649
650 </para>
651
652 @pad: 
653 @Returns: 
654
655
656 <!-- ##### FUNCTION gst_pad_set_element_private ##### -->
657 <para>
658
659 </para>
660
661 @pad: 
662 @priv: 
663
664
665 <!-- ##### FUNCTION gst_pad_get_element_private ##### -->
666 <para>
667
668 </para>
669
670 @pad: 
671 @Returns: 
672
673
674 <!-- ##### FUNCTION gst_pad_get_pad_template ##### -->
675 <para>
676
677 </para>
678
679 @pad: 
680 @Returns: 
681
682
683 <!-- ##### FUNCTION gst_pad_set_bufferalloc_function ##### -->
684 <para>
685
686 </para>
687
688 @pad: 
689 @bufalloc: 
690 <!-- # Unused Parameters # -->
691 @bufferalloc: 
692
693
694 <!-- ##### FUNCTION gst_pad_alloc_buffer ##### -->
695 <para>
696
697 </para>
698
699 @pad: 
700 @offset: 
701 @size: 
702 @caps: 
703 @buf: 
704 @Returns: 
705
706
707 <!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
708 <para>
709
710 </para>
711
712 @pad: 
713 @chain: 
714
715
716 <!-- ##### FUNCTION gst_pad_chain ##### -->
717 <para>
718
719 </para>
720
721 @pad: 
722 @buffer: 
723 @Returns: 
724
725
726 <!-- ##### FUNCTION gst_pad_set_checkgetrange_function ##### -->
727 <para>
728
729 </para>
730
731 @pad: 
732 @check: 
733
734
735 <!-- ##### FUNCTION gst_pad_set_getrange_function ##### -->
736 <para>
737
738 </para>
739
740 @pad: 
741 @get: 
742
743
744 <!-- ##### FUNCTION gst_pad_get_range ##### -->
745 <para>
746
747 </para>
748
749 @pad: 
750 @offset: 
751 @size: 
752 @buffer: 
753 @Returns: 
754
755
756 <!-- ##### FUNCTION gst_pad_set_event_function ##### -->
757 <para>
758
759 </para>
760
761 @pad: 
762 @event: 
763
764
765 <!-- ##### FUNCTION gst_pad_set_unlink_function ##### -->
766 <para>
767
768 </para>
769
770 @pad: 
771 @unlink: 
772
773
774 <!-- ##### FUNCTION gst_pad_set_activate_function ##### -->
775 <para>
776
777 </para>
778
779 @pad: 
780 @activate: 
781
782
783 <!-- ##### FUNCTION gst_pad_set_activatepull_function ##### -->
784 <para>
785
786 </para>
787
788 @pad: 
789 @activatepull: 
790
791
792 <!-- ##### FUNCTION gst_pad_start_task ##### -->
793 <para>
794
795 </para>
796
797 @pad: 
798 @func: 
799 @data: 
800 @Returns: 
801
802
803 <!-- ##### FUNCTION gst_pad_pause_task ##### -->
804 <para>
805
806 </para>
807
808 @pad: 
809 @Returns: 
810
811
812 <!-- ##### FUNCTION gst_pad_stop_task ##### -->
813 <para>
814
815 </para>
816
817 @pad: 
818 @Returns: 
819
820
821 <!-- ##### FUNCTION gst_pad_link ##### -->
822 <para>
823
824 </para>
825
826 @srcpad: 
827 @sinkpad: 
828 @Returns: 
829
830
831 <!-- ##### FUNCTION gst_pad_unlink ##### -->
832 <para>
833
834 </para>
835
836 @srcpad: 
837 @sinkpad: 
838 @Returns: 
839
840
841 <!-- ##### FUNCTION gst_pad_is_linked ##### -->
842 <para>
843
844 </para>
845
846 @pad: 
847 @Returns: 
848
849
850 <!-- ##### FUNCTION gst_pad_set_link_function ##### -->
851 <para>
852
853 </para>
854
855 @pad: 
856 @link: 
857
858
859 <!-- ##### FUNCTION gst_pad_can_link ##### -->
860 <para>
861
862 </para>
863
864 @srcpad: 
865 @sinkpad: 
866 @Returns: 
867
868
869 <!-- ##### FUNCTION gst_pad_accept_caps ##### -->
870 <para>
871
872 </para>
873
874 @pad: 
875 @caps: 
876 @Returns: 
877
878
879 <!-- ##### FUNCTION gst_pad_get_negotiated_caps ##### -->
880 <para>
881
882 </para>
883
884 @pad: 
885 @Returns: 
886
887
888 <!-- ##### FUNCTION gst_pad_get_caps ##### -->
889 <para>
890
891 </para>
892
893 @pad: 
894 @Returns: 
895
896
897 <!-- ##### FUNCTION gst_pad_set_caps ##### -->
898 <para>
899
900 </para>
901
902 @pad: 
903 @caps: 
904 @Returns: 
905
906
907 <!-- ##### FUNCTION gst_pad_get_pad_template_caps ##### -->
908 <para>
909
910 </para>
911
912 @pad: 
913 @Returns: 
914
915
916 <!-- ##### FUNCTION gst_pad_set_acceptcaps_function ##### -->
917 <para>
918
919 </para>
920
921 @pad: 
922 @acceptcaps: 
923
924
925 <!-- ##### FUNCTION gst_pad_set_getcaps_function ##### -->
926 <para>
927
928 </para>
929
930 @pad: 
931 @getcaps: 
932
933
934 <!-- ##### FUNCTION gst_pad_set_setcaps_function ##### -->
935 <para>
936
937 </para>
938
939 @pad: 
940 @setcaps: 
941
942
943 <!-- ##### FUNCTION gst_pad_proxy_getcaps ##### -->
944 <para>
945
946 </para>
947
948 @pad: 
949 @Returns: 
950
951
952 <!-- ##### FUNCTION gst_pad_proxy_setcaps ##### -->
953 <para>
954
955 </para>
956
957 @pad: 
958 @caps: 
959 @Returns: 
960
961
962 <!-- ##### FUNCTION gst_pad_get_allowed_caps ##### -->
963 <para>
964
965 </para>
966
967 @srcpad: 
968 @Returns: 
969 <!-- # Unused Parameters # -->
970 @pad: 
971
972
973 <!-- ##### FUNCTION gst_pad_get_fixed_caps_func ##### -->
974 <para>
975
976 </para>
977
978 @pad: 
979 @Returns: 
980
981
982 <!-- ##### FUNCTION gst_pad_get_peer ##### -->
983 <para>
984
985 </para>
986
987 @pad: 
988 @Returns: 
989
990
991 <!-- ##### FUNCTION gst_pad_peer_get_caps ##### -->
992 <para>
993
994 </para>
995
996 @pad: 
997 @Returns: 
998
999
1000 <!-- ##### FUNCTION gst_pad_peer_accept_caps ##### -->
1001 <para>
1002
1003 </para>
1004
1005 @pad: 
1006 @caps: 
1007 @Returns: 
1008
1009
1010 <!-- ##### FUNCTION gst_pad_use_fixed_caps ##### -->
1011 <para>
1012
1013 </para>
1014
1015 @pad: 
1016
1017
1018 <!-- ##### FUNCTION gst_pad_fixate_caps ##### -->
1019 <para>
1020
1021 </para>
1022
1023 @pad: 
1024 @caps: 
1025
1026
1027 <!-- ##### FUNCTION gst_pad_set_fixatecaps_function ##### -->
1028 <para>
1029
1030 </para>
1031
1032 @pad: 
1033 @fixatecaps: 
1034
1035
1036 <!-- ##### FUNCTION gst_pad_set_activatepush_function ##### -->
1037 <para>
1038
1039 </para>
1040
1041 @pad: 
1042 @activatepush: 
1043
1044
1045 <!-- ##### FUNCTION gst_pad_push ##### -->
1046 <para>
1047
1048 </para>
1049
1050 @pad: 
1051 @buffer: 
1052 @Returns: 
1053 <!-- # Unused Parameters # -->
1054 @data: 
1055 @buf: 
1056
1057
1058 <!-- ##### FUNCTION gst_pad_push_event ##### -->
1059 <para>
1060
1061 </para>
1062
1063 @pad: 
1064 @event: 
1065 @Returns: 
1066
1067
1068 <!-- ##### FUNCTION gst_pad_check_pull_range ##### -->
1069 <para>
1070
1071 </para>
1072
1073 @pad: 
1074 @Returns: 
1075
1076
1077 <!-- ##### FUNCTION gst_pad_pull_range ##### -->
1078 <para>
1079
1080 </para>
1081
1082 @pad: 
1083 @offset: 
1084 @size: 
1085 @buffer: 
1086 @Returns: 
1087
1088
1089 <!-- ##### FUNCTION gst_pad_activate_pull ##### -->
1090 <para>
1091
1092 </para>
1093
1094 @pad: 
1095 @active: 
1096 @Returns: 
1097
1098
1099 <!-- ##### FUNCTION gst_pad_activate_push ##### -->
1100 <para>
1101
1102 </para>
1103
1104 @pad: 
1105 @active: 
1106 @Returns: 
1107
1108
1109 <!-- ##### FUNCTION gst_pad_send_event ##### -->
1110 <para>
1111
1112 </para>
1113
1114 @pad: 
1115 @event: 
1116 @Returns: 
1117
1118
1119 <!-- ##### FUNCTION gst_pad_event_default ##### -->
1120 <para>
1121
1122 </para>
1123
1124 @pad: 
1125 @event: 
1126 @Returns: 
1127
1128
1129 <!-- ##### FUNCTION gst_pad_set_query_function ##### -->
1130 <para>
1131
1132 </para>
1133
1134 @pad: 
1135 @query: 
1136
1137
1138 <!-- ##### FUNCTION gst_pad_set_query_type_function ##### -->
1139 <para>
1140
1141 </para>
1142
1143 @pad: 
1144 @type_func: 
1145
1146
1147 <!-- ##### FUNCTION gst_pad_get_query_types ##### -->
1148 <para>
1149
1150 </para>
1151
1152 @pad: 
1153 @Returns: 
1154
1155
1156 <!-- ##### FUNCTION gst_pad_get_query_types_default ##### -->
1157 <para>
1158
1159 </para>
1160
1161 @pad: 
1162 @Returns: 
1163
1164
1165 <!-- ##### FUNCTION gst_pad_query ##### -->
1166 <para>
1167
1168 </para>
1169
1170 @pad: 
1171 @query: 
1172 @Returns: 
1173 <!-- # Unused Parameters # -->
1174 @type: 
1175 @format: 
1176 @value: 
1177
1178
1179 <!-- ##### FUNCTION gst_pad_query_default ##### -->
1180 <para>
1181
1182 </para>
1183
1184 @pad: 
1185 @query: 
1186 @Returns: 
1187 <!-- # Unused Parameters # -->
1188 @type: 
1189 @format: 
1190 @value: 
1191
1192
1193 <!-- ##### FUNCTION gst_pad_query_position ##### -->
1194 <para>
1195
1196 </para>
1197
1198 @pad: 
1199 @format: 
1200 @cur: 
1201 @end: 
1202 @Returns: 
1203
1204
1205 <!-- ##### FUNCTION gst_pad_query_convert ##### -->
1206 <para>
1207
1208 </para>
1209
1210 @pad: 
1211 @src_format: 
1212 @src_val: 
1213 @dest_format: 
1214 @dest_val: 
1215 @Returns: 
1216 <!-- # Unused Parameters # -->
1217 @dest_fmt: 
1218
1219
1220 <!-- ##### FUNCTION gst_pad_set_internal_link_function ##### -->
1221 <para>
1222
1223 </para>
1224
1225 @pad: 
1226 @intlink: 
1227
1228
1229 <!-- ##### FUNCTION gst_pad_get_internal_links ##### -->
1230 <para>
1231
1232 </para>
1233
1234 @pad: 
1235 @Returns: 
1236
1237
1238 <!-- ##### FUNCTION gst_pad_get_internal_links_default ##### -->
1239 <para>
1240
1241 </para>
1242
1243 @pad: 
1244 @Returns: 
1245
1246
1247 <!-- ##### FUNCTION gst_pad_dispatcher ##### -->
1248 <para>
1249
1250 </para>
1251
1252 @pad: 
1253 @dispatch: 
1254 @data: 
1255 @Returns: 
1256
1257
1258 <!-- ##### FUNCTION gst_pad_load_and_link ##### -->
1259 <para>
1260
1261 </para>
1262
1263 @self: 
1264 @parent: 
1265
1266
1267 <!-- ##### FUNCTION gst_pad_add_data_probe ##### -->
1268 <para>
1269
1270 </para>
1271
1272 @pad: 
1273 @handler: 
1274 @data: 
1275 @Returns: 
1276
1277
1278 <!-- ##### FUNCTION gst_pad_add_buffer_probe ##### -->
1279 <para>
1280
1281 </para>
1282
1283 @pad: 
1284 @handler: 
1285 @data: 
1286 @Returns: 
1287
1288
1289 <!-- ##### FUNCTION gst_pad_add_event_probe ##### -->
1290 <para>
1291
1292 </para>
1293
1294 @pad: 
1295 @handler: 
1296 @data: 
1297 @Returns: 
1298
1299
1300 <!-- ##### FUNCTION gst_pad_remove_data_probe ##### -->
1301 <para>
1302
1303 </para>
1304
1305 @pad: 
1306 @handler: 
1307 @data: 
1308
1309
1310 <!-- ##### FUNCTION gst_pad_remove_buffer_probe ##### -->
1311 <para>
1312
1313 </para>
1314
1315 @pad: 
1316 @handler: 
1317 @data: 
1318
1319
1320 <!-- ##### FUNCTION gst_pad_remove_event_probe ##### -->
1321 <para>
1322
1323 </para>
1324
1325 @pad: 
1326 @handler: 
1327 @data: 
1328
1329