-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGstPlay-1.0.gir
2990 lines (2962 loc) · 152 KB
/
GstPlay-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="GstAudio" version="1.0"/>
<include name="GstBase" version="1.0"/>
<include name="GstPbutils" version="1.0"/>
<include name="GstTag" version="1.0"/>
<include name="GstVideo" version="1.0"/>
<package name="gstreamer-play-1.0"/>
<c:include name="gst/play/play.h"/>
<namespace name="GstPlay" version="1.0" shared-library="libgstplay-1.0.so.0" c:identifier-prefixes="Gst" c:symbol-prefixes="gst">
<function-macro name="IS_PLAY" c:identifier="GST_IS_PLAY" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_AUDIO_INFO" c:identifier="GST_IS_PLAY_AUDIO_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_AUDIO_INFO_CLASS" c:identifier="GST_IS_PLAY_AUDIO_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_CLASS" c:identifier="GST_IS_PLAY_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_MEDIA_INFO" c:identifier="GST_IS_PLAY_MEDIA_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_MEDIA_INFO_CLASS" c:identifier="GST_IS_PLAY_MEDIA_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_SIGNAL_ADAPTER" c:identifier="GST_IS_PLAY_SIGNAL_ADAPTER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_SIGNAL_ADAPTER_CLASS" c:identifier="GST_IS_PLAY_SIGNAL_ADAPTER_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_STREAM_INFO" c:identifier="GST_IS_PLAY_STREAM_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_STREAM_INFO_CLASS" c:identifier="GST_IS_PLAY_STREAM_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_SUBTITLE_INFO" c:identifier="GST_IS_PLAY_SUBTITLE_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_SUBTITLE_INFO_CLASS" c:identifier="GST_IS_PLAY_SUBTITLE_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_VIDEO_INFO" c:identifier="GST_IS_PLAY_VIDEO_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_VIDEO_INFO_CLASS" c:identifier="GST_IS_PLAY_VIDEO_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER" c:identifier="GST_IS_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_CLASS" c:identifier="GST_IS_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_PLAY_VIDEO_RENDERER" c:identifier="GST_IS_PLAY_VIDEO_RENDERER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY" c:identifier="GST_PLAY" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_AUDIO_INFO" c:identifier="GST_PLAY_AUDIO_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_AUDIO_INFO_CLASS" c:identifier="GST_PLAY_AUDIO_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_CAST" c:identifier="GST_PLAY_CAST" version="1.20" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_CLASS" c:identifier="GST_PLAY_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_DEPRECATED_FOR" c:identifier="GST_PLAY_DEPRECATED_FOR" introspectable="0">
<parameters>
<parameter name="f">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_GET_CLASS" c:identifier="GST_PLAY_GET_CLASS" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_MEDIA_INFO" c:identifier="GST_PLAY_MEDIA_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_MEDIA_INFO_CLASS" c:identifier="GST_PLAY_MEDIA_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_SIGNAL_ADAPTER" c:identifier="GST_PLAY_SIGNAL_ADAPTER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_SIGNAL_ADAPTER_CAST" c:identifier="GST_PLAY_SIGNAL_ADAPTER_CAST" version="1.20" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_SIGNAL_ADAPTER_CLASS" c:identifier="GST_PLAY_SIGNAL_ADAPTER_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_SIGNAL_ADAPTER_GET_CLASS" c:identifier="GST_PLAY_SIGNAL_ADAPTER_GET_CLASS" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_STREAM_INFO" c:identifier="GST_PLAY_STREAM_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_STREAM_INFO_CLASS" c:identifier="GST_PLAY_STREAM_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_SUBTITLE_INFO" c:identifier="GST_PLAY_SUBTITLE_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_SUBTITLE_INFO_CLASS" c:identifier="GST_PLAY_SUBTITLE_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_INFO" c:identifier="GST_PLAY_VIDEO_INFO" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_INFO_CLASS" c:identifier="GST_PLAY_VIDEO_INFO_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_OVERLAY_VIDEO_RENDERER" c:identifier="GST_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_CAST" c:identifier="GST_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_CAST" version="1.20" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_CLASS" c:identifier="GST_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_GET_CLASS" c:identifier="GST_PLAY_VIDEO_OVERLAY_VIDEO_RENDERER_GET_CLASS" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_RENDERER" c:identifier="GST_PLAY_VIDEO_RENDERER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="PLAY_VIDEO_RENDERER_GET_INTERFACE" c:identifier="GST_PLAY_VIDEO_RENDERER_GET_INTERFACE" version="1.20" introspectable="0">
<parameters>
<parameter name="inst">
</parameter>
</parameters>
</function-macro>
<class name="Play" c:symbol-prefix="play" c:type="GstPlay" version="1.20" parent="Gst.Object" glib:type-name="GstPlay" glib:get-type="gst_play_get_type" glib:type-struct="PlayClass">
<doc xml:space="preserve">The goal of the GstPlay library is to ease the integration of multimedia
playback features in applications. Thus, if you need to build a media player
from the ground-up, GstPlay provides the features you will most likely need.
An example player is available in gst-examples/playback/player/gst-play/.
Internally the GstPlay makes use of the `playbin3` element. The legacy
`playbin2` can be selected if the `GST_PLAY_USE_PLAYBIN3=0` environment
variable has been set.
**Important note**: If your application relies on the GstBus to get
notifications from GstPlay, you need to add some explicit clean-up code in
order to prevent the GstPlay object from leaking. See below for the details.
If you use the GstPlaySignalAdapter, no special clean-up is required.
When the GstPlaySignalAdapter is not used, the GstBus owned by GstPlay should
be set to flushing state before any attempt to drop the last reference of the
GstPlay object. An example in C:
```c
...
GstBus *bus = gst_play_get_message_bus (player);
gst_bus_set_flushing (bus, TRUE);
gst_object_unref (bus);
gst_object_unref (player);
```
The messages managed by the player contain a reference to itself, and if the
bus watch is just removed together with dropping the player then the bus will
simply keep them around forever (and the bus never goes away because the
player has a strong reference to it, so there's a reference cycle as long as
there are messages). Setting the bus to flushing state forces it to get rid
of its queued messages, thus breaking any possible reference cycle.</doc>
<constructor name="new" c:identifier="gst_play_new" version="1.20">
<doc xml:space="preserve">Creates a new #GstPlay instance.
Video is going to be rendered by @video_renderer, or if %NULL is provided
no special video set up will be done and some default handling will be
performed.
This also initializes GStreamer via `gst_init()` on the first call if this
didn't happen before.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</return-value>
<parameters>
<parameter name="video_renderer" transfer-ownership="full" nullable="1" allow-none="1">
<doc xml:space="preserve">GstPlayVideoRenderer to use</doc>
<type name="PlayVideoRenderer" c:type="GstPlayVideoRenderer*"/>
</parameter>
</parameters>
</constructor>
<function name="config_get_pipeline_dump_in_error_details" c:identifier="gst_play_config_get_pipeline_dump_in_error_details" version="1.24">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if pipeline dumps are included in #GstPlay error message
details.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</function>
<function name="config_get_position_update_interval" c:identifier="gst_play_config_get_position_update_interval" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">current position update interval in milliseconds</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</function>
<function name="config_get_seek_accurate" c:identifier="gst_play_config_get_seek_accurate" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if accurate seeking is enabled</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</function>
<function name="config_get_user_agent" c:identifier="gst_play_config_get_user_agent" version="1.20">
<doc xml:space="preserve">Return the user agent which has been configured using
gst_play_config_set_user_agent() if any.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the configured agent, or %NULL</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</function>
<function name="config_set_pipeline_dump_in_error_details" c:identifier="gst_play_config_set_pipeline_dump_in_error_details" version="1.24">
<doc xml:space="preserve">When enabled, the error message emitted by #GstPlay will include a pipeline
dump (in Graphviz DOT format) in the error details #GstStructure. The field
name is `pipeline-dump`.
This option is disabled by default.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">Include pipeline dumps in error details, or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="config_set_position_update_interval" c:identifier="gst_play_config_set_position_update_interval" version="1.20">
<doc xml:space="preserve">Set desired interval in milliseconds between two position-updated messages.
Pass 0 to stop updating the position.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
<parameter name="interval" transfer-ownership="none">
<doc xml:space="preserve">interval in ms</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="config_set_seek_accurate" c:identifier="gst_play_config_set_seek_accurate" version="1.20">
<doc xml:space="preserve">Enable or disable accurate seeking. When enabled, elements will try harder
to seek as accurately as possible to the requested seek position. Generally
it will be slower especially for formats that don't have any indexes or
timestamp markers in the stream.
If accurate seeking is disabled, elements will seek as close as the request
position without slowing down seeking too much.
Accurate seeking is disabled by default.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
<parameter name="accurate" transfer-ownership="none">
<doc xml:space="preserve">accurate seek or not</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="config_set_user_agent" c:identifier="gst_play_config_set_user_agent" version="1.20">
<doc xml:space="preserve">Set the user agent to pass to the server if @play needs to connect
to a server during playback. This is typically used when playing HTTP
or RTSP streams.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlay configuration</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
<parameter name="agent" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">the string to use as user agent</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="get_audio_streams" c:identifier="gst_play_get_audio_streams" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #GList of
matching #GstPlayAudioInfo.</doc>
<type name="GLib.List" c:type="GList*">
<type name="PlayAudioInfo"/>
</type>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlayMediaInfo</doc>
<type name="PlayMediaInfo" c:type="const GstPlayMediaInfo*"/>
</parameter>
</parameters>
</function>
<function name="get_subtitle_streams" c:identifier="gst_play_get_subtitle_streams" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #GList of
matching #GstPlaySubtitleInfo.</doc>
<type name="GLib.List" c:type="GList*">
<type name="PlaySubtitleInfo"/>
</type>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlayMediaInfo</doc>
<type name="PlayMediaInfo" c:type="const GstPlayMediaInfo*"/>
</parameter>
</parameters>
</function>
<function name="get_video_streams" c:identifier="gst_play_get_video_streams" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #GList of
matching #GstPlayVideoInfo.</doc>
<type name="GLib.List" c:type="GList*">
<type name="PlayVideoInfo"/>
</type>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstPlayMediaInfo</doc>
<type name="PlayMediaInfo" c:type="const GstPlayMediaInfo*"/>
</parameter>
</parameters>
</function>
<function name="is_play_message" c:identifier="gst_play_is_play_message" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #gboolean indicating whether the passed message represents a #GstPlay message or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="visualizations_free" c:identifier="gst_play_visualizations_free" version="1.20">
<doc xml:space="preserve">Frees a %NULL terminated array of #GstPlayVisualization.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="viss" transfer-ownership="none">
<doc xml:space="preserve">a %NULL terminated array of #GstPlayVisualization to free</doc>
<type name="PlayVisualization" c:type="GstPlayVisualization**"/>
</parameter>
</parameters>
</function>
<function name="visualizations_get" c:identifier="gst_play_visualizations_get" version="1.20">
<return-value transfer-ownership="full">
<doc xml:space="preserve">
a %NULL terminated array containing all available
visualizations. Use gst_play_visualizations_free() after
usage.</doc>
<array c:type="GstPlayVisualization**">
<type name="PlayVisualization"/>
</array>
</return-value>
</function>
<method name="get_audio_video_offset" c:identifier="gst_play_get_audio_video_offset" glib:get-property="audio-video-offset" version="1.20">
<doc xml:space="preserve">Retrieve the current value of audio-video-offset property</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of audio-video-offset in nanoseconds</doc>
<type name="gint64" c:type="gint64"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_color_balance" c:identifier="gst_play_get_color_balance" version="1.20">
<doc xml:space="preserve">Retrieve the current value of the indicated @type.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of @type, between [0,1]. In case of
error -1 is returned.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">#GstPlayColorBalanceType</doc>
<type name="PlayColorBalanceType" c:type="GstPlayColorBalanceType"/>
</parameter>
</parameters>
</method>
<method name="get_config" c:identifier="gst_play_get_config" version="1.20">
<doc xml:space="preserve">Get a copy of the current configuration of the play. This configuration
can either be modified and used for the gst_play_set_config() call
or it must be freed after usage.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a copy of the current configuration of @play. Use
gst_structure_free() after usage or gst_play_set_config().</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_current_audio_track" c:identifier="gst_play_get_current_audio_track" glib:get-property="current-audio-track" version="1.20">
<doc xml:space="preserve">A Function to get current audio #GstPlayAudioInfo instance.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">current audio track.
The caller should free it with g_object_unref()</doc>
<type name="PlayAudioInfo" c:type="GstPlayAudioInfo*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_current_subtitle_track" c:identifier="gst_play_get_current_subtitle_track" glib:get-property="current-subtitle-track" version="1.20">
<doc xml:space="preserve">A Function to get current subtitle #GstPlaySubtitleInfo instance.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">current subtitle track.
The caller should free it with g_object_unref()</doc>
<type name="PlaySubtitleInfo" c:type="GstPlaySubtitleInfo*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_current_video_track" c:identifier="gst_play_get_current_video_track" glib:get-property="current-video-track" version="1.20">
<doc xml:space="preserve">A Function to get current video #GstPlayVideoInfo instance.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">current video track.
The caller should free it with g_object_unref()</doc>
<type name="PlayVideoInfo" c:type="GstPlayVideoInfo*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_current_visualization" c:identifier="gst_play_get_current_visualization" version="1.20">
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">Name of the currently enabled
visualization.
g_free() after usage.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_duration" c:identifier="gst_play_get_duration" glib:get-property="duration" version="1.20">
<doc xml:space="preserve">Retrieves the duration of the media stream that self represents.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the duration of the currently-playing media stream, in
nanoseconds.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_media_info" c:identifier="gst_play_get_media_info" glib:get-property="media-info" version="1.20">
<doc xml:space="preserve">A Function to get the current media info #GstPlayMediaInfo instance.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">media info instance.
The caller should free it with g_object_unref()</doc>
<type name="PlayMediaInfo" c:type="GstPlayMediaInfo*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_message_bus" c:identifier="gst_play_get_message_bus" version="1.20">
<doc xml:space="preserve">GstPlay API exposes a #GstBus instance which purpose is to provide data
structures representing play-internal events in form of #GstMessage<!-- -->s of
type GST_MESSAGE_APPLICATION.
Each message carries a "play-message" field of type #GstPlayMessage.
Further fields of the message data are specific to each possible value of
that enumeration.
Applications can consume the messages asynchronously within their own
event-loop / UI-thread etc. Note that in case the application does not
consume the messages, the bus will accumulate these internally and eventually
fill memory. To avoid that, the bus has to be set "flushing".</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The play message bus instance</doc>
<type name="Gst.Bus" c:type="GstBus*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_multiview_flags" c:identifier="gst_play_get_multiview_flags" version="1.20">
<doc xml:space="preserve">Retrieve the current value of the indicated @type.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of @type, Default: 0x00000000 "none</doc>
<type name="GstVideo.VideoMultiviewFlags" c:type="GstVideoMultiviewFlags"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_multiview_mode" c:identifier="gst_play_get_multiview_mode" version="1.20">
<doc xml:space="preserve">Retrieve the current value of the indicated @type.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of @type, Default: -1 "none"</doc>
<type name="GstVideo.VideoMultiviewFramePacking" c:type="GstVideoMultiviewFramePacking"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_mute" c:identifier="gst_play_get_mute" glib:get-property="mute" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the currently-playing stream is muted.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pipeline" c:identifier="gst_play_get_pipeline" glib:get-property="pipeline" version="1.20">
<return-value transfer-ownership="full">
<doc xml:space="preserve">The internal playbin instance.
The caller should free it with g_object_unref()</doc>
<type name="Gst.Element" c:type="GstElement*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_position" c:identifier="gst_play_get_position" glib:get-property="position" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the absolute position time, in nanoseconds, of the
currently-playing stream.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_rate" c:identifier="gst_play_get_rate" glib:get-property="rate" version="1.20">
<return-value transfer-ownership="none">
<doc xml:space="preserve">current playback rate</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_subtitle_uri" c:identifier="gst_play_get_subtitle_uri" version="1.20">
<doc xml:space="preserve">Current subtitle URI</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">URI of the current external subtitle.
g_free() after usage.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_subtitle_video_offset" c:identifier="gst_play_get_subtitle_video_offset" glib:get-property="subtitle-video-offset" version="1.20">
<doc xml:space="preserve">Retrieve the current value of subtitle-video-offset property</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of subtitle-video-offset in nanoseconds</doc>
<type name="gint64" c:type="gint64"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_uri" c:identifier="gst_play_get_uri" glib:get-property="uri" version="1.20">
<doc xml:space="preserve">Gets the URI of the currently-playing stream.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a string containing the URI of the
currently-playing stream. g_free() after usage.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_video_snapshot" c:identifier="gst_play_get_video_snapshot" version="1.20">
<doc xml:space="preserve">Get a snapshot of the currently selected video stream, if any. The format can be
selected with @format and optional configuration is possible with @config.
Currently supported settings are:
- width, height of type G_TYPE_INT
- pixel-aspect-ratio of type GST_TYPE_FRACTION
Except for GST_PLAY_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">Current video snapshot sample or %NULL on failure</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">output format of the video snapshot</doc>
<type name="PlaySnapshotFormat" c:type="GstPlaySnapshotFormat"/>
</parameter>
<parameter name="config" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">Additional configuration</doc>
<type name="Gst.Structure" c:type="const GstStructure*"/>
</parameter>
</parameters>
</method>
<method name="get_volume" c:identifier="gst_play_get_volume" glib:get-property="volume" version="1.20">
<doc xml:space="preserve">Returns the current volume level, as a percentage between 0 and 1.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the volume as percentage between 0 and 1.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_color_balance" c:identifier="gst_play_has_color_balance" version="1.20">
<doc xml:space="preserve">Checks whether the @play has color balance support available.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @play has color balance support. Otherwise,
%FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="pause" c:identifier="gst_play_pause" version="1.20">
<doc xml:space="preserve">Pauses the current stream.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="play" c:identifier="gst_play_play" version="1.20">
<doc xml:space="preserve">Request to play the loaded stream.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="seek" c:identifier="gst_play_seek" version="1.20">
<doc xml:space="preserve">Seeks the currently-playing stream to the absolute @position time
in nanoseconds.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve">position to seek in nanoseconds</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_audio_track" c:identifier="gst_play_set_audio_track" version="1.20" deprecated="1" deprecated-version="1.26">
<doc-deprecated xml:space="preserve">Use gst_play_set_audio_track_id() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE
Sets the audio track @stream_index.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="stream_index" transfer-ownership="none">
<doc xml:space="preserve">stream index</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_audio_track_enabled" c:identifier="gst_play_set_audio_track_enabled" version="1.20">
<doc xml:space="preserve">Enable or disable the current audio track.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">TRUE or FALSE</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_audio_track_id" c:identifier="gst_play_set_audio_track_id" version="1.26">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE
Sets the audio track @stream_id.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">stream id</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_audio_video_offset" c:identifier="gst_play_set_audio_video_offset" glib:set-property="audio-video-offset" version="1.20">
<doc xml:space="preserve">Sets audio-video-offset property by value of @offset</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="offset" transfer-ownership="none">
<doc xml:space="preserve">#gint64 in nanoseconds</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
</parameters>
</method>
<method name="set_color_balance" c:identifier="gst_play_set_color_balance" version="1.20">
<doc xml:space="preserve">Sets the current value of the indicated channel @type to the passed
value.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="play" transfer-ownership="none">
<doc xml:space="preserve">#GstPlay instance</doc>
<type name="Play" c:type="GstPlay*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">#GstPlayColorBalanceType</doc>
<type name="PlayColorBalanceType" c:type="GstPlayColorBalanceType"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value for the @type, ranged [0,1]</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
</parameters>
</method>
<method name="set_config" c:identifier="gst_play_set_config" version="1.20">
<doc xml:space="preserve">Set the configuration of the play. If the play is already configured, and
the configuration hasn't changed, this function will return %TRUE. If the
play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE
and active configuration will remain.
@config is a #GstStructure that contains the configuration parameters for
the play.