/
VoiceControlManagerClient.cs
2063 lines (1970 loc) · 88.7 KB
/
VoiceControlManagerClient.cs
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
/*
* Copyright (c) 2019 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using Tizen.Applications;
using static Interop.VoiceControlManager;
using static Interop.VoiceControlCommand;
using System.Text;
namespace Tizen.Uix.VoiceControlManager
{
/// <summary>
/// Enumeration for the error values that can occur.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum VoiceError
{
/// <summary>
/// Successful, no error.
/// </summary>
None,
/// <summary>
/// Out of memory.
/// </summary>
OutOfMemory,
/// <summary>
/// I/O error.
/// </summary>
IoError,
/// <summary>
/// Invalid parameter.
/// </summary>
InvalidParameter,
/// <summary>
/// No answer from the STT service.
/// </summary>
TimedOut,
/// <summary>
/// Device or resource busy.
/// </summary>
RecorderBusy,
/// <summary>
/// Permission denied.
/// </summary>
PermissionDenied,
/// <summary>
/// VC NOT supported.
/// </summary>
NotSupported,
/// <summary>
/// Invalid state.
/// </summary>
InvalidState,
/// <summary>
/// Invalid language.
/// </summary>
InvalidLanguage,
/// <summary>
/// No available engine.
/// </summary>
EngineNotFound,
/// <summary>
/// Operation failed.
/// </summary>
OperationFailed,
/// <summary>
/// Operation rejected.
/// </summary>
OperationRejected,
/// <summary>
/// List reached end.
/// </summary>
IterationEnd,
/// <summary>
/// List empty.
/// </summary>
Empty,
/// <summary>
/// Service reset.
/// </summary>
ServiceReset,
/// <summary>
/// Progress to ready is not finished.
/// </summary>
InProgressToReady,
/// <summary>
/// Progress to recording is not finished.
/// </summary>
InProgressToRecording,
/// <summary>
/// Progress to processing is not finished.
/// </summary>
InProgressToProcessing,
/// <summary>
/// Not supported feature of current engine.
/// </summary>
NotSupportedFeature
};
/// <summary>
/// Enumeration for the client state.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum State
{
/// <summary>
/// 'None' state.
/// </summary>
None = 0,
/// <summary>
/// 'Initialized' state.
/// </summary>
Initialized = 1,
/// <summary>
/// 'Ready' state.
/// </summary>
Ready = 2,
/// <summary>
/// The state cannot be determined.
/// </summary>
Unavailable = -1
};
/// <summary>
/// Enumeration for the service state.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum ServiceState
{
/// <summary>
/// 'None' state.
/// </summary>
None = 0,
/// <summary>
/// 'Ready' state.
/// </summary>
Ready = 1,
/// <summary>
/// 'Recording' state.
/// </summary>
Recording = 2,
/// <summary>
/// 'Processing' state.
/// </summary>
Processing = 3,
/// <summary>
/// The state cannot be determined.
/// </summary>
Unavailable = -1
};
/// <summary>
/// Enumeration for the result of recognizing a VoiceCommand
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum RecognizedResult
{
/// <summary>
/// Normal result.
/// </summary>
Success = 0,
/// <summary>
/// Rejected result.
/// </summary>
Rejected = 1
};
/// <summary>
/// Enumeration for the command type.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum CommandType
{
/// <summary>
/// foreground command type
/// </summary>
Foreground = 1,
/// <summary>
/// background command type
/// </summary>
Background = 2,
/// <summary>
/// widget command type
/// </summary>
Widget = 3,
/// <summary>
/// system command type
/// </summary>
System = 4,
/// <summary>
/// system background command type
/// </summary>
SystemBackground = 5,
/// <summary>
/// exclusive command type
/// </summary>
Exclusive = 6,
/// <summary>
/// Undefined command
/// </summary>
Undefined = -1
};
/// <summary>
/// Enumerations of recognition mode
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum RecognitionModeType
{
/// <summary>
/// Default mode
/// </summary>
StopBySilence,
/// <summary>
/// Restart recognition after rejected result
/// </summary>
RestartAfterReject,
/// <summary>
/// Continuously restart recognition - not support yet
/// </summary>
RestartContinuously,
/// <summary>
/// Start and stop manually without silence
/// </summary>
Manual,
/// <summary>
/// Undefined
/// </summary>
Undefined = -1
}
/// <summary>
/// Enumerations of send event type
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum SendEventType
{
/// <summary>
/// Send text event to vc engine
/// </summary>
Text,
/// <summary>
/// Send list event to vc engine
/// </summary>
ListEvent,
/// <summary>
/// Send haptic event to vc engine
/// </summary>
HapticEvent,
}
/// <summary>
/// Enumerations for audio channels
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum AudioChanelType
{
/// <summary>
/// 1 channel, mono
/// </summary>
Mono = 0,
/// <summary>
/// 2 channels, stereo
/// </summary>
Stereo
}
/// <summary>
/// Enumerations of audio types
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum AudioType
{
/// <summary>
/// Signed 16bit audio type, Little endian
/// </summary>
PcmS16Le = 0,
/// <summary>
/// Unsigned 8bit audio type
/// </summary>
PcmU8
}
/// <summary>
/// Enumeration for TTS feedback type
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum FeedbackType
{
/// <summary>
/// Failed
/// </summary>
Fail = -1,
/// <summary>
/// Start event
/// </summary>
Start = 1,
/// <summary>
/// Continue event
/// </summary>
Continue = 2,
/// <summary>
/// Finish event
/// </summary>
Finish = 3
}
/// <summary>
/// Enumerations of pre result event
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum PreResultEventType
{
/// <summary>
/// Final result
/// </summary>
FinalResult = 0,
/// <summary>
/// Partial Result
/// </summary>
PartialResult,
/// <summary>
/// Error
/// </summary>
Error,
}
/// <summary>
/// Voice Control Manager Class
/// </summary>
/// <since_tizen> 6 </since_tizen>
public static class VoiceControlManagerClient
{
private static event EventHandler<PreRecognitionResultUpdatedEventArgs> _preResult;
private static event EventHandler<SpecificEngineResultEventArgs> _specificEngineResult;
private static event EventHandler<EventArgs> _speechDetected;
private static event EventHandler<ConversationRequestedEventArgs> _conversationRequested;
private static event EventHandler<PrivateDataUpdatedEventArgs> _privateDataSet;
private static event EventHandler<FeedbackAudioFormatEventArgs> _feedbackAudioFormat;
private static event EventHandler<FeedbackStreamingEventArgs> _feedbackStreaming;
private static event EventHandler<VcTtsStreamingEventArgs> _vcTtsStreaming;
private static event EventHandler<RecognitionResultUpdatedEventArgs> _recognitionResult;
private static event EventHandler<CurrentLanguageChangedEventArgs> _currentLanguageChanged;
private static event EventHandler<StateChangedEventArgs> _stateChanged;
private static event EventHandler<ServiceStateChangedEventArgs> _serviceStateChanged;
private static event EventHandler<ErrorOccurredEventArgs> _errorOccurred;
private static event EventHandler<AllRecognitionResultEventArgs> _allRecognitionResult;
private static VcMgrPreResultCallback _preResultDelegate;
private static VcMgrSpecificEngineResultCallback _specificEngineResultDelegate;
private static VcMgrBeginSpeechDetectedCallback _beginSpeechDetectedDelegate;
private static VcMgrDialogRequestCallback _conversationRequestDelegate;
private static VcMgrPrivateDataSetCallback _privateDataSetDelegate;
private static VcMgrPrivateDataRequestedCallback _privateDataRequestedDelegate;
private static VcMgrFeedbackAudioFormatCallback _feedbackAudioFormatDelegate;
private static VcMgrFeedbackStreamingCallback _feedbackStreamingDelegate;
private static VcMgrVcTtsStreamingCallback _vcTtsStreamingDelegate;
private static VcMgrResultCallback s_resultDelegate;
private static VcMgrCurrentLanguageChangedCallback _languageDelegate;
private static VcMgrStateChangedCallback _stateDelegate;
private static VcMgrServiceStateChangedCallback _serviceStateDelegate;
private static VcMgrErrorCallback _errorDelegate;
private static SelectRecognizedCommandsDelegate _recognizedCommandsDelegate;
private static VcMgrAllResultCallback _recognizedCommandsSelectionCallback = (RecognizedResult result, IntPtr vcCmdList, IntPtr recognizedText, IntPtr msg, IntPtr userData) =>
{
string recognizedString = Marshal.PtrToStringAnsi(recognizedText);
string msgString = Marshal.PtrToStringAnsi(msg);
if (_allRecognitionResult != null)
{
AllRecognitionResultEventArgs args = new AllRecognitionResultEventArgs(result, recognizedString, msgString);
_allRecognitionResult?.Invoke(null, args);
if (result == RecognizedResult.Rejected)
return true;
}
if (_recognizedCommandsDelegate != null && result == RecognizedResult.Success)
{
VoiceCommandsGroup cmdList = new VoiceCommandsGroup(new SafeCommandListHandle(vcCmdList));
IEnumerable<VoiceCommand> selectedList = _recognizedCommandsDelegate.Invoke(cmdList.Commands, recognizedString, msgString);
if (selectedList == null)
return true;
VoiceCommandsGroup resultList = new VoiceCommandsGroup();
foreach (VoiceCommand command in selectedList)
{
resultList.Commands.Add(command);
}
ErrorCode error = VcMgrSetSelectedResults(resultList._handle);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetSelectedResults Failed with error " + error);
}
return false;
}
return true;
};
/// <summary>
/// The delegate is invoked when engine requests private data is needed.
/// </summary>
/// <param name="key">Private key</param>
/// <returns>Private data</returns>
/// <since_tizen> 6 </since_tizen>
public delegate string PrivateDataProvider(string key);
/// <summary>
/// The delegate is invoked when the sentence match, client selects valid commands from all commands.
/// </summary>
/// <param name="commands">Command list</param>
/// <param name="recognizedText">The Recognized text</param>
/// <param name="message">Engine message</param>
/// <returns>Valid commands</returns>
/// <since_tizen> 6 </since_tizen>
public delegate IEnumerable<VoiceCommand> SelectRecognizedCommandsDelegate(IEnumerable<VoiceCommand> commands, string recognizedText, string message);
/// <summary>
/// Initialize voice control manager.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
/// 1) This exception can be due to out of memory.
/// 2) This exception can be due to operation failed.
/// </exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <post>
/// The State will be Initialized.
/// </post>
public static void Initialize()
{
ErrorCode error = VcMgrInitialize();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "Initialize Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Deinitialize the voice control manager.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <post>
/// The State will be None.
/// </post>
public static void Deinitialize()
{
ErrorCode error = VcMgrDeinitialize();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "Deinitialize Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Connects the voice control service.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The state must be initialized.
/// </pre>
/// <post>
/// The state must be ready.
/// </post>
public static void Prepare()
{
ErrorCode error = VcMgrPrepare();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "Prepare Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Disconnects the voice control service.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The state must be ready.
/// </pre>
/// <post>
/// The state must be initialized.
/// </post>
public static void Unprepare()
{
ErrorCode error = VcMgrUnprepare();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "Unprepare Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Retrieves all the supported languages.
/// A language is specified as an ISO 3166 alpha-2 two letter country-code
/// followed by ISO 639-1 for the two-letter language code.
/// For example, "ko_KR" for Korean, "en_US" for American English.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <returns>
/// List of strings for supported languages.
/// </returns>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The state must be ready or initialized.
/// </pre>
public static IEnumerable<string> GetSupportedLanguages()
{
List<string> supportedLanguages = new List<string>();
VcMgrSupportedLanguageCallback supportedLanguagesDelegate = (IntPtr language, IntPtr userData) =>
{
string languageStr = Marshal.PtrToStringAnsi(language);
supportedLanguages.Add(languageStr);
return true;
};
ErrorCode error = VcMgrForeachSupportedLanguages(supportedLanguagesDelegate, IntPtr.Zero);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetSupportedLanguages Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
return supportedLanguages;
}
/// <summary>
/// Gets the current language.
/// A language is specified as an ISO 3166 alpha-2 two letter country-code
/// followed by ISO 639-1 for the two-letter language code.
/// For example, "ko_KR" for Korean, "en_US" for American English.
/// An empty string is returned in case of some internal error.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <value>The current language in voice control.</value>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The state must be initialized or ready.
/// </pre>
public static string CurrentLanguage
{
get
{
string currentLanguage;
ErrorCode error = VcMgrGetCurrentLanguage(out currentLanguage);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "CurrentLanaguge Failed with error " + error);
return string.Empty;
}
return currentLanguage;
}
}
/// <summary>
/// Gets the current state of the voice control client.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <value>The current state of the voice control client.</value>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The state must be initialized or ready.
/// </pre>
public static State State
{
get
{
State state;
ErrorCode error = VcMgrGetState(out state);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "State Failed with error " + error);
return State.Unavailable;
}
return state;
}
}
/// <summary>
/// Gets the current state of the voice control service.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <value>The current state of the voice control service.</value>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
/// 1) This exception can be due to an invalid state.
/// 2) This exception can be due to operation failed.
/// </exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The state must be ready.
/// </pre>
public static ServiceState ServiceState
{
get
{
ServiceState state;
ErrorCode error = VcMgrGetServiceState(out state);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "ServiceState Failed with error " + error);
return ServiceState.Unavailable;
}
return state;
}
}
/// <summary>
/// Checks whether the command format is supported.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <param name="format">The command format</param>
/// <returns>The result status, true if supported</returns>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State must be Ready.
/// </pre>
public static bool IsSupportedCommandFormat(CommandFormat format)
{
bool supported = false;
ErrorCode error = VcMgrIsCommandFormatSupported(format, out supported);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "IsSupportedCommandFormat Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
return supported;
}
/// <summary>
/// Sets system or exclusive commands.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <param name="commands">Command list</param>
/// <exception cref="InvalidOperationException">This exception can be due to invalid state.</exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State should be Ready
/// </pre>
public static void SetCommands(VoiceCommandsGroup commands)
{
if (commands == null)
throw new ArgumentException("Parameter is null");
ErrorCode error = VcMgrSetCommandList(commands._handle);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetCommands Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Clears commands.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to invalid state.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State should be Ready
/// </pre>
public static void ClearCommands()
{
ErrorCode error = VcMgrUnsetCommandList();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "ClearCommands Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Sets commands from file.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <param name="path">File Path</param>
/// <param name="type">Command type</param>
/// <exception cref="InvalidOperationException">This exception can be due to invalid state.</exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State should be Ready
/// </pre>
public static void SetCommandsFromFile(string path, CommandType type)
{
ErrorCode error = VcMgrSetCommandListFromFile(path, type);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetCommandsFromFile Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Retrieves all available commands.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>>
/// <returns>
/// The Command List else null in case of no System Commands
/// </returns>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
/// 1) This exception can be due to an invalid state.
/// 2) This exception can be due to operation failed.
/// </exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State should be Ready
/// </pre>
public static IEnumerable<VoiceCommand> GetCurrentCommands()
{
IntPtr handle = IntPtr.Zero;
ErrorCode error = VcMgrGetCurrentCommands(out handle);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetCurrentCommands Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
if (handle == IntPtr.Zero)
{
Log.Error(LogTag, "GetCurrentCommands handle is null");
return null;
}
SafeCommandListHandle list = new SafeCommandListHandle(handle);
VoiceCommandsGroup cmdList = new VoiceCommandsGroup(list);
return cmdList.Commands;
}
/// <summary>
/// Sets or Gets the Audio In Type.
/// The Values of the strings can be "VC_AUDIO_ID_BLUETOOTH" or "VC_AUDIO_ID_MSF"
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to invalid state.</exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State must be Ready.
/// </pre>
public static string AudioType
{
get
{
string type;
ErrorCode error = VcMgrGetAudioType(out type);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetAudioType Failed with error " + error);
return string.Empty;
}
return type;
}
set
{
ErrorCode error = VcMgrSetAudioType(value);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetAudioType Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
}
/// <summary>
/// Sets or Gets the recognition mode.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State must be Ready.
/// </pre>
public static RecognitionModeType RecognitionMode
{
get
{
RecognitionModeType mode;
ErrorCode error = VcMgrGetRecognitionMode(out mode);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetRecognitionMode Failed with error " + error);
return RecognitionModeType.Undefined;
}
return mode;
}
set
{
ErrorCode error = VcMgrSetRecognitionMode(value);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetRecognitionMode Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
}
/// <summary>
/// Sets private data between app and engine.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <param name="key">Private key</param>
/// <param name="data">Private data</param>
/// <exception cref="InvalidOperationException">
/// This can occur due to the following reasons:
/// 1) This exception can be due to an invalid state.
/// 2) This exception can be due to operation failed.
/// </exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException" > The required feature is not supported.</exception>
/// <pre>
/// The State must be Ready.
/// </pre>
public static void SetPrivateData(string key, string data)
{
ErrorCode error = VcMgrSetPrivateData(key, data);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetPrivateData Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Gets private data between app and engine.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>
/// <param name="key">Private key</param>
/// <returns>Private data</returns>
/// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <pre>
/// The State must be Ready.
/// </pre>
public static string GetPrivateData(string key)
{
string data;
ErrorCode error = VcMgrGetPrivateData(key, out data);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetPrivateData Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
return data;
}
/// <summary>
/// Request to do action as if utterence is spoken.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege>http://tizen.org/privilege/voicecontrol.manager</privilege>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// <privlevel>platform</privlevel>
/// <feature>http://tizen.org/feature/speech.control_manager</feature>
/// <feature>http://tizen.org/feature/microphone</feature>