-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGstRtspServer-1.0.gir
12319 lines (12130 loc) · 593 KB
/
GstRtspServer-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="GstNet" version="1.0"/>
<include name="GstRtsp" version="1.0"/>
<package name="gstreamer-rtsp-server-1.0"/>
<c:include name="gst/rtsp-server/rtsp-server.h"/>
<namespace name="GstRtspServer" version="1.0" shared-library="libgstrtspserver-1.0.so.0" c:identifier-prefixes="Gst" c:symbol-prefixes="gst">
<function-macro name="IS_RTSP_ADDRESS_POOL" c:identifier="GST_IS_RTSP_ADDRESS_POOL" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ADDRESS_POOL_CLASS" c:identifier="GST_IS_RTSP_ADDRESS_POOL_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_AUTH" c:identifier="GST_IS_RTSP_AUTH" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_AUTH_CLASS" c:identifier="GST_IS_RTSP_AUTH_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_CLIENT" c:identifier="GST_IS_RTSP_CLIENT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_CLIENT_CLASS" c:identifier="GST_IS_RTSP_CLIENT_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MEDIA" c:identifier="GST_IS_RTSP_MEDIA" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MEDIA_CLASS" c:identifier="GST_IS_RTSP_MEDIA_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MEDIA_FACTORY" c:identifier="GST_IS_RTSP_MEDIA_FACTORY" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MEDIA_FACTORY_CLASS" c:identifier="GST_IS_RTSP_MEDIA_FACTORY_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MEDIA_FACTORY_URI" c:identifier="GST_IS_RTSP_MEDIA_FACTORY_URI" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MEDIA_FACTORY_URI_CLASS" c:identifier="GST_IS_RTSP_MEDIA_FACTORY_URI_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MOUNT_POINTS" c:identifier="GST_IS_RTSP_MOUNT_POINTS" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_MOUNT_POINTS_CLASS" c:identifier="GST_IS_RTSP_MOUNT_POINTS_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_CLIENT" c:identifier="GST_IS_RTSP_ONVIF_CLIENT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_CLIENT_CLASS" c:identifier="GST_IS_RTSP_ONVIF_CLIENT_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_MEDIA" c:identifier="GST_IS_RTSP_ONVIF_MEDIA" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_MEDIA_CLASS" c:identifier="GST_IS_RTSP_ONVIF_MEDIA_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_MEDIA_FACTORY" c:identifier="GST_IS_RTSP_ONVIF_MEDIA_FACTORY" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_MEDIA_FACTORY_CLASS" c:identifier="GST_IS_RTSP_ONVIF_MEDIA_FACTORY_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_SERVER" c:identifier="GST_IS_RTSP_ONVIF_SERVER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_ONVIF_SERVER_CLASS" c:identifier="GST_IS_RTSP_ONVIF_SERVER_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_PERMISSIONS" c:identifier="GST_IS_RTSP_PERMISSIONS" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SERVER" c:identifier="GST_IS_RTSP_SERVER" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SERVER_CLASS" c:identifier="GST_IS_RTSP_SERVER_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SESSION" c:identifier="GST_IS_RTSP_SESSION" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SESSION_CLASS" c:identifier="GST_IS_RTSP_SESSION_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SESSION_MEDIA" c:identifier="GST_IS_RTSP_SESSION_MEDIA" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SESSION_MEDIA_CLASS" c:identifier="GST_IS_RTSP_SESSION_MEDIA_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SESSION_POOL" c:identifier="GST_IS_RTSP_SESSION_POOL" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_SESSION_POOL_CLASS" c:identifier="GST_IS_RTSP_SESSION_POOL_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_STREAM" c:identifier="GST_IS_RTSP_STREAM" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_STREAM_CLASS" c:identifier="GST_IS_RTSP_STREAM_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_STREAM_TRANSPORT" c:identifier="GST_IS_RTSP_STREAM_TRANSPORT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_STREAM_TRANSPORT_CLASS" c:identifier="GST_IS_RTSP_STREAM_TRANSPORT_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_THREAD" c:identifier="GST_IS_RTSP_THREAD" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_THREAD_POOL" c:identifier="GST_IS_RTSP_THREAD_POOL" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_THREAD_POOL_CLASS" c:identifier="GST_IS_RTSP_THREAD_POOL_CLASS" introspectable="0">
<parameters>
<parameter name="klass">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_RTSP_TOKEN" c:identifier="GST_IS_RTSP_TOKEN" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<record name="RTSPAddress" c:type="GstRTSPAddress" glib:type-name="GstRTSPAddress" glib:get-type="gst_rtsp_address_get_type" c:symbol-prefix="rtsp_address">
<doc xml:space="preserve">An address</doc>
<field name="pool" writable="1">
<doc xml:space="preserve">the #GstRTSPAddressPool owner of this address</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</field>
<field name="address" writable="1">
<doc xml:space="preserve">the address</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="port" writable="1">
<doc xml:space="preserve">the port number</doc>
<type name="guint16" c:type="guint16"/>
</field>
<field name="n_ports" writable="1">
<doc xml:space="preserve">number of ports</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="ttl" writable="1">
<doc xml:space="preserve">TTL or 0 for unicast addresses</doc>
<type name="guint8" c:type="guint8"/>
</field>
<field name="priv" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<method name="copy" c:identifier="gst_rtsp_address_copy">
<doc xml:space="preserve">Make a copy of @addr.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a copy of @addr.</doc>
<type name="RTSPAddress" c:type="GstRTSPAddress*"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddress</doc>
<type name="RTSPAddress" c:type="GstRTSPAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="gst_rtsp_address_free">
<doc xml:space="preserve">Free @addr and releasing it back into the pool when owned by a
pool.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddress</doc>
<type name="RTSPAddress" c:type="GstRTSPAddress*"/>
</instance-parameter>
</parameters>
</method>
</record>
<bitfield name="RTSPAddressFlags" c:type="GstRTSPAddressFlags">
<doc xml:space="preserve">Flags used to control allocation of addresses</doc>
<member name="none" value="0" c:identifier="GST_RTSP_ADDRESS_FLAG_NONE">
<doc xml:space="preserve">no flags</doc>
</member>
<member name="ipv4" value="1" c:identifier="GST_RTSP_ADDRESS_FLAG_IPV4">
<doc xml:space="preserve">an IPv4 address</doc>
</member>
<member name="ipv6" value="2" c:identifier="GST_RTSP_ADDRESS_FLAG_IPV6">
<doc xml:space="preserve">and IPv6 address</doc>
</member>
<member name="even_port" value="4" c:identifier="GST_RTSP_ADDRESS_FLAG_EVEN_PORT">
<doc xml:space="preserve">address with an even port</doc>
</member>
<member name="multicast" value="8" c:identifier="GST_RTSP_ADDRESS_FLAG_MULTICAST">
<doc xml:space="preserve">a multicast address</doc>
</member>
<member name="unicast" value="16" c:identifier="GST_RTSP_ADDRESS_FLAG_UNICAST">
<doc xml:space="preserve">a unicast address</doc>
</member>
</bitfield>
<class name="RTSPAddressPool" c:symbol-prefix="rtsp_address_pool" c:type="GstRTSPAddressPool" parent="GObject.Object" glib:type-name="GstRTSPAddressPool" glib:get-type="gst_rtsp_address_pool_get_type" glib:type-struct="RTSPAddressPoolClass">
<doc xml:space="preserve">An address pool, all member are private</doc>
<constructor name="new" c:identifier="gst_rtsp_address_pool_new">
<doc xml:space="preserve">Make a new #GstRTSPAddressPool.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</return-value>
</constructor>
<method name="acquire_address" c:identifier="gst_rtsp_address_pool_acquire_address">
<doc xml:space="preserve">Take an address and ports from @pool. @flags can be used to control the
allocation. @n_ports consecutive ports will be allocated of which the first
one can be found in @port.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #GstRTSPAddress that should be freed with
gst_rtsp_address_free after use or %NULL when no address could be
acquired.</doc>
<type name="RTSPAddress" c:type="GstRTSPAddress*"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags</doc>
<type name="RTSPAddressFlags" c:type="GstRTSPAddressFlags"/>
</parameter>
<parameter name="n_ports" transfer-ownership="none">
<doc xml:space="preserve">the amount of ports</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="add_range" c:identifier="gst_rtsp_address_pool_add_range">
<doc xml:space="preserve">Adds the addresses from @min_addess to @max_address (inclusive)
to @pool. The valid port range for the addresses will be from @min_port to
@max_port inclusive.
When @ttl is 0, @min_address and @max_address should be unicast addresses.
@min_address and @max_address can be set to
#GST_RTSP_ADDRESS_POOL_ANY_IPV4 or #GST_RTSP_ADDRESS_POOL_ANY_IPV6 to bind
to all available IPv4 or IPv6 addresses.
When @ttl > 0, @min_address and @max_address should be multicast addresses.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the addresses could be added.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</instance-parameter>
<parameter name="min_address" transfer-ownership="none">
<doc xml:space="preserve">a minimum address to add</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="max_address" transfer-ownership="none">
<doc xml:space="preserve">a maximum address to add</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="min_port" transfer-ownership="none">
<doc xml:space="preserve">the minimum port</doc>
<type name="guint16" c:type="guint16"/>
</parameter>
<parameter name="max_port" transfer-ownership="none">
<doc xml:space="preserve">the maximum port</doc>
<type name="guint16" c:type="guint16"/>
</parameter>
<parameter name="ttl" transfer-ownership="none">
<doc xml:space="preserve">a TTL or 0 for unicast addresses</doc>
<type name="guint8" c:type="guint8"/>
</parameter>
</parameters>
</method>
<method name="clear" c:identifier="gst_rtsp_address_pool_clear">
<doc xml:space="preserve">Clear all addresses in @pool. There should be no outstanding
allocations.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="dump" c:identifier="gst_rtsp_address_pool_dump">
<doc xml:space="preserve">Dump the free and allocated addresses to stdout.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_unicast_addresses" c:identifier="gst_rtsp_address_pool_has_unicast_addresses">
<doc xml:space="preserve">Used to know if the pool includes any unicast addresses.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the pool includes any unicast addresses, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</instance-parameter>
</parameters>
</method>
<method name="reserve_address" c:identifier="gst_rtsp_address_pool_reserve_address">
<doc xml:space="preserve">Take a specific address and ports from @pool. @n_ports consecutive
ports will be allocated of which the first one can be found in
@port.
If @ttl is 0, @address should be a unicast address. If @ttl > 0, @address
should be a valid multicast address.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#GST_RTSP_ADDRESS_POOL_OK if an address was reserved. The address
is returned in @address and should be freed with gst_rtsp_address_free
after use.</doc>
<type name="RTSPAddressPoolResult" c:type="GstRTSPAddressPoolResult"/>
</return-value>
<parameters>
<instance-parameter name="pool" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAddressPool</doc>
<type name="RTSPAddressPool" c:type="GstRTSPAddressPool*"/>
</instance-parameter>
<parameter name="ip_address" transfer-ownership="none">
<doc xml:space="preserve">The IP address to reserve</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">The first port to reserve</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_ports" transfer-ownership="none">
<doc xml:space="preserve">The number of ports</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="ttl" transfer-ownership="none">
<doc xml:space="preserve">The requested ttl</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="address" direction="out" caller-allocates="0" transfer-ownership="full">
<doc xml:space="preserve">storage for a #GstRTSPAddress</doc>
<type name="RTSPAddress" c:type="GstRTSPAddress**"/>
</parameter>
</parameters>
</method>
<field name="parent">
<doc xml:space="preserve">the parent GObject</doc>
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="RTSPAddressPoolPrivate" c:type="GstRTSPAddressPoolPrivate*"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="RTSPAddressPoolClass" c:type="GstRTSPAddressPoolClass" glib:is-gtype-struct-for="RTSPAddressPool">
<doc xml:space="preserve">Opaque Address pool class.</doc>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="RTSPAddressPoolPrivate" c:type="GstRTSPAddressPoolPrivate" disguised="1" opaque="1"/>
<enumeration name="RTSPAddressPoolResult" c:type="GstRTSPAddressPoolResult">
<doc xml:space="preserve">Result codes from RTSP address pool functions.</doc>
<member name="ok" value="0" c:identifier="GST_RTSP_ADDRESS_POOL_OK">
<doc xml:space="preserve">no error</doc>
</member>
<member name="einval" value="-1" c:identifier="GST_RTSP_ADDRESS_POOL_EINVAL">
<doc xml:space="preserve">invalid arguments were provided to a function</doc>
</member>
<member name="ereserved" value="-2" c:identifier="GST_RTSP_ADDRESS_POOL_ERESERVED">
<doc xml:space="preserve">the addres has already been reserved</doc>
</member>
<member name="erange" value="-3" c:identifier="GST_RTSP_ADDRESS_POOL_ERANGE">
<doc xml:space="preserve">the address is not in the pool</doc>
</member>
<member name="elast" value="-4" c:identifier="GST_RTSP_ADDRESS_POOL_ELAST">
<doc xml:space="preserve">last error</doc>
</member>
</enumeration>
<class name="RTSPAuth" c:symbol-prefix="rtsp_auth" c:type="GstRTSPAuth" parent="GObject.Object" glib:type-name="GstRTSPAuth" glib:get-type="gst_rtsp_auth_get_type" glib:type-struct="RTSPAuthClass">
<doc xml:space="preserve">The authentication structure.</doc>
<constructor name="new" c:identifier="gst_rtsp_auth_new">
<doc xml:space="preserve">Create a new #GstRTSPAuth instance.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</return-value>
</constructor>
<function name="check" c:identifier="gst_rtsp_auth_check">
<doc xml:space="preserve">Check if @check is allowed in the current context.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">FALSE if check failed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="check" transfer-ownership="none">
<doc xml:space="preserve">the item to check</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="make_basic" c:identifier="gst_rtsp_auth_make_basic">
<doc xml:space="preserve">Construct a Basic authorisation token from @user and @pass.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the base64 encoding of the string @user:@pass.
g_free() after usage.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="user" transfer-ownership="none">
<doc xml:space="preserve">a userid</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="pass" transfer-ownership="none">
<doc xml:space="preserve">a password</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<virtual-method name="accept_certificate">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="connection" transfer-ownership="none">
<type name="Gio.TlsConnection" c:type="GTlsConnection*"/>
</parameter>
<parameter name="peer_cert" transfer-ownership="none">
<type name="Gio.TlsCertificate" c:type="GTlsCertificate*"/>
</parameter>
<parameter name="errors" transfer-ownership="none">
<type name="Gio.TlsCertificateFlags" c:type="GTlsCertificateFlags"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="authenticate">
<doc xml:space="preserve">check the authentication of a client. The default implementation
checks if the authentication in the header matches one of the basic
authentication tokens. This function should set the authgroup field
in the context.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="ctx" transfer-ownership="none">
<type name="RTSPContext" c:type="GstRTSPContext*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="check">
<doc xml:space="preserve">check if a resource can be accessed. this function should
call authenticate to authenticate the client when needed. The method
should also construct and send an appropriate response message on
error.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="ctx" transfer-ownership="none">
<type name="RTSPContext" c:type="GstRTSPContext*"/>
</parameter>
<parameter name="check" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="generate_authenticate_header">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="ctx" transfer-ownership="none">
<type name="RTSPContext" c:type="GstRTSPContext*"/>
</parameter>
</parameters>
</virtual-method>
<method name="add_basic" c:identifier="gst_rtsp_auth_add_basic">
<doc xml:space="preserve">Add a basic token for the default authentication algorithm that
enables the client with privileges listed in @token.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="basic" transfer-ownership="none">
<doc xml:space="preserve">the basic token</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="token" transfer-ownership="none">
<doc xml:space="preserve">authorisation token</doc>
<type name="RTSPToken" c:type="GstRTSPToken*"/>
</parameter>
</parameters>
</method>
<method name="add_digest" c:identifier="gst_rtsp_auth_add_digest" version="1.12">
<doc xml:space="preserve">Add a digest @user and @pass for the default authentication algorithm that
enables the client with privileges listed in @token.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="user" transfer-ownership="none">
<doc xml:space="preserve">the digest user name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="pass" transfer-ownership="none">
<doc xml:space="preserve">the digest password</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="token" transfer-ownership="none">
<doc xml:space="preserve">authorisation token</doc>
<type name="RTSPToken" c:type="GstRTSPToken*"/>
</parameter>
</parameters>
</method>
<method name="get_default_token" c:identifier="gst_rtsp_auth_get_default_token">
<doc xml:space="preserve">Get the default token for @auth. This token will be used for unauthenticated
users.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the #GstRTSPToken of @auth. gst_rtsp_token_unref() after
usage.</doc>
<type name="RTSPToken" c:type="GstRTSPToken*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_realm" c:identifier="gst_rtsp_auth_get_realm" version="1.16">
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the @realm of @auth</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_supported_methods" c:identifier="gst_rtsp_auth_get_supported_methods" version="1.12">
<doc xml:space="preserve">Gets the supported authentication methods of @auth.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The supported authentication methods</doc>
<type name="GstRtsp.RTSPAuthMethod" c:type="GstRTSPAuthMethod"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tls_authentication_mode" c:identifier="gst_rtsp_auth_get_tls_authentication_mode">
<doc xml:space="preserve">Get the #GTlsAuthenticationMode.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the #GTlsAuthenticationMode.</doc>
<type name="Gio.TlsAuthenticationMode" c:type="GTlsAuthenticationMode"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tls_certificate" c:identifier="gst_rtsp_auth_get_tls_certificate">
<doc xml:space="preserve">Get the #GTlsCertificate used for negotiating TLS @auth.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the #GTlsCertificate of @auth. g_object_unref() after
usage.</doc>
<type name="Gio.TlsCertificate" c:type="GTlsCertificate*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tls_database" c:identifier="gst_rtsp_auth_get_tls_database" version="1.6">
<doc xml:space="preserve">Get the #GTlsDatabase used for verifying client certificate.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the #GTlsDatabase of @auth. g_object_unref() after
usage.</doc>
<type name="Gio.TlsDatabase" c:type="GTlsDatabase*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="parse_htdigest" c:identifier="gst_rtsp_auth_parse_htdigest" version="1.16">
<doc xml:space="preserve">Parse the contents of the file at @path and enable the privileges
listed in @token for the users it describes.
The format of the file is expected to match the format described by
<https://en.wikipedia.org/wiki/Digest_access_authentication#The_.htdigest_file>,
as output by the `htdigest` command.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the file was successfully parsed, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">Path to the htdigest file</doc>
<type name="filename" c:type="const gchar*"/>
</parameter>
<parameter name="token" transfer-ownership="none">
<doc xml:space="preserve">authorisation token</doc>
<type name="RTSPToken" c:type="GstRTSPToken*"/>
</parameter>
</parameters>
</method>
<method name="remove_basic" c:identifier="gst_rtsp_auth_remove_basic">
<doc xml:space="preserve">Removes @basic authentication token.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="basic" transfer-ownership="none">
<doc xml:space="preserve">the basic token</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="remove_digest" c:identifier="gst_rtsp_auth_remove_digest" version="1.12">
<doc xml:space="preserve">Removes a digest user.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="user" transfer-ownership="none">
<doc xml:space="preserve">the digest user name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_default_token" c:identifier="gst_rtsp_auth_set_default_token">
<doc xml:space="preserve">Set the default #GstRTSPToken to @token in @auth. The default token will
be used for unauthenticated users.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="token" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GstRTSPToken</doc>
<type name="RTSPToken" c:type="GstRTSPToken*"/>
</parameter>
</parameters>
</method>
<method name="set_realm" c:identifier="gst_rtsp_auth_set_realm" version="1.16">
<doc xml:space="preserve">Set the @realm of @auth</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="realm" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">The realm to set</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_supported_methods" c:identifier="gst_rtsp_auth_set_supported_methods" version="1.12">
<doc xml:space="preserve">Sets the supported authentication @methods for @auth.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="methods" transfer-ownership="none">
<doc xml:space="preserve">supported methods</doc>
<type name="GstRtsp.RTSPAuthMethod" c:type="GstRTSPAuthMethod"/>
</parameter>
</parameters>
</method>
<method name="set_tls_authentication_mode" c:identifier="gst_rtsp_auth_set_tls_authentication_mode" version="1.6">
<doc xml:space="preserve">The #GTlsAuthenticationMode to set on the underlying GTlsServerConnection.
When set to another value than %G_TLS_AUTHENTICATION_NONE,
#GstRTSPAuth::accept-certificate signal will be emitted and must be handled.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">a #GTlsAuthenticationMode</doc>
<type name="Gio.TlsAuthenticationMode" c:type="GTlsAuthenticationMode"/>
</parameter>
</parameters>
</method>
<method name="set_tls_certificate" c:identifier="gst_rtsp_auth_set_tls_certificate">
<doc xml:space="preserve">Set the TLS certificate for the auth. Client connections will only
be accepted when TLS is negotiated.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="cert" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GTlsCertificate</doc>
<type name="Gio.TlsCertificate" c:type="GTlsCertificate*"/>
</parameter>
</parameters>
</method>
<method name="set_tls_database" c:identifier="gst_rtsp_auth_set_tls_database" version="1.6">
<doc xml:space="preserve">Sets the certificate database that is used to verify peer certificates.
If set to %NULL (the default), then peer certificate validation will always
set the %G_TLS_CERTIFICATE_UNKNOWN_CA error.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #GstRTSPAuth</doc>
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</instance-parameter>
<parameter name="database" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a #GTlsDatabase</doc>
<type name="Gio.TlsDatabase" c:type="GTlsDatabase*"/>
</parameter>
</parameters>
</method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="RTSPAuthPrivate" c:type="GstRTSPAuthPrivate*"/>
</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="accept-certificate" when="last" version="1.6">
<doc xml:space="preserve">Emitted during the TLS handshake after the client certificate has
been received. See also gst_rtsp_auth_set_tls_authentication_mode().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE to accept @peer_cert (which will also
immediately end the signal emission). %FALSE to allow the signal
emission to continue, which will cause the handshake to fail if
no one else overrides it.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">a #GTlsConnection</doc>
<type name="Gio.TlsConnection"/>
</parameter>
<parameter name="peer_cert" transfer-ownership="none">
<doc xml:space="preserve">the peer's #GTlsCertificate</doc>
<type name="Gio.TlsCertificate"/>
</parameter>
<parameter name="errors" transfer-ownership="none">
<doc xml:space="preserve">the problems with @peer_cert.</doc>
<type name="Gio.TlsCertificateFlags"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="RTSPAuthClass" c:type="GstRTSPAuthClass" glib:is-gtype-struct-for="RTSPAuth">
<doc xml:space="preserve">The authentication class.</doc>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="authenticate">
<doc xml:space="preserve">check the authentication of a client. The default implementation
checks if the authentication in the header matches one of the basic
authentication tokens. This function should set the authgroup field
in the context.</doc>
<callback name="authenticate">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</parameter>
<parameter name="ctx" transfer-ownership="none">
<type name="RTSPContext" c:type="GstRTSPContext*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="check">
<doc xml:space="preserve">check if a resource can be accessed. this function should
call authenticate to authenticate the client when needed. The method
should also construct and send an appropriate response message on
error.</doc>
<callback name="check">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</parameter>
<parameter name="ctx" transfer-ownership="none">
<type name="RTSPContext" c:type="GstRTSPContext*"/>
</parameter>
<parameter name="check" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="generate_authenticate_header">
<callback name="generate_authenticate_header">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="auth" transfer-ownership="none">
<type name="RTSPAuth" c:type="GstRTSPAuth*"/>
</parameter>