-
Notifications
You must be signed in to change notification settings - Fork 0
/
GstApp-1.0.gir
2430 lines (2314 loc) · 120 KB
/
GstApp-1.0.gir
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0" version="1.2">
<include name="Gst" version="1.0"/>
<include name="GstBase" version="1.0"/>
<package name="gstreamer-app-1.0"/>
<c:include name="gst/app/app.h"/>
<namespace name="GstApp" version="1.0" shared-library="libgstapp-1.0.so.0" c:identifier-prefixes="Gst" c:symbol-prefixes="gst">
<function-macro name="APP_SINK" c:identifier="GST_APP_SINK" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="APP_SINK_CAST" c:identifier="GST_APP_SINK_CAST" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="APP_SINK_CLASS" c:identifier="GST_APP_SINK_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="APP_SRC" c:identifier="GST_APP_SRC" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="APP_SRC_CAST" c:identifier="GST_APP_SRC_CAST" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="APP_SRC_CLASS" c:identifier="GST_APP_SRC_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<enumeration name="AppLeakyType" version="1.20" glib:type-name="GstAppLeakyType" glib:get-type="gst_app_leaky_type_get_type" c:type="GstAppLeakyType">
<doc xml:space="preserve">Buffer dropping scheme to avoid the element's internal queue to block when
full.</doc>
<member name="none" value="0" c:identifier="GST_APP_LEAKY_TYPE_NONE" glib:nick="none" glib:name="GST_APP_LEAKY_TYPE_NONE">
<doc xml:space="preserve">Not Leaky</doc>
</member>
<member name="upstream" value="1" c:identifier="GST_APP_LEAKY_TYPE_UPSTREAM" glib:nick="upstream" glib:name="GST_APP_LEAKY_TYPE_UPSTREAM">
<doc xml:space="preserve">Leaky on upstream (new buffers)</doc>
</member>
<member name="downstream" value="2" c:identifier="GST_APP_LEAKY_TYPE_DOWNSTREAM" glib:nick="downstream" glib:name="GST_APP_LEAKY_TYPE_DOWNSTREAM">
<doc xml:space="preserve">Leaky on downstream (old buffers)</doc>
</member>
</enumeration>
<class name="AppSink" c:symbol-prefix="app_sink" c:type="GstAppSink" parent="GstBase.BaseSink" glib:type-name="GstAppSink" glib:get-type="gst_app_sink_get_type" glib:type-struct="AppSinkClass">
<doc xml:space="preserve">Appsink is a sink plugin that supports many different methods for making
the application get a handle on the GStreamer data in a pipeline. Unlike
most GStreamer elements, Appsink provides external API functions.
appsink can be used by linking to the gstappsink.h header file to access the
methods or by using the appsink action signals and properties.
The normal way of retrieving samples from appsink is by using the
gst_app_sink_pull_sample() and gst_app_sink_pull_preroll() methods.
These methods block until a sample becomes available in the sink or when the
sink is shut down or reaches EOS. There are also timed variants of these
methods, gst_app_sink_try_pull_sample() and gst_app_sink_try_pull_preroll(),
which accept a timeout parameter to limit the amount of time to wait.
Appsink will internally use a queue to collect buffers from the streaming
thread. If the application is not pulling samples fast enough, this queue
will consume a lot of memory over time. The "max-buffers", "max-time" and "max-bytes"
properties can be used to limit the queue size. The "drop" property controls whether the
streaming thread blocks or if older buffers are dropped when the maximum
queue size is reached. Note that blocking the streaming thread can negatively
affect real-time performance and should be avoided.
If a blocking behaviour is not desirable, setting the "emit-signals" property
to %TRUE will make appsink emit the "new-sample" and "new-preroll" signals
when a sample can be pulled without blocking.
The "caps" property on appsink can be used to control the formats that
appsink can receive. This property can contain non-fixed caps, the format of
the pulled samples can be obtained by getting the sample caps.
If one of the pull-preroll or pull-sample methods return %NULL, the appsink
is stopped or in the EOS state. You can check for the EOS state with the
"eos" property or with the gst_app_sink_is_eos() method.
The eos signal can also be used to be informed when the EOS state is reached
to avoid polling.</doc>
<implements name="Gst.URIHandler"/>
<virtual-method name="eos">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="new_preroll">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="new_sample">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="pull_preroll" invoker="pull_preroll">
<doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED
state. Calling this function after doing a seek will give the sample right
after the seek position.
Calling this function will clear the internal reference to the preroll
buffer.
Note that the preroll sample will also be returned as the first sample
when calling gst_app_sink_pull_sample().
If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
This function blocks until a preroll sample or EOS is received or the appsink
element is set to the READY/NULL state.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="pull_sample" invoker="pull_sample">
<doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers will be put in a queue so that the application
can pull samples at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="try_pull_object" invoker="try_pull_object" version="1.20" introspectable="0">
<doc xml:space="preserve">This function blocks until a sample or an event or EOS becomes available or the appsink
element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers and events will be put in a queue so that the application
can pull them at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
%NULL. Use gst_app_sink_is_eos() to check for the EOS condition.
This method is a variant of gst_app_sink_try_pull_sample() that can be used
to handle incoming events events as well as samples.
Note that future releases may extend this API to return other object types
so make sure that your code is checking for the actual type it is handling.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_mini_object_unref() after usage.</doc>
<type name="Gst.MiniObject" c:type="GstMiniObject*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for a sample</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="try_pull_preroll" invoker="try_pull_preroll" version="1.10">
<doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED
state. Calling this function after doing a seek will give the sample right
after the seek position.
Calling this function will clear the internal reference to the preroll
buffer.
Note that the preroll sample will also be returned as the first sample
when calling gst_app_sink_pull_sample().
If an EOS event was received before any buffers or the timeout expires,
this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
condition.
This function blocks until a preroll sample or EOS is received, the appsink
element is set to the READY/NULL state, or the timeout expires.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for the preroll sample</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="try_pull_sample" invoker="try_pull_sample" version="1.10">
<doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers will be put in a queue so that the application
can pull samples at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
If an EOS event was received before any buffers or the timeout expires,
this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
condition.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for a sample</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_buffer_list_support" c:identifier="gst_app_sink_get_buffer_list_support" version="1.12">
<doc xml:space="preserve">Check if @appsink supports buffer lists.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @appsink supports buffer lists.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_caps" c:identifier="gst_app_sink_get_caps" glib:get-property="caps">
<doc xml:space="preserve">Get the configured caps on @appsink.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the #GstCaps accepted by the sink. gst_caps_unref() after usage.</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_drop" c:identifier="gst_app_sink_get_drop" glib:get-property="drop">
<doc xml:space="preserve">Check if @appsink will drop old buffers when the maximum amount of queued
data is reached (meaning max buffers, time or bytes limit, whichever is hit first).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @appsink is dropping old buffers when the queue is
filled.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_emit_signals" c:identifier="gst_app_sink_get_emit_signals" glib:get-property="emit-signals">
<doc xml:space="preserve">Check if appsink will emit the "new-preroll" and "new-sample" signals.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @appsink is emitting the "new-preroll" and "new-sample"
signals.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_max_buffers" c:identifier="gst_app_sink_get_max_buffers" glib:get-property="max-buffers">
<doc xml:space="preserve">Get the maximum amount of buffers that can be queued in @appsink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The maximum amount of buffers that can be queued.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_max_bytes" c:identifier="gst_app_sink_get_max_bytes" glib:get-property="max-bytes" version="1.24">
<doc xml:space="preserve">Get the maximum total size, in bytes, that can be queued in @appsink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The maximum amount of bytes that can be queued</doc>
<type name="guint64" c:type="guint64"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_max_time" c:identifier="gst_app_sink_get_max_time" glib:get-property="max-time" version="1.24">
<doc xml:space="preserve">Get the maximum total duration that can be queued in @appsink.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The maximum total duration that can be queued.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wait_on_eos" c:identifier="gst_app_sink_get_wait_on_eos" glib:get-property="wait-on-eos">
<doc xml:space="preserve">Check if @appsink will wait for all buffers to be consumed when an EOS is
received.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @appsink will wait for all buffers to be consumed when an
EOS is received.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_eos" c:identifier="gst_app_sink_is_eos" glib:get-property="eos">
<doc xml:space="preserve">Check if @appsink is EOS, which is when no more samples can be pulled because
an EOS event was received.
This function also returns %TRUE when the appsink is not in the PAUSED or
PLAYING state.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if no more samples can be pulled and the appsink is EOS.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="pull_object" c:identifier="gst_app_sink_pull_object" version="1.20" introspectable="0">
<doc xml:space="preserve">This function blocks until a sample or an event becomes available or the appsink
element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers and events will be put in a queue so that the application
can pull them at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
%NULL. Use gst_app_sink_is_eos() to check for the EOS condition.
This method is a variant of gst_app_sink_pull_sample() that can be used
to handle incoming events events as well as samples.
Note that future releases may extend this API to return other object types
so make sure that your code is checking for the actual type it is handling.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample, or a #GstEvent or NULL when the appsink is stopped or EOS.
Call gst_mini_object_unref() after usage.</doc>
<type name="Gst.MiniObject" c:type="GstMiniObject*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="pull_preroll" c:identifier="gst_app_sink_pull_preroll">
<doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED
state. Calling this function after doing a seek will give the sample right
after the seek position.
Calling this function will clear the internal reference to the preroll
buffer.
Note that the preroll sample will also be returned as the first sample
when calling gst_app_sink_pull_sample().
If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
This function blocks until a preroll sample or EOS is received or the appsink
element is set to the READY/NULL state.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="pull_sample" c:identifier="gst_app_sink_pull_sample">
<doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers will be put in a queue so that the application
can pull samples at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_buffer_list_support" c:identifier="gst_app_sink_set_buffer_list_support" version="1.12">
<doc xml:space="preserve">Instruct @appsink to enable or disable buffer list support.
For backwards-compatibility reasons applications need to opt in
to indicate that they will be able to handle buffer lists.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="enable_lists" transfer-ownership="none">
<doc xml:space="preserve">enable or disable buffer list support</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_callbacks" c:identifier="gst_app_sink_set_callbacks" introspectable="0">
<doc xml:space="preserve">Set callbacks which will be executed for each new preroll, new sample and eos.
This is an alternative to using the signals, it has lower overhead and is thus
less expensive, but also less flexible.
If callbacks are installed, no signals will be emitted for performance
reasons.
Before 1.16.3 it was not possible to change the callbacks in a thread-safe
way.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="callbacks" transfer-ownership="none">
<doc xml:space="preserve">the callbacks</doc>
<type name="AppSinkCallbacks" c:type="GstAppSinkCallbacks*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a user_data argument for the callbacks</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a destroy notify function</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="set_caps" c:identifier="gst_app_sink_set_caps" glib:set-property="caps">
<doc xml:space="preserve">Set the capabilities on the appsink element. This function takes
a copy of the caps structure. After calling this method, the sink will only
accept caps that match @caps. If @caps is non-fixed, or incomplete,
you must check the caps on the samples to get the actual used caps.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">caps to set</doc>
<type name="Gst.Caps" c:type="const GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_drop" c:identifier="gst_app_sink_set_drop" glib:set-property="drop">
<doc xml:space="preserve">Instruct @appsink to drop old buffers when the maximum amount of queued
data is reached, that is, when any configured limit is hit (max-buffers, max-time or max-bytes).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="drop" transfer-ownership="none">
<doc xml:space="preserve">the new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_emit_signals" c:identifier="gst_app_sink_set_emit_signals" glib:set-property="emit-signals">
<doc xml:space="preserve">Make appsink emit the "new-preroll" and "new-sample" signals. This option is
by default disabled because signal emission is expensive and unneeded when
the application prefers to operate in pull mode.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="emit" transfer-ownership="none">
<doc xml:space="preserve">the new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_max_buffers" c:identifier="gst_app_sink_set_max_buffers" glib:set-property="max-buffers">
<doc xml:space="preserve">Set the maximum amount of buffers that can be queued in @appsink. After this
amount of buffers are queued in appsink, any more buffers will block upstream
elements until a sample is pulled from @appsink, unless 'drop' is set, in which
case new buffers will be discarded.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="max" transfer-ownership="none">
<doc xml:space="preserve">the maximum number of buffers to queue</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_max_bytes" c:identifier="gst_app_sink_set_max_bytes" glib:set-property="max-bytes" version="1.24">
<doc xml:space="preserve">Set the maximum total size that can be queued in @appsink. After this
amount of buffers are queued in appsink, any more buffers will block upstream
elements until a sample is pulled from @appsink, unless 'drop' is set, in which
case new buffers will be discarded.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="max" transfer-ownership="none">
<doc xml:space="preserve">the maximum total size of buffers to queue, in bytes</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
</parameters>
</method>
<method name="set_max_time" c:identifier="gst_app_sink_set_max_time" glib:set-property="max-time" version="1.24">
<doc xml:space="preserve">Set the maximum total duration that can be queued in @appsink. After this
amount of buffers are queued in appsink, any more buffers will block upstream
elements until a sample is pulled from @appsink, unless 'drop' is set, in which
case new buffers will be discarded.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="max" transfer-ownership="none">
<doc xml:space="preserve">the maximum total duration to queue</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_wait_on_eos" c:identifier="gst_app_sink_set_wait_on_eos" glib:set-property="wait-on-eos">
<doc xml:space="preserve">Instruct @appsink to wait for all buffers to be consumed when an EOS is received.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="wait" transfer-ownership="none">
<doc xml:space="preserve">the new state</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="try_pull_object" c:identifier="gst_app_sink_try_pull_object" version="1.20" introspectable="0">
<doc xml:space="preserve">This function blocks until a sample or an event or EOS becomes available or the appsink
element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers and events will be put in a queue so that the application
can pull them at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
%NULL. Use gst_app_sink_is_eos() to check for the EOS condition.
This method is a variant of gst_app_sink_try_pull_sample() that can be used
to handle incoming events events as well as samples.
Note that future releases may extend this API to return other object types
so make sure that your code is checking for the actual type it is handling.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_mini_object_unref() after usage.</doc>
<type name="Gst.MiniObject" c:type="GstMiniObject*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for a sample</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="try_pull_preroll" c:identifier="gst_app_sink_try_pull_preroll" version="1.10">
<doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED
state. Calling this function after doing a seek will give the sample right
after the seek position.
Calling this function will clear the internal reference to the preroll
buffer.
Note that the preroll sample will also be returned as the first sample
when calling gst_app_sink_pull_sample().
If an EOS event was received before any buffers or the timeout expires,
this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
condition.
This function blocks until a preroll sample or EOS is received, the appsink
element is set to the READY/NULL state, or the timeout expires.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for the preroll sample</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="try_pull_sample" c:identifier="gst_app_sink_try_pull_sample" version="1.10">
<doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING
state. All rendered buffers will be put in a queue so that the application
can pull samples at its own rate. Note that when the application does not
pull samples fast enough, the queued buffers could consume a lot of memory,
especially when dealing with raw video frames.
If an EOS event was received before any buffers or the timeout expires,
this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
condition.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
Call gst_sample_unref() after usage.</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="appsink" transfer-ownership="none">
<doc xml:space="preserve">a #GstAppSink</doc>
<type name="AppSink" c:type="GstAppSink*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for a sample</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<property name="buffer-list" writable="1" transfer-ownership="none" default-value="FALSE">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="caps" writable="1" transfer-ownership="none" setter="set_caps" getter="get_caps">
<type name="Gst.Caps"/>
</property>
<property name="drop" writable="1" transfer-ownership="none" setter="set_drop" getter="get_drop" default-value="FALSE">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="emit-signals" writable="1" transfer-ownership="none" setter="set_emit_signals" getter="get_emit_signals" default-value="FALSE">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="eos" transfer-ownership="none" getter="is_eos" default-value="TRUE">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="max-buffers" writable="1" transfer-ownership="none" setter="set_max_buffers" getter="get_max_buffers" default-value="0">
<doc xml:space="preserve">Maximum amount of buffers in the queue (0 = unlimited).</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="max-bytes" version="1.24" writable="1" transfer-ownership="none" setter="set_max_bytes" getter="get_max_bytes" default-value="0">
<doc xml:space="preserve">Maximum amount of bytes in the queue (0 = unlimited)</doc>
<type name="guint64" c:type="guint64"/>
</property>
<property name="max-time" version="1.24" writable="1" transfer-ownership="none" setter="set_max_time" getter="get_max_time" default-value="0">
<doc xml:space="preserve">Maximum total duration of data in the queue (0 = unlimited)</doc>
<type name="guint64" c:type="guint64"/>
</property>
<property name="wait-on-eos" version="1.8" writable="1" transfer-ownership="none" setter="set_wait_on_eos" getter="get_wait_on_eos" default-value="TRUE">
<doc xml:space="preserve">Wait for all buffers to be processed after receiving an EOS.
In cases where it is uncertain if an @appsink will have a consumer for its buffers
when it receives an EOS, set to %FALSE to ensure that the @appsink will not hang.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="basesink">
<type name="GstBase.BaseSink" c:type="GstBaseSink"/>
</field>
<field name="priv" readable="0" private="1">
<type name="AppSinkPrivate" c:type="GstAppSinkPrivate*"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<glib:signal name="eos" when="last">
<doc xml:space="preserve">Signal that the end-of-stream has been reached. This signal is emitted from
the streaming thread.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="new-preroll" when="last">
<doc xml:space="preserve">Signal that a new preroll sample is available.
This signal is emitted from the streaming thread and only when the
"emit-signals" property is %TRUE.
The new preroll sample can be retrieved with the "pull-preroll" action
signal or gst_app_sink_pull_preroll() either from this signal callback
or from any other thread.
Note that this signal is only emitted when the "emit-signals" property is
set to %TRUE, which it is not by default for performance reasons.</doc>
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn"/>
</return-value>
</glib:signal>
<glib:signal name="new-sample" when="last">
<doc xml:space="preserve">Signal that a new sample is available.
This signal is emitted from the streaming thread and only when the
"emit-signals" property is %TRUE.
The new sample can be retrieved with the "pull-sample" action
signal or gst_app_sink_pull_sample() either from this signal callback
or from any other thread.
Note that this signal is only emitted when the "emit-signals" property is
set to %TRUE, which it is not by default for performance reasons.</doc>
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn"/>
</return-value>
</glib:signal>
<glib:signal name="new-serialized-event" when="last" version="1.20">
<doc xml:space="preserve">Signal that a new downstream serialized event is available.
This signal is emitted from the streaming thread and only when the
"emit-signals" property is %TRUE.
The new event can be retrieved with the "try-pull-object" action
signal or gst_app_sink_pull_object() either from this signal callback
or from any other thread.
EOS will not be notified using this signal, use #GstAppSink::eos instead.
EOS cannot be pulled either, use gst_app_sink_is_eos() to check for it.
Note that this signal is only emitted when the "emit-signals" property is
set to %TRUE, which it is not by default for performance reasons.
The callback should return %TRUE if the event has been handled, which will
skip basesink handling of the event, %FALSE otherwise.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
</glib:signal>
<glib:signal name="propose-allocation" when="last" version="1.24">
<doc xml:space="preserve">Signal that a new propose_allocation query is available.
This signal is emitted from the streaming thread and only when the
"emit-signals" property is %TRUE.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">the allocation query</doc>
<type name="Gst.Query"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="pull-preroll" when="last" action="1">
<doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED
state. Calling this function after doing a seek will give the sample right
after the seek position.
Calling this function will clear the internal reference to the preroll
buffer.
Note that the preroll sample will also be returned as the first sample
when calling gst_app_sink_pull_sample() or the "pull-sample" action signal.
If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
This function blocks until a preroll sample or EOS is received or the appsink
element is set to the READY/NULL state.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or %NULL when the appsink is stopped or EOS.</doc>
<type name="Gst.Sample"/>
</return-value>
</glib:signal>
<glib:signal name="pull-sample" when="last" action="1">
<doc xml:space="preserve">This function blocks until a sample or EOS becomes available or the appsink
element is set to the READY/NULL state.
This function will only return samples when the appsink is in the PLAYING
state. All rendered samples will be put in a queue so that the application
can pull samples at its own rate.
Note that when the application does not pull samples fast enough, the
queued samples could consume a lot of memory, especially when dealing with
raw video frames. It's possible to control the behaviour of the queue with
the "drop" and "max-buffers" / "max-bytes" / "max-time" set of properties.
If an EOS event was received before any buffers, this function returns
%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or %NULL when the appsink is stopped or EOS.</doc>
<type name="Gst.Sample"/>
</return-value>
</glib:signal>
<glib:signal name="try-pull-object" when="last" action="1" version="1.20">
<doc xml:space="preserve">This function blocks until a sample or an event becomes available or the appsink
element is set to the READY/NULL state or the timeout expires.
This function will only return samples when the appsink is in the PLAYING
state. All rendered samples and events will be put in a queue so that the application
can pull them at its own rate.
Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state.
Note that when the application does not pull samples fast enough, the
queued samples could consume a lot of memory, especially when dealing with
raw video frames. It's possible to control the behaviour of the queue with
the "drop" and "max-buffers" / "max-bytes" / "max-time" set of properties.
This function will only pull serialized events, excluding
the EOS event for which this functions returns
%NULL. Use gst_app_sink_is_eos() to check for the EOS condition.
This signal is a variant of #GstAppSink::try-pull-sample: that can be used
to handle incoming events as well as samples.
Note that future releases may extend this API to return other object types
so make sure that your code is checking for the actual type it is handling.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or a #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires.</doc>
<type name="Gst.MiniObject"/>
</return-value>
<parameters>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">the maximum amount of time to wait for a sample</doc>
<type name="guint64" c:type="guint64"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="try-pull-preroll" when="last" action="1" version="1.10">
<doc xml:space="preserve">Get the last preroll sample in @appsink. This was the sample that caused the
appsink to preroll in the PAUSED state.
This function is typically used when dealing with a pipeline in the PAUSED
state. Calling this function after doing a seek will give the sample right
after the seek position.
Calling this function will clear the internal reference to the preroll
buffer.
Note that the preroll sample will also be returned as the first sample
when calling gst_app_sink_pull_sample() or the "pull-sample" action signal.
If an EOS event was received before any buffers or the timeout expires,
this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
condition.
This function blocks until a preroll sample or EOS is received, the appsink
element is set to the READY/NULL state, or the timeout expires.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstSample or %NULL when the appsink
is stopped or EOS or the timeout expires.</doc>
<type name="Gst.Sample"/>
</return-value>
<parameters>