/
VoiceCommand.cs
273 lines (254 loc) · 9.43 KB
/
VoiceCommand.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
/*
* 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 static Interop.VoiceControlManager;
using static Interop.VoiceControlCommand;
namespace Tizen.Uix.VoiceControlManager
{
/// <summary>
/// Enumeration for the command format.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public enum CommandFormat
{
/// <summary>
/// The fixed command format.
/// </summary>
Fixed = 0,
/// <summary>
/// The fixed and variable fixed command format.
/// </summary>
FixedAndVFixed = 1,
/// <summary>
/// The variable fixed and fixed command format.
/// </summary>
VFixedAndFixed = 2,
/// <summary>
/// The fixed and non-fixed command format.
/// </summary>
FixedAndNonFixed = 3,
/// <summary>
/// The non-fixed and fixed command format.
/// </summary>
NonFixedAndFixed = 4,
/// <summary>
/// The action command
/// </summary>
Action = 5,
/// <summary>
/// The partial matched command
/// </summary>
Partial = 6,
/// <summary>
/// Undefined
/// </summary>
Undefined = -1
};
/// <summary>
/// This class represents a voice command.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public class VoiceCommand : IDisposable
{
internal SafeCommandHandle _handle;
private bool _disposed = false;
/// <summary>
/// The public constructor.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege> http://tizen.org/privilege/recorder </privilege>
/// <privlevel>public</privlevel>
/// <feature> http://tizen.org/feature/microphone </feature>
/// <feature> http://tizen.org/feature/speech.control </feature>
/// <exception cref="InvalidOperationException">This exception can be due to out of memory.</exception>
/// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
public VoiceCommand()
{
SafeCommandHandle handle;
ErrorCode error = VcCmdCreate(out handle);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "Create Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
_handle = handle;
}
internal VoiceCommand(SafeCommandHandle handle)
{
_handle = handle;
}
/// <summary>
/// The destructor of the VoiceCommand class.
/// </summary>
/// <since_tizen> 6 </since_tizen>
~VoiceCommand()
{
Dispose(false);
}
/// <summary>
/// Gets the unfixed command.
/// This property should be used for commands which have non-fixed format.
/// An empty string will be returned in case of some internal error.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public string UnfixedCommand
{
get
{
string unfixedCommand;
ErrorCode error = VcCmdGetUnfixedCommand(_handle, out unfixedCommand);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "UnfixedCommand Failed with error " + error);
return string.Empty;
}
return unfixedCommand;
}
}
/// <summary>
/// Gets or sets the command type.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege> http://tizen.org/privilege/recorder </privilege>
/// <privlevel>public</privlevel>
/// <feature> http://tizen.org/feature/microphone </feature>
/// <feature> http://tizen.org/feature/speech.control </feature>
/// <remarks>If you do not set the command type, the default value is undefined. You should set the type if the command is valid.</remarks>
/// <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>
public CommandType CommandType
{
get
{
CommandType cmdType = CommandType.Undefined;
int type;
ErrorCode error = VcCmdGetType(_handle, out type);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetType Failed with error " + error);
return CommandType.Undefined;
}
if (type != -1)
{
cmdType = (CommandType)type;
}
return cmdType;
}
set
{
ErrorCode error = VcCmdSetType(_handle, value);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetType Failed with error " + error);
}
}
}
/// <summary>
/// Gets or sets the command format.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <feature> http://tizen.org/feature/microphone </feature>
/// <feature> http://tizen.org/feature/speech.control </feature>
/// <remarks>The default format is Fixed.</remarks>
/// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
public CommandFormat Format
{
get
{
CommandFormat format;
ErrorCode error = VcCmdGetFormat(_handle, out format);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetFormat Failed with error " + error);
return CommandFormat.Undefined;
}
return format;
}
set
{
ErrorCode error = VcCmdSetFormat(_handle, value);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetFormat Failed with error " + error);
}
}
}
/// <summary>
/// Gets or sets the command.
/// A get empty string will be returned in case of some internal error.
/// </summary>
/// <since_tizen> 6 </since_tizen>
/// <privilege> http://tizen.org/privilege/recorder </privilege>
/// <privlevel>public</privlevel>
/// <feature> http://tizen.org/feature/microphone </feature>
/// <feature> http://tizen.org/feature/speech.control </feature>
/// <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>
public string Command
{
get
{
string command;
ErrorCode error = VcCmdGetCommand(_handle, out command);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetCommand Failed with error " + error);
return string.Empty;
}
return command;
}
set
{
ErrorCode error = VcCmdSetCommand(_handle, value);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "SetCommand Failed with error " + error);
}
}
}
/// <summary>
/// Release any unmanaged resources used by this object.
/// </summary>
/// <since_tizen> 6 </since_tizen>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// Release any unmanaged resources used by this object.
/// </summary>
/// <param name="disposing">
/// If true, disposes any disposable objects. If false, does not dispose disposable objects.
/// </param>
/// <since_tizen> 6 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (_disposed)
return;
if (disposing)
{
_handle?.Dispose();
_handle = null;
}
_disposed = true;
}
}
}