ssip_client_async/
constants.rs

1// ssip-client -- Speech Dispatcher client in Rust
2// Copyright (c) 2021 Laurent Pelecq
3//
4// Licensed under the Apache License, Version 2.0
5// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
6// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
7// option. All files in the project carrying such notice may not be copied,
8// modified, or distributed except according to those terms.
9
10use crate::types::ReturnCode;
11
12/// Successful completion: OK LANGUAGE SET
13pub const OK_LANGUAGE_SET: ReturnCode = 201;
14
15/// Successful completion: OK PRIORITY SET
16pub const OK_PRIORITY_SET: ReturnCode = 202;
17
18/// Successful completion: OK RATE SET
19pub const OK_RATE_SET: ReturnCode = 203;
20
21/// Successful completion: OK PITCH SET
22pub const OK_PITCH_SET: ReturnCode = 204;
23
24/// Successful completion: OK PUNCTUATION SET
25pub const OK_PUNCTUATION_SET: ReturnCode = 205;
26
27/// Successful completion: OK CAP LET RECOGNITION SET
28pub const OK_CAP_LET_RECOGN_SET: ReturnCode = 206;
29
30/// Successful completion: OK SPELLING SET
31pub const OK_SPELLING_SET: ReturnCode = 207;
32
33/// Successful completion: OK CLIENT NAME SET
34pub const OK_CLIENT_NAME_SET: ReturnCode = 208;
35
36/// Successful completion: OK VOICE SET
37pub const OK_VOICE_SET: ReturnCode = 209;
38
39/// Successful completion: OK STOPPED
40pub const OK_STOPPED: ReturnCode = 210;
41
42/// Successful completion: OK PAUSED
43pub const OK_PAUSED: ReturnCode = 211;
44
45/// Successful completion: OK RESUMED
46pub const OK_RESUMED: ReturnCode = 212;
47
48/// Successful completion: OK CANCELED
49pub const OK_CANCELED: ReturnCode = 213;
50
51/// Successful completion: OK TABLE SET
52pub const OK_TABLE_SET: ReturnCode = 215;
53
54/// Successful completion: OK OUTPUT MODULE SET
55pub const OK_OUTPUT_MODULE_SET: ReturnCode = 216;
56
57/// Successful completion: OK PAUSE CONTEXT SET
58pub const OK_PAUSE_CONTEXT_SET: ReturnCode = 217;
59
60/// Successful completion: OK VOLUME SET
61pub const OK_VOLUME_SET: ReturnCode = 218;
62
63/// Successful completion: OK SSML MODE SET
64pub const OK_SSML_MODE_SET: ReturnCode = 219;
65
66/// Successful completion: OK NOTIFICATION SET
67pub const OK_NOTIFICATION_SET: ReturnCode = 220;
68
69/// Successful completion: OK CURSOR SET FIRST
70pub const OK_CUR_SET_FIRST: ReturnCode = 220;
71
72/// Successful completion: OK CURSOR SET LAST
73pub const OK_CUR_SET_LAST: ReturnCode = 221;
74
75/// Successful completion: OK CURSOR SET TO POSITION
76pub const OK_CUR_SET_POS: ReturnCode = 222;
77
78/// Successful completion: OK CURSOR MOVED FORWARD
79pub const OK_CUR_MOV_FOR: ReturnCode = 223;
80
81/// Successful completion: OK CURSOR MOVED BACKWARD
82pub const OK_CUR_MOV_BACK: ReturnCode = 224;
83
84/// Successful completion: OK MESSAGE QUEUED
85pub const OK_MESSAGE_QUEUED: ReturnCode = 225;
86
87/// Successful completion: OK SOUND ICON QUEUED
88pub const OK_SND_ICON_QUEUED: ReturnCode = 226;
89
90/// Successful completion: OK MESSAGE CANCELED
91pub const OK_MSG_CANCELED: ReturnCode = 227;
92
93/// Successful completion: OK RECEIVING DATA
94pub const OK_RECEIVING_DATA: ReturnCode = 230;
95
96// Successful completion: HAPPY HACKING
97pub const OK_BYE: ReturnCode = 231;
98
99/// Successful completion: OK CLIENTS LIST SENT
100pub const OK_CLIENTS_LIST_SENT: ReturnCode = 240;
101
102/// Successful completion: OK MSGS LIST SENT
103pub const OK_MSGS_LIST_SENT: ReturnCode = 241;
104
105/// Successful completion: OK LAST MSG SAID
106pub const OK_LAST_MSG: ReturnCode = 242;
107
108/// Successful completion: OK CURSOR POSITION RETURNED
109pub const OK_CUR_POS_RET: ReturnCode = 243;
110
111/// Successful completion: OK TABLE LIST SEND
112pub const OK_TABLE_LIST_SENT: ReturnCode = 244;
113
114/// Successful completion: OK CLIENT ID SENT
115pub const OK_CLIENT_ID_SENT: ReturnCode = 245;
116
117/// Successful completion: OK MESSAGE TEXT SENT
118pub const OK_MSG_TEXT_SENT: ReturnCode = 246;
119
120/// Successful completion: OK HELP SENT
121pub const OK_HELP_SENT: ReturnCode = 248;
122
123/// Successful completion: OK VOICE LIST SENT
124pub const OK_VOICES_LIST_SENT: ReturnCode = 249;
125
126/// Successful completion: OK MODULE LIST SENT
127pub const OK_OUTPUT_MODULES_LIST_SENT: ReturnCode = 250;
128
129/// Successful completion: OK GET RETURNED
130pub const OK_GET: ReturnCode = 251;
131
132/// Successful completion: OK INSIDE BLOCK
133pub const OK_INSIDE_BLOCK: ReturnCode = 260;
134
135/// Successful completion: OK OUTSIDE BLOCK
136pub const OK_OUTSIDE_BLOCK: ReturnCode = 261;
137
138/// Successful completion: OK DEBUGGING SET
139pub const OK_DEBUG_SET: ReturnCode = 262;
140
141/// Successful completion: OK PITCH RANGE SET
142pub const OK_PITCH_RANGE_SET: ReturnCode = 263;
143
144/// Successful completion: OK BUT NOT IMPLEMENTED -- DOES NOTHING
145pub const OK_NOT_IMPLEMENTED: ReturnCode = 299;
146
147/// Server error: ERR INTERNAL
148pub const ERR_INTERNAL: ReturnCode = 300;
149
150/// Server error: ERR COULDNT SET PRIORITY
151pub const ERR_COULDNT_SET_PRIORITY: ReturnCode = 301;
152
153/// Server error: ERR COULDNT SET LANGUAGE
154pub const ERR_COULDNT_SET_LANGUAGE: ReturnCode = 302;
155
156/// Server error: ERR COULDNT SET RATE
157pub const ERR_COULDNT_SET_RATE: ReturnCode = 303;
158
159/// Server error: ERR COULDNT SET PITCH
160pub const ERR_COULDNT_SET_PITCH: ReturnCode = 304;
161
162/// Server error: ERR COULDNT SET PUNCT MODE
163pub const ERR_COULDNT_SET_PUNCTUATION: ReturnCode = 305;
164
165/// Server error: ERR COULDNT SET CAP LET RECOGNITION
166pub const ERR_COULDNT_SET_CAP_LET_RECOG: ReturnCode = 306;
167
168/// Server error: ERR COULDNT SET SPELLING
169pub const ERR_COULDNT_SET_SPELLING: ReturnCode = 308;
170
171/// Server error: ERR COULDNT SET VOICE
172pub const ERR_COULDNT_SET_VOICE: ReturnCode = 309;
173
174/// Server error: ERR COULDNT SET TABLE
175pub const ERR_COULDNT_SET_TABLE: ReturnCode = 310;
176
177/// Server error: ERR COULDNT SET CLIENT_NAME
178pub const ERR_COULDNT_SET_CLIENT_NAME: ReturnCode = 311;
179
180/// Server error: ERR COULDNT SET OUTPUT MODULE
181pub const ERR_COULDNT_SET_OUTPUT_MODULE: ReturnCode = 312;
182
183/// Server error: ERR COULDNT SET PAUSE CONTEXT
184pub const ERR_COULDNT_SET_PAUSE_CONTEXT: ReturnCode = 313;
185
186/// Server error: ERR COULDNT SET VOLUME
187pub const ERR_COULDNT_SET_VOLUME: ReturnCode = 314;
188
189/// Server error: ERR COULDNT SET SSML MODE
190pub const ERR_COULDNT_SET_SSML_MODE: ReturnCode = 315;
191
192/// Server error: ERR COULDNT SET NOTIFICATION
193pub const ERR_COULDNT_SET_NOTIFICATION: ReturnCode = 316;
194
195/// Server error: ERR COULDNT SET DEBUGGING
196pub const ERR_COULDNT_SET_DEBUG: ReturnCode = 317;
197
198/// Server error: ERR NO SOUND ICONS
199pub const ERR_NO_SND_ICONS: ReturnCode = 320;
200
201/// Server error: ERR MODULE CANT REPORT VOICES
202pub const ERR_CANT_REPORT_VOICES: ReturnCode = 321;
203
204/// Server error: ERR NO OUTPUT MODULE LOADED
205pub const ERR_NO_OUTPUT_MODULE: ReturnCode = 321;
206
207/// Server error: ERR ALREADY INSIDE BLOCK
208pub const ERR_ALREADY_INSIDE_BLOCK: ReturnCode = 330;
209
210/// Server error: ERR ALREADY OUTSIDE BLOCK
211pub const ERR_ALREADY_OUTSIDE_BLOCK: ReturnCode = 331;
212
213/// Server error: ERR NOT ALLOWED INSIDE BLOCK
214pub const ERR_NOT_ALLOWED_INSIDE_BLOCK: ReturnCode = 332;
215
216/// Server error: ERR COULDNT SET PITCH RANGE
217pub const ERR_COULDNT_SET_PITCH_RANGE: ReturnCode = 340;
218
219/// Server error: ERR NOT YET IMPLEMENTED
220pub const ERR_NOT_IMPLEMENTED: ReturnCode = 380;
221
222/// Client error: ERR NO CLIENT
223pub const ERR_NO_CLIENT: ReturnCode = 401;
224
225/// Client error: ERR NO SUCH CLIENT
226pub const ERR_NO_SUCH_CLIENT: ReturnCode = 402;
227
228/// Client error: ERR NO MESSAGE
229pub const ERR_NO_MESSAGE: ReturnCode = 403;
230
231/// Client error: ERR POSITION TOO LOW
232pub const ERR_POS_LOW: ReturnCode = 404;
233
234/// Client error: ERR POSITION TOO HIGH
235pub const ERR_POS_HIGH: ReturnCode = 405;
236
237/// Client error: ERR ID DOESNT EXIST
238pub const ERR_ID_NOT_EXIST: ReturnCode = 406;
239
240/// Client error: ERR UNKNOWN ICON
241pub const ERR_UNKNOWN_ICON: ReturnCode = 407;
242
243/// Client error: ERR UNKNOWN PRIORITY
244pub const ERR_UNKNOWN_PRIORITY: ReturnCode = 408;
245
246/// Client error: ERR RATE TOO HIGH
247pub const ERR_RATE_TOO_HIGH: ReturnCode = 409;
248
249/// Client error: ERR RATE TOO LOW
250pub const ERR_RATE_TOO_LOW: ReturnCode = 410;
251
252/// Client error: ERR PITCH TOO HIGH
253pub const ERR_PITCH_TOO_HIGH: ReturnCode = 411;
254
255/// Client error: ERR PITCH TOO LOW
256pub const ERR_PITCH_TOO_LOW: ReturnCode = 412;
257
258/// Client error: ERR VOLUME TOO HIGH
259pub const ERR_VOLUME_TOO_HIGH: ReturnCode = 413;
260
261/// Client error: ERR VOLUME TOO LOW
262pub const ERR_VOLUME_TOO_LOW: ReturnCode = 414;
263
264/// Client error: ERR PITCH RANGE TOO HIGH
265pub const ERR_PITCH_RANGE_TOO_HIGH: ReturnCode = 415;
266
267/// Client error: ERR PITCH RANGE TOO LOW
268pub const ERR_PITCH_RANGE_TOO_LOW: ReturnCode = 416;
269
270/// Client error: ERR INVALID COMMAND
271pub const ERR_INVALID_COMMAND: ReturnCode = 500;
272
273/// Client error: ERR INVALID ENCODING
274pub const ERR_INVALID_ENCODING: ReturnCode = 501;
275
276/// Client error: ERR MISSING PARAMETER
277pub const ERR_MISSING_PARAMETER: ReturnCode = 510;
278
279/// Client error: ERR PARAMETER NOT A NUMBER
280pub const ERR_NOT_A_NUMBER: ReturnCode = 511;
281
282/// Client error: ERR PARAMETER NOT A STRING
283pub const ERR_NOT_A_STRING: ReturnCode = 512;
284
285/// Client error: ERR PARAMETER NOT ON OR OFF
286pub const ERR_PARAMETER_NOT_ON_OFF: ReturnCode = 513;
287
288/// Client error: ERR PARAMETER INVALID
289pub const ERR_PARAMETER_INVALID: ReturnCode = 514;
290
291/// Event: INDEX MARK
292pub const EVENT_INDEX_MARK: ReturnCode = 700;
293
294/// Event: BEGIN
295pub const EVENT_BEGIN: ReturnCode = 701;
296
297/// Event: END
298pub const EVENT_END: ReturnCode = 702;
299
300/// Event: CANCELED
301pub const EVENT_CANCELED: ReturnCode = 703;
302
303/// Event: PAUSED
304pub const EVENT_PAUSED: ReturnCode = 704;
305
306/// Event: RESUMED
307pub const EVENT_RESUMED: ReturnCode = 705;