Removed some stuff from the makefile until it stopped complaining when building debs...
[platform/upstream/gstreamer.git] / docs / gst / tmpl / gstreamer-unused.sgml
1 <!-- ##### FUNCTION gst_fakesink_chain ##### -->
2 <para>
3
4 </para>
5
6 @pad: 
7 @buf: 
8
9 <!-- ##### ARG GstTypeFind:type ##### -->
10 <para>
11 Query the element for the current mime type
12 </para>
13
14
15 <!-- ##### ARG GstAudioSink:mute ##### -->
16 <para>
17
18 </para>
19
20
21 <!-- ##### STRUCT GstFakeSrc ##### -->
22 <para>
23
24 </para>
25
26
27 <!-- ##### FUNCTION gst_tee_get_type ##### -->
28 <para>
29
30 </para>
31
32 @Returns: 
33
34 <!-- ##### MACRO GST_IS_SINK ##### -->
35 <para>
36
37 </para>
38
39 @obj: 
40
41 <!-- ##### MACRO GST_META ##### -->
42 <para>
43
44 </para>
45
46 @meta: 
47
48 <!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
49 <para>
50
51 </para>
52
53 @fromcaps: 
54 @tocaps: 
55 @Returns: 
56
57 <!-- ##### MACRO GST_IS_CONNECTION ##### -->
58 <para>
59
60 </para>
61
62 @obj: 
63
64 <!-- ##### MACRO GST_TYPE_FAKESINK ##### -->
65 <para>
66
67 </para>
68
69
70 <!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
71 <para>
72
73 </para>
74
75 @pad: 
76 @parent: 
77
78 <!-- ##### FUNCTION gst_fdsink_chain ##### -->
79 <para>
80
81 </para>
82
83 @pad: 
84 @buf: 
85
86 <!-- ##### FUNCTION gst_identity_chain ##### -->
87 <para>
88
89 </para>
90
91 @pad: 
92 @buf: 
93
94 <!-- ##### FUNCTION gst_connection_get_type ##### -->
95 <para>
96
97 </para>
98
99 @Returns: 
100
101 <!-- ##### FUNCTION gst_audiosink_chain ##### -->
102 <para>
103
104 </para>
105
106 @pad: 
107 @buf: 
108
109 <!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
110 <para>
111
112 </para>
113
114 @klass: 
115
116 <!-- ##### FUNCTION gst_elementfactory_add_src ##### -->
117 <para>
118
119 </para>
120
121 @elementfactory: 
122 @id: 
123
124 <!-- ##### STRUCT GstConnectionClass ##### -->
125 <para>
126
127 </para>
128
129
130 <!-- ##### ARG GstSineSrc:channels ##### -->
131 <para>
132 The number of channels.
133 </para>
134
135
136 <!-- ##### MACRO DEBUG ##### -->
137 <para>
138 Use this macro to show debugging info. This is only usefull when developing new
139 plugin elements.
140 If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce
141 g_print messages.
142 </para>
143
144 @format: the format specification as in g_print
145 @args...: arguments
146
147 <!-- ##### SECTION ./tmpl/gstesdsink.sgml:Title ##### -->
148 GstEsdSink
149
150
151 <!-- ##### MACRO GST_TYPE_IDENTITY ##### -->
152 <para>
153
154 </para>
155
156
157 <!-- ##### FUNCTION gst_type_save_thyself ##### -->
158 <para>
159
160 </para>
161
162 @type: 
163 @parent: 
164 @Returns: 
165
166 <!-- ##### FUNCTION gst_audiosrc_push ##### -->
167 <para>
168
169 </para>
170
171 @src: 
172
173 <!-- ##### MACRO GST_IS_FAKESRC_CLASS ##### -->
174 <para>
175
176 </para>
177
178 @obj: 
179
180 <!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:See_Also ##### -->
181 <para>
182
183 </para>
184
185
186 <!-- ##### MACRO GST_AUDIOSINK ##### -->
187 <para>
188
189 </para>
190
191 @obj: 
192
193 <!-- ##### SIGNAL GstSrc::eos ##### -->
194 <para>
195 An eos signal is triggered whenever the GstSrc has reached the end of 
196 the stream.
197
198 </para>
199
200 @gstsrc: the object which received the signal.
201 @arg1: the object which received the signal
202
203 <!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
204 <para>
205
206 </para>
207
208
209 <!-- ##### FUNCTION gst_disksrc_get_type ##### -->
210 <para>
211
212 </para>
213
214 @Returns: 
215
216 <!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### -->
217 <para>
218
219 </para>
220
221 @obj: 
222
223 <!-- ##### SECTION ./tmpl/gstmeta.sgml:Short_Description ##### -->
224 Provide context for buffers
225
226
227 <!-- ##### MACRO DEBUG_ENTER_STRING ##### -->
228 <para>
229
230 </para>
231
232
233 <!-- ##### SECTION ./tmpl/audioraw.sgml:See_Also ##### -->
234 <para>
235
236 </para>
237
238
239 <!-- ##### FUNCTION gst_padtemplate_create ##### -->
240 <para>
241
242 </para>
243
244 @name_template: 
245 @direction: 
246 @presence: 
247 @caps: 
248 @Returns: 
249
250 <!-- ##### MACRO GST_IS_ESDSINK_CLASS ##### -->
251 <para>
252
253 </para>
254
255 @obj: 
256
257 <!-- ##### SECTION ./tmpl/gstgetbits.sgml:See_Also ##### -->
258 <para>
259
260 </para>
261
262
263 <!-- ##### MACRO GST_SRC ##### -->
264 <para>
265
266 </para>
267
268 @obj: 
269
270 <!-- ##### FUNCTION gst_sink_new ##### -->
271 <para>
272
273 </para>
274
275 @name: 
276 @Returns: 
277
278 <!-- ##### MACRO GST_PAD_CLASS ##### -->
279 <para>
280
281 </para>
282
283 @klass: 
284
285 <!-- ##### FUNCTION plugin_load_all ##### -->
286 <para>
287
288 </para>
289
290
291 <!-- ##### MACRO GST_SINESRC_CLASS ##### -->
292 <para>
293
294 </para>
295
296 @klass: 
297
298 <!-- ##### FUNCTION gst_pad_save_thyself ##### -->
299 <para>
300
301 </para>
302
303 @pad: 
304 @parent: 
305 @Returns: 
306
307 <!-- ##### MACRO GST_IS_AUDIOSINK_CLASS ##### -->
308 <para>
309
310 </para>
311
312 @obj: 
313
314 <!-- ##### STRUCT GstDiskSrc ##### -->
315 <para>
316
317 </para>
318
319
320 <!-- ##### ARG GstDiskSink:location ##### -->
321 <para>
322 The filename to write to.
323 </para>
324
325
326 <!-- ##### MACRO GST_IS_SRC_CLASS ##### -->
327 <para>
328
329 </para>
330
331 @obj: 
332
333 <!-- ##### ARG GstAsyncDiskSrc:bytesperread ##### -->
334 <para>
335 Specify how many bytes to read at a time.
336 </para>
337
338
339 <!-- ##### FUNCTION gst_filter_new ##### -->
340 <para>
341
342 </para>
343
344 @name: 
345 @Returns: 
346
347 <!-- ##### SECTION ./tmpl/gstesdsink.sgml:Short_Description ##### -->
348
349
350
351 <!-- ##### FUNCTION gst_sink_get_type ##### -->
352 <para>
353
354 </para>
355
356 @Returns: 
357
358 <!-- ##### FUNCTION gst_queue_push ##### -->
359 <para>
360
361 </para>
362
363 @connection: 
364
365 <!-- ##### MACRO GST_FILTER_FLAG_LAST ##### -->
366 <para>
367 subclass use this to start their flag enumeration
368 </para>
369
370
371 <!-- ##### FUNCTION gst_audiosink_set_channels ##### -->
372 <para>
373
374 </para>
375
376 @audiosink: 
377 @channels: 
378
379 <!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
380 Generic connection between elements.
381
382
383 <!-- ##### STRUCT GstSinkClass ##### -->
384 <para>
385
386 </para>
387
388
389 <!-- ##### STRUCT GstFilterClass ##### -->
390 <para>
391
392 </para>
393
394
395 <!-- ##### MACRO GST_FDSINK ##### -->
396 <para>
397
398 </para>
399
400 @obj: 
401
402 <!-- ##### FUNCTION gst_bin_schedule ##### -->
403 <para>
404
405 </para>
406
407 @bin: 
408
409 <!-- ##### MACRO ERROR ##### -->
410 <para>
411
412 </para>
413
414 @element: 
415 @format: 
416 @args...: 
417
418 <!-- ##### STRUCT MetaVideoRaw ##### -->
419 <para>
420
421 </para>
422
423 @meta: 
424 @format: 
425 @visual: 
426 @width: 
427 @height: 
428 @overlay_info: 
429 @dga_info: 
430
431 <!-- ##### FUNCTION gst_meta_ref ##### -->
432 <para>
433
434 </para>
435
436 @meta: 
437
438 <!-- ##### SECTION ./tmpl/gstaudiosink.sgml:See_Also ##### -->
439 <para>
440
441 </para>
442
443
444 <!-- ##### MACRO GST_FILTER ##### -->
445 <para>
446
447 </para>
448
449 @obj: 
450
451 <!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
452 <para>
453
454 </para>
455
456
457 <!-- ##### FUNCTION gst_esdsink_set_channels ##### -->
458 <para>
459
460 </para>
461
462 @esdsink: 
463 @channels: 
464
465 <!-- ##### FUNCTION gst_autoplug_caps_list ##### -->
466 <para>
467
468 </para>
469
470 @autoplug: 
471 @srcpad: 
472 @sinkpad: 
473 @Varargs: 
474 @Returns: 
475 @srccaps: 
476 @sinkcaps: 
477
478 <!-- ##### MACRO GST_ELEMENT ##### -->
479 <para>
480
481 </para>
482
483 @obj: 
484
485 <!-- ##### ARG GstQueue:block ##### -->
486 <para>
487 Specify wether the queue blocks or not. 
488 </para>
489
490
491 <!-- ##### FUNCTION gst_pad_pull_region ##### -->
492 <para>
493
494 </para>
495
496 @pad: 
497 @offset: 
498 @size: 
499 @Returns: 
500
501 <!-- ##### FUNCTION gst_fdsink_new_with_fd ##### -->
502 <para>
503
504 </para>
505
506 @name: 
507 @fd: 
508 @Returns: 
509
510 <!-- ##### MACRO GST_IS_ELEMENT_CLASS ##### -->
511 <para>
512
513 </para>
514
515 @obj: 
516
517 <!-- ##### STRUCT GstSrcClass ##### -->
518 <para>
519
520 </para>
521
522
523 <!-- ##### ARG GstIdentity:control ##### -->
524 <para>
525
526 </para>
527
528
529 <!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
530 <para>
531
532 </para>
533
534
535 <!-- ##### MACRO GST_PAD ##### -->
536 <para>
537
538 </para>
539
540 @obj: 
541
542 <!-- ##### FUNCTION gst_pad_set_pull_function ##### -->
543 <para>
544
545 </para>
546
547 @pad: 
548 @pull: 
549
550 <!-- ##### STRUCT GstSink ##### -->
551 <para>
552
553 </para>
554
555
556 <!-- ##### FUNCTION gst_pipeline_get_type ##### -->
557 <para>
558
559 </para>
560
561 @Returns: 
562
563 <!-- ##### MACRO GST_IS_THREAD ##### -->
564 <para>
565
566 </para>
567
568 @obj: 
569
570 <!-- ##### MACRO GST_TYPE_THREAD ##### -->
571 <para>
572
573 </para>
574
575
576 <!-- ##### STRUCT GstAsyncDiskSrcClass ##### -->
577 <para>
578
579 </para>
580
581
582 <!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
583 <para>
584
585 </para>
586
587 @pad: 
588 @caps: 
589
590 <!-- ##### MACRO GST_PROPS_FOURCC_INT ##### -->
591 <para>
592 Create a fourcc property out of an integer value.
593 </para>
594
595 @a: the integer value
596
597 <!-- ##### MACRO GST_TYPE_SINK ##### -->
598 <para>
599
600 </para>
601
602
603 <!-- ##### MACRO DEBUG_SET_STRING ##### -->
604 <para>
605
606 </para>
607
608 @format: 
609 @args...: 
610
611 <!-- ##### MACRO GST_IS_THREAD_CLASS ##### -->
612 <para>
613
614 </para>
615
616 @obj: 
617
618 <!-- ##### FUNCTION gst_bin_get_type ##### -->
619 <para>
620
621 </para>
622
623 @Returns: 
624
625 <!-- ##### ARG GstAsyncDiskSrc:offset ##### -->
626 <para>
627 Specify the current offset in the file.
628 </para>
629
630
631 <!-- ##### MACRO STACK_SIZE ##### -->
632 <para>
633
634 </para>
635
636
637 <!-- ##### MACRO GST_TYPE_AUDIOSINK ##### -->
638 <para>
639
640 </para>
641
642
643 <!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### -->
644 <para>
645
646 </para>
647
648
649 <!-- ##### MACRO GST_FILTER_CLASS ##### -->
650 <para>
651
652 </para>
653
654 @klass: 
655
656 <!-- ##### FUNCTION gst_pad_select ##### -->
657 <para>
658
659 </para>
660
661 @nextpad: 
662 @Varargs: 
663 @Returns: 
664
665 <!-- ##### FUNCTION gst_identity_get_type ##### -->
666 <para>
667
668 </para>
669
670 @Returns: 
671
672 <!-- ##### TYPEDEF GstCapsFactory[] ##### -->
673 <para>
674
675 </para>
676
677
678 <!-- ##### MACRO GST_PROPS_BOOL_ID ##### -->
679 <para>
680
681 </para>
682
683
684 <!-- ##### FUNCTION gst_meta_unref ##### -->
685 <para>
686
687 </para>
688
689 @meta: 
690
691 <!-- ##### STRUCT GstSineSrc ##### -->
692 <para>
693
694 </para>
695
696
697 <!-- ##### STRUCT MetaDGA ##### -->
698 <para>
699
700 </para>
701
702 @base: 
703 @swidth: 
704 @sheight: 
705 @bytes_per_line: 
706
707 <!-- ##### SECTION ./tmpl/spectrum.sgml:Title ##### -->
708 spectrum
709
710
711 <!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
712 <para>
713
714 </para>
715
716
717 <!-- ##### ARG GstAudioSink:format ##### -->
718 <para>
719
720 </para>
721
722
723 <!-- ##### MACRO GST_IS_FAKESINK_CLASS ##### -->
724 <para>
725
726 </para>
727
728 @obj: 
729
730 <!-- ##### MACRO GST_AUDIOSRC_CLASS ##### -->
731 <para>
732
733 </para>
734
735 @klass: 
736
737 <!-- ##### STRUCT GstAudioSrcClass ##### -->
738 <para>
739
740 </para>
741
742
743 <!-- ##### FUNCTION gst_audiosrc_new ##### -->
744 <para>
745
746 </para>
747
748 @name: 
749 @Returns: 
750
751 <!-- ##### STRUCT GstConnection ##### -->
752 <para>
753
754 </para>
755
756
757 <!-- ##### STRUCT GstQueueClass ##### -->
758 <para>
759
760 </para>
761
762
763 <!-- ##### FUNCTION gst_fakesrc_push ##### -->
764 <para>
765
766 </para>
767
768 @src: 
769
770 <!-- ##### FUNCTION gst_type_add_sink ##### -->
771 <para>
772
773 </para>
774
775 @id: 
776 @sink: 
777
778 <!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
779 <para>
780
781 </para>
782
783 @obj: 
784
785 <!-- ##### SECTION ./tmpl/gstgetbits.sgml:Title ##### -->
786 GstGetbits
787
788
789 <!-- ##### SECTION ./tmpl/audioraw.sgml:Title ##### -->
790 audioraw
791
792
793 <!-- ##### MACRO GST_FDSINK_CLASS ##### -->
794 <para>
795
796 </para>
797
798 @klass: 
799
800 <!-- ##### FUNCTION gst_fdsink_new ##### -->
801 <para>
802
803 </para>
804
805 @name: 
806 @Returns: 
807
808 <!-- ##### FUNCTION gst_element_save_thyself ##### -->
809 <para>
810
811 </para>
812
813 @element: 
814 @parent: 
815 @Returns: 
816
817 <!-- ##### MACRO GST_IS_TEE ##### -->
818 <para>
819
820 </para>
821
822 @obj: 
823
824 <!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
825 <para>
826
827 </para>
828
829 @sinkid: 
830 @srcid: 
831 @Returns: 
832
833 <!-- ##### MACRO GST_PROPS_INT_ID ##### -->
834 <para>
835
836 </para>
837
838
839 <!-- ##### STRUCT GstTeeClass ##### -->
840 <para>
841
842 </para>
843
844
845 <!-- ##### MACRO GST_FAKESINK ##### -->
846 <para>
847
848 </para>
849
850 @obj: 
851
852 <!-- ##### FUNCTION gst_type_get_srcs ##### -->
853 <para>
854
855 </para>
856
857 @id: 
858 @Returns: 
859
860 <!-- ##### FUNCTION gst_esdsink_set_frequency ##### -->
861 <para>
862
863 </para>
864
865 @esdsink: 
866 @frequency: 
867
868 <!-- ##### SECTION ./tmpl/gstgetbits.sgml:Short_Description ##### -->
869
870
871
872 <!-- ##### MACRO GST_TYPE_SRC ##### -->
873 <para>
874
875 </para>
876
877
878 <!-- ##### MACRO GST_FAKESRC ##### -->
879 <para>
880
881 </para>
882
883 @obj: 
884
885 <!-- ##### MACRO GST_IS_HTTPSRC ##### -->
886 <para>
887
888 </para>
889
890 @obj: 
891
892 <!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
893 <para>
894
895 </para>
896
897 @cat: 
898 @format: 
899 @args...: 
900
901 <!-- ##### MACRO GST_IDENTITY ##### -->
902 <para>
903
904 </para>
905
906 @obj: 
907
908 <!-- ##### ARG GstAudioSrc:format ##### -->
909 <para>
910 The audio format as defined in soundcard.h
911 </para>
912
913
914 <!-- ##### MACRO GST_IS_HTTPSRC_CLASS ##### -->
915 <para>
916
917 </para>
918
919 @obj: 
920
921 <!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Title ##### -->
922 GstAsyncDiskSrc
923
924
925 <!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### -->
926 >>>>>>> 1.23.2.3
927 <para>
928
929 </para>
930
931
932 <!-- ##### FUNCTION gst_elementfactory_add_sink ##### -->
933 <para>
934
935 </para>
936
937 @elementfactory: 
938 @id: 
939
940 <!-- ##### FUNCTION gst_bin_schedule_func ##### -->
941 <para>
942
943 </para>
944
945 @bin: 
946
947 <!-- ##### MACRO GST_IS_OBJECT ##### -->
948 <para>
949
950 </para>
951
952 @obj: 
953
954 <!-- ##### MACRO GST_TYPE_OBJECT ##### -->
955 <para>
956
957 </para>
958
959
960 <!-- ##### ARG GstSineSrc:frequency ##### -->
961 <para>
962 The fequency.
963 </para>
964
965
966 <!-- ##### FUNCTION gst_src_get_type ##### -->
967 <para>
968
969 </para>
970
971 @Returns: 
972
973 <!-- ##### FUNCTION gst_tee_new ##### -->
974 <para>
975
976 </para>
977
978 @name: 
979 @Returns: 
980
981 <!-- ##### STRUCT GstAudioSink ##### -->
982 <para>
983
984 </para>
985
986
987 <!-- ##### MACRO GST_IS_QUEUE ##### -->
988 <para>
989
990 </para>
991
992 @obj: 
993
994 <!-- ##### TYPEDEF GstPropsFactory[] ##### -->
995 <para>
996
997 </para>
998
999
1000 <!-- ##### SIGNAL GstAudioSink::handoff ##### -->
1001 <para>
1002 The buffer is sent to the sound card.
1003 </para>
1004
1005 @gstaudiosink: the object which received the signal.
1006 @arg1: the audiosink.
1007
1008 <!-- ##### MACRO GST_IS_FDSRC_CLASS ##### -->
1009 <para>
1010
1011 </para>
1012
1013 @obj: 
1014
1015 <!-- ##### MACRO GST_IS_OBJECT_CLASS ##### -->
1016 <para>
1017
1018 </para>
1019
1020 @obj: 
1021
1022 <!-- ##### FUNCTION gst_esdsink_chain ##### -->
1023 <para>
1024
1025 </para>
1026
1027 @pad: 
1028 @buf: 
1029
1030 <!-- ##### FUNCTION gst_buffer_add_meta ##### -->
1031 <para>
1032
1033 </para>
1034
1035 @buffer: 
1036 @meta: 
1037
1038 <!-- ##### FUNCTION gst_elementfactory_can_src_caps_list ##### -->
1039 <para>
1040
1041 </para>
1042
1043 @factory: 
1044 @caps: 
1045 @Returns: 
1046
1047 <!-- ##### FUNCTION gst_queue_chain ##### -->
1048 <para>
1049
1050 </para>
1051
1052 @pad: 
1053 @buf: 
1054
1055 <!-- ##### MACRO GST_TYPE_QUEUE ##### -->
1056 <para>
1057
1058 </para>
1059
1060
1061 <!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
1062 <para>
1063
1064 </para>
1065
1066 @buffer: 
1067 @meta: 
1068
1069 <!-- ##### FUNCTION gst_caps_register_count ##### -->
1070 <para>
1071
1072 </para>
1073
1074 @factory: 
1075 @counter: 
1076 @Returns: 
1077 @count: 
1078
1079 <!-- ##### MACRO GST_TYPE_HTTPSRC ##### -->
1080 <para>
1081
1082 </para>
1083
1084
1085 <!-- ##### MACRO GST_TYPE_PAD ##### -->
1086 <para>
1087
1088 </para>
1089
1090
1091 <!-- ##### MACRO GST_IS_AUDIOSRC ##### -->
1092 <para>
1093
1094 </para>
1095
1096 @obj: 
1097
1098 <!-- ##### MACRO GST_DISKSRC ##### -->
1099 <para>
1100
1101 </para>
1102
1103 @obj: 
1104
1105 <!-- ##### MACRO INFO_ELEMENT ##### -->
1106 <para>
1107
1108 </para>
1109
1110 @cat: 
1111 @element: 
1112 @format: 
1113 @args...: 
1114
1115 <!-- ##### MACRO GST_SINK_CLASS ##### -->
1116 <para>
1117
1118 </para>
1119
1120 @klass: 
1121
1122 <!-- ##### STRUCT GstAudioSinkClass ##### -->
1123 <para>
1124
1125 </para>
1126
1127
1128 <!-- ##### FUNCTION gst_type_add_src ##### -->
1129 <para>
1130
1131 </para>
1132
1133 @id: 
1134 @src: 
1135
1136 <!-- ##### STRUCT GstFdSink ##### -->
1137 <para>
1138
1139 </para>
1140
1141
1142 <!-- ##### MACRO GST_IS_PIPELINE ##### -->
1143 <para>
1144
1145 </para>
1146
1147 @obj: 
1148
1149 <!-- ##### STRUCT GstFdSinkClass ##### -->
1150 <para>
1151
1152 </para>
1153
1154
1155 <!-- ##### MACRO GST_IS_SINESRC_CLASS ##### -->
1156 <para>
1157
1158 </para>
1159
1160 @obj: 
1161
1162 <!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### -->
1163 <para>
1164
1165 </para>
1166
1167 @klass: 
1168
1169 <!-- ##### FUNCTION gst_esdsink_sync_parms ##### -->
1170 <para>
1171
1172 </para>
1173
1174 @esdsink: 
1175
1176 <!-- ##### FUNCTION gst_connection_push ##### -->
1177 <para>
1178
1179 </para>
1180
1181 @connection: 
1182
1183 <!-- ##### SIGNAL GstDiskSink::handoff ##### -->
1184 <para>
1185 Is emited after the buffer has been written to the disk.
1186 </para>
1187
1188 @gstdisksink: the object which received the signal.
1189
1190 <!-- ##### FUNCTION gst_audiosink_new ##### -->
1191 <para>
1192
1193 </para>
1194
1195 @name: 
1196 @Returns: 
1197
1198 <!-- ##### FUNCTION gst_bin_set_element_manager ##### -->
1199 <para>
1200
1201 </para>
1202
1203 @element: 
1204 @manager: 
1205
1206 <!-- ##### MACRO GST_ESDSINK ##### -->
1207 <para>
1208
1209 </para>
1210
1211 @obj: 
1212
1213 <!-- ##### FUNCTION gst_type_initialize ##### -->
1214 <para>
1215
1216 </para>
1217
1218
1219 <!-- ##### SECTION ./tmpl/gstfilter.sgml:Title ##### -->
1220 GstFilter
1221
1222
1223 <!-- ##### MACRO GST_TEE ##### -->
1224 <para>
1225
1226 </para>
1227
1228 @obj: 
1229
1230 <!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
1231 <para>
1232
1233 </para>
1234
1235 @obj: 
1236
1237 <!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
1238 <para>
1239
1240 </para>
1241
1242 @Returns: 
1243
1244 <!-- ##### FUNCTION gst_pad_get_type_id ##### -->
1245 <para>
1246
1247 </para>
1248
1249 @pad: 
1250 @Returns: 
1251
1252 <!-- ##### FUNCTION gst_thread_iterate ##### -->
1253 <para>
1254
1255 </para>
1256
1257 @thread: 
1258
1259 <!-- ##### STRUCT OverlayClip ##### -->
1260 <para>
1261
1262 </para>
1263
1264 @x1: 
1265 @x2: 
1266 @y1: 
1267 @y2: 
1268
1269 <!-- ##### ENUM GstSrcFlags ##### -->
1270 <para>
1271 Flags for the GstSrc element
1272 </para>
1273
1274 @GST_SRC_ASYNC: Indicates that this src is asynchronous
1275 @GST_SRC_FLAG_LAST: subclasses can use this to number their flags
1276
1277 <!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Short_Description ##### -->
1278
1279
1280
1281 <!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### -->
1282 GstColorSpace
1283
1284
1285 <!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
1286 <para>
1287 Defines an entry for a padfactory.
1288 </para>
1289
1290
1291 <!-- ##### ENUM GstAsyncDiskSrcFlags ##### -->
1292 <para>
1293 <informaltable pgwide=1 frame="none" role="enum">
1294 <tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
1295 <tbody>
1296 <row>
1297 <entry>GST_ASYNCDISKSRC_OPEN</entry>
1298 <entry>the asyncdisksrc is open for reading</entry>
1299 </row>
1300
1301 </tbody></tgroup></informaltable>
1302
1303 </para>
1304
1305 @GST_ASYNCDISKSRC_OPEN: 
1306 @GST_ASYNCDISKSRC_FLAG_LAST: 
1307
1308 <!-- ##### STRUCT GstAsyncDiskSrc ##### -->
1309 <para>
1310
1311 </para>
1312
1313
1314 <!-- ##### FUNCTION gst_element_change_state ##### -->
1315 <para>
1316
1317 </para>
1318
1319 @element: 
1320 @state: 
1321 @Returns: 
1322
1323 <!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
1324 <para>
1325
1326 </para>
1327
1328 @pad: 
1329 @Returns: 
1330
1331 <!-- ##### STRUCT GstFilter ##### -->
1332 <para>
1333
1334 </para>
1335
1336
1337 <!-- ##### MACRO GST_IS_BIN ##### -->
1338 <para>
1339
1340 </para>
1341
1342 @obj: 
1343
1344 <!-- ##### MACRO GST_OBJECT_FLAG_LAST ##### -->
1345 <para>
1346 subclasses can use this value to start the enumeration of their flags
1347 </para>
1348
1349
1350 <!-- ##### SECTION ./tmpl/spectrum.sgml:Short_Description ##### -->
1351 Frequencies of a spectrum analysis.
1352
1353
1354 <!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
1355 <para>
1356
1357 </para>
1358
1359 @Returns: 
1360
1361 <!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
1362 <para>
1363
1364 </para>
1365
1366 @klass: 
1367
1368 <!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
1369 <para>
1370 Indicates a sinkpad for the padfactory.
1371 </para>
1372
1373
1374 <!-- ##### MACRO GST_SRC_CLASS ##### -->
1375 <para>
1376
1377 </para>
1378
1379 @klass: 
1380
1381 <!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Long_Description ##### -->
1382 <para>
1383
1384 </para>
1385
1386
1387 <!-- ##### FUNCTION gst_type_load_thyself ##### -->
1388 <para>
1389
1390 </para>
1391
1392 @parent: 
1393 @Returns: 
1394
1395 <!-- ##### FUNCTION gst_pad_get_caps_list ##### -->
1396 <para>
1397
1398 </para>
1399
1400 @pad: 
1401 @Returns: 
1402
1403 <!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
1404 <para>
1405
1406 </para>
1407
1408
1409 <!-- ##### FUNCTION gst_esdsink_new ##### -->
1410 <para>
1411
1412 </para>
1413
1414 @name: 
1415 @Returns: 
1416
1417 <!-- ##### MACRO GST_META_FLAGS ##### -->
1418 <para>
1419 Retrieve the flags of the given meta information.
1420 </para>
1421
1422 @meta: the meta information
1423
1424 <!-- ##### FUNCTION gst_element_request_pad ##### -->
1425 <para>
1426
1427 </para>
1428
1429 @element: 
1430 @templ: 
1431 @Returns: 
1432 @temp: 
1433
1434 <!-- ##### MACRO GST_SINESRC ##### -->
1435 <para>
1436
1437 </para>
1438
1439 @obj: 
1440
1441 <!-- ##### SECTION ./tmpl/gstsink.sgml:Short_Description ##### -->
1442 The end point of a filter graph
1443
1444
1445 <!-- ##### STRUCT MetaAudioRaw ##### -->
1446 <para>
1447
1448 </para>
1449
1450 @meta: 
1451 @format: 
1452 @channels: 
1453 @frequency: 
1454 @bps: 
1455
1456 <!-- ##### ARG GstAudioSrc:channels ##### -->
1457 <para>
1458 The number of channels (mono, stereo, ...)
1459 </para>
1460
1461
1462 <!-- ##### STRUCT GstFakeSink ##### -->
1463 <para>
1464
1465 </para>
1466
1467
1468 <!-- ##### MACRO GST_STATE_IS_SET ##### -->
1469 <para>
1470 This macro checks to see if the given state is set.
1471 </para>
1472
1473 @obj: Element to check for state.
1474 @flag: State to check for, must be a single bit in guint32.
1475
1476 <!-- ##### STRUCT GstMeta ##### -->
1477 <para>
1478
1479 </para>
1480
1481 @lock: for locking purposes
1482 @flags: the flags of the meta data
1483 @data: the meta data
1484 @size: the size of the meta data
1485
1486 <!-- ##### FUNCTION gst_xml_new_from_memory ##### -->
1487 <para>
1488
1489 </para>
1490
1491 @buffer: 
1492 @size: 
1493 @root: 
1494 @Returns: 
1495
1496 <!-- ##### MACRO GST_PROPS_LIST_ID ##### -->
1497 <para>
1498
1499 </para>
1500
1501
1502 <!-- ##### SECTION ./tmpl/gstconnection.sgml:See_Also ##### -->
1503 <para>
1504
1505 </para>
1506
1507
1508 <!-- ##### FUNCTION plugin_load ##### -->
1509 <para>
1510
1511 </para>
1512
1513 @name: 
1514 @Returns: 
1515
1516 <!-- ##### MACRO GST_IS_ELEMENT ##### -->
1517 <para>
1518
1519 </para>
1520
1521 @obj: 
1522
1523 <!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Title ##### -->
1524 GstAudioSink
1525
1526
1527 <!-- ##### MACRO GST_IS_ASYNCDISKSRC ##### -->
1528 <para>
1529
1530 </para>
1531
1532 @obj: 
1533
1534 <!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
1535 <para>
1536 This macro sets the given flags.
1537 </para>
1538
1539 @src: 
1540 @flag: Flag to set, can by any number of bits in guint32.
1541 @obj: GstSrc to set flag in.
1542
1543 <!-- ##### MACRO GST_BUFFER_TYPE ##### -->
1544 <para>
1545 Retrieves the type id of the data in the buffer.
1546 </para>
1547
1548 @buf: GstBuffer
1549
1550 <!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### -->
1551 <para>
1552
1553 </para>
1554
1555 @a: 
1556
1557 <!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
1558 <para>
1559
1560 </para>
1561
1562
1563 <!-- ##### FUNCTION gst_filter_get_type ##### -->
1564 <para>
1565
1566 </para>
1567
1568 @Returns: 
1569
1570 <!-- ##### FUNCTION plugin_load_absolute ##### -->
1571 <para>
1572
1573 </para>
1574
1575 @name: 
1576 @Returns: 
1577
1578 <!-- ##### STRUCT GstObjectClass ##### -->
1579 <para>
1580
1581 </para>
1582
1583
1584 <!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
1585 GstSink
1586
1587
1588 <!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
1589 <para>
1590 A flag indicating that MMX instructions are supported.
1591 </para>
1592
1593
1594 <!-- ##### FUNCTION gst_object_get_type ##### -->
1595 <para>
1596
1597 </para>
1598
1599 @Returns: 
1600
1601 <!-- ##### STRUCT GstSineSrcClass ##### -->
1602 <para>
1603
1604 </para>
1605
1606
1607 <!-- ##### FUNCTION gst_elementfactory_can_sink_caps_list ##### -->
1608 <para>
1609
1610 </para>
1611
1612 @factory: 
1613 @caps: 
1614 @Returns: 
1615
1616 <!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
1617 <para>
1618 This macro usets the given flags.
1619 </para>
1620
1621 @src: 
1622 @flag: Flag to set, must be a single bit in guint32.
1623 @obj: GstSrc to unset flag in.
1624
1625 <!-- ##### ARG GstAudioSrc:frequency ##### -->
1626 <para>
1627 The frequency.
1628 </para>
1629
1630
1631 <!-- ##### MACRO GST_PAD_FACTORY_SRC ##### -->
1632 <para>
1633 Indicates a srcpad for the padfactory.
1634 </para>
1635
1636
1637 <!-- ##### ARG GstDiskSink:closed ##### -->
1638 <para>
1639
1640 </para>
1641
1642
1643 <!-- ##### FUNCTION gst_buffer_get_first_meta ##### -->
1644 <para>
1645
1646 </para>
1647
1648 @buffer: 
1649 @Returns: 
1650
1651 <!-- ##### MACRO GST_IS_SINK_CLASS ##### -->
1652 <para>
1653
1654 </para>
1655
1656 @obj: 
1657
1658 <!-- ##### MACRO GST_IS_PIPELINE_CLASS ##### -->
1659 <para>
1660
1661 </para>
1662
1663 @obj: 
1664
1665 <!-- ##### MACRO GST_PROPS_INT_RANGE_ID ##### -->
1666 <para>
1667
1668 </para>
1669
1670
1671 <!-- ##### STRUCT GstAudioSrc ##### -->
1672 <para>
1673
1674 </para>
1675
1676
1677 <!-- ##### MACRO GST_TYPE_ELEMENT ##### -->
1678 <para>
1679
1680 </para>
1681
1682
1683 <!-- ##### ARG GstFakeSrc:patern ##### -->
1684 <para>
1685
1686 </para>
1687
1688
1689 <!-- ##### FUNCTION gst_pad_get_caps_by_name ##### -->
1690 <para>
1691
1692 </para>
1693
1694 @pad: 
1695 @name: 
1696 @Returns: 
1697
1698 <!-- ##### SECTION ./tmpl/gstsrc.sgml:See_Also ##### -->
1699 <para>
1700
1701 </para>
1702
1703
1704 <!-- ##### FUNCTION gst_esdsink_set_format ##### -->
1705 <para>
1706
1707 </para>
1708
1709 @esdsink: 
1710 @format: 
1711
1712 <!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
1713 <para>
1714
1715 </para>
1716
1717 @cat: 
1718 @format: 
1719 @args...: 
1720
1721 <!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### -->
1722 <para>
1723
1724 </para>
1725
1726
1727 <!-- ##### MACRO GST_IS_FDSRC ##### -->
1728 <para>
1729
1730 </para>
1731
1732 @obj: 
1733
1734 <!-- ##### STRUCT GstIdentity ##### -->
1735 <para>
1736
1737 </para>
1738
1739
1740 <!-- ##### FUNCTION gst_thread_get_type ##### -->
1741 <para>
1742
1743 </para>
1744
1745 @Returns: 
1746
1747 <!-- ##### MACRO GST_QUEUE ##### -->
1748 <para>
1749
1750 </para>
1751
1752 @obj: 
1753
1754 <!-- ##### MACRO GST_THREAD ##### -->
1755 <para>
1756
1757 </para>
1758
1759 @obj: 
1760
1761 <!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
1762 <para>
1763 The maximum number of cothreads we are going to support.
1764 </para>
1765
1766
1767 <!-- ##### FUNCTION gst_fakesink_new ##### -->
1768 <para>
1769
1770 </para>
1771
1772 @name: 
1773 @Returns: 
1774
1775 <!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### -->
1776 <para>
1777 Starts the declaration of a the capabilities for this padtemplate.
1778 </para>
1779
1780 @a...: a capability factory
1781
1782 <!-- ##### SECTION ./tmpl/gstsrc.sgml:Title ##### -->
1783 GstSrc
1784
1785
1786 <!-- ##### FUNCTION gst_pad_get_directory ##### -->
1787 <para>
1788
1789 </para>
1790
1791 @pad: 
1792 @Returns: 
1793
1794 <!-- ##### FUNCTION gst_tee_chain ##### -->
1795 <para>
1796
1797 </para>
1798
1799 @pad: 
1800 @buf: 
1801
1802 <!-- ##### FUNCTION gst_caps_new_with_props ##### -->
1803 <para>
1804
1805 </para>
1806
1807 @name: 
1808 @mime: 
1809 @props: 
1810 @Returns: 
1811
1812 <!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
1813 <para>
1814 The Element is going from the READY state to the PLAYING state.
1815 </para>
1816
1817
1818 <!-- ##### MACRO GST_TYPE_AUDIOSRC ##### -->
1819 <para>
1820
1821 </para>
1822
1823
1824 <!-- ##### SECTION ./tmpl/plugin.sgml:See_Also ##### -->
1825 <para>
1826
1827 </para>
1828
1829
1830 <!-- ##### SECTION ./tmpl/gstmeta.sgml:See_Also ##### -->
1831 <para>
1832
1833 </para>
1834
1835
1836 <!-- ##### MACRO GST_IS_TEE_CLASS ##### -->
1837 <para>
1838
1839 </para>
1840
1841 @obj: 
1842
1843 <!-- ##### FUNCTION gst_thread_main_loop ##### -->
1844 <para>
1845
1846 </para>
1847
1848 @arg: 
1849
1850 <!-- ##### SECTION ./tmpl/gstmeta.sgml:Long_Description ##### -->
1851 <para>
1852 The point of the metadata is to provide some context for each buffer.  In
1853 the case of audio data, for instance, it would provide the samplerate, bit
1854 depth, and channel count.
1855 </para>
1856
1857 <para>
1858 The trick is that there may be multiple types of metadata ganged onto a
1859 single buffer.  This is why they're going to be a GList.  This does mean
1860 extra overhead in all cases, but I think it's minimal.  The GList type
1861 uses a chunk allocater so we're not wasting too much memory or time when
1862 adding to the list.
1863 </para>
1864
1865 <para>
1866 The trick is dealing with these structs as they pass through a pipeline,
1867 since they have potentially different mutability properties.  For
1868 instance, if you've got a mp3 decoder connected to a tee, which sends the
1869 buffers off to both the decoder and a spectrum analyzer (and then a
1870 visualization element).  The preferred setup would be where every time a
1871 audio/raw metadata comes down the pipe (indicating a potential change in
1872 audio format), the audiosink and spectrum would just save off pointers.
1873 </para>
1874
1875 <para>
1876 So when exactly does this metadata go away (deallocated)?  Well, that
1877 means metadata has to be refcounted.  But that gets rather hairy.  OK, in
1878 the simple case you create a metadata struct, it comes with refcount set
1879 to 1.  You pass it through, it stays one, eventually someone drops the
1880 last reference on the buffer it's tied to, you free the metadata too.
1881 Easy.  What if you tee?  You could go through and for every metadata in
1882 the buffer, increment the refcount by the same as the buffer.  So in the
1883 above case (tee'd), the audiosink and spectrum would get the buffer with a
1884 refcount of 2, and it'd have a metadata with refcount 2.  Do they ref it
1885 each themselves, then unref the buffer?  Or do they remove the metadata?
1886 Removing the metadata would require a buffer CoW, which would suck, so
1887 yes, they'd just ref the metadata.
1888 </para>
1889
1890 <para>
1891 But....  what if they're all in different threads?  Then we're off into
1892 the magical world of mutexes.  Everything with a refcount in a threaded
1893 world must be mutexed, else you can do atomic increment and atomic
1894 dec and test.  Can this be done from C easily?  Perhaps it needs to be found
1895 from kernel includes via autoconf?
1896 </para>
1897
1898 <para>
1899 The goal in designing the way metadata will be defined and used is to keep
1900 it as simple as possible.  The basis for accomplishing this is the fact
1901 that in order to actually use (rather than just pass) the metadata, you
1902 have to know what the fields are, which means you have to have compiled in
1903 support for that metadata at build time.  Therefore, if you're using
1904 metadata, you must have build-time access to the necessary include file
1905 that defines it.
1906 </para>
1907
1908 <para>
1909 So, given that you've got an include file, it would be nice if the whole
1910 thing could be contained there.  This would limit the need to be linked
1911 against something, or have load-time requirements as to that has to be
1912 loaded before you are.
1913 </para>
1914
1915 <para>
1916 Given that really all metadata is is a region of memory of a given size
1917 with a certain signature, this isn't all that hard.  First you lay out the
1918 struct that defines the metadata.  Then you set up #defines that expand to
1919 the size of the struct in question, as well as the four-cc code that
1920 defines the type.
1921 </para>
1922
1923 <para>
1924 The work is done by a few #defines, a la the #defines used in all Gtk
1925 objects.  The first is a NEW() method that allocates the memory for the
1926 metadata and fills in all the normal fields (type, size, utility
1927 functions).  Because of the way it's defined (as a #define, no less),
1928 you'll have to invoke it as META_NEW(meta), since it can't return()
1929 anything.
1930 </para>
1931
1932 <para>
1933 Another #define will check to make sure a meta is indeed that type by
1934 verifying the type code and size.  Theoretically, meta types can overlap
1935 with the same fourcc code, as long as they have different sizes.  But I
1936 probably ought to have a global public registry so people writing things
1937 don't conflict.  MSFT got that right, at least.
1938 </para>
1939
1940 <para>
1941 So, a hairy problem is what to do when there are utility functions
1942 associated with one of these things.  One option is to not bother with
1943 them.  This is very likely a possible solution, since metadata is supposed
1944 to be flat memory of a given size.  Not much to do to either free or copy
1945 it, is there?
1946 </para>
1947
1948
1949 <!-- ##### SECTION ./tmpl/gstconnection.sgml:Title ##### -->
1950 GstConnection
1951
1952
1953 <!-- ##### MACRO GST_TYPE_FDSRC ##### -->
1954 <para>
1955
1956 </para>
1957
1958
1959 <!-- ##### MACRO GST_TYPE_PIPELINE ##### -->
1960 <para>
1961
1962 </para>
1963
1964
1965 <!-- ##### STRUCT GstHttpSrcClass ##### -->
1966 <para>
1967
1968 </para>
1969
1970
1971 <!-- ##### SECTION ./tmpl/GstElement.sgml:Short_Description ##### -->
1972
1973
1974
1975 <!-- ##### SECTION ./tmpl/gstesdsink.sgml:See_Also ##### -->
1976 <para>
1977
1978 </para>
1979
1980
1981 <!-- ##### MACRO GST_TYPE_TEE ##### -->
1982 <para>
1983
1984 </para>
1985
1986
1987 <!-- ##### MACRO GST_BIN ##### -->
1988 <para>
1989
1990 </para>
1991
1992 @obj: 
1993
1994 <!-- ##### SECTION ./tmpl/GstElement.sgml:Title ##### -->
1995 GstElement
1996
1997
1998 <!-- ##### FUNCTION gst_type_get_sinks ##### -->
1999 <para>
2000
2001 </para>
2002
2003 @id: 
2004 @Returns: 
2005
2006 <!-- ##### MACRO GST_BUFFER_POOL ##### -->
2007 <para>
2008
2009 </para>
2010
2011 @buf: 
2012
2013 <!-- ##### STRUCT GstEsdSink ##### -->
2014 <para>
2015
2016 </para>
2017
2018
2019 <!-- ##### MACRO GST_META_FLAG_UNSET ##### -->
2020 <para>
2021 Clear a flag in the meta data.
2022 </para>
2023
2024 @meta: the meta data
2025 @flag: the flag to clear
2026
2027 <!-- ##### MACRO GST_IS_FAKESRC ##### -->
2028 <para>
2029
2030 </para>
2031
2032 @obj: 
2033
2034 <!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Long_Description ##### -->
2035 <para>
2036
2037 </para>
2038
2039
2040 <!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### -->
2041 <para>
2042 The sink is the end of the filter graph. A typical sink would be an audio
2043 or a video card.
2044
2045 </para>
2046
2047
2048 <!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
2049 <para>
2050
2051 </para>
2052
2053 @obj: 
2054
2055 <!-- ##### FUNCTION gst_esdsink_get_type ##### -->
2056 <para>
2057
2058 </para>
2059
2060 @Returns: 
2061
2062 <!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
2063 <para>
2064
2065 </para>
2066
2067
2068 <!-- ##### STRUCT GstEsdSinkClass ##### -->
2069 <para>
2070
2071 </para>
2072
2073
2074 <!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
2075 <para>
2076 Query whether this object has multiple input pads.
2077
2078 </para>
2079
2080 @obj: Element to query for multiple input pads.
2081
2082 <!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
2083 <para>
2084
2085 </para>
2086
2087
2088 <!-- ##### MACRO DEBUG_NOPREFIX ##### -->
2089 <para>
2090
2091 </para>
2092
2093 @format: 
2094 @args...: 
2095
2096 <!-- ##### ARG GstAudioSink:frequency ##### -->
2097 <para>
2098
2099 </para>
2100
2101
2102 <!-- ##### STRUCT GstFdSrc ##### -->
2103 <para>
2104
2105 </para>
2106
2107
2108 <!-- ##### FUNCTION gst_props_register ##### -->
2109 <para>
2110
2111 </para>
2112
2113 @factory: 
2114 @Returns: 
2115
2116 <!-- ##### STRUCT GstThreadClass ##### -->
2117 <para>
2118
2119 </para>
2120
2121
2122 <!-- ##### FUNCTION gst_element_load_thyself ##### -->
2123 <para>
2124
2125 </para>
2126
2127 @self: 
2128 @parent: 
2129 @Returns: 
2130 @elements: 
2131
2132 <!-- ##### FUNCTION gst_src_signal_eos ##### -->
2133 <para>
2134
2135 </para>
2136
2137 @src: 
2138
2139 <!-- ##### STRUCT GstHttpSrc ##### -->
2140 <para>
2141
2142 </para>
2143
2144
2145 <!-- ##### STRUCT GstSrc ##### -->
2146 <para>
2147
2148 </para>
2149
2150
2151 <!-- ##### SECTION ./tmpl/videoraw.sgml:Long_Description ##### -->
2152 <para>
2153 Information about video buffers.
2154 </para>
2155
2156
2157 <!-- ##### FUNCTION gst_bin_add_managed_element ##### -->
2158 <para>
2159
2160 </para>
2161
2162 @bin: 
2163 @element: 
2164
2165 <!-- ##### FUNCTION gst_queue_new ##### -->
2166 <para>
2167
2168 </para>
2169
2170 @name: 
2171 @Returns: 
2172
2173 <!-- ##### MACRO GST_THREAD_CLASS ##### -->
2174 <para>
2175
2176 </para>
2177
2178 @klass: 
2179
2180 <!-- ##### TYPEDEF GstPropsFactoryEntry ##### -->
2181 <para>
2182
2183 </para>
2184
2185
2186 <!-- ##### MACRO GST_IS_FILTER_CLASS ##### -->
2187 <para>
2188
2189 </para>
2190
2191 @obj: 
2192
2193 <!-- ##### MACRO GST_CONNECTION_CLASS ##### -->
2194 <para>
2195
2196 </para>
2197
2198 @klass: 
2199
2200 <!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### -->
2201 <para>
2202
2203 </para>
2204
2205
2206 <!-- ##### FUNCTION gst_connection_new ##### -->
2207 <para>
2208
2209 </para>
2210
2211 @name: 
2212 @Returns: 
2213
2214 <!-- ##### MACRO GST_SINK ##### -->
2215 <para>
2216
2217 </para>
2218
2219 @obj: 
2220
2221 <!-- ##### MACRO GST_FDSRC_CLASS ##### -->
2222 <para>
2223
2224 </para>
2225
2226 @klass: 
2227
2228 <!-- ##### MACRO GST_TYPE_FAKESRC ##### -->
2229 <para>
2230
2231 </para>
2232
2233
2234 <!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->
2235
2236
2237
2238 <!-- ##### FUNCTION gst_pad_get_type ##### -->
2239 <para>
2240
2241 </para>
2242
2243 @Returns: 
2244
2245 <!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### -->
2246 <para>
2247
2248 </para>
2249
2250
2251 <!-- ##### MACRO GST_IS_AUDIOSINK ##### -->
2252 <para>
2253
2254 </para>
2255
2256 @obj: 
2257
2258 <!-- ##### SECTION ./tmpl/gstfilter.sgml:Long_Description ##### -->
2259 <para>
2260 Filters take data in and spit data out. They are the main Element in a filter graph.
2261 Filters have zero or more inputs and zero or more outputs. Filters are connected
2262 together to form filter graphs. A GstFilter is the base class and is not very usefull
2263 on its own.
2264 </para>
2265
2266
2267 <!-- ##### FUNCTION gst_tee_new_pad ##### -->
2268 <para>
2269
2270 </para>
2271
2272 @tee: 
2273 @Returns: 
2274
2275 <!-- ##### MACRO GST_OBJECT ##### -->
2276 <para>
2277
2278 </para>
2279
2280 @obj: 
2281
2282 <!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
2283 <para>
2284 The Element is going from the PLAYING state to the READY state.
2285 </para>
2286
2287
2288 <!-- ##### MACRO GST_IS_FDSINK ##### -->
2289 <para>
2290
2291 </para>
2292
2293 @obj: 
2294
2295 <!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
2296 <para>
2297 Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
2298 </para>
2299
2300
2301 <!-- ##### MACRO GST_IS_DISKSRC ##### -->
2302 <para>
2303
2304 </para>
2305
2306 @obj: 
2307
2308 <!-- ##### MACRO GST_FAKESINK_CLASS ##### -->
2309 <para>
2310
2311 </para>
2312
2313 @klass: 
2314
2315 <!-- ##### MACRO GST_TYPE_FDSINK ##### -->
2316 <para>
2317
2318 </para>
2319
2320
2321 <!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Short_Description ##### -->
2322
2323
2324
2325 <!-- ##### SECTION ./tmpl/videoraw.sgml:Title ##### -->
2326 videoraw
2327
2328
2329 <!-- ##### MACRO GST_IS_FILTER ##### -->
2330 <para>
2331
2332 </para>
2333
2334 @obj: 
2335
2336 <!-- ##### STRUCT MetaOverlay ##### -->
2337 <para>
2338
2339 </para>
2340
2341 @wx: 
2342 @wy: 
2343 @overlay_element: 
2344 @clip_count: 
2345 @overlay_clip: 
2346 @width: 
2347 @height: 
2348 @did_overlay: 
2349 @fully_obscured: 
2350
2351 <!-- ##### MACRO GST_TYPE_FILTER ##### -->
2352 <para>
2353
2354 </para>
2355
2356
2357 <!-- ##### FUNCTION gst_identity_new ##### -->
2358 <para>
2359
2360 </para>
2361
2362 @name: 
2363 @Returns: 
2364
2365 <!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### -->
2366 <para>
2367
2368 </para>
2369
2370 @obj: 
2371
2372 <!-- ##### STRUCT GstIdentityClass ##### -->
2373 <para>
2374
2375 </para>
2376
2377
2378 <!-- ##### MACRO GST_IS_PAD_CLASS ##### -->
2379 <para>
2380
2381 </para>
2382
2383 @obj: 
2384
2385 <!-- ##### MACRO GST_IDENTITY_CLASS ##### -->
2386 <para>
2387
2388 </para>
2389
2390 @klass: 
2391
2392 <!-- ##### MACRO GST_SINK_FLAG_LAST ##### -->
2393 <para>
2394
2395 </para>
2396
2397
2398 <!-- ##### MACRO GST_IS_FDSINK_CLASS ##### -->
2399 <para>
2400
2401 </para>
2402
2403 @obj: 
2404
2405 <!-- ##### MACRO GST_SRC_FLAGS ##### -->
2406 <para>
2407 This macro returns the entire set of flags for the object.
2408 </para>
2409
2410 @obj: GstSrc to return flags for.
2411
2412 <!-- ##### STRUCT GstFakeSinkClass ##### -->
2413 <para>
2414
2415 </para>
2416
2417
2418 <!-- ##### ARG GstAsyncDiskSrc:length ##### -->
2419 <para>
2420 Get the size of the current file.
2421 </para>
2422
2423
2424 <!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Short_Description ##### -->
2425
2426
2427
2428 <!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### -->
2429 The start point of a filter graph
2430
2431
2432 <!-- ##### FUNCTION gst_src_push ##### -->
2433 <para>
2434
2435 </para>
2436
2437 @src: 
2438
2439 <!-- ##### MACRO GST_IS_ESDSINK ##### -->
2440 <para>
2441
2442 </para>
2443
2444 @obj: 
2445
2446 <!-- ##### FUNCTION gst_sinesrc_push ##### -->
2447 <para>
2448
2449 </para>
2450
2451 @src: 
2452
2453 <!-- ##### FUNCTION gst_bin_create_plan ##### -->
2454 <para>
2455
2456 </para>
2457
2458 @bin: 
2459
2460 <!-- ##### FUNCTION gst_props_register_count ##### -->
2461 <para>
2462
2463 </para>
2464
2465 @factory: 
2466 @counter: 
2467 @Returns: 
2468
2469 <!-- ##### ARG GstFakeSink:num_sources ##### -->
2470 <para>
2471
2472 </para>
2473
2474
2475 <!-- ##### MACRO GST_PROPS_FLOAT_RANGE_STRING ##### -->
2476 <para>
2477
2478 </para>
2479
2480 @a: 
2481 @b: 
2482
2483 <!-- ##### MACRO GST_FAKESRC_CLASS ##### -->
2484 <para>
2485
2486 </para>
2487
2488 @klass: 
2489
2490 <!-- ##### ARG GstQueue:timeout ##### -->
2491 <para>
2492
2493 </para>
2494
2495
2496 <!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
2497 <para>
2498 The default stack size of a cothread.
2499 </para>
2500
2501
2502 <!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
2503 <para>
2504
2505 </para>
2506
2507
2508 <!-- ##### STRUCT GstBinClass ##### -->
2509 <para>
2510
2511 </para>
2512
2513
2514 <!-- ##### MACRO GST_TYPE_DISKSRC ##### -->
2515 <para>
2516
2517 </para>
2518
2519
2520 <!-- ##### FUNCTION gst_audiosrc_get_type ##### -->
2521 <para>
2522
2523 </para>
2524
2525 @Returns: 
2526
2527 <!-- ##### FUNCTION gst_httpsrc_get_type ##### -->
2528 <para>
2529
2530 </para>
2531
2532 @Returns: 
2533
2534 <!-- ##### MACRO GST_DISKSRC_CLASS ##### -->
2535 <para>
2536
2537 </para>
2538
2539 @klass: 
2540
2541 <!-- ##### MACRO GST_ESDSINK_CLASS ##### -->
2542 <para>
2543
2544 </para>
2545
2546 @klass: <<<<<<< gstreamer-unused.sgml
2547
2548 <!-- ##### MACRO GST_PAD_FACTORY_REQUEST ##### -->
2549 <para>
2550 Indicates that this pad will be available on request. Use 
2551 this in the factory definition. 
2552 </para>
2553
2554
2555 <!-- ##### FUNCTION gst_audiosink_sync_parms ##### -->
2556 <para>
2557
2558 </para>
2559
2560 @audiosink: 
2561
2562 <!-- ##### MACRO GST_IS_FAKESINK ##### -->
2563 <para>
2564
2565 </para>
2566
2567 @obj: 
2568
2569 <!-- ##### MACRO GST_STATE_UNSET ##### -->
2570 <para>
2571 This macro unsets the given state on the element.
2572 </para>
2573
2574 @obj: Element to unset state of.
2575 @flag: State to unset, can be any number of bits in guint32.
2576
2577 <!-- ##### MACRO GST_QUEUE_CLASS ##### -->
2578 <para>
2579
2580 </para>
2581
2582 @klass: 
2583
2584 <!-- ##### FUNCTION gst_pad_set_type_id ##### -->
2585 <para>
2586
2587 </para>
2588
2589 @pad: 
2590 @id: 
2591
2592 <!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
2593 <para>
2594 Indicate that this pad will always be available.
2595 Use this in the factory definition.
2596 </para>
2597
2598
2599 <!-- ##### FUNCTION gst_pad_add_ghost_parent ##### -->
2600 <para>
2601
2602 </para>
2603
2604 @pad: 
2605 @parent: 
2606
2607 <!-- ##### FUNCTION gst_audiosink_set_frequency ##### -->
2608 <para>
2609
2610 </para>
2611
2612 @audiosink: 
2613 @frequency: 
2614
2615 <!-- ##### MACRO GST_TYPE_BIN ##### -->
2616 <para>
2617
2618 </para>
2619
2620
2621 <!-- ##### FUNCTION gst_elementfactory_register ##### -->
2622 <para>
2623
2624 </para>
2625
2626 @elementfactory: 
2627
2628 <!-- ##### ARG GstAudioSrc:bytes_per_read ##### -->
2629 <para>
2630 The number of bytes per read.
2631 </para>
2632
2633
2634 <!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
2635 <para>
2636 </para>
2637
2638 @argc: 
2639 @argv: 
2640 @Returns: 
2641
2642 <!-- ##### MACRO GST_IS_SINESRC ##### -->
2643 <para>
2644
2645 </para>
2646
2647 @obj: 
2648
2649 <!-- ##### FUNCTION gst_meta_new_size ##### -->
2650 <para>
2651
2652 </para>
2653
2654 @size: 
2655 @Returns: 
2656
2657 <!-- ##### MACRO ERROR_OBJECT ##### -->
2658 <para>
2659
2660 </para>
2661
2662 @element: 
2663 @object: 
2664 @format: 
2665 @args...: 
2666
2667 <!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
2668 <para>
2669
2670 </para>
2671
2672 @Returns: 
2673
2674 <!-- ##### MACRO GST_IS_IDENTITY ##### -->
2675 <para>
2676
2677 </para>
2678
2679 @obj: 
2680
2681 <!-- ##### MACRO GST_AUDIOSRC ##### -->
2682 <para>
2683
2684 </para>
2685
2686 @obj: 
2687
2688 <!-- ##### MACRO GST_TYPE_ESDSINK ##### -->
2689 <para>
2690
2691 </para>
2692
2693
2694 <!-- ##### MACRO GST_FDSRC ##### -->
2695 <para>
2696
2697 </para>
2698
2699 @obj: 
2700
2701 <!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Long_Description ##### -->
2702 <para>
2703
2704 </para>
2705
2706
2707 <!-- ##### FUNCTION gst_audiosink_get_type ##### -->
2708 <para>
2709
2710 </para>
2711
2712 @Returns: 
2713
2714 <!-- ##### MACRO GST_OBJECT_CLASS ##### -->
2715 <para>
2716
2717 </para>
2718
2719 @klass: 
2720
2721 <!-- ##### SECTION ./tmpl/gstconnection.sgml:Long_Description ##### -->
2722 <para>
2723 A connection is a bas class for a generic connection between
2724 elements. A connection is typically a bas class for queues.
2725
2726 </para>
2727
2728
2729 <!-- ##### MACRO GST_BUFFER ##### -->
2730 <para>
2731
2732 </para>
2733
2734 @buf: 
2735
2736 <!-- ##### MACRO GST_SRC_IS_ASYNC ##### -->
2737 <para>
2738 Query a GstSrc for the ASYNC flag
2739 </para>
2740
2741 @obj: The GstSrc to query
2742
2743 <!-- ##### MACRO GST_PIPELINE ##### -->
2744 <para>
2745
2746 </para>
2747
2748 @obj: 
2749
2750 <!-- ##### MACRO GST_STATE_SET ##### -->
2751 <para>
2752 This macro sets the given state on the element.
2753 </para>
2754
2755 @obj: Element to set state of.
2756 @flag: State to set, can be any number of bits in guint32.
2757
2758 <!-- ##### FUNCTION gst_fakesink_get_type ##### -->
2759 <para>
2760
2761 </para>
2762
2763 @Returns: 
2764
2765 <!-- ##### MACRO GST_TYPE_CONNECTION ##### -->
2766 <para>
2767
2768 </para>
2769
2770
2771 <!-- ##### ENUM GstMetaFlags ##### -->
2772 <para>
2773 Flags indicating properties about the meta data.
2774 </para>
2775
2776 @GST_META_FREEABLE: the meta data can be freed
2777
2778 <!-- ##### SECTION ./tmpl/spectrum.sgml:See_Also ##### -->
2779 <para>
2780
2781 </para>
2782
2783
2784 <!-- ##### MACRO GST_CONNECTION ##### -->
2785 <para>
2786
2787 </para>
2788
2789 @obj: 
2790
2791 <!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
2792 Information about video buffers.
2793
2794
2795 <!-- ##### FUNCTION gst_fdsink_get_type ##### -->
2796 <para>
2797
2798 </para>
2799
2800 @Returns: 
2801
2802 <!-- ##### FUNCTION gst_src_push_region ##### -->
2803 <para>
2804
2805 </para>
2806
2807 @src: 
2808 @offset: 
2809 @size: 
2810
2811 <!-- ##### STRUCT GstPipelineClass ##### -->
2812 <para>
2813
2814 </para>
2815
2816
2817 <!-- ##### MACRO DEBUG_ENTER ##### -->
2818 <para>
2819
2820 </para>
2821
2822 @format: 
2823 @args...: 
2824
2825 <!-- ##### SIGNAL GstXML::object-loaded ##### -->
2826 <para>
2827 Is trigered whenever the state of an element changes
2828 </para>
2829
2830 @gstelement: the object which received the signal.
2831 @arg1: the new state of the object
2832
2833 <!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
2834 <para>
2835
2836 </para>
2837
2838 @klass: 
2839
2840 <!-- ##### FUNCTION gst_fakesrc_new ##### -->
2841 <para>
2842
2843 </para>
2844
2845 @name: 
2846 @Returns: 
2847
2848 <!-- ##### FUNCTION gst_fakesrc_get_type ##### -->
2849 <para>
2850
2851 </para>
2852
2853 @Returns: 
2854
2855 <!-- ##### SECTION ./tmpl/audioraw.sgml:Short_Description ##### -->
2856 Information about audio buffers.
2857
2858
2859 <!-- ##### SECTION ./tmpl/videoraw.sgml:See_Also ##### -->
2860 <para>
2861
2862 </para>
2863
2864
2865 <!-- ##### SECTION ./tmpl/gstfilter.sgml:Short_Description ##### -->
2866 Take data in and spit data out
2867
2868
2869 <!-- ##### TYPEDEF GstPadFactory[] ##### -->
2870 <para>
2871 The padfactory.
2872 </para>
2873
2874
2875 <!-- ##### MACRO GST_SRC_ASYNC ##### -->
2876 <para>
2877 This macro checks to see if the GST_SRC_ASYNC flag is set.
2878 </para>
2879
2880 @obj: GstSrc to check for flag in.
2881
2882 <!-- ##### STRUCT GstPluginElement ##### -->
2883 <para>
2884
2885 </para>
2886
2887
2888 <!-- ##### MACRO GST_TYPE_SINESRC ##### -->
2889 <para>
2890
2891 </para>
2892
2893
2894 <!-- ##### SECTION ./tmpl/gstmeta.sgml:Title ##### -->
2895 GstMeta
2896
2897
2898 <!-- ##### TYPEDEF GstCapsFactory ##### -->
2899 <para>
2900
2901 </para>
2902
2903
2904 <!-- ##### STRUCT GstFdSrcClass ##### -->
2905 <para>
2906
2907 </para>
2908
2909
2910 <!-- ##### MACRO GST_CPU_FLAG_SSE ##### -->
2911 <para>
2912 A flag indicating that SSE instructions are supported.
2913 </para>
2914
2915
2916 <!-- ##### MACRO GST_IS_CONNECTION_CLASS ##### -->
2917 <para>
2918
2919 </para>
2920
2921 @obj: 
2922
2923 <!-- ##### FUNCTION gst_util_get_widget_arg ##### -->
2924 <para>
2925
2926 </para>
2927
2928 @object: 
2929 @argname: 
2930 @Returns: 
2931
2932 <!-- ##### ARG GstAsyncDiskSrc:size ##### -->
2933 <para>
2934
2935 </para>
2936
2937
2938 <!-- ##### STRUCT GstDiskSrcClass ##### -->
2939 <para>
2940
2941 </para>
2942
2943
2944 <!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
2945 <para>
2946 Set the debug string for the current function, typically containing the arguments
2947 to the current function, i.e. "('element')"
2948 </para>
2949
2950 @format: printf-style format string
2951 @args...: printf arguments
2952
2953 <!-- ##### FUNCTION gst_element_get_type ##### -->
2954 <para>
2955
2956 </para>
2957
2958 @Returns: 
2959
2960 <!-- ##### FUNCTION gst_bin_remove_managed_element ##### -->
2961 <para>
2962
2963 </para>
2964
2965 @bin: 
2966 @element: 
2967
2968 <!-- ##### STRUCT GstElementClass ##### -->
2969 <para>
2970
2971 </para>
2972
2973
2974 <!-- ##### MACRO GST_META_FLAG_SET ##### -->
2975 <para>
2976 Set a flag in the meta data.
2977 </para>
2978
2979 @meta: the meta data
2980 @flag: the flag to set
2981
2982 <!-- ##### MACRO GST_IS_SRC ##### -->
2983 <para>
2984
2985 </para>
2986
2987 @obj: 
2988
2989 <!-- ##### SECTION ./tmpl/audioraw.sgml:Long_Description ##### -->
2990 <para>
2991 Information about audio buffers.
2992 </para>
2993
2994
2995 <!-- ##### ENUM GstPropsId ##### -->
2996 <para>
2997
2998 </para>
2999
3000 @GST_PROPS_END_ID_NUM: 
3001 @GST_PROPS_LIST_ID_NUM: 
3002 @GST_PROPS_INT_ID_NUM: 
3003 @GST_PROPS_INT_RANGE_ID_NUM: 
3004 @GST_PROPS_FOURCC_ID_NUM: 
3005 @GST_PROPS_BOOL_ID_NUM: 
3006
3007 <!-- ##### ENUM GstCapsDefinition ##### -->
3008 <para>
3009
3010 </para>
3011
3012 @GST_CAPS_ALWAYS: 
3013 @GST_CAPS_MAYBE: 
3014
3015 <!-- ##### MACRO GST_META_FLAG_IS_SET ##### -->
3016 <para>
3017 Check if a given flag is set.
3018 </para>
3019
3020 @meta: the meta data to test
3021 @flag: the flag to test
3022
3023 <!-- ##### STRUCT GstPadClass ##### -->
3024 <para>
3025
3026 </para>
3027
3028
3029 <<<<<<< gstreamer-unused.sgml
3030
3031
3032 <!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:See_Also ##### -->
3033 <para>
3034
3035 </para>
3036
3037
3038 <!-- ##### MACRO GST_HTTPSRC ##### -->
3039 >>>>>>> 1.23.2.3
3040 <para>
3041
3042 </para>
3043
3044 @obj: 
3045
3046 <!-- ##### STRUCT GstQueue ##### -->
3047 <para>
3048
3049 </para>
3050
3051
3052 <!-- ##### MACRO gst_meta_new ##### -->
3053 <para>
3054 Create new meta data.
3055 </para>
3056
3057 @type: the type of the meta data to create
3058
3059 <!-- ##### FUNCTION plugin_initialize ##### -->
3060 <para>
3061
3062 </para>
3063
3064
3065 <!-- ##### FUNCTION gst_caps_register ##### -->
3066 <para>
3067
3068 </para>
3069
3070 @factory: 
3071 @Returns: 
3072
3073 <!-- ##### ARG GstAsyncDiskSrc:location ##### -->
3074 <para>
3075 Specify the location of the file to read.
3076 </para>
3077
3078
3079 <!-- ##### MACRO GST_TEE_CLASS ##### -->
3080 <para>
3081
3082 </para>
3083
3084 @klass: 
3085
3086 <!-- ##### FUNCTION gst_queue_get_type ##### -->
3087 <para>
3088
3089 </para>
3090
3091 @Returns: 
3092
3093 <!-- ##### MACRO DEBUG_LEAVE ##### -->
3094 <para>
3095
3096 </para>
3097
3098 @format: 
3099 @args...: 
3100
3101 <!-- ##### FUNCTION gst_audiosink_set_format ##### -->
3102 <para>
3103
3104 </para>
3105
3106 @audiosink: 
3107 @format: 
3108
3109 <!-- ##### SECTION ./tmpl/spectrum.sgml:Long_Description ##### -->
3110 <para>
3111 Frequencies of a spectrum analysis.
3112
3113 </para>
3114
3115
3116 <!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Title ##### -->
3117 GstAudioSrc
3118
3119
3120 <!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
3121 <para>
3122 Indicate that this pad will become available depending
3123 on the media type. Use this in the factory definition.
3124 </para>
3125
3126
3127 <!-- ##### MACRO INFO ##### -->
3128 <para>
3129
3130 </para>
3131
3132 @cat: 
3133 @format: 
3134 @args...: 
3135
3136 <!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Long_Description ##### -->
3137 <para>
3138 Reads data from a file. You can seek to a specific location by setting
3139 the offset.
3140 </para>
3141
3142
3143 <!-- ##### FUNCTION gst_sinesrc_new ##### -->
3144 <para>
3145
3146 </para>
3147
3148 @name: 
3149 @Returns: 
3150
3151 <!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
3152 <para>
3153
3154 </para>
3155
3156 @obj: 
3157
3158 <!-- ##### FUNCTION gst_buffer_get_metas ##### -->
3159 <para>
3160
3161 </para>
3162
3163 @buffer: 
3164 @Returns: 
3165
3166 <!-- ##### ARG GstAudioSrc:curoffset ##### -->
3167 <para>
3168 Get the current number of bytes read.
3169 </para>
3170
3171
3172 <!-- ##### FUNCTION gst_plugin_init ##### -->
3173 <para>
3174
3175 </para>
3176
3177
3178 <!-- ##### STRUCT MetaAudioSpectrum ##### -->
3179 <para>
3180
3181 </para>
3182
3183 @meta: 
3184 @bands: 
3185 @channels: 
3186 @interleaved: 
3187 @lowfreq: 
3188 @highfreq: 
3189 @steps: 
3190
3191 <!-- ##### SECTION ./tmpl/plugin.sgml:Title ##### -->
3192 plugin
3193
3194
3195 <!-- ##### MACRO GST_IS_PAD ##### -->
3196 <para>
3197
3198 </para>
3199
3200 @obj: 
3201
3202 <!-- ##### STRUCT GstFakeSrcClass ##### -->
3203 <para>
3204
3205 </para>
3206
3207
3208 <!-- ##### FUNCTION gst_type_dump ##### -->
3209 <para>
3210
3211 </para>
3212
3213
3214 <!-- ##### ARG GstAudioSink:channels ##### -->
3215 <para>
3216
3217 </para>
3218
3219
3220 <!-- ##### MACRO GST_BIN_CLASS ##### -->
3221 <para>
3222
3223 </para>
3224
3225 @klass: 
3226
3227 <!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
3228 <para>
3229
3230 </para>
3231
3232 @klass: 
3233
3234 <!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
3235 <para>
3236
3237 </para>
3238
3239 @obj: 
3240
3241 <!-- ##### ARG GstPad:active ##### -->
3242 <para>
3243 Indicates this pad is active
3244 </para>
3245
3246
3247 <!-- ##### STRUCT GstTee ##### -->
3248 <para>
3249
3250 </para>
3251
3252
3253 <!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### -->
3254 <para>
3255 A GstSrc is the start of a filter graph. It typically is a file or an
3256 audio source. It provides data for the next element in the graph.
3257
3258 </para>
3259
3260