-
Notifications
You must be signed in to change notification settings - Fork 1
/
ALSASeq-0.0.gir
6844 lines (6761 loc) · 302 KB
/
ALSASeq-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="ALSATimer" version="0.0"/>
<include name="GLib" version="2.0"/>
<include name="GObject" version="2.0"/>
<package name="alsaseq"/>
<c:include name="alsaseq.h"/>
<namespace name="ALSASeq"
version="0.0"
shared-library="libalsaseq.so.0"
c:identifier-prefixes="ALSASeq"
c:symbol-prefixes="alsaseq_">
<record name="Addr"
c:type="ALSASeqAddr"
glib:type-name="ALSASeqAddr"
glib:get-type="alsaseq_addr_get_type"
c:symbol-prefix="addr">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="4">A boxed object to express address in ALSA Sequencer.
A [struct@Addr] is a boxed object to express address in ALSA Sequencer. The address consists
of two parts; the numeric ID of client and port.
The object wraps `struct snd_seq_addr` in UAPI of Linux sound subsystem.</doc>
<source-position filename="../src/seq/addr.h" line="11"/>
<constructor name="new" c:identifier="alsaseq_addr_new">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="28">Allocate and return an instance of [struct@Addr].</doc>
<source-position filename="../src/seq/addr.h" line="15"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="35">A [struct@Addr].</doc>
<type name="Addr" c:type="ALSASeqAddr*"/>
</return-value>
<parameters>
<parameter name="client_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="30">The numeric ID of client to address.</doc>
<type name="guint8" c:type="guint8"/>
</parameter>
<parameter name="port_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="31">The numeric ID of port to address.</doc>
<type name="guint8" c:type="guint8"/>
</parameter>
</parameters>
</constructor>
<method name="equal" c:identifier="alsaseq_addr_equal">
<source-position filename="../src/seq/addr.h" line="21"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="76">whether the given object indicates the same element.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="73">A [struct@Addr].</doc>
<type name="Addr" c:type="const ALSASeqAddr*"/>
</instance-parameter>
<parameter name="target" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="74">A [struct@Addr] to compare.</doc>
<type name="Addr" c:type="const ALSASeqAddr*"/>
</parameter>
</parameters>
</method>
<method name="get_client_id" c:identifier="alsaseq_addr_get_client_id">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="47">Get the numeric ID of client to address.</doc>
<source-position filename="../src/seq/addr.h" line="17"/>
<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/seq/addr.c"
line="49">A [struct@Addr].</doc>
<type name="Addr" c:type="const ALSASeqAddr*"/>
</instance-parameter>
<parameter name="client_id"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="50">The numeric ID of client to address.</doc>
<type name="guint8" c:type="guint8*"/>
</parameter>
</parameters>
</method>
<method name="get_port_id" c:identifier="alsaseq_addr_get_port_id">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="59">Get the numeric ID of port to address.</doc>
<source-position filename="../src/seq/addr.h" line="19"/>
<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/seq/addr.c"
line="61">A [struct@Addr].</doc>
<type name="Addr" c:type="const ALSASeqAddr*"/>
</instance-parameter>
<parameter name="port_id"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/addr.c"
line="62">The numeric ID of port to address.</doc>
<type name="guint8" c:type="guint8*"/>
</parameter>
</parameters>
</method>
</record>
<class name="ClientInfo"
c:symbol-prefix="client_info"
c:type="ALSASeqClientInfo"
parent="GObject.Object"
glib:type-name="ALSASeqClientInfo"
glib:get-type="alsaseq_client_info_get_type"
glib:type-struct="ClientInfoClass">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="7">A GObject-derived object to express information of client.
A [class@ClientInfo] is a GObject-derived object to express information of client. The call
of [func@get_client_info] returns the instance of object. The call of
[[email protected]_info] and [[email protected]_info] require the instance of object.
The object wraps `struct snd_seq_client_info` in UAPI of Linux sound subsystem.</doc>
<source-position filename="../src/seq/client-info.h" line="15"/>
<constructor name="new" c:identifier="alsaseq_client_info_new">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="243">Allocate and return an instance of [class@ClientInfo].</doc>
<source-position filename="../src/seq/client-info.h" line="17"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="248">An instance of [class@ClientInfo].</doc>
<type name="ClientInfo" c:type="ALSASeqClientInfo*"/>
</return-value>
</constructor>
<method name="get_event_filter"
c:identifier="alsaseq_client_info_get_event_filter"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="294">Get the list of type of events configured to be listen.</doc>
<source-position filename="../src/seq/client-info.h" line="23"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="304">%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/seq/client-info.c"
line="296">A [class@ClientInfo].</doc>
<type name="ClientInfo" c:type="ALSASeqClientInfo*"/>
</instance-parameter>
<parameter name="event_types"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="297">The array with elements for the type of
event to listen.</doc>
<array length="1" zero-terminated="0" c:type="ALSASeqEventType**">
<type name="EventType" c:type="ALSASeqEventType*"/>
</array>
</parameter>
<parameter name="event_type_count"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="299">The number of elements for the type of event.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</method>
<method name="set_event_filter"
c:identifier="alsaseq_client_info_set_event_filter"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="255">Set the list of type of events configured to be listen.</doc>
<source-position filename="../src/seq/client-info.h" line="19"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="265">%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/seq/client-info.c"
line="257">A [class@ClientInfo].</doc>
<type name="ClientInfo" c:type="ALSASeqClientInfo*"/>
</instance-parameter>
<parameter name="event_types" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="258">The array with elements for the type of event to
listen.</doc>
<array length="1"
zero-terminated="0"
c:type="const ALSASeqEventType*">
<type name="EventType" c:type="ALSASeqEventType"/>
</array>
</parameter>
<parameter name="event_type_count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="260">The number of elements for the type of event.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<property name="card-id" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="207">The numeric ID of sound card. Available in Linux kernel 4.6.0 or later.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="client-id" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="123">The numeric ID of client. One of [enum@SpecificClientId] is available as well as any
numeric value.</doc>
<type name="guint8" c:type="guint8"/>
</property>
<property name="filter-attributes"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="160">The attributes for event filter.</doc>
<type name="FilterAttrFlag"/>
</property>
<property name="lost-count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="195">The number of lost events.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="name" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="149">The name of client.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="port-count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="183">The number of ports opened by the client.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="process-id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="220">The process ID for user client, otherwise -1. Available in Linux kernel 4.6.0 or later.</doc>
<type name="gint64" c:type="gint64"/>
</property>
<property name="type" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="137">The type of client, one of [enum@ClientType].</doc>
<type name="ClientType"/>
</property>
<property name="use-filter" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-info.c"
line="172">Whether using filter to receive event or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ClientInfoClass"
c:type="ALSASeqClientInfoClass"
glib:is-gtype-struct-for="ClientInfo">
<source-position filename="../src/seq/client-info.h" line="15"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="ClientPool"
c:symbol-prefix="client_pool"
c:type="ALSASeqClientPool"
parent="GObject.Object"
glib:type-name="ALSASeqClientPool"
glib:get-type="alsaseq_client_pool_get_type"
glib:type-struct="ClientPoolClass">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="4">A GObject-derived object to express information of pool owned by client.
A [class@ClientPool] is a GObject-derived object to express information of pool owned by
client. The pool consists of a batch of cells to store message contents in kernel space. The
call of [func@get_client_pool] returns the instance of object. The call of
[[email protected]_pool]) and [[email protected]_pool] require the instance of object.
The object wraps `struct snd_seq_client_pool` in UAPI of Linux sound subsystem.</doc>
<source-position filename="../src/seq/client-pool.h" line="15"/>
<constructor name="new" c:identifier="alsaseq_client_pool_new">
<source-position filename="../src/seq/client-pool.h" line="17"/>
<return-value transfer-ownership="full">
<type name="ClientPool" c:type="ALSASeqClientPool*"/>
</return-value>
</constructor>
<property name="client-id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="99">The numeric ID of client. One of [enum@SpecificClientId] is available as well as any
numeric value.</doc>
<type name="guint8" c:type="guint8"/>
</property>
<property name="input-free" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="167">The current number of free cells in memory pool for input direction.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="input-pool" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="127">The total number of cells in memory pool for input direction. The client dequeue any event
from the pool when the event is copied from the output memory pool of source client.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="output-free" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="155">The current number of free cells in memory pool for output direction.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="output-pool" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="113">The total number of cells in memory pool for output direction. The client enqueue any event
into the pool at scheduling, then the event is copied to input memory pool of destination
client.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="output-room" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/client-pool.c"
line="140">The number of cells in memory pool for output direction as threshold for writable condition
at the result of poll(2). The property is useless for [class@UserClient] since it doesn't
perform poll(2) to check writable or not.</doc>
<type name="guint" c:type="guint"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ClientPoolClass"
c:type="ALSASeqClientPoolClass"
glib:is-gtype-struct-for="ClientPool">
<source-position filename="../src/seq/client-pool.h" line="15"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="ClientType"
glib:type-name="ALSASeqClientType"
glib:get-type="alsaseq_client_type_get_type"
c:type="ALSASeqClientType">
<doc xml:space="preserve"
filename="../src/seq/alsaseq-enum-types.h"
line="35">A set of enumerations for the type of client.</doc>
<member name="none"
value="0"
c:identifier="ALSASEQ_CLIENT_TYPE_NONE"
glib:nick="none"
glib:name="ALSASEQ_CLIENT_TYPE_NONE">
<doc xml:space="preserve"
filename="../src/seq/alsaseq-enum-types.h"
line="37">The client is invalid.</doc>
</member>
<member name="user"
value="1"
c:identifier="ALSASEQ_CLIENT_TYPE_USER"
glib:nick="user"
glib:name="ALSASEQ_CLIENT_TYPE_USER">
<doc xml:space="preserve"
filename="../src/seq/alsaseq-enum-types.h"
line="38">The client is userspace application.</doc>
</member>
<member name="kernel"
value="2"
c:identifier="ALSASEQ_CLIENT_TYPE_KERNEL"
glib:nick="kernel"
glib:name="ALSASEQ_CLIENT_TYPE_KERNEL">
<doc xml:space="preserve"
filename="../src/seq/alsaseq-enum-types.h"
line="39">The client is kernel driver.</doc>
</member>
</enumeration>
<record name="Event"
c:type="ALSASeqEvent"
glib:type-name="ALSASeqEvent"
glib:get-type="alsaseq_event_get_type"
c:symbol-prefix="event">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="4">A boxed structure for sequencer event.
A [struct@Event] expresses any type of event in ALSA Sequencer. The event consists of some
product-type propertiess and two variant-type properties.
The instance should be released by call of [[email protected]_free] since it can point to the
other allocated object for blob data, therefore it's preferable to use [[email protected]_copy]
to duplicate the instance so that the blob data is going to be duplicated as well.
This is the list of product-type properties:
- the type of event
- the mode of time stamp
- the mode of time
- the mode of length
- the mode of priority
- the numeric value of tag associated to the event
- the numeric identifier of queue to schedule the event
- destination address
- source address
One of variant-type property is for time stamp.
- tick count as time stamp of event
- real time as time stamp of event
Another variant-type property is for data of event.
- note
- control
- 12 bytes
- 3 quadlets
- blob as variable length of bytes
- pointer in VMA of user process
- queue control
- tick count as arbitrary time stamp
- real time as arbitrary time stamp
- arbitrary address
- connection between source and destination addresses
- result
The type of time stamp is associated to the mode of time stamp, while the type of data is
associated to the type of event loosely. Each of the variant type property has single storage
internally, thus an event can includes the sole variant.
The object wraps `struct snd_seq_event` in UAPI of Linux sound subsystem.</doc>
<source-position filename="../src/seq/event.h" line="11"/>
<constructor name="new" c:identifier="alsaseq_event_new">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="127">Allocate and return an instance of [struct@Event].</doc>
<source-position filename="../src/seq/event.h" line="19"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="133">An instance of [struct@Event].</doc>
<type name="Event" c:type="ALSASeqEvent*"/>
</return-value>
<parameters>
<parameter name="event_type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="129">A [enum@EventType].</doc>
<type name="EventType" c:type="ALSASeqEventType"/>
</parameter>
</parameters>
</constructor>
<method name="calculate_pool_consumption"
c:identifier="alsaseq_event_calculate_pool_consumption">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1623">Calculate the number of cells in client pool to be consumed when the event is delivered.
The comparison to properties of [class@ClientPool] is useful when scheduling the event.</doc>
<source-position filename="../src/seq/event.h" line="110"/>
<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/seq/event.c"
line="1625">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="cells"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1626">The number of consumed cells in client pool.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</method>
<method name="get_addr_data"
c:identifier="alsaseq_event_get_addr_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1385">Get the address data of event, available when [[email protected]_event_type] results in one of:
- [enum@EventType].CLIENT_START
- [enum@EventType].CLIENT_EXIT
- [enum@EventType].CLIENT_CHANGE
- [enum@EventType].PORT_START
- [enum@EventType].PORT_EXIT
- [enum@EventType].PORT_CHANGE
- [enum@EventType].USR0
- [enum@EventType].USR1
- [enum@EventType].USR2
- [enum@EventType].USR3
- [enum@EventType].USR4
- [enum@EventType].USR5
- [enum@EventType].USR6
- [enum@EventType].USR7
- [enum@EventType].USR8
- [enum@EventType].USR9</doc>
<source-position filename="../src/seq/event.h" line="96"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1410">%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/seq/event.c"
line="1387">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1388">The address data of event.</doc>
<type name="Addr" c:type="const ALSASeqAddr**"/>
</parameter>
</parameters>
</method>
<method name="get_blob_data"
c:identifier="alsaseq_event_get_blob_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1005">Refer to the blob data, available when [[email protected]_event_type] results in one of:
- [enum@EventType].SYSEX
- [enum@EventType].BOUNCE
- [enum@EventType].USR_VAR0
- [enum@EventType].USR_VAR1
- [enum@EventType].USR_VAR2
- [enum@EventType].USR_VAR3
- [enum@EventType].USR_VAR4</doc>
<source-position filename="../src/seq/event.h" line="72"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1022">%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/seq/event.c"
line="1007">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1008">The pointer to blob data.</doc>
<array length="1" zero-terminated="0" c:type="const guint8**">
<type name="guint8" c:type="guint8*"/>
</array>
</parameter>
<parameter name="length"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1009">The length of data in byte unit.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</method>
<method name="get_byte_data"
c:identifier="alsaseq_event_get_byte_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="853">Get the byte data, available when [[email protected]_event_type] results in one of:
- [enum@EventType].USR0
- [enum@EventType].USR1
- [enum@EventType].USR2
- [enum@EventType].USR3
- [enum@EventType].USR4
- [enum@EventType].USR5
- [enum@EventType].USR6
- [enum@EventType].USR7
- [enum@EventType].USR8
- [enum@EventType].USR9</doc>
<source-position filename="../src/seq/event.h" line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="872">%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/seq/event.c"
line="855">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="856">The byte data of event.</doc>
<array zero-terminated="0" c:type="const guint8**" fixed-size="12">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_connect_data"
c:identifier="alsaseq_event_get_connect_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1469">Get the connect data of event, available when [[email protected]_event_type] results in one of:
- [enum@EventType].PORT_SUBSCRIBED
- [enum@EventType].PORT_UNSUBSCRIBED
- [enum@EventType].USR0
- [enum@EventType].USR1
- [enum@EventType].USR2
- [enum@EventType].USR3
- [enum@EventType].USR4
- [enum@EventType].USR5
- [enum@EventType].USR6
- [enum@EventType].USR7
- [enum@EventType].USR8
- [enum@EventType].USR9</doc>
<source-position filename="../src/seq/event.h" line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1490">%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/seq/event.c"
line="1471">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1472">The connect data of event.</doc>
<type name="EventDataConnect"
c:type="const ALSASeqEventDataConnect**"/>
</parameter>
</parameters>
</method>
<method name="get_ctl_data"
c:identifier="alsaseq_event_get_ctl_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="756">Refer to the control data, available when [[email protected]_event_type] results in one of:
- [enum@EventType].CONTROLLER
- [enum@EventType].PGMCHANGE
- [enum@EventType].CHANPRESS
- [enum@EventType].PITCHBEND
- [enum@EventType].CONTROL14
- [enum@EventType].NONREGPARAM
- [enum@EventType].REGPARAM
- [enum@EventType].SONGPOS
- [enum@EventType].SONGSEL
- [enum@EventType].QFRAME
- [enum@EventType].TIMESIGN
- [enum@EventType].KEYSIGN
- [enum@EventType].USR0
- [enum@EventType].USR1
- [enum@EventType].USR2
- [enum@EventType].USR3
- [enum@EventType].USR4
- [enum@EventType].USR5
- [enum@EventType].USR6
- [enum@EventType].USR7
- [enum@EventType].USR8
- [enum@EventType].USR9</doc>
<source-position filename="../src/seq/event.h" line="58"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="787">%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/seq/event.c"
line="758">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="759">The control data of event.</doc>
<type name="EventDataCtl" c:type="const ALSASeqEventDataCtl**"/>
</parameter>
</parameters>
</method>
<method name="get_destination"
c:identifier="alsaseq_event_get_destination">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="338">Refer to the destination address of event.</doc>
<source-position filename="../src/seq/event.h" line="42"/>
<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/seq/event.c"
line="340">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="addr"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="341">A [struct@Addr] for event destination.</doc>
<type name="Addr" c:type="const ALSASeqAddr**"/>
</parameter>
</parameters>
</method>
<method name="get_event_type"
c:identifier="alsaseq_event_get_event_type">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="144">Get the type of event.</doc>
<source-position filename="../src/seq/event.h" line="21"/>
<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/seq/event.c"
line="146">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="event_type"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="147">A [enum@EventType].</doc>
<type name="EventType" c:type="ALSASeqEventType*"/>
</parameter>
</parameters>
</method>
<method name="get_length_mode"
c:identifier="alsaseq_event_get_length_mode">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="159">Get the mode of data length for the event.</doc>
<source-position filename="../src/seq/event.h" line="23"/>
<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/seq/event.c"
line="161">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="length_mode"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="162">A [enum@EventLengthMode] for the mode of data length.</doc>
<type name="EventLengthMode" c:type="ALSASeqEventLengthMode*"/>
</parameter>
</parameters>
</method>
<method name="get_note_data"
c:identifier="alsaseq_event_get_note_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="675">Refer to the note data, available when [[email protected]_event_type] results in one of:
- [enum@EventType].NOTE
- [enum@EventType].NOTEON
- [enum@EventType].NOTEOFF
- [enum@EventType].KEYPRESS
- [enum@EventType].USR0
- [enum@EventType].USR1
- [enum@EventType].USR2
- [enum@EventType].USR3
- [enum@EventType].USR4
- [enum@EventType].USR5
- [enum@EventType].USR6
- [enum@EventType].USR7
- [enum@EventType].USR8
- [enum@EventType].USR9</doc>
<source-position filename="../src/seq/event.h" line="53"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="698">%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/seq/event.c"
line="677">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="678">The note data of event.</doc>
<type name="EventDataNote" c:type="const ALSASeqEventDataNote**"/>
</parameter>
</parameters>
</method>
<method name="get_pointer_data"
c:identifier="alsaseq_event_get_pointer_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1075">Get the pointer and length in data of event. It has no gurantee that the dereference of pointer
is safe in VMA of user process, thus users have to know the purpose of the pointer in advance;
e.g. inter-process communication between forked parent and child processes.</doc>
<source-position filename="../src/seq/event.h" line="77"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1086">%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/seq/event.c"
line="1077">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none"
nullable="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1078">A pointer to user data.</doc>
<type name="gpointer" c:type="gconstpointer*"/>
</parameter>
<parameter name="length"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="1079">The length of user data.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</method>
<method name="get_priority_mode"
c:identifier="alsaseq_event_get_priority_mode">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="219">Get the mode of priority for the event.</doc>
<source-position filename="../src/seq/event.h" line="29"/>
<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/seq/event.c"
line="221">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="priority_mode"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="222">A [enum@EventPriorityMode] The mode of priority.</doc>
<type name="EventPriorityMode" c:type="ALSASeqEventPriorityMode*"/>
</parameter>
</parameters>
</method>
<method name="get_quadlet_data"
c:identifier="alsaseq_event_get_quadlet_data"
throws="1">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="929">Get the quadlet data of event, available when [[email protected]_event_type] results in one of:
- [enum@EventType].USR0
- [enum@EventType].USR1
- [enum@EventType].USR2
- [enum@EventType].USR3
- [enum@EventType].USR4
- [enum@EventType].USR5
- [enum@EventType].USR6
- [enum@EventType].USR7
- [enum@EventType].USR8
- [enum@EventType].USR9</doc>
<source-position filename="../src/seq/event.h" line="67"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"
line="948">%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/seq/event.c"
line="931">A [struct@Event].</doc>
<type name="Event" c:type="const ALSASeqEvent*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../src/seq/event.c"