/
Hitaki-0.0.gir
3111 lines (3094 loc) · 144 KB
/
Hitaki-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="hitaki"/>
<c:include name="hitaki.h"/>
<namespace name="Hitaki"
version="0.0"
shared-library="libhitaki.so.0"
c:identifier-prefixes="Hitaki"
c:symbol-prefixes="hitaki_">
<interface name="AlsaFirewire"
c:symbol-prefix="alsa_firewire"
c:type="HitakiAlsaFirewire"
glib:type-name="HitakiAlsaFirewire"
glib:get-type="hitaki_alsa_firewire_get_type"
glib:type-struct="AlsaFirewireInterface">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="4">An interface to operate ALSA HwDep character device for Audio and Music unit in IEEE 1394 bus.
All of driver in ALSA firewire stack allow userspace application to use specific function via
ALSA HwDep character device. The function includes common and specific parts. The
[iface@AlsaFirewire] is an object interface to operate the character device for the common
functions.</doc>
<source-position filename="../src/alsa_firewire.h" line="71"/>
<virtual-method name="create_source" invoker="create_source" throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="193">Allocate [struct@GLib.Source] to handle events from ALSA HwDep character device.</doc>
<source-position filename="../src/alsa_firewire.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="201">TRUE if the overall operation finished 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/alsa_firewire.c"
line="195">A [iface@AlsaFirewire].</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
<parameter name="source"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="196">A [struct@GLib.Source] to handle events from ALSA HwDep character device.</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="lock" invoker="lock" throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="157">Lock kernel driver bound to the associated ALSA HwDep character device so that it is prohibited
to start packet streaming.</doc>
<source-position filename="../src/alsa_firewire.h" line="45"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="165">TRUE if the overall operation finished 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/alsa_firewire.c"
line="159">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open" invoker="open" throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="136">Open the special file for ALSA HwDep character device.</doc>
<source-position filename="../src/alsa_firewire.h" line="33"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="145">TRUE if the overall operation finished 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/alsa_firewire.c"
line="138">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="139">A 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/alsa_firewire.c"
line="140">The flag of `open(2)` system call.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="unlock" invoker="unlock" throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="175">Unlock kernel driver bound to the associated ALSA HwDep character device so that it can start
packet streaming.</doc>
<source-position filename="../src/alsa_firewire.h" line="57"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="183">TRUE if the overall operation finished 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/alsa_firewire.c"
line="177">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="create_source"
c:identifier="hitaki_alsa_firewire_create_source"
throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="193">Allocate [struct@GLib.Source] to handle events from ALSA HwDep character device.</doc>
<source-position filename="../src/alsa_firewire.h" line="80"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="201">TRUE if the overall operation finished 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/alsa_firewire.c"
line="195">A [iface@AlsaFirewire].</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
<parameter name="source"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="196">A [struct@GLib.Source] to handle events from ALSA HwDep character device.</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</method>
<method name="lock" c:identifier="hitaki_alsa_firewire_lock" throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="157">Lock kernel driver bound to the associated ALSA HwDep character device so that it is prohibited
to start packet streaming.</doc>
<source-position filename="../src/alsa_firewire.h" line="76"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="165">TRUE if the overall operation finished 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/alsa_firewire.c"
line="159">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
</parameters>
</method>
<method name="open" c:identifier="hitaki_alsa_firewire_open" throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="136">Open the special file for ALSA HwDep character device.</doc>
<source-position filename="../src/alsa_firewire.h" line="73"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="145">TRUE if the overall operation finished 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/alsa_firewire.c"
line="138">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="139">A 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/alsa_firewire.c"
line="140">The flag of `open(2)` system call.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="unlock"
c:identifier="hitaki_alsa_firewire_unlock"
throws="1">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="175">Unlock kernel driver bound to the associated ALSA HwDep character device so that it can start
packet streaming.</doc>
<source-position filename="../src/alsa_firewire.h" line="78"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="183">TRUE if the overall operation finished 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/alsa_firewire.c"
line="177">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</instance-parameter>
</parameters>
</method>
<property name="card-id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="77">The numeric identifier for sound card.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="guid" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="111">Global unique identifier for the node in IEEE 1394 bus.</doc>
<type name="guint64" c:type="guint64"/>
</property>
<property name="is-disconnected" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="122">Whether the sound card is unavailable. It becomes FALSE when the sound card is removed or
driver is unbound to it. Then the owner of this object should call
[method@GObject.Object.unref] as quickly as possible to release ALSA hwdep character device.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="is-locked" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="100">Whether the associated unit is locked or not to start packet streaming.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="node-device" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="89">The name of node device in Linux FireWire subsystem which owns the unit; e.g. `fw1`.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="unit-type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="65">The type of sound unit.</doc>
<type name="AlsaFirewireType"/>
</property>
</interface>
<enumeration name="AlsaFirewireError"
glib:type-name="HitakiAlsaFirewireError"
glib:get-type="hitaki_alsa_firewire_error_get_type"
c:type="HitakiAlsaFirewireError"
glib:error-domain="hitaki-alsa-firewire-error-quark">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="31">The enumerations to report result of operation in [iface@AlsaFirewire].</doc>
<member name="failed"
value="0"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_FAILED"
glib:nick="failed"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_FAILED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="33">The system call fails.</doc>
</member>
<member name="is_opened"
value="1"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_IS_OPENED"
glib:nick="is-opened"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_IS_OPENED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="34">The instance is already associated to any ALSA HwDep
character device.</doc>
</member>
<member name="is_not_opened"
value="2"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_IS_NOT_OPENED"
glib:nick="is-not-opened"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_IS_NOT_OPENED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="36">The instance is not associated to any ALSA HwDep
character device yet.</doc>
</member>
<member name="is_used"
value="3"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_IS_USED"
glib:nick="is-used"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_IS_USED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="38">The ALSA HwDep character device is used by the other
process.</doc>
</member>
<member name="is_locked"
value="4"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_IS_LOCKED"
glib:nick="is-locked"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_IS_LOCKED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="40">The functionality of packet streaming is prohibited.</doc>
</member>
<member name="is_unlocked"
value="5"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_IS_UNLOCKED"
glib:nick="is-unlocked"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_IS_UNLOCKED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="41">The functionality of packet streaming is available.</doc>
</member>
<member name="is_disconnected"
value="6"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_IS_DISCONNECTED"
glib:nick="is-disconnected"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_IS_DISCONNECTED">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="42">The sound card is disconnected.</doc>
</member>
<member name="wrong_class"
value="7"
c:identifier="HITAKI_ALSA_FIREWIRE_ERROR_WRONG_CLASS"
glib:nick="wrong-class"
glib:name="HITAKI_ALSA_FIREWIRE_ERROR_WRONG_CLASS">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="43">Mismatch between GObject class and thetype of sound
unit.</doc>
</member>
<function name="quark" c:identifier="hitaki_alsa_firewire_error_quark">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="15">Return the [alias@GLib.Quark] for [struct@GLib.Error] with code in Hitaki.AlsaFirewireError
enumerations.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="21">A [alias@GLib.Quark].</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="to_label"
c:identifier="hitaki_alsa_firewire_error_to_label">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="25">Retrieve the string label of error from code.</doc>
<source-position filename="../src/alsa_firewire.h" line="17"/>
<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/alsa_firewire.c"
line="27">A Hitaki.AlsaFirewireError.</doc>
<type name="AlsaFirewireError" c:type="HitakiAlsaFirewireError"/>
</parameter>
<parameter name="label"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="28">The string label of error.</doc>
<type name="utf8" c:type="const char**"/>
</parameter>
</parameters>
</function>
</enumeration>
<record name="AlsaFirewireInterface"
c:type="HitakiAlsaFirewireInterface"
glib:is-gtype-struct-for="AlsaFirewire">
<source-position filename="../src/alsa_firewire.h" line="71"/>
<field name="iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="open">
<callback name="open" throws="1">
<source-position filename="../src/alsa_firewire.h" line="33"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="145">TRUE if the overall operation finished 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/alsa_firewire.c"
line="138">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="139">A 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/alsa_firewire.c"
line="140">The flag of `open(2)` system call.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="lock">
<callback name="lock" throws="1">
<source-position filename="../src/alsa_firewire.h" line="45"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="165">TRUE if the overall operation finished 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/alsa_firewire.c"
line="159">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="unlock">
<callback name="unlock" throws="1">
<source-position filename="../src/alsa_firewire.h" line="57"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="183">TRUE if the overall operation finished 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/alsa_firewire.c"
line="177">A [iface@AlsaFirewire]</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="create_source">
<callback name="create_source" throws="1">
<source-position filename="../src/alsa_firewire.h" line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="201">TRUE if the overall operation finished 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/alsa_firewire.c"
line="195">A [iface@AlsaFirewire].</doc>
<type name="AlsaFirewire" c:type="HitakiAlsaFirewire*"/>
</parameter>
<parameter name="source"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/alsa_firewire.c"
line="196">A [struct@GLib.Source] to handle events from ALSA HwDep character device.</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<enumeration name="AlsaFirewireType"
glib:type-name="HitakiAlsaFirewireType"
glib:get-type="hitaki_alsa_firewire_type_get_type"
c:type="HitakiAlsaFirewireType">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="7">The enumerations for type of sound unit defined by ALSA firewire stack.</doc>
<member name="dice"
value="1"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_DICE"
glib:nick="dice"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_DICE">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="9">The type of DICE ASIC.</doc>
</member>
<member name="fireworks"
value="2"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_FIREWORKS"
glib:nick="fireworks"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_FIREWORKS">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="10">The type of Fireworks board module.</doc>
</member>
<member name="bebob"
value="3"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_BEBOB"
glib:nick="bebob"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_BEBOB">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="11">The type of BeBoB ASIC.</doc>
</member>
<member name="oxfw"
value="4"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_OXFW"
glib:nick="oxfw"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_OXFW">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="12">The type of OXFW ASIC</doc>
</member>
<member name="digi00x"
value="5"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_DIGI00X"
glib:nick="digi00x"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_DIGI00X">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="13">The type of Digi00x series.</doc>
</member>
<member name="tascam"
value="6"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_TASCAM"
glib:nick="tascam"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_TASCAM">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="14">The type of Tascam FireWire series.</doc>
</member>
<member name="motu"
value="7"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_MOTU"
glib:nick="motu"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_MOTU">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="15">The type of MOTU FireWire series.</doc>
</member>
<member name="fireface"
value="8"
c:identifier="HITAKI_ALSA_FIREWIRE_TYPE_FIREFACE"
glib:nick="fireface"
glib:name="HITAKI_ALSA_FIREWIRE_TYPE_FIREFACE">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="16">The type of RME Fireface series.</doc>
</member>
</enumeration>
<interface name="EfwProtocol"
c:symbol-prefix="efw_protocol"
c:type="HitakiEfwProtocol"
glib:type-name="HitakiEfwProtocol"
glib:get-type="hitaki_efw_protocol_get_type"
glib:type-struct="EfwProtocolInterface">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="10">An interface for Fireworks Protocol.
Echo Audio Fireworks devices listen to specific address space for specific request frame. When
accepting and handling the request frame, it transfers response frame to specific address in
requester. The [iface@EfwProtocol] is an object interface for the Fireworks protocol.</doc>
<source-position filename="../src/efw_protocol.h" line="61"/>
<virtual-method name="get_seqnum">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="34">Virtual function to retrieve the sequence number for request frame of transaction. The number
is used for the frame transmitted to device, then the device is expected to transmit response
frame with the number incremented by 1.</doc>
<source-position filename="../src/efw_protocol.h" line="43"/>
<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/efw_protocol.h"
line="36">A [iface@EfwProtocol].</doc>
<type name="EfwProtocol" c:type="HitakiEfwProtocol*"/>
</instance-parameter>
<parameter name="seqnum"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="37">The sequence number for request frame of transaction.</doc>
<type name="guint32" c:type="guint32*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="responded">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="45">Class closure for the [signal@EfwProtocol::responded] signal.</doc>
<source-position filename="../src/efw_protocol.h" line="59"/>
<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/efw_protocol.h"
line="47">A [iface@EfwProtocol].</doc>
<type name="EfwProtocol" c:type="HitakiEfwProtocol*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="48">The version of transaction protocol.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="seqnum" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="49">The sequence number of response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="50">The value of category field in the response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="51">The value of command field in the response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="status" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="52">The status of response.</doc>
<type name="EfwProtocolError" c:type="HitakiEfwProtocolError"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="53">The array with quadlet elements
of parameters in response of Fireworks protocol.</doc>
<array length="6" zero-terminated="0" c:type="const guint32*">
<type name="guint32"/>
</array>
</parameter>
<parameter name="param_count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="55">The number of elements of the array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="transmit_request" throws="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="22">Virtual function to transmit the content of request frame to target device.</doc>
<source-position filename="../src/efw_protocol.h" line="31"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="24">A [iface@EfwProtocol].</doc>
<type name="EfwProtocol" c:type="HitakiEfwProtocol*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="25">The content of request frame for transaction.</doc>
<array length="1" zero-terminated="0" c:type="const guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.h"
line="26">The length of content.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</virtual-method>
<method name="receive_response"
c:identifier="hitaki_efw_protocol_receive_response">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="226">Parse the given buffer for response frame of Fireworks transaction. The buffer should includes
one response frames at least. It results in [signal@EfwProtocol::responded] per response frame.
It's expected that the function is used by any implementation of [iface@EfwProtocol].</doc>
<source-position filename="../src/efw_protocol.h" line="67"/>
<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/efw_protocol.c"
line="228">A [iface@EfwProtocol].</doc>
<type name="EfwProtocol" c:type="HitakiEfwProtocol*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="229">The buffer for transaction frames.</doc>
<array length="1" zero-terminated="0" c:type="const guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="230">The length of buffer.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="transaction"
c:identifier="hitaki_efw_protocol_transaction"
throws="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="295">Transfer asynchronous transaction for request frame of Echo Efw protocol and wait for response
matched to the command. The call results in [signal@EfwProtocol::responded] signal with data of
response.</doc>
<source-position filename="../src/efw_protocol.h" line="69"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="316">TRUE if the overall operation finished 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/efw_protocol.c"
line="297">A [iface@EfwProtocol].</doc>
<type name="EfwProtocol" c:type="HitakiEfwProtocol*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="298">One of category for the transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="299">One of commands for the transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="args"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="300">An array with elements for quadlet data as
arguments for command.</doc>
<array length="3" zero-terminated="0" c:type="const guint32*">
<type name="guint32" c:type="guint32"/>
</array>
</parameter>
<parameter name="arg_count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="302">The number of quadlets in the args array.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="params"
direction="inout"
caller-allocates="0"
transfer-ownership="full"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="303">An array with elements for quadlet data
to save parameters in response. Callers should give it for buffer with enough space
against the request since this library performs no reallocation. Due to the reason, the
value of this argument should point to the pointer to the array and immutable. The
content of array is mutable for parameters in response.</doc>
<array length="5" zero-terminated="0" c:type="guint32* const*">
<type name="guint32" c:type="guint32*"/>
</array>
</parameter>
<parameter name="param_count"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="308">The number of quadlets in the params array.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="timeout_ms" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="309">The timeout to wait for response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="transmit_request"
c:identifier="hitaki_efw_protocol_transmit_request"
throws="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="124">Transfer asynchronous transaction for request frame of Fireworks transaction. It calls
[vfunc@EfwProtocol.transmit_request] internally after composing request frame. It results in
[signal@EfwProtocol::responded] signal with response parameters when receiving response for the
transaction.</doc>
<source-position filename="../src/efw_protocol.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="140">TRUE if the overall operation finished 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/efw_protocol.c"
line="126">A [iface@EfwProtocol].</doc>
<type name="EfwProtocol" c:type="HitakiEfwProtocol*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="127">One of category for the transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="128">One of commands for the transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="args"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="129">An array with elements of quadlet data for
arguments of command.</doc>
<array length="3" zero-terminated="0" c:type="const guint32*">
<type name="guint32" c:type="guint32"/>
</array>
</parameter>
<parameter name="arg_count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="131">The number of quadlets in the args array.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="resp_seqnum"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="132">The sequence number to match response.</doc>
<type name="guint32" c:type="guint32*"/>
</parameter>
</parameters>
</method>
<glib:signal name="responded" when="last" action="1">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="97">Emitted when the unit transfers asynchronous packet as response of Echo Audio Efw
transaction and the process successfully reads the content of response from ALSA Efw
driver.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="100">The version of transaction protocol.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="seqnum" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="101">The sequence number of response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="102">The value of category field in the response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="103">The value of command field in the response.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="status" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="104">The status of response.</doc>
<type name="EfwProtocolError"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="105">The array with quadlet elements
of parameters in response of Fireworks protocol.</doc>
<array length="6" zero-terminated="0" c:type="gpointer">
<type name="guint32"/>
</array>
</parameter>
<parameter name="param_count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/efw_protocol.c"
line="107">The number of elements of the array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
</interface>
<enumeration name="EfwProtocolError"
glib:type-name="HitakiEfwProtocolError"
glib:get-type="hitaki_efw_protocol_error_get_type"
c:type="HitakiEfwProtocolError"
glib:error-domain="hitaki-efw-protocol-error-quark">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="59">The enumerations to report status of response in Fireworks protocol.</doc>
<member name="ok"
value="0"
c:identifier="HITAKI_EFW_PROTOCOL_ERROR_OK"
glib:nick="ok"
glib:name="HITAKI_EFW_PROTOCOL_ERROR_OK">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="61">The transaction finished successfully.</doc>
</member>
<member name="bad"
value="1"
c:identifier="HITAKI_EFW_PROTOCOL_ERROR_BAD"
glib:nick="bad"
glib:name="HITAKI_EFW_PROTOCOL_ERROR_BAD">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="62">The request or response includes invalid header.</doc>
</member>
<member name="bad_command"
value="2"
c:identifier="HITAKI_EFW_PROTOCOL_ERROR_BAD_COMMAND"
glib:nick="bad-command"
glib:name="HITAKI_EFW_PROTOCOL_ERROR_BAD_COMMAND">
<doc xml:space="preserve"
filename="../src/hitaki_enum_types.h"
line="63">The request includes invalid category or command.</doc>
</member>