-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathALSAHwdep-0.0.gir
1114 lines (1107 loc) · 50.1 KB
/
ALSAHwdep-0.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 version="1.2"
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">
<include name="GLib" version="2.0"/>
<include name="GObject" version="2.0"/>
<package name="alsahwdep"/>
<c:include name="alsahwdep.h"/>
<namespace name="ALSAHwdep"
version="0.0"
shared-library="libalsahwdep.so.0"
c:identifier-prefixes="ALSAHwdep"
c:symbol-prefixes="alsahwdep_">
<interface name="DeviceCommon"
c:symbol-prefix="device_common"
c:type="ALSAHwdepDeviceCommon"
version="0.3."
glib:type-name="ALSAHwdepDeviceCommon"
glib:get-type="alsahwdep_device_common_get_type"
glib:type-struct="DeviceCommonInterface">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="4">An interface to express common features of ALSA HwDep device.
A [iface@DeviceCommon] should be implemented by any type of ALSA HwDep device.</doc>
<source-position filename="../src/hwdep/device-common.h" line="88"/>
<virtual-method name="create_source" invoker="create_source" throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="166">Allocate [[email protected]] structure to handle events from ALSA hwdep character device. In
each iteration of [[email protected]], the `read(2)` system call is executed to dispatch
hwdep event, according to the result of `poll(2)` system call.</doc>
<source-position filename="../src/hwdep/device-common.h" line="79"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="176">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="168">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="source"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="169">A [[email protected]] to handle events from ALSA hwdep character device.</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_device_info"
invoker="get_device_info"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="144">Get the information according to given numeric IDs for card and device. The call of function is
expected to executes `ioctl(2)` system call with `SNDRV_CTL_IOCTL_HWDEP_INFO` command to the
character device.</doc>
<source-position filename="../src/hwdep/device-common.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="154">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="146">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="device_info"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="147">The information of device.</doc>
<type name="DeviceInfo" c:type="ALSAHwdepDeviceInfo**"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_protocol_version"
invoker="get_protocol_version"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="119">Get the version of hwdep protocol used currently. The version is expressed as the array with
three elements; major, minor, and micro version in the order. The length of major version is
16 bit, the length of minor and micro version is 8 bit each.</doc>
<source-position filename="../src/hwdep/device-common.h" line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="130">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="121">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="proto_ver_triplet"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="122">The version of protocol used
currently.</doc>
<array zero-terminated="0" c:type="guint16* const*" fixed-size="3">
<type name="guint16" c:type="guint16"/>
</array>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="handle_disconnection">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="81">Closure for the [signal@DeviceCommon::handle-disconnection] signal.</doc>
<source-position filename="../src/hwdep/device-common.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="83">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open" throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="20">Open one of ALSA hwdep character devices for the sound card.
The call of function is expected to execute `open(2)` system call for ALSA hwdep character
device.</doc>
<source-position filename="../src/hwdep/device-common.h" line="34"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="32">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="22">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="23">The path to special file for ALSA HwDep character device.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="open_flag" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="24">The flag of `open(2)` system call.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<method name="create_source"
c:identifier="alsahwdep_device_common_create_source"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="166">Allocate [[email protected]] structure to handle events from ALSA hwdep character device. In
each iteration of [[email protected]], the `read(2)` system call is executed to dispatch
hwdep event, according to the result of `poll(2)` system call.</doc>
<source-position filename="../src/hwdep/device-common.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="176">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="168">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="source"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="169">A [[email protected]] to handle events from ALSA hwdep character device.</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</method>
<method name="get_device_info"
c:identifier="alsahwdep_device_common_get_device_info"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="144">Get the information according to given numeric IDs for card and device. The call of function is
expected to executes `ioctl(2)` system call with `SNDRV_CTL_IOCTL_HWDEP_INFO` command to the
character device.</doc>
<source-position filename="../src/hwdep/device-common.h" line="97"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="154">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="146">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="device_info"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="147">The information of device.</doc>
<type name="DeviceInfo" c:type="ALSAHwdepDeviceInfo**"/>
</parameter>
</parameters>
</method>
<method name="get_protocol_version"
c:identifier="alsahwdep_device_common_get_protocol_version"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="119">Get the version of hwdep protocol used currently. The version is expressed as the array with
three elements; major, minor, and micro version in the order. The length of major version is
16 bit, the length of minor and micro version is 8 bit each.</doc>
<source-position filename="../src/hwdep/device-common.h" line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="130">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="121">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="proto_ver_triplet"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="122">The version of protocol used
currently.</doc>
<array zero-terminated="0" c:type="guint16* const*" fixed-size="3">
<type name="guint16" c:type="guint16"/>
</array>
</parameter>
</parameters>
</method>
<method name="open"
c:identifier="alsahwdep_device_common_open"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="86">Open one of ALSA hwdep character devices for the sound card.
The call of function is expected to execute `open(2)` system call for ALSA hwdep character
device.</doc>
<source-position filename="../src/hwdep/device-common.h" line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="99">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="88">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</instance-parameter>
<parameter name="card_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="89">The numeric identifier of sound card.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="device_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="90">The numerid identifier of device.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="open_flag" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="91">The flag of `open(2)` system call.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<glib:signal name="handle-disconnection" when="last" action="1">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="69">Emitted when the sound card is not available anymore due to unbinding driver or hot
unplugging. The owner of the object should prepare to call [[email protected]]
so that ALSA HwDep character device is going to be closed and sound card is released.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</interface>
<enumeration name="DeviceCommonError"
glib:type-name="ALSAHwdepDeviceCommonError"
glib:get-type="alsahwdep_device_common_error_get_type"
c:type="ALSAHwdepDeviceCommonError"
glib:error-domain="alsahwdep-device-common-error-quark">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="71">A set of enumerations for code of ALSAHwDep.DeviceCommonError error domain.</doc>
<member name="failed"
value="1"
c:identifier="ALSAHWDEP_DEVICE_COMMON_ERROR_FAILED"
glib:nick="failed"
glib:name="ALSAHWDEP_DEVICE_COMMON_ERROR_FAILED">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="73">The operation failed due to unspecified reason.</doc>
</member>
<member name="is_opened"
value="2"
c:identifier="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_OPENED"
glib:nick="is-opened"
glib:name="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_OPENED">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="74">The instance is already associated to character device.</doc>
</member>
<member name="is_not_opened"
value="3"
c:identifier="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_NOT_OPENED"
glib:nick="is-not-opened"
glib:name="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_NOT_OPENED">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="75">The instance is not associated to character device yet.</doc>
</member>
<member name="is_used"
value="4"
c:identifier="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_USED"
glib:nick="is-used"
glib:name="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_USED">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="76">The character device is already used.</doc>
</member>
<member name="is_not_supported"
value="5"
c:identifier="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_NOT_SUPPORTED"
glib:nick="is-not-supported"
glib:name="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_NOT_SUPPORTED">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="77">The HwDep device associated to the character device is not supported.</doc>
</member>
<member name="is_disconnected"
value="6"
c:identifier="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_DISCONNECTED"
glib:nick="is-disconnected"
glib:name="ALSAHWDEP_DEVICE_COMMON_ERROR_IS_DISCONNECTED">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="78">The sound card is under disconnected state.</doc>
</member>
<function name="quark"
c:identifier="alsahwdep_device_common_error_quark">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="17">Return the [[email protected]] for [[email protected]] with code in ALSAHwdep.DeviceCommonError
enumerations.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="23">A [[email protected]].</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="to_label"
c:identifier="alsahwdep_device_common_error_to_label">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="27">Retrieve the string label of error from code.</doc>
<source-position filename="../src/hwdep/device-common.h" line="15"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="code" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="29">A ALSAHwdep.DeviceCommonError.</doc>
<type name="DeviceCommonError"
c:type="ALSAHwdepDeviceCommonError"/>
</parameter>
<parameter name="label"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="30">The string label of error.</doc>
<type name="utf8" c:type="const char**"/>
</parameter>
</parameters>
</function>
</enumeration>
<record name="DeviceCommonInterface"
c:type="ALSAHwdepDeviceCommonInterface"
glib:is-gtype-struct-for="DeviceCommon">
<source-position filename="../src/hwdep/device-common.h" line="88"/>
<field name="parent_iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="open">
<callback name="open" throws="1">
<source-position filename="../src/hwdep/device-common.h" line="34"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="32">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="22">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="23">The path to special file for ALSA HwDep character device.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="open_flag" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="24">The flag of `open(2)` system call.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_protocol_version">
<callback name="get_protocol_version" throws="1">
<source-position filename="../src/hwdep/device-common.h" line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="130">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="121">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</parameter>
<parameter name="proto_ver_triplet"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="122">The version of protocol used
currently.</doc>
<array zero-terminated="0"
c:type="guint16* const*"
fixed-size="3">
<type name="guint16" c:type="guint16"/>
</array>
</parameter>
</parameters>
</callback>
</field>
<field name="get_device_info">
<callback name="get_device_info" throws="1">
<source-position filename="../src/hwdep/device-common.h" line="64"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="154">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="146">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</parameter>
<parameter name="device_info"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="147">The information of device.</doc>
<type name="DeviceInfo" c:type="ALSAHwdepDeviceInfo**"/>
</parameter>
</parameters>
</callback>
</field>
<field name="create_source">
<callback name="create_source" throws="1">
<source-position filename="../src/hwdep/device-common.h" line="79"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="176">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="168">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</parameter>
<parameter name="source"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="169">A [[email protected]] to handle events from ALSA hwdep character device.</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_disconnection">
<callback name="handle_disconnection">
<source-position filename="../src/hwdep/device-common.h" line="87"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.h"
line="83">A [iface@DeviceCommon].</doc>
<type name="DeviceCommon" c:type="ALSAHwdepDeviceCommon*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="DeviceInfo"
c:symbol-prefix="device_info"
c:type="ALSAHwdepDeviceInfo"
parent="GObject.Object"
glib:type-name="ALSAHwdepDeviceInfo"
glib:get-type="alsahwdep_device_info_get_type"
glib:type-struct="DeviceInfoClass">
<doc xml:space="preserve"
filename="../src/hwdep/device-info.c"
line="4">A GObject-derived object to express information of ALSA hwdep device.
A [class@DeviceInfo] is a GObject-derived object to express information of ALSA hwdep device.
The call of [func@get_device_info] returns an instance of the object.
The object wraps `struct snd_hwdep_info` in UAPI of Linux sound subsystem.</doc>
<source-position filename="../src/hwdep/device-info.h" line="15"/>
<property name="card-id"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-info.c"
line="103">The numeric ID of sound card.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="device-id"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-info.c"
line="91">The numeric ID of device.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="id"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-info.c"
line="115">The string ID of the hwdep device.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="iface"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-info.c"
line="137">The type of interface for the hwdep device, one of ALSAHwdepIfaceType.</doc>
<type name="IfaceType"/>
</property>
<property name="name"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-info.c"
line="126">The name of the hwdep device.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="DeviceInfoClass"
c:type="ALSAHwdepDeviceInfoClass"
glib:is-gtype-struct-for="DeviceInfo">
<source-position filename="../src/hwdep/device-info.h" line="15"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="IfaceType"
glib:type-name="ALSAHwdepIfaceType"
glib:get-type="alsahwdep_iface_type_get_type"
c:type="ALSAHwdepIfaceType">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="9">A set of enumerations for the interface of hwdep device.</doc>
<member name="opl2"
value="0"
c:identifier="ALSAHWDEP_IFACE_TYPE_OPL2"
glib:nick="opl2"
glib:name="ALSAHWDEP_IFACE_TYPE_OPL2">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="11">For OPL2 sound chip.</doc>
</member>
<member name="opl3"
value="1"
c:identifier="ALSAHWDEP_IFACE_TYPE_OPL3"
glib:nick="opl3"
glib:name="ALSAHWDEP_IFACE_TYPE_OPL3">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="12">For OPL3 sound chip.</doc>
</member>
<member name="opl4"
value="2"
c:identifier="ALSAHWDEP_IFACE_TYPE_OPL4"
glib:nick="opl4"
glib:name="ALSAHWDEP_IFACE_TYPE_OPL4">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="13">For OPL4 sound chip.</doc>
</member>
<member name="sb16csp"
value="3"
c:identifier="ALSAHWDEP_IFACE_TYPE_SB16CSP"
glib:nick="sb16csp"
glib:name="ALSAHWDEP_IFACE_TYPE_SB16CSP">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="14">For Creative Signal Processor.</doc>
</member>
<member name="emu10k1"
value="4"
c:identifier="ALSAHWDEP_IFACE_TYPE_EMU10K1"
glib:nick="emu10k1"
glib:name="ALSAHWDEP_IFACE_TYPE_EMU10K1">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="15">For FX8010 processor in EMU10K1 chip.</doc>
</member>
<member name="yss225"
value="5"
c:identifier="ALSAHWDEP_IFACE_TYPE_YSS225"
glib:nick="yss225"
glib:name="ALSAHWDEP_IFACE_TYPE_YSS225">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="16">For Yamaha FX processor.</doc>
</member>
<member name="ics2115"
value="6"
c:identifier="ALSAHWDEP_IFACE_TYPE_ICS2115"
glib:nick="ics2115"
glib:name="ALSAHWDEP_IFACE_TYPE_ICS2115">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="17">For Wavetable synth.</doc>
</member>
<member name="sscape"
value="7"
c:identifier="ALSAHWDEP_IFACE_TYPE_SSCAPE"
glib:nick="sscape"
glib:name="ALSAHWDEP_IFACE_TYPE_SSCAPE">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="18">For Ensoniq SoundScape ISA card (MC68EC000).</doc>
</member>
<member name="vx"
value="8"
c:identifier="ALSAHWDEP_IFACE_TYPE_VX"
glib:nick="vx"
glib:name="ALSAHWDEP_IFACE_TYPE_VX">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="19">For Digigram VX cards.</doc>
</member>
<member name="mixart"
value="9"
c:identifier="ALSAHWDEP_IFACE_TYPE_MIXART"
glib:nick="mixart"
glib:name="ALSAHWDEP_IFACE_TYPE_MIXART">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="20">For Digigram miXart cards.</doc>
</member>
<member name="usx2y"
value="10"
c:identifier="ALSAHWDEP_IFACE_TYPE_USX2Y"
glib:nick="usx2y"
glib:name="ALSAHWDEP_IFACE_TYPE_USX2Y">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="21">For Tascam US122, US224 & US428 usb.</doc>
</member>
<member name="emux_wavetable"
value="11"
c:identifier="ALSAHWDEP_IFACE_TYPE_EMUX_WAVETABLE"
glib:nick="emux-wavetable"
glib:name="ALSAHWDEP_IFACE_TYPE_EMUX_WAVETABLE">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="22">For EmuX wavetable.</doc>
</member>
<member name="bluetooth"
value="12"
c:identifier="ALSAHWDEP_IFACE_TYPE_BLUETOOTH"
glib:nick="bluetooth"
glib:name="ALSAHWDEP_IFACE_TYPE_BLUETOOTH">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="23">For Bluetooth audio.</doc>
</member>
<member name="usx2y_pcm"
value="13"
c:identifier="ALSAHWDEP_IFACE_TYPE_USX2Y_PCM"
glib:nick="usx2y-pcm"
glib:name="ALSAHWDEP_IFACE_TYPE_USX2Y_PCM">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="24">For Tascam US122, US224 & US428 rawusb pcm.</doc>
</member>
<member name="pcxhr"
value="14"
c:identifier="ALSAHWDEP_IFACE_TYPE_PCXHR"
glib:nick="pcxhr"
glib:name="ALSAHWDEP_IFACE_TYPE_PCXHR">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="25">For Digigram PCXHR.</doc>
</member>
<member name="sb_rc"
value="15"
c:identifier="ALSAHWDEP_IFACE_TYPE_SB_RC"
glib:nick="sb-rc"
glib:name="ALSAHWDEP_IFACE_TYPE_SB_RC">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="26">For SB Extigy/Audigy2NX remote control.</doc>
</member>
<member name="hda"
value="16"
c:identifier="ALSAHWDEP_IFACE_TYPE_HDA"
glib:nick="hda"
glib:name="ALSAHWDEP_IFACE_TYPE_HDA">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="27">For HD-audio.</doc>
</member>
<member name="usb_stream"
value="17"
c:identifier="ALSAHWDEP_IFACE_TYPE_USB_STREAM"
glib:nick="usb-stream"
glib:name="ALSAHWDEP_IFACE_TYPE_USB_STREAM">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="28">For direct access to usb stream.</doc>
</member>
<member name="fw_dice"
value="18"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_DICE"
glib:nick="fw-dice"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_DICE">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="29">For TC DICE FireWire device.</doc>
</member>
<member name="fw_fireworks"
value="19"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_FIREWORKS"
glib:nick="fw-fireworks"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_FIREWORKS">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="30">For Echo Audio Fireworks based devices.</doc>
</member>
<member name="fw_bebob"
value="20"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_BEBOB"
glib:nick="fw-bebob"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_BEBOB">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="31">For BridgeCo BeBoB based device.</doc>
</member>
<member name="fw_oxfw"
value="21"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_OXFW"
glib:nick="fw-oxfw"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_OXFW">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="32">For Oxford OXFW970/971 based devices.</doc>
</member>
<member name="fw_digi00x"
value="22"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_DIGI00X"
glib:nick="fw-digi00x"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_DIGI00X">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="33">For Digidesign Digi 002/003 family.</doc>
</member>
<member name="fw_tascam"
value="23"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_TASCAM"
glib:nick="fw-tascam"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_TASCAM">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="34">For TASCAM FireWire series.</doc>
</member>
<member name="line6"
value="24"
c:identifier="ALSAHWDEP_IFACE_TYPE_LINE6"
glib:nick="line6"
glib:name="ALSAHWDEP_IFACE_TYPE_LINE6">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="35">For Line6 USB processors. Available in Linux kernel 4.9.0 or later.</doc>
</member>
<member name="fw_motu"
value="25"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_MOTU"
glib:nick="fw-motu"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_MOTU">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="36">For MOTU FireWire series. Available in Linux kernel 4.12.0 or later.</doc>
</member>
<member name="fw_fireface"
value="26"
c:identifier="ALSAHWDEP_IFACE_TYPE_FW_FIREFACE"
glib:nick="fw-fireface"
glib:name="ALSAHWDEP_IFACE_TYPE_FW_FIREFACE">
<doc xml:space="preserve"
filename="../src/hwdep/alsahwdep-enum-types.h"
line="37">For RME Fireface series. Available in Linux kernel 4.12.0 or later.</doc>
</member>
</enumeration>
<function name="device_common_error_quark"
c:identifier="alsahwdep_device_common_error_quark"
moved-to="DeviceCommonError.quark">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="17">Return the [[email protected]] for [[email protected]] with code in ALSAHwdep.DeviceCommonError
enumerations.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="23">A [[email protected]].</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="device_common_error_to_label"
c:identifier="alsahwdep_device_common_error_to_label"
moved-to="DeviceCommonError.to_label">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="27">Retrieve the string label of error from code.</doc>
<source-position filename="../src/hwdep/device-common.h" line="15"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="code" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="29">A ALSAHwdep.DeviceCommonError.</doc>
<type name="DeviceCommonError" c:type="ALSAHwdepDeviceCommonError"/>
</parameter>
<parameter name="label"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/device-common.c"
line="30">The string label of error.</doc>
<type name="utf8" c:type="const char**"/>
</parameter>
</parameters>
</function>
<function name="get_device_id_list"
c:identifier="alsahwdep_get_device_id_list"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/query.c"
line="8">Get the list of numeric ID for available hwdep devices of sound card.
Nodes under sound subsystem in sysfs are used to gather the information.</doc>
<source-position filename="../src/hwdep/query.h" line="9"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/query.c"
line="19">%TRUE when the overall operation finishes successfully, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="card_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/hwdep/query.c"
line="10">The numeric ID of sound card.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="entries"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/query.c"
line="11">The list of numeric ID for hwdep device.</doc>
<array length="2" zero-terminated="0" c:type="guint**">
<type name="guint" c:type="guint*"/>
</array>
</parameter>
<parameter name="entry_count"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/hwdep/query.c"
line="12">The number of entries.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</function>
<function name="get_device_info"
c:identifier="alsahwdep_get_device_info"
throws="1">
<doc xml:space="preserve"
filename="../src/hwdep/query.c"
line="99">Get the information according to given numeric IDs for card and device.