Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Uix.VoiceControl.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Uix.VoiceControl</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Interop">\r
8             <summary>\r
9             Partial interop class.\r
10             </summary>\r
11             <summary>\r
12             Partial interop class.\r
13             </summary>\r
14             <summary>\r
15             Partial interop class.\r
16             </summary>\r
17         </member>\r
18         <member name="T:Interop.Libraries">\r
19             <summary>\r
20             Partial libraries class.\r
21             </summary>\r
22         </member>\r
23         <member name="T:Interop.VoiceControl">\r
24             <summary>\r
25             VoiceControl interop class.\r
26             </summary>\r
27         </member>\r
28         <!-- "F:Interop.VoiceControl.ErrorCode.OutOfMemory" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
29         <!-- "F:Interop.VoiceControl.ErrorCode.IoError" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
30         <!-- "F:Interop.VoiceControl.ErrorCode.InvalidParameter" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
31         <!-- "F:Interop.VoiceControl.ErrorCode.TimedOut" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
32         <!-- "F:Interop.VoiceControl.ErrorCode.RecorderBusy" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
33         <!-- "F:Interop.VoiceControl.ErrorCode.PermissionDenied" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
34         <!-- "F:Interop.VoiceControl.ErrorCode.NotSupported" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
35         <!-- "F:Interop.VoiceControl.ErrorCode.InvalidState" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
36         <!-- "F:Interop.VoiceControl.ErrorCode.InvalidLanguage" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
37         <!-- "F:Interop.VoiceControl.ErrorCode.EngineNotFound" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
38         <!-- "F:Interop.VoiceControl.ErrorCode.OperationFailed" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
39         <!-- "F:Interop.VoiceControl.ErrorCode.OperationRejected" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
40         <!-- "F:Interop.VoiceControl.ErrorCode.IterationEnd" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
41         <!-- "F:Interop.VoiceControl.ErrorCode.Empty" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
42         <!-- "F:Interop.VoiceControl.ErrorCode.ServiceReset" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
43         <!-- "F:Interop.VoiceControl.ErrorCode.InProgressToReady" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
44         <!-- "F:Interop.VoiceControl.ErrorCode.InProgressToRecording" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
45         <!-- "F:Interop.VoiceControl.ErrorCode.InProgressToProcessing" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
46         <member name="T:Interop.VoiceControlCommand">\r
47             <summary>\r
48             VoiceControlCommand interop class.\r
49             </summary>\r
50         </member>\r
51         <member name="T:Tizen.Uix.VoiceControl.CurrentLanguageChangedEventArgs">\r
52             <summary>\r
53             This class holds information about the CurrentLanguageChanged event.\r
54             </summary>\r
55             <since_tizen> 3 </since_tizen>\r
56         </member>\r
57         <member name="P:Tizen.Uix.VoiceControl.CurrentLanguageChangedEventArgs.PreviousLanguage">\r
58             <summary>\r
59             The previous language.\r
60             </summary>\r
61             <since_tizen> 3 </since_tizen>\r
62         </member>\r
63         <member name="P:Tizen.Uix.VoiceControl.CurrentLanguageChangedEventArgs.CurrentLanguage">\r
64             <summary>\r
65             The current language.\r
66             </summary>\r
67             <since_tizen> 3 </since_tizen>\r
68         </member>\r
69         <member name="T:Tizen.Uix.VoiceControl.ErrorOccuredEventArgs">\r
70             <summary>\r
71             This class holds information related to the VoiceControl ErrorOccured event.\r
72             </summary>\r
73             <since_tizen> 3 </since_tizen>\r
74         </member>\r
75         <member name="P:Tizen.Uix.VoiceControl.ErrorOccuredEventArgs.ErrorValue">\r
76             <summary>\r
77             The error value.\r
78             </summary>\r
79             <since_tizen> 3 </since_tizen>\r
80         </member>\r
81         <member name="T:Tizen.Uix.VoiceControl.RecognitionResult">\r
82             <summary>\r
83             The recognition result from the engine.\r
84             If the duplicated commands are recognized, the event(e.g. Result.Rejected) of a command may be rejected\r
85             for selecting the command as a priority. If you set similar or same commands, or the recognized results are multi-results, the CommandList has multi commands.\r
86             </summary>\r
87             <since_tizen> 3 </since_tizen>\r
88         </member>\r
89         <member name="P:Tizen.Uix.VoiceControl.RecognitionResult.Result">\r
90             <summary>\r
91             The result event.\r
92             </summary>\r
93             <since_tizen> 3 </since_tizen>\r
94         </member>\r
95         <member name="P:Tizen.Uix.VoiceControl.RecognitionResult.ResultMessage">\r
96             <summary>\r
97             The spoken text.\r
98             </summary>\r
99             <since_tizen> 3 </since_tizen>\r
100         </member>\r
101         <member name="P:Tizen.Uix.VoiceControl.RecognitionResult.CommandList">\r
102             <summary>\r
103             The recognized command list.\r
104             </summary>\r
105             <since_tizen> 3 </since_tizen>\r
106         </member>\r
107         <member name="T:Tizen.Uix.VoiceControl.RecognitionResultEventArgs">\r
108             <summary>\r
109             The recognition result from the engine.\r
110             </summary>\r
111             <since_tizen> 3 </since_tizen>\r
112         </member>\r
113         <member name="P:Tizen.Uix.VoiceControl.RecognitionResultEventArgs.Result">\r
114             <summary>\r
115             Gets the recognition result.\r
116             </summary>\r
117             <since_tizen> 3 </since_tizen>\r
118         </member>\r
119         <member name="T:Tizen.Uix.VoiceControl.ServiceStateChangedEventArgs">\r
120             <summary>\r
121             This class holds information related to the VoiceControl service ServiceStateChanged event.\r
122             </summary>\r
123             <since_tizen> 3 </since_tizen>\r
124         </member>\r
125         <member name="P:Tizen.Uix.VoiceControl.ServiceStateChangedEventArgs.Previous">\r
126             <summary>\r
127             The previous state.\r
128             </summary>\r
129             <since_tizen> 3 </since_tizen>\r
130         </member>\r
131         <member name="P:Tizen.Uix.VoiceControl.ServiceStateChangedEventArgs.Current">\r
132             <summary>\r
133             The current state.\r
134             </summary>\r
135             <since_tizen> 3 </since_tizen>\r
136         </member>\r
137         <member name="T:Tizen.Uix.VoiceControl.StateChangedEventArgs">\r
138             <summary>\r
139             This class holds information related to the VoiceControl client StateChanged event.\r
140             </summary>\r
141             <since_tizen> 3 </since_tizen>\r
142         </member>\r
143         <member name="P:Tizen.Uix.VoiceControl.StateChangedEventArgs.Previous">\r
144             <summary>\r
145             The previous state.\r
146             </summary>\r
147             <since_tizen> 3 </since_tizen>\r
148         </member>\r
149         <member name="P:Tizen.Uix.VoiceControl.StateChangedEventArgs.Current">\r
150             <summary>\r
151             The current state.\r
152             </summary>\r
153             <since_tizen> 3 </since_tizen>\r
154         </member>\r
155         <member name="T:Tizen.Uix.VoiceControl.CommandFormat">\r
156             <summary>\r
157             Enumeration for the command format.\r
158             </summary>\r
159             <since_tizen> 3 </since_tizen>\r
160         </member>\r
161         <member name="F:Tizen.Uix.VoiceControl.CommandFormat.Fixed">\r
162             <summary>\r
163             The fixed command format.\r
164             </summary>\r
165         </member>\r
166         <member name="F:Tizen.Uix.VoiceControl.CommandFormat.FixedAndVFixed">\r
167             <summary>\r
168             The fixed and variable fixed command format.\r
169             </summary>\r
170         </member>\r
171         <member name="F:Tizen.Uix.VoiceControl.CommandFormat.VFixedAndFixed">\r
172             <summary>\r
173             The variable fixed and fixed command format.\r
174             </summary>\r
175         </member>\r
176         <member name="F:Tizen.Uix.VoiceControl.CommandFormat.FixedAndNonFixed">\r
177             <summary>\r
178             The fixed and non-fixed command format.\r
179             </summary>\r
180         </member>\r
181         <member name="F:Tizen.Uix.VoiceControl.CommandFormat.NonFixedAndFixed">\r
182             <summary>\r
183             The non-fixed and fixed command format.\r
184             </summary>\r
185         </member>\r
186         <member name="F:Tizen.Uix.VoiceControl.CommandFormat.Undefined">\r
187             <summary>\r
188             Undefined.\r
189             </summary>\r
190         </member>\r
191         <member name="T:Tizen.Uix.VoiceControl.VoiceCommand">\r
192             <summary>\r
193             This class represents a voice command.\r
194             </summary>\r
195             <since_tizen> 3 </since_tizen>\r
196         </member>\r
197         <member name="M:Tizen.Uix.VoiceControl.VoiceCommand.#ctor">\r
198             <summary>\r
199             The public constructor.\r
200             </summary>\r
201             <since_tizen> 3 </since_tizen>\r
202             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
203             <exception cref="T:System.OutOfMemoryException">This exception can be due to out Of memory.</exception>\r
204             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
205             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
206         </member>\r
207         <member name="P:Tizen.Uix.VoiceControl.VoiceCommand.UnfixedCommand">\r
208             <summary>\r
209             Gets the unfixed command.\r
210             This property should be used for commands which have non-fixed format.\r
211             An empty string will be returned in case of some internal error.\r
212             </summary>\r
213             <since_tizen> 3 </since_tizen>\r
214         </member>\r
215         <member name="P:Tizen.Uix.VoiceControl.VoiceCommand.Type">\r
216             <summary>\r
217             Gets or sets the command type.\r
218             </summary>\r
219             <since_tizen> 3 </since_tizen>\r
220             <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>\r
221             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
222             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
223         </member>\r
224         <member name="P:Tizen.Uix.VoiceControl.VoiceCommand.Format">\r
225             <summary>\r
226             Gets or sets the command format.\r
227             </summary>\r
228             <since_tizen> 3 </since_tizen>\r
229             <remarks>The default format is Fixed.</remarks>\r
230             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
231             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
232         </member>\r
233         <member name="P:Tizen.Uix.VoiceControl.VoiceCommand.Command">\r
234             <summary>\r
235             Gets or sets the command.\r
236             A get empty string will be returned in case of some internal error.\r
237             </summary>\r
238             <since_tizen> 3 </since_tizen>\r
239             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
240             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
241         </member>\r
242         <member name="T:Tizen.Uix.VoiceControl.VoiceCommandList">\r
243             <summary>\r
244             This class represents a list of the voice commands.\r
245             </summary>\r
246             <since_tizen> 3 </since_tizen>\r
247         </member>\r
248         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.#ctor">\r
249             <summary>\r
250             The public constructor.\r
251             </summary>\r
252             <since_tizen> 3 </since_tizen>\r
253             <privilege>\r
254             http://tizen.org/privilege/recorder\r
255             </privilege>\r
256             <privlevel>\r
257             public\r
258             </privlevel>\r
259             <feature>\r
260             http://tizen.org/feature/speech.control\r
261             http://tizen.org/feature/microphone\r
262             </feature>\r
263             <exception cref="T:System.OutOfMemoryException">This exception can be due to out of memory.</exception>\r
264             <exception cref="T:System.ArgumentException">This exception can be due to an invalid parameter.</exception>\r
265             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
266             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
267         </member>\r
268         <member name="P:Tizen.Uix.VoiceControl.VoiceCommandList.Count">\r
269             <summary>\r
270             Gets a command count of the list.\r
271             -1 is returned in case of an internal failure.\r
272             </summary>\r
273             <since_tizen> 3 </since_tizen>\r
274             <value>\r
275             Command count of the list.\r
276             </value>\r
277             <privilege>\r
278             http://tizen.org/privilege/recorder\r
279             </privilege>\r
280             <privlevel>\r
281             public\r
282             </privlevel>\r
283         </member>\r
284         <member name="P:Tizen.Uix.VoiceControl.VoiceCommandList.Current">\r
285             <summary>\r
286             Gets the current command from the command list by index.\r
287             Null will be returned in case of an empty list.\r
288             </summary>\r
289             <since_tizen> 3 </since_tizen>\r
290             <value>\r
291             Current command from the command list.\r
292             </value>\r
293             <privilege>\r
294             http://tizen.org/privilege/recorder\r
295             </privilege>\r
296             <privlevel>\r
297             public\r
298             </privlevel>\r
299         </member>\r
300         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.Add(Tizen.Uix.VoiceControl.VoiceCommand)">\r
301             <summary>\r
302             Adds a command to the command list.\r
303             </summary>\r
304             <since_tizen> 3 </since_tizen>\r
305             <privilege>\r
306             http://tizen.org/privilege/recorder\r
307             </privilege>\r
308             <privlevel>\r
309             public\r
310             </privlevel>\r
311             <feature>\r
312             http://tizen.org/feature/speech.control\r
313             http://tizen.org/feature/microphone\r
314             </feature>\r
315             <param name="command">The command</param>\r
316             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
317             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
318             <exception cref="T:System.NullReferenceException">This will occur if the provided parameter is null.</exception>\r
319         </member>\r
320         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.Remove(Tizen.Uix.VoiceControl.VoiceCommand)">\r
321             <summary>\r
322             Removes a command from the command list.\r
323             </summary>\r
324             <since_tizen> 3 </since_tizen>\r
325             <privilege>\r
326             http://tizen.org/privilege/recorder\r
327             </privilege>\r
328             <privlevel>\r
329             public\r
330             </privlevel>\r
331             <feature>\r
332             http://tizen.org/feature/speech.control\r
333             http://tizen.org/feature/microphone\r
334             </feature>\r
335             <param name="command">The command</param>\r
336             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
337             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
338             <exception cref="T:System.NullReferenceException">This will occur if the provided parameter is null.</exception>\r
339         </member>\r
340         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.GetAllCommands">\r
341             <summary>\r
342             Retrieves all commands from the command list.\r
343             </summary>\r
344             <since_tizen> 3 </since_tizen>\r
345             <privilege>\r
346             http://tizen.org/privilege/recorder\r
347             </privilege>\r
348             <privlevel>\r
349             public\r
350             </privlevel>\r
351             <feature>\r
352             http://tizen.org/feature/speech.control\r
353             http://tizen.org/feature/microphone\r
354             </feature>\r
355             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
356             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
357         </member>\r
358         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.First">\r
359             <summary>\r
360             Moves an index to the first command.\r
361             </summary>\r
362             <since_tizen> 3 </since_tizen>\r
363             <privilege>\r
364             http://tizen.org/privilege/recorder\r
365             </privilege>\r
366             <privlevel>\r
367             public\r
368             </privlevel>\r
369             <feature>\r
370             http://tizen.org/feature/speech.control\r
371             http://tizen.org/feature/microphone\r
372             </feature>\r
373             <exception cref="T:System.InvalidOperationException">This exception can be due to list empty.</exception>\r
374             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
375             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
376         </member>\r
377         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.Last">\r
378             <summary>\r
379             Moves an index to the last command.\r
380             </summary>\r
381             <since_tizen> 3 </since_tizen>\r
382             <privilege>\r
383             http://tizen.org/privilege/recorder\r
384             </privilege>\r
385             <privlevel>\r
386             public\r
387             </privlevel>\r
388             <feature>\r
389             http://tizen.org/feature/speech.control\r
390             http://tizen.org/feature/microphone\r
391             </feature>\r
392             <exception cref="T:System.InvalidOperationException">This exception can be due to list empty.</exception>\r
393             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
394             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
395         </member>\r
396         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.Next">\r
397             <summary>\r
398             Moves an index to the next command.\r
399             </summary>\r
400             <since_tizen> 3 </since_tizen>\r
401             <privilege>\r
402             http://tizen.org/privilege/recorder\r
403             </privilege>\r
404             <privlevel>\r
405             public\r
406             </privlevel>\r
407             <feature>\r
408             http://tizen.org/feature/speech.control\r
409             http://tizen.org/feature/microphone\r
410             </feature>\r
411             <exception cref="T:System.InvalidOperationException">\r
412             This exception can be due to the following reasons:\r
413             1. List empty\r
414             2. List reached end\r
415             </exception>\r
416             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
417             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
418         </member>\r
419         <member name="M:Tizen.Uix.VoiceControl.VoiceCommandList.Previous">\r
420             <summary>\r
421             Moves an index to the previous command.\r
422             </summary>\r
423             <since_tizen> 3 </since_tizen>\r
424             <privilege>\r
425             http://tizen.org/privilege/recorder\r
426             </privilege>\r
427             <privlevel>\r
428             public\r
429             </privlevel>\r
430             <feature>\r
431             http://tizen.org/feature/speech.control\r
432             http://tizen.org/feature/microphone\r
433             </feature>\r
434             <exception cref="T:System.InvalidOperationException">\r
435             This exception can be due to the following reasons:\r
436             1. List empty\r
437             2. List reached end\r
438             </exception>\r
439             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
440             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
441         </member>\r
442         <member name="T:Tizen.Uix.VoiceControl.Error">\r
443             <summary>\r
444             Enumeration for the error values that can occur.\r
445             </summary>\r
446             <since_tizen> 3 </since_tizen>\r
447         </member>\r
448         <member name="F:Tizen.Uix.VoiceControl.Error.None">\r
449             <summary>\r
450             Successful, no error.\r
451             </summary>\r
452         </member>\r
453         <member name="F:Tizen.Uix.VoiceControl.Error.OutOfMemory">\r
454             <summary>\r
455             Out of memory.\r
456             </summary>\r
457         </member>\r
458         <member name="F:Tizen.Uix.VoiceControl.Error.IoError">\r
459             <summary>\r
460             I/O error.\r
461             </summary>\r
462         </member>\r
463         <member name="F:Tizen.Uix.VoiceControl.Error.InvalidParameter">\r
464             <summary>\r
465             Invalid parameter.\r
466             </summary>\r
467         </member>\r
468         <member name="F:Tizen.Uix.VoiceControl.Error.TimedOut">\r
469             <summary>\r
470             No answer from the STT service.\r
471             </summary>\r
472         </member>\r
473         <member name="F:Tizen.Uix.VoiceControl.Error.RecorderBusy">\r
474             <summary>\r
475             Device or resource busy.\r
476             </summary>\r
477         </member>\r
478         <member name="F:Tizen.Uix.VoiceControl.Error.PermissionDenied">\r
479             <summary>\r
480             Permission denied.\r
481             </summary>\r
482         </member>\r
483         <member name="F:Tizen.Uix.VoiceControl.Error.NotSupported">\r
484             <summary>\r
485             VC NOT supported.\r
486             </summary>\r
487         </member>\r
488         <member name="F:Tizen.Uix.VoiceControl.Error.InvalidState">\r
489             <summary>\r
490             Invalid state.\r
491             </summary>\r
492         </member>\r
493         <member name="F:Tizen.Uix.VoiceControl.Error.InvalidLanguage">\r
494             <summary>\r
495             Invalid language.\r
496             </summary>\r
497         </member>\r
498         <member name="F:Tizen.Uix.VoiceControl.Error.EngineNotFound">\r
499             <summary>\r
500             No available engine.\r
501             </summary>\r
502         </member>\r
503         <member name="F:Tizen.Uix.VoiceControl.Error.OperationFailed">\r
504             <summary>\r
505             Operation failed.\r
506             </summary>\r
507         </member>\r
508         <member name="F:Tizen.Uix.VoiceControl.Error.OperationRejected">\r
509             <summary>\r
510             Operation rejected.\r
511             </summary>\r
512         </member>\r
513         <member name="F:Tizen.Uix.VoiceControl.Error.IterationEnd">\r
514             <summary>\r
515             List reached end.\r
516             </summary>\r
517         </member>\r
518         <member name="F:Tizen.Uix.VoiceControl.Error.Empty">\r
519             <summary>\r
520             List empty.\r
521             </summary>\r
522         </member>\r
523         <member name="F:Tizen.Uix.VoiceControl.Error.ServiceReset">\r
524             <summary>\r
525             Service reset.\r
526             </summary>\r
527         </member>\r
528         <member name="F:Tizen.Uix.VoiceControl.Error.InProgressToReady">\r
529             <summary>\r
530             Progress to ready is not finished.\r
531             </summary>\r
532         </member>\r
533         <member name="F:Tizen.Uix.VoiceControl.Error.InProgressToRecording">\r
534             <summary>\r
535             Progress to recording is not finished.\r
536             </summary>\r
537         </member>\r
538         <member name="F:Tizen.Uix.VoiceControl.Error.InProgressToProcessing">\r
539             <summary>\r
540             Progress to processing is not finished.\r
541             </summary>\r
542         </member>\r
543         <member name="T:Tizen.Uix.VoiceControl.State">\r
544             <summary>\r
545             Enumeration for the client state.\r
546             </summary>\r
547             <since_tizen> 3 </since_tizen>\r
548         </member>\r
549         <member name="F:Tizen.Uix.VoiceControl.State.None">\r
550             <summary>\r
551             'None' state.\r
552             </summary>\r
553         </member>\r
554         <member name="F:Tizen.Uix.VoiceControl.State.Initialized">\r
555             <summary>\r
556             'Initialized' state.\r
557             </summary>\r
558         </member>\r
559         <member name="F:Tizen.Uix.VoiceControl.State.Ready">\r
560             <summary>\r
561             'Ready' state.\r
562             </summary>\r
563         </member>\r
564         <member name="F:Tizen.Uix.VoiceControl.State.Unavailable">\r
565             <summary>\r
566             The state cannot be determined.\r
567             </summary>\r
568         </member>\r
569         <member name="T:Tizen.Uix.VoiceControl.ServiceState">\r
570             <summary>\r
571             Enumeration for the service state.\r
572             </summary>\r
573             <since_tizen> 3 </since_tizen>\r
574         </member>\r
575         <member name="F:Tizen.Uix.VoiceControl.ServiceState.None">\r
576             <summary>\r
577             'None' state.\r
578             </summary>\r
579         </member>\r
580         <member name="F:Tizen.Uix.VoiceControl.ServiceState.Ready">\r
581             <summary>\r
582             'Ready' state.\r
583             </summary>\r
584         </member>\r
585         <member name="F:Tizen.Uix.VoiceControl.ServiceState.Recording">\r
586             <summary>\r
587             'Recording' state.\r
588             </summary>\r
589         </member>\r
590         <member name="F:Tizen.Uix.VoiceControl.ServiceState.Processing">\r
591             <summary>\r
592             'Processing' state.\r
593             </summary>\r
594         </member>\r
595         <member name="F:Tizen.Uix.VoiceControl.ServiceState.Unavailable">\r
596             <summary>\r
597             The state cannot be determined.\r
598             </summary>\r
599         </member>\r
600         <member name="T:Tizen.Uix.VoiceControl.ResultEvent">\r
601             <summary>\r
602             Enumeration for the result event.\r
603             </summary>\r
604             <since_tizen> 3 </since_tizen>\r
605         </member>\r
606         <member name="F:Tizen.Uix.VoiceControl.ResultEvent.Success">\r
607             <summary>\r
608             Normal result.\r
609             </summary>\r
610         </member>\r
611         <member name="F:Tizen.Uix.VoiceControl.ResultEvent.Rejected">\r
612             <summary>\r
613             Rejected result.\r
614             </summary>\r
615         </member>\r
616         <member name="T:Tizen.Uix.VoiceControl.CommandType">\r
617             <summary>\r
618             Enumeration for the command type.\r
619             </summary>\r
620             <since_tizen> 3 </since_tizen>\r
621         </member>\r
622         <member name="F:Tizen.Uix.VoiceControl.CommandType.Foreground">\r
623             <summary>\r
624             Foreground command by the client.\r
625             </summary>\r
626         </member>\r
627         <member name="F:Tizen.Uix.VoiceControl.CommandType.Background">\r
628             <summary>\r
629             Background command by the client.\r
630             </summary>\r
631         </member>\r
632         <member name="F:Tizen.Uix.VoiceControl.CommandType.Undefined">\r
633             <summary>\r
634             The undefined command.\r
635             </summary>\r
636         </member>\r
637         <member name="T:Tizen.Uix.VoiceControl.VoiceControlClient">\r
638             <summary>\r
639             A main function of the voice control API registers the command and gets a notification for the recognition result. \r
640             Applications can add their own commands and provide results when their command is recognized by the user voice input.\r
641             </summary>\r
642             <since_tizen> 3 </since_tizen>\r
643         </member>\r
644         <member name="P:Tizen.Uix.VoiceControl.VoiceControlClient.CurrentLanguage">\r
645             <summary>\r
646             Gets the current language.\r
647             A language is specified as an ISO 3166 alpha-2 two letter country-code\r
648             followed by ISO 639-1 for the two-letter language code.\r
649             For example, "ko_KR" for Korean, "en_US" for American English.\r
650             An empty string is returned in case of some internal error.\r
651             </summary>\r
652             <since_tizen> 3 </since_tizen>\r
653             <value>\r
654             The current language in voice control.\r
655             </value>\r
656             <privilege>\r
657             http://tizen.org/privilege/recorder\r
658             </privilege>\r
659             <pre>\r
660             The state must be initialized or ready.\r
661             </pre>\r
662         </member>\r
663         <member name="P:Tizen.Uix.VoiceControl.VoiceControlClient.State">\r
664             <summary>\r
665             Gets the current state of the voice control client.\r
666             </summary>\r
667             <since_tizen> 3 </since_tizen>\r
668             <value>\r
669             The current state of the voice control client.\r
670             </value>\r
671             <privilege>\r
672             http://tizen.org/privilege/recorder\r
673             </privilege>\r
674             <pre>\r
675             The state must be initialized or ready.\r
676             </pre>\r
677         </member>\r
678         <member name="P:Tizen.Uix.VoiceControl.VoiceControlClient.ServiceState">\r
679             <summary>\r
680             Gets the current state of the voice control service.\r
681             </summary>\r
682             <since_tizen> 3 </since_tizen>\r
683             <value>\r
684             The current state of the voice control service.\r
685             </value>\r
686             <privilege>\r
687             http://tizen.org/privilege/recorder\r
688             </privilege>\r
689             <pre>\r
690             The state must be ready.\r
691             </pre>\r
692         </member>\r
693         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.SetInvocationName(System.String)">\r
694             <summary>\r
695             Sets the invocation name.\r
696             </summary>\r
697             <since_tizen> 3 </since_tizen>\r
698             <privilege>\r
699             http://tizen.org/privilege/recorder\r
700             </privilege>\r
701             <privlevel>\r
702             public\r
703             </privlevel>\r
704             <feature>\r
705             http://tizen.org/feature/speech.control\r
706             http://tizen.org/feature/microphone\r
707             </feature>\r
708             <remarks>\r
709             The invocation name is used to activate background commands. The invocation name can be same as the application name or any other phrase.\r
710             For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample".\r
711             In order to activate the background command, users can say "Tizen Sample, Play music". The invocation name is dependent on the current language.\r
712             For example, if the current language is "en_US"(English), the invocation name is also "en_US".\r
713             If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized.\r
714             This function should be called before the SetCommandList().\r
715             </remarks>\r
716             <param name="name">Invocation name to be invoked by an application.</param>\r
717             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
718             <exception cref="T:System.ArgumentException">This exception can be due to an invalid parameter.</exception>\r
719             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
720             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
721             <pre>\r
722             The state must be ready.\r
723             </pre>\r
724         </member>\r
725         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.Initialize">\r
726             <summary>\r
727             Initializes the voice control.\r
728             </summary>\r
729             <since_tizen> 3 </since_tizen>\r
730             <privilege>\r
731             http://tizen.org/privilege/recorder\r
732             </privilege>\r
733             <privlevel>\r
734             public\r
735             </privlevel>\r
736             <feature>\r
737             http://tizen.org/feature/speech.control\r
738             http://tizen.org/feature/microphone\r
739             </feature>\r
740             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>\r
741             <exception cref="T:System.OutOfMemoryException">This exception can be due to out Of memory.</exception>\r
742             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
743             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
744             <post>\r
745             The state will be initialized.\r
746             </post>\r
747         </member>\r
748         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.Deinitialize">\r
749             <summary>\r
750             Deinitializes the voice control.\r
751             </summary>\r
752             <since_tizen> 3 </since_tizen>\r
753             <privilege>\r
754             http://tizen.org/privilege/recorder\r
755             </privilege>\r
756             <privlevel>\r
757             public\r
758             </privlevel>\r
759             <feature>\r
760             http://tizen.org/feature/speech.control\r
761             http://tizen.org/feature/microphone\r
762             </feature>\r
763             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
764             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>\r
765             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
766             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
767         </member>\r
768         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.Prepare">\r
769             <summary>\r
770             Connects the voice control service.\r
771             </summary>\r
772             <since_tizen> 3 </since_tizen>\r
773             <privilege>\r
774             http://tizen.org/privilege/recorder\r
775             </privilege>\r
776             <privlevel>\r
777             public\r
778             </privlevel>\r
779             <feature>\r
780             http://tizen.org/feature/speech.control\r
781             http://tizen.org/feature/microphone\r
782             </feature>\r
783             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
784             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>\r
785             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
786             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
787             <pre>\r
788             The state must be initialized.\r
789             </pre>\r
790             <post>\r
791             The state must be ready.\r
792             </post>\r
793         </member>\r
794         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.Unprepare">\r
795             <summary>\r
796             Disconnects the voice control service.\r
797             </summary>\r
798             <since_tizen> 3 </since_tizen>\r
799             <privilege>\r
800             http://tizen.org/privilege/recorder\r
801             </privilege>\r
802             <privlevel>\r
803             public\r
804             </privlevel>\r
805             <feature>\r
806             http://tizen.org/feature/speech.control\r
807             http://tizen.org/feature/microphone\r
808             </feature>\r
809             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
810             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
811             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
812             <pre>\r
813             The state must be ready.\r
814             </pre>\r
815             <post>\r
816             The state must be initialized.\r
817             </post>\r
818         </member>\r
819         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.GetSupportedLanguages">\r
820             <summary>\r
821             Retrieves all the supported languages.\r
822             A language is specified as an ISO 3166 alpha-2 two letter country-code\r
823             followed by ISO 639-1 for the two-letter language code.\r
824             For example, "ko_KR" for Korean, "en_US" for American English.\r
825             </summary>\r
826             <since_tizen> 3 </since_tizen>\r
827             <privilege>\r
828             http://tizen.org/privilege/recorder\r
829             </privilege>\r
830             <privlevel>\r
831             public\r
832             </privlevel>\r
833             <feature>\r
834             http://tizen.org/feature/speech.control\r
835             http://tizen.org/feature/microphone\r
836             </feature>\r
837             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
838             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>\r
839             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
840             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
841             <pre>\r
842             The state must be ready or initialized.\r
843             </pre>\r
844         </member>\r
845         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.GetSystemCommandList">\r
846             <summary>\r
847             Gets the system command list.\r
848             </summary>\r
849             <since_tizen> 3 </since_tizen>\r
850             <returns>\r
851             The command list, else null in case of no system commands.\r
852             </returns>\r
853             <privilege>\r
854             http://tizen.org/privilege/recorder\r
855             </privilege>\r
856             <privlevel>\r
857             public.\r
858             </privlevel>\r
859             <feature>\r
860             http://tizen.org/feature/speech.control\r
861             http://tizen.org/feature/microphone\r
862             </feature>\r
863             <remarks>\r
864             In the system command list, there are system commands predefined by product manufacturers.\r
865             Those commands have the highest priority. Therefore, the user cannot set any commands similar to system commands.\r
866             </remarks>\r
867             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
868             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>\r
869             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
870             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
871             <pre>\r
872             The state must be ready.\r
873             </pre>\r
874         </member>\r
875         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.RequestDialog(System.String,System.String,System.Boolean)">\r
876             <summary>\r
877             Requests to start the dialogue.\r
878             By using this function, the developer can start requesting the dialogue to the framework.\r
879             When the developer requests the dialogue, two types of texts, dispText and uttText can be sent by this function. dispText is a text for displaying and uttText is that for uttering.\r
880             For example, if dispText is "October 10th" and uttText is "Today is October 10th.", "October 10th" will be displayed on the screen and "Today is October 10th." will be spoken.\r
881             Also, the developer can set whether the dialogue starts automatically or not, using autoStart.\r
882             If the developer sets autoStart as True, the framework will start to record the next speech and continue the dialogue.\r
883             </summary>\r
884             <since_tizen> 3 </since_tizen>\r
885             <privilege>\r
886             http://tizen.org/privilege/recorder\r
887             </privilege>\r
888             <privlevel>\r
889             public\r
890             </privlevel>\r
891             <feature>\r
892             http://tizen.org/feature/speech.control\r
893             http://tizen.org/feature/microphone\r
894             </feature>\r
895             <remarks>\r
896             If autoStart is True, the recognition will start again. In this case, it can be restarted up to 4 times.\r
897             </remarks>\r
898             <param name="dispText">Text to be displayed on the screen.</param>\r
899             <param name="uttText">Text to be spoken.</param>\r
900             <param name="autoStart">A variable for setting whether the dialog session will be restarted automatically or not.</param>\r
901             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
902             <exception cref="T:System.ArgumentException">This exception can be due to an invalid parameter.</exception>\r
903             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
904             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
905             <pre>\r
906             The state must be ready.\r
907             </pre>\r
908         </member>\r
909         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.SetCommandList(Tizen.Uix.VoiceControl.VoiceCommandList,Tizen.Uix.VoiceControl.CommandType)">\r
910             <summary>\r
911             Sets the command list.\r
912             </summary>\r
913             <since_tizen> 3 </since_tizen>\r
914             <privilege>\r
915             http://tizen.org/privilege/recorder\r
916             </privilege>\r
917             <privlevel>\r
918             public\r
919             </privlevel>\r
920             <feature>\r
921             http://tizen.org/feature/speech.control\r
922             http://tizen.org/feature/microphone\r
923             </feature>\r
924             <remarks>\r
925             The command type is valid for CommandType 'Foreground' or 'Background'.\r
926             The matched commands of the command list should be set and they should include type and command text at least.\r
927             </remarks>\r
928             <param name="list">Command list</param>\r
929             <param name="type">Command type</param>\r
930             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
931             <exception cref="T:System.ArgumentException">This exception can be due to an invalid parameter.</exception>\r
932             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
933             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
934             <pre>\r
935             The state must be ready.\r
936             </pre>\r
937         </member>\r
938         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.UnsetCommandList(Tizen.Uix.VoiceControl.CommandType)">\r
939             <summary>\r
940             Unsets the command list.\r
941             </summary>\r
942             <since_tizen> 3 </since_tizen>\r
943             <privilege>\r
944             http://tizen.org/privilege/recorder\r
945             </privilege>\r
946             <privlevel>\r
947             public\r
948             </privlevel>\r
949             <feature>\r
950             http://tizen.org/feature/speech.control\r
951             http://tizen.org/feature/microphone\r
952             </feature>\r
953             <param name="type">Command type</param>\r
954             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
955             <exception cref="T:System.ArgumentException">This exception can be due to an invalid parameter.</exception>\r
956             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
957             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
958             <pre>\r
959             The state should be ready.\r
960             </pre>\r
961         </member>\r
962         <member name="M:Tizen.Uix.VoiceControl.VoiceControlClient.GetResult">\r
963             <summary>\r
964             Gets the recognition result.\r
965             </summary>\r
966             <since_tizen> 3 </since_tizen>\r
967             <privilege>\r
968             http://tizen.org/privilege/recorder\r
969             </privilege>\r
970             <privlevel>\r
971             public\r
972             </privlevel>\r
973             <feature>\r
974             http://tizen.org/feature/speech.control\r
975             http://tizen.org/feature/microphone\r
976             </feature>\r
977             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
978             <exception cref="T:System.ArgumentException">This exception can be due to an invalid parameter.</exception>\r
979             <exception cref="T:System.NotSupportedException">This exception can be due to not supported.</exception>\r
980             <returns>The recognition result if possible, else a null object.</returns>\r
981             <pre>\r
982             The state must be ready.\r
983             </pre>\r
984         </member>\r
985         <member name="E:Tizen.Uix.VoiceControl.VoiceControlClient.RecognitionResult">\r
986             <summary>\r
987             Event to be invoked when the recognition is done.\r
988             </summary>\r
989             <since_tizen> 3 </since_tizen>\r
990             <pre>\r
991             The state must be initialized.\r
992             </pre>\r
993         </member>\r
994         <member name="E:Tizen.Uix.VoiceControl.VoiceControlClient.ServiceStateChanged">\r
995             <summary>\r
996             Event to be invoked when the VoiceControl service state changes.\r
997             </summary>\r
998             <since_tizen> 3 </since_tizen>\r
999             <pre>\r
1000             The state must be initialized.\r
1001             </pre>\r
1002         </member>\r
1003         <member name="E:Tizen.Uix.VoiceControl.VoiceControlClient.StateChanged">\r
1004             <summary>\r
1005             Event to be invoked when the VoiceControl client state changes.\r
1006             </summary>\r
1007             <since_tizen> 3 </since_tizen>\r
1008             <pre>\r
1009             The state must be initialized.\r
1010             </pre>\r
1011         </member>\r
1012         <member name="E:Tizen.Uix.VoiceControl.VoiceControlClient.ErrorOccured">\r
1013             <summary>\r
1014             Event to be invoked when an error occurs.\r
1015             </summary>\r
1016             <since_tizen> 3 </since_tizen>\r
1017             <pre>\r
1018             The state must be initialized.\r
1019             </pre>\r
1020         </member>\r
1021         <member name="E:Tizen.Uix.VoiceControl.VoiceControlClient.CurrentLanguageChanged">\r
1022             <summary>\r
1023             Event to be invoked when the default language changes.\r
1024             </summary>\r
1025             <since_tizen> 3 </since_tizen>\r
1026             <pre>\r
1027             The state must be initialized.\r
1028             </pre>\r
1029         </member>\r
1030     </members>\r
1031 </doc>\r