source: roaraudio/doc/new-cmds @ 4092:00c7256bff54

Last change on this file since 4092:00c7256bff54 was 4092:00c7256bff54, checked in by phi, 14 years ago

added Revision-tag

File size: 4.9 KB
Line 
1#($Revision$)
2+DEVCTL = NEEDS_CONST
3 +:version (uint8)
4 +:type (uint8)
5 +:vendor (uint8)
6 +VENDOR_ROARAUDIO = 0
7 +VENDOR_BASICDEV  = 1
8 +:subtype (uint8)
9 +:flags (uint8)
10 +:ot (uint8)
11 +:(id) (uint16) #(if not UNIID or SID)
12 +:data... (vardata)
13+CAPS = NEEDS_CONST
14 +:version (uint8)
15 +:type (uint8)
16 +:flags (uint16)
17 +CT_CAPS      = 0
18 +::dataarray (dataarray)
19 +:::captype (TODO)
20 +:::... (TODO)
21 +CT_STANDARDS = 1
22 +::dataarray
23 +:::stdvendor (uint8)
24 +STDV_ROARAUDIO = 0
25 +STDV_PROTO     = 1
26 +STDV_RFC       = 2
27 +:::stdversion (uint8)
28 +:::standard (uint16)
29+WAIT = NEEDS_CONST
30 +:version (TODO)
31 +:flags (TODO)
32 :(TODO)
33+NOTIFY = NEEDS_CONST
34 +structof(WAIT)
35+SEEK = NEEDS_CONST
36 +:version (TODO)
37 +:flags (TODO)
38 +:destination possition (TODO)
39 +:destination possition whence (TODO)
40 +:hint pos (TODO)
41 +:hint whence (TODO)
42 +:hint quality (TODO)
43 +:seek at (TODO)
44 +:seek to (TODO)
45 +:seek whence (TODO)
46 +SF_CONT_WHILE_SEEK = 0x01
47 +SF_CONT_ON_ERROR   = 0x02
48 +SF_HINT            = 0x04
49 +SF_SEEK            = 0x08
50 +HQ_BAD       = 0
51 +HQ_BAD_NB    = 1 #(bad, not before this possition)
52 +HQ_NEAR      = 2
53 +HQ_NEAR_NB   = 3 #(Near, not before this possition)
54 +HQ_GOOD      = 4
55 +HQ_GOOD_NB   = 5 #(good, not before this possition)
56 +HQ_EXACT     = HQ_EXACT_NB #(ID 6 is skiped here)
57 +HQ_EXACT_NB  = 7
58 +WHENCE_BEGIN = 0
59 +WHENCE_CUR   = 1
60 +WHENCE_END   = 2
61+CLIENTCTL = NEEDS_CONST
62 +:version (uint8)
63 +:subcmd (uint8)
64 +:flags (uint16)
65 +:data (vardata)
66 +CC_HASHTABLE = PARA_HASHTABLE
67 +CC_WININFO   = PARA_WININFO
68 +CC_PROPTABLE = PARA_PROPTABLE
69+LOOKUP = NEEDS_CONST
70 +:version (uint8)
71 +:flags (uint8)
72 +:extflags (uint8)
73 +:ot (uint8)
74 +:ht (uint32) #(hash type)
75 +:hash... (vardata)
76*SERVER_INFO
77 +IT_SERVER   = 1
78  :(TODO)
79 +IT_COUNTERS = 2
80  +:version (uint8)
81  +:reserved (uint24)
82  +:data... (dataarray)
83  +::type (uint8)
84  +::flags (uint8)
85  +::reserved (uint16)
86  +::counter (uint32)
87  +CF_CURRENT = 0x01 #(Current value if set, sum if unset)
88  +CF_OTTYPE  = 0x02 #(Type is a OT_* type if set, or other if unset)
89 +IT_LISTEN   = 3
90  +:version (TODO)
91  +:listensocks... (dataarray)
92  +::id (uint16)
93  +::flags (uint8)
94  +::socktype (uint8)
95  +::proto (uint16)
96  +::byteorder (uint16)
97  +::dir (uint32)
98  +::auinfo (packed-audioinfo) #(4*4*8 = 128bit)
99  +::addrlen (uint16)
100  +::addr (padded-string(:addrlen))
101  +LF_HAVEDIR = 0x01
102  +LF_HAVEAI  = 0x02
103*[GS]ET_STREAM_PARA
104 *PARA_INFO
105  +STREAMSTATE_ERROR    = 5 #(Stream is in some error condition, parent client should close or kick it)
106  +STREAMSTATE_NEEDSEEK = 6 #(like Error but stream can become usable again if you do a seek)
107 +PARA_HASHTABLE  = 6   #(GTN, UUID, ...)
108  +:htsettertype (uint32)
109  +:htsettersize (uint16)
110  +:htsetterdata (vardata)
111  +:hashtable... (dataarray)
112  +::httype (uint32)
113  +::htsize (uint16)
114  +::htfunction (uint16)
115  +::htdata (vardata)
116  +HT_MD5        = 1
117  +HT_SHA1       = 2
118  +HT_RIPEMD160  = 3
119  +HT_SHA256     = 8
120  +HT_SHA384     = 9
121  +HT_SHA512     = 10
122  +HT_SHA224     = 11
123  +HT_UUID       = 70000
124  +HT_GTN8       = 70001
125  +HT_GTN16      = 70002
126  +HT_GTN32      = 70004
127  +HT_GTN64      = 70008
128  +HT_CLIENTID   = 71000 + OT_CLIENT   = 71001
129  +HT_STREAMID   = 71000 + OT_STREAM   = 71002
130  +HT_SOURCEID   = 71000 + OT_SOURCE   = 71003
131  +HT_SAMPLEID   = 71000 + OT_SAMPLE   = 71004
132  +HT_MIXERID    = 71000 + OT_MIXER    = 71005
133  +HT_BRIDGEID   = 71000 + OT_BRIDGE   = 71006
134  +HT_LISTENID   = 71000 + OT_LISTEN   = 71007
135  +HT_ACTIONID   = 71000 + OT_ACTION   = 71008
136  +HT_MSGQUEUEID = 71000 + OT_MSGQUEUE = 71009
137  +HT_MSGBUSID   = 71000 + OT_MSGBUS   = 71010
138  +HF_NONE       = 0 #(This entry does not have anything to do with the object...)
139  +HF_OBJECT     = 1 #(This is an entry for exacltly this object)
140  +HF_PARENT     = 2 #(This is the parent object)
141  +HF_LOGIC      = 3 #(This is a logic group of this object)
142  +HF_PERMANENT  = 4 #(This can be used to acces exactly this object with a premanent address)
143  +HF_DEVICE     = 5 #(The device this is on or the device itself if this is a device)
144  +HF_DISK       = 6 #(The disk this is on, if this is a disk the same as HF_DEVICE)
145  +HF_SONG       = 7 #(This identifys the Song. This may for example be used with Tantalos)
146  +HF_APP        = 8 #(The application, device or other source generating this object)
147  +HF_FILE       = 9 #(The source file for this object)
148 +PARA_WININFO   = 7
149  :(TODO)
150  +:wsystype (uint8)
151  +:socktype (uint8)
152  +:display (uint8)
153  +:screen (uint8)
154  +:addrlen (uint16)
155  +:addr (padded-string(:addrlen))
156  +:wins (dataarray)
157  +::window (uint32)
158 +PARA_PROPTABLE = 8
159  :(TODO)
160*KICK,...
161 +OT_MIXER    =  5
162 +OT_BRIDGE   =  6
163 +OT_LISTEN   =  7
164 +OT_ACTION   =  8
165 +OT_MSGQUEUE =  9 #(Message queue, message is gone as soon as one client took it)
166 +OT_MSGBUS   = 10 #(Message bus, message is gone as soon as all listening clients got it)
167*ATTACH
168 *ATTACH_SOURCE
169  :(TODO)
170 *ATTACH_OUTPUT
171  :(TODO)
172 +ATTACH_MIXER    = 4
173  :(TODO)
174 +ATTACH_BRIDGE   = 5
175  :(TODO)
176*SET_VOL
177 +SET_VOL_MS      = 3
178 +SET_VOL_UNMAPED = 4 #(like roarctls mono/stereo...)
Note: See TracBrowser for help on using the repository browser.