Release 4.0.0-preview1-00138
[platform/core/csapi/tizenfx.git] / Artifacts / bin / Tizen.Uix.Stt.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Tizen.Uix.Stt</name>
5     </assembly>
6     <members>
7         <member name="T:Interop">
8             <summary>
9             Partial interop class.
10             </summary>
11             <summary>
12             Partial interop class.
13             </summary>
14         </member>
15         <member name="T:Interop.Libraries">
16             <summary>
17             Partial libraries class.
18             </summary>
19         </member>
20         <member name="T:Interop.Stt">
21             <summary>
22             Stt interop class.
23             </summary>
24         </member>
25         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.OutOfMemory" -->
26         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.IoError" -->
27         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.InvalidParameter" -->
28         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.TimedOut" -->
29         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.RecorderBusy" -->
30         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.OutOfNetwork" -->
31         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.PermissionDenied" -->
32         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.NotSupported" -->
33         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.InvalidState" -->
34         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.InvalidLanguage" -->
35         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.EngineNotFound" -->
36         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.OperationFailed" -->
37         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.NotSupportedFeature" -->
38         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.RecordingTimedOut" -->
39         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.NoSpeech" -->
40         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.InProgressToReady" -->
41         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.InProgressToRecording" -->
42         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.InProgressToProcessing" -->
43         <!-- Badly formed XML comment ignored for member "F:Interop.Stt.SttError.ServiceReset" -->
44         <member name="T:Tizen.Uix.Stt.DefaultLanguageChangedEventArgs">
45             <summary>
46             This class holds information about the DefaultLanguageChanged event.
47             </summary>
48             <since_tizen> 3 </since_tizen>
49         </member>
50         <member name="P:Tizen.Uix.Stt.DefaultLanguageChangedEventArgs.PreviousLanguage">
51             <summary>
52             The previous language.
53             </summary>
54             <since_tizen> 3 </since_tizen>
55         </member>
56         <member name="P:Tizen.Uix.Stt.DefaultLanguageChangedEventArgs.CurrentLanguage">
57             <summary>
58             The current language.
59             </summary>
60             <since_tizen> 3 </since_tizen>
61         </member>
62         <member name="T:Tizen.Uix.Stt.EngineChangedEventArgs">
63             <summary>
64             This class holds information related to the EngineChanged event.
65             </summary>
66             <since_tizen> 3 </since_tizen>
67         </member>
68         <member name="P:Tizen.Uix.Stt.EngineChangedEventArgs.EngineId">
69             <summary>
70             The Engine ID.
71             </summary>
72             <since_tizen> 3 </since_tizen>
73         </member>
74         <member name="P:Tizen.Uix.Stt.EngineChangedEventArgs.Language">
75             <summary>
76             The default language.
77             </summary>
78             <since_tizen> 3 </since_tizen>
79         </member>
80         <member name="P:Tizen.Uix.Stt.EngineChangedEventArgs.NeedCredential">
81             <summary>
82             The necessity of the credential.
83             </summary>
84             <since_tizen> 3 </since_tizen>
85         </member>
86         <member name="P:Tizen.Uix.Stt.EngineChangedEventArgs.SupportSilence">
87             <summary>
88             Whether silence detection is supported or not.
89             </summary>
90             <since_tizen> 3 </since_tizen>
91         </member>
92         <member name="T:Tizen.Uix.Stt.ErrorOccurredEventArgs">
93             <summary>
94             This class holds information related to the STT ErrorOccurred event.
95             </summary>
96             <since_tizen> 3 </since_tizen>
97         </member>
98         <member name="P:Tizen.Uix.Stt.ErrorOccurredEventArgs.ErrorValue">
99             <summary>
100             The error value.
101             </summary>
102             <since_tizen> 3 </since_tizen>
103         </member>
104         <member name="P:Tizen.Uix.Stt.ErrorOccurredEventArgs.ErrorMessage">
105             <summary>
106             Gets the current error message.
107             </summary>
108             <since_tizen> 3 </since_tizen>
109             <returns>
110             String error message.
111             </returns>
112         </member>
113         <member name="T:Tizen.Uix.Stt.RecognitionResultEventArgs">
114             <summary>
115             The recognition result from the engine.
116             </summary>
117             <since_tizen> 3 </since_tizen>
118         </member>
119         <member name="P:Tizen.Uix.Stt.RecognitionResultEventArgs.Result">
120             <summary>
121             The result event.
122             </summary>
123             <since_tizen> 3 </since_tizen>
124         </member>
125         <member name="P:Tizen.Uix.Stt.RecognitionResultEventArgs.Data">
126             <summary>
127             The result text.
128             </summary>
129             <since_tizen> 3 </since_tizen>
130         </member>
131         <member name="P:Tizen.Uix.Stt.RecognitionResultEventArgs.DataCount">
132             <summary>
133             Returns the result text count.
134             </summary>
135             <since_tizen> 3 </since_tizen>
136         </member>
137         <member name="P:Tizen.Uix.Stt.RecognitionResultEventArgs.Message">
138             <summary>
139             The engine message.
140             </summary>
141             <since_tizen> 3 </since_tizen>
142         </member>
143         <member name="T:Tizen.Uix.Stt.ResultTime">
144             <summary>
145             This class represents the result of recognition result from the engine.
146             </summary>
147             <since_tizen> 3 </since_tizen>
148         </member>
149         <member name="P:Tizen.Uix.Stt.ResultTime.Index">
150             <summary>
151             The result index.
152             </summary>
153             <since_tizen> 3 </since_tizen>
154         </member>
155         <member name="P:Tizen.Uix.Stt.ResultTime.TokenEvent">
156             <summary>
157             The token event.
158             </summary>
159             <since_tizen> 3 </since_tizen>
160         </member>
161         <member name="P:Tizen.Uix.Stt.ResultTime.Text">
162             <summary>
163             The result text.
164             </summary>
165             <since_tizen> 3 </since_tizen>
166         </member>
167         <member name="P:Tizen.Uix.Stt.ResultTime.StartTime">
168             <summary>
169             The start time of result text.
170             </summary>
171             <since_tizen> 3 </since_tizen>
172         </member>
173         <member name="P:Tizen.Uix.Stt.ResultTime.EndTime">
174             <summary>
175             The end time of result text.
176             </summary>
177             <since_tizen> 3 </since_tizen>
178         </member>
179         <member name="T:Tizen.Uix.Stt.StateChangedEventArgs">
180             <summary>
181             This class holds information related to the STT StateChanged event.
182             </summary>
183             <since_tizen> 3 </since_tizen>
184         </member>
185         <member name="P:Tizen.Uix.Stt.StateChangedEventArgs.Previous">
186             <summary>
187             The previous state.
188             </summary>
189             <since_tizen> 3 </since_tizen>
190         </member>
191         <member name="P:Tizen.Uix.Stt.StateChangedEventArgs.Current">
192             <summary>
193             The current state.
194             </summary>
195             <since_tizen> 3 </since_tizen>
196         </member>
197         <member name="T:Tizen.Uix.Stt.ResultEvent">
198             <summary>
199             The token event.
200             </summary>
201             <since_tizen> 3 </since_tizen>
202         </member>
203         <member name="F:Tizen.Uix.Stt.ResultEvent.FinalResult">
204             <summary>
205             Event when the recognition for full or last result is ready.
206             </summary>
207             <since_tizen> 3 </since_tizen>
208         </member>
209         <member name="F:Tizen.Uix.Stt.ResultEvent.PartialResult">
210             <summary>
211             Event when the recognition for partial result is ready.
212             </summary>
213             <since_tizen> 3 </since_tizen>
214         </member>
215         <member name="F:Tizen.Uix.Stt.ResultEvent.Error">
216             <summary>
217             Event when the recognition has failed.
218             </summary>
219             <since_tizen> 3 </since_tizen>
220         </member>
221         <member name="T:Tizen.Uix.Stt.ResultMessage">
222             <summary>
223             Enumeration for representing the result message.
224             </summary>
225             <since_tizen> 3 </since_tizen>
226         </member>
227         <member name="F:Tizen.Uix.Stt.ResultMessage.None">
228             <summary>
229             No Error.
230             </summary>
231             <since_tizen> 3 </since_tizen>
232         </member>
233         <member name="F:Tizen.Uix.Stt.ResultMessage.TooSoon">
234             <summary>
235             Recognition failed  because the speech started too soon.
236             </summary>
237             <since_tizen> 3 </since_tizen>
238         </member>
239         <member name="F:Tizen.Uix.Stt.ResultMessage.TooShort">
240             <summary>
241             Recognition failed  because the speech is too short.
242             </summary>
243             <since_tizen> 3 </since_tizen>
244         </member>
245         <member name="F:Tizen.Uix.Stt.ResultMessage.TooLong">
246             <summary>
247             Recognition failed  because the speech is too long.
248             </summary>
249             <since_tizen> 3 </since_tizen>
250         </member>
251         <member name="F:Tizen.Uix.Stt.ResultMessage.TooQuiet">
252             <summary>
253             Recognition failed  because the speech is too quiet to listen.
254             </summary>
255             <since_tizen> 3 </since_tizen>
256         </member>
257         <member name="F:Tizen.Uix.Stt.ResultMessage.TooLoud">
258             <summary>
259             Recognition failed  because the speech is too loud to listen.
260             </summary>
261             <since_tizen> 3 </since_tizen>
262         </member>
263         <member name="F:Tizen.Uix.Stt.ResultMessage.TooFast">
264             <summary>
265             Recognition failed  because the speech is too fast to listen.
266             </summary>
267             <since_tizen> 3 </since_tizen>
268         </member>
269         <member name="T:Tizen.Uix.Stt.TimeEvent">
270             <summary>
271             Enumeration for the token types.
272             </summary>
273             <since_tizen> 3 </since_tizen>
274         </member>
275         <member name="F:Tizen.Uix.Stt.TimeEvent.Beginning">
276             <summary>
277             Event when the token is beginning type.
278             </summary>
279             <since_tizen> 3 </since_tizen>
280         </member>
281         <member name="F:Tizen.Uix.Stt.TimeEvent.Middle">
282             <summary>
283             Event when the token is middle type.
284             </summary>
285             <since_tizen> 3 </since_tizen>
286         </member>
287         <member name="F:Tizen.Uix.Stt.TimeEvent.End">
288             <summary>
289             Event when the token is end type.
290             </summary>
291             <since_tizen> 3 </since_tizen>
292         </member>
293         <member name="T:Tizen.Uix.Stt.Error">
294             <summary>
295             Enumeration for the error values that can occur.
296             </summary>
297             <since_tizen> 3 </since_tizen>
298         </member>
299         <member name="F:Tizen.Uix.Stt.Error.None">
300             <summary>
301             Successful, No error.
302             </summary>
303             <since_tizen> 3 </since_tizen>
304         </member>
305         <member name="F:Tizen.Uix.Stt.Error.OutOfMemory">
306             <summary>
307             Out of Memory.
308             </summary>
309             <since_tizen> 3 </since_tizen>.
310         </member>
311         <member name="F:Tizen.Uix.Stt.Error.IoError">
312             <summary>
313             I/O error.
314             </summary>
315             <since_tizen> 3 </since_tizen>.
316         </member>
317         <member name="F:Tizen.Uix.Stt.Error.InvalidParameter">
318             <summary>
319             Invalid parameter.
320             </summary>
321             <since_tizen> 3 </since_tizen>
322         </member>
323         <member name="F:Tizen.Uix.Stt.Error.TimedOut">
324             <summary>
325             No answer from the STT service.
326             </summary>
327             <since_tizen> 3 </since_tizen>
328         </member>
329         <member name="F:Tizen.Uix.Stt.Error.RecorderBusy">
330             <summary>
331             Device or resource busy.
332             </summary>
333             <since_tizen> 3 </since_tizen>
334         </member>
335         <member name="F:Tizen.Uix.Stt.Error.OutOfNetwork">
336             <summary>
337             Network is down.
338             </summary>
339             <since_tizen> 3 </since_tizen>
340         </member>
341         <member name="F:Tizen.Uix.Stt.Error.PermissionDenied">
342             <summary>
343             Permission denied.
344             </summary>
345             <since_tizen> 3 </since_tizen>
346         </member>
347         <member name="F:Tizen.Uix.Stt.Error.NotSupported">
348             <summary>
349             STT NOT supported.
350             </summary>
351             <since_tizen> 3 </since_tizen>
352         </member>
353         <member name="F:Tizen.Uix.Stt.Error.InvalidState">
354             <summary>
355             Invalid state.
356             </summary>
357             <since_tizen> 3 </since_tizen>
358         </member>
359         <member name="F:Tizen.Uix.Stt.Error.InvalidLanguage">
360             <summary>
361             Invalid language.
362             </summary>
363             <since_tizen> 3 </since_tizen>
364         </member>
365         <member name="F:Tizen.Uix.Stt.Error.EngineNotFound">
366             <summary>
367             No available engine.
368             </summary>
369             <since_tizen> 3 </since_tizen>
370         </member>
371         <member name="F:Tizen.Uix.Stt.Error.OperationFailed">
372             <summary>
373             Operation failed.
374             </summary>
375             <since_tizen> 3 </since_tizen>
376         </member>
377         <member name="F:Tizen.Uix.Stt.Error.NotSupportedFeature">
378             <summary>
379             Not supported feature of current engine.
380             </summary>
381             <since_tizen> 3 </since_tizen>
382         </member>
383         <member name="F:Tizen.Uix.Stt.Error.RecordingTimedOut">
384             <summary>
385             Recording timed out.
386             </summary>
387             <since_tizen> 3 </since_tizen>
388         </member>
389         <member name="F:Tizen.Uix.Stt.Error.NoSpeech">
390             <summary>
391             No speech while recording.
392             </summary>
393             <since_tizen> 3 </since_tizen>
394         </member>
395         <member name="F:Tizen.Uix.Stt.Error.InProgressToReady">
396             <summary>
397             Progress to ready is not finished.
398             </summary>
399             <since_tizen> 3 </since_tizen>
400         </member>
401         <member name="F:Tizen.Uix.Stt.Error.InProgressToRecording">
402             <summary>
403             Progress to recording is not finished.
404             </summary>
405             <since_tizen> 3 </since_tizen>
406         </member>
407         <member name="F:Tizen.Uix.Stt.Error.InProgressToProcessing">
408             <summary>
409             Progress to processing is not finished.
410             </summary>
411             <since_tizen> 3 </since_tizen>
412         </member>
413         <member name="F:Tizen.Uix.Stt.Error.ServiceReset">
414             <summary>
415             Service reset.
416             </summary>
417             <since_tizen> 3 </since_tizen>
418         </member>
419         <member name="T:Tizen.Uix.Stt.RecognitionType">
420             <summary>
421             Enumeration for the recognition types.
422             </summary>
423             <since_tizen> 3 </since_tizen>
424         </member>
425         <member name="F:Tizen.Uix.Stt.RecognitionType.Free">
426             <summary>
427             Free form dictation.
428             </summary>
429             <since_tizen> 3 </since_tizen>
430         </member>
431         <member name="F:Tizen.Uix.Stt.RecognitionType.Partial">
432             <summary>
433             Continuous free dictation.
434             </summary>
435             <since_tizen> 3 </since_tizen>
436         </member>
437         <member name="F:Tizen.Uix.Stt.RecognitionType.Search">
438             <summary>
439             Search.
440             </summary>
441             <since_tizen> 3 </since_tizen>
442         </member>
443         <member name="F:Tizen.Uix.Stt.RecognitionType.WebSearch">
444             <summary>
445             Web search.
446             </summary>
447             <since_tizen> 3 </since_tizen>
448         </member>
449         <member name="F:Tizen.Uix.Stt.RecognitionType.Map">
450             <summary>
451             Map.
452             </summary>
453             <since_tizen> 3 </since_tizen>
454         </member>
455         <member name="T:Tizen.Uix.Stt.State">
456             <summary>
457             Enumeration for the state types.
458             </summary>
459             <since_tizen> 3 </since_tizen>
460         </member>
461         <member name="F:Tizen.Uix.Stt.State.Created">
462             <summary>
463             Created state.
464             </summary>
465             <since_tizen> 3 </since_tizen>
466         </member>
467         <member name="F:Tizen.Uix.Stt.State.Ready">
468             <summary>
469             Ready state.
470             </summary>
471             <since_tizen> 3 </since_tizen>
472         </member>
473         <member name="F:Tizen.Uix.Stt.State.Recording">
474             <summary>
475             Recording state.
476             </summary>
477             <since_tizen> 3 </since_tizen>
478         </member>
479         <member name="F:Tizen.Uix.Stt.State.Processing">
480             <summary>
481             Processing state.
482             </summary>
483             <since_tizen> 3 </since_tizen>
484         </member>
485         <member name="F:Tizen.Uix.Stt.State.Unavailable">
486             <summary>
487             Unavailable.
488             </summary>
489             <since_tizen> 3 </since_tizen>
490         </member>
491         <member name="T:Tizen.Uix.Stt.SilenceDetection">
492             <summary>
493             Enumeration for the silence detection types.
494             </summary>
495             <since_tizen> 3 </since_tizen>
496         </member>
497         <member name="F:Tizen.Uix.Stt.SilenceDetection.False">
498             <summary>
499             Silence detection type - False.
500             </summary>
501             <since_tizen> 3 </since_tizen>
502         </member>
503         <member name="F:Tizen.Uix.Stt.SilenceDetection.True">
504             <summary>
505             Silence detection type - True.
506             </summary>
507             <since_tizen> 3 </since_tizen>
508         </member>
509         <member name="F:Tizen.Uix.Stt.SilenceDetection.Auto">
510             <summary>
511             Silence detection type - Auto.
512             </summary>
513             <since_tizen> 3 </since_tizen>
514         </member>
515         <member name="T:Tizen.Uix.Stt.SttClient">
516             <summary>
517             A main function of Speech-To-Text (below STT) API recognizes sound data recorded by users.
518             After choosing a language, the applications will start recording and recognizing.
519             After recording, the applications will receive the recognized result.
520             The STT has a client-server for the service of multi-applications.
521             The STT service always works in the background as a server. If the service is not working, client library will invoke it and the client will communicate with it.
522             The service has engines and a recorder, so that the client does not have the recorder itself. Only the client request commands to the STT service for using STT.
523             </summary>
524             <since_tizen> 3 </since_tizen>
525         </member>
526         <member name="M:Tizen.Uix.Stt.SttClient.#ctor">
527             <summary>
528             Constructor to create a STT instance.
529             </summary>
530             <since_tizen> 3 </since_tizen>
531             <privilege>
532             http://tizen.org/privilege/recorder
533             </privilege>
534             <feature>
535             http://tizen.org/feature/speech.recognition
536             http://tizen.org/feature/microphone
537             </feature>
538             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>
539             <exception cref="T:System.OutOfMemoryException">This exception can be due to out of memory.</exception>
540             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
541             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
542         </member>
543         <member name="E:Tizen.Uix.Stt.SttClient.RecognitionResult">
544             <summary>
545             Event to be invoked when the recognition is done.
546             </summary>
547             <since_tizen> 3 </since_tizen>
548         </member>
549         <member name="E:Tizen.Uix.Stt.SttClient.StateChanged">
550             <summary>
551             Event to be invoked when the STT state changes.
552             </summary>
553             <since_tizen> 3 </since_tizen>
554         </member>
555         <member name="E:Tizen.Uix.Stt.SttClient.ErrorOccurred">
556             <summary>
557             Event to be invoked when an error occurs.
558             </summary>
559             <since_tizen> 3 </since_tizen>
560         </member>
561         <member name="E:Tizen.Uix.Stt.SttClient.DefaultLanguageChanged">
562             <summary>
563             Event to be invoked when the default language changes.
564             </summary>
565             <since_tizen> 3 </since_tizen>
566         </member>
567         <member name="E:Tizen.Uix.Stt.SttClient.EngineChanged">
568             <summary>
569             Event to be invoked to detect the engine change.
570             </summary>
571             <since_tizen> 3 </since_tizen>
572         </member>
573         <member name="P:Tizen.Uix.Stt.SttClient.DefaultLanguage">
574             <summary>
575             Gets the default language set by the user.
576             The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code.
577             For example, "ko_KR" for Korean, "en_US" for American English.
578             </summary>
579             <since_tizen> 3 </since_tizen>
580             <value>
581             Default language in STT.
582             </value>
583             <privilege>
584             http://tizen.org/privilege/recorder
585             </privilege>
586             <returns>
587             Default Language string value.
588             </returns>
589         </member>
590         <member name="P:Tizen.Uix.Stt.SttClient.RecordingVolume">
591             <summary>
592             Gets the microphone volume during recording.
593             </summary>
594             <since_tizen> 3 </since_tizen>
595             <value>
596             Recording volume in STT.
597             </value>
598             <privilege>
599             http://tizen.org/privilege/recorder
600             </privilege>
601             <pre>
602             The state must be recording.
603             </pre>
604         </member>
605         <member name="P:Tizen.Uix.Stt.SttClient.CurrentState">
606             <summary>
607             Gets the current STT state.
608             </summary>
609             <since_tizen> 3 </since_tizen>
610             <value>
611             Current state of STT.
612             </value>
613             <privilege>
614             http://tizen.org/privilege/recorder
615             </privilege>
616             <returns>
617             Current STT state value.
618             </returns>
619         </member>
620         <member name="P:Tizen.Uix.Stt.SttClient.Engine">
621             <summary>
622             This property can be used to get and set the current engine id.
623             </summary>
624             <since_tizen> 3 </since_tizen>
625             <value>
626             Current STT engine id.
627             </value>
628             <privilege>
629             http://tizen.org/privilege/recorder
630             </privilege>
631             <exception cref="T:System.InvalidOperationException">
632             This exceptioncan occur while setting due to the following reasons:
633             1. Operation Failed
634             2. Invalid State
635             </exception>
636             <exception cref="T:System.OutOfMemoryException">This exception can be due to out of memory.</exception>
637             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
638             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
639             <exception cref="T:System.ArgumentException">This can happen if improper EngineId is provided while setting the value.</exception>
640             <pre>
641             The state must be created.
642             </pre>
643         </member>
644         <member name="M:Tizen.Uix.Stt.SttClient.GetDetailedResult">
645             <summary>
646             Retrieves the time stamp of the current recognition result.
647             </summary>
648             <since_tizen> 3 </since_tizen>
649             <returns>
650             List of ResultTime.
651             </returns>
652             <privilege>
653             http://tizen.org/privilege/recorder
654             </privilege>
655             <feature>
656             http://tizen.org/feature/speech.recognition
657             http://tizen.org/feature/microphone
658             </feature>
659             <remarks>
660             This function should only be called in the RecognitionResult event.
661             </remarks>
662             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>
663             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
664             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
665         </member>
666         <member name="M:Tizen.Uix.Stt.SttClient.GetPrivateData(System.String)">
667             <summary>
668             Gets the private data from the STT engine.
669             </summary>
670             <since_tizen> 3 </since_tizen>
671             <param name="key">
672             The key string.
673             </param>
674             <returns>
675             The data corresponding to the key is provided.
676             </returns>
677             <privilege>
678             http://tizen.org/privilege/recorder
679             </privilege>
680             <feature>
681             http://tizen.org/feature/speech.recognition
682             http://tizen.org/feature/microphone
683             </feature>
684             <exception cref="T:System.InvalidOperationException">This exception can be due to invalid state.</exception>
685             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
686             <exception cref="T:System.TimeoutException">This exception can be due to No Answer from STT Service.</exception>
687             <pre>
688             The state must be ready.
689             </pre>
690         </member>
691         <member name="M:Tizen.Uix.Stt.SttClient.SetPrivateData(System.String,System.String)">
692             <summary>
693             Sets the private data to the STT engine.
694             </summary>
695             <since_tizen> 3 </since_tizen>
696             <param name="key">
697             The key string.
698             </param>
699             <param name="data">
700             The data string.
701             </param>
702             <privilege>
703             http://tizen.org/privilege/recorder
704             </privilege>
705             <feature>
706             http://tizen.org/feature/speech.recognition
707             http://tizen.org/feature/microphone
708             </feature>
709             <exception cref="T:System.InvalidOperationException">This exception can be due to invalid state.</exception>
710             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
711             <exception cref="T:System.TimeoutException">This exception can be due to No Answer from STT Service.</exception>
712             <exception cref="T:System.ArgumentException"> This can happen if Improper value is provided while setting the value. </exception>
713             <pre>
714             The state must be ready.
715             </pre>
716         </member>
717         <member name="M:Tizen.Uix.Stt.SttClient.GetSupportedEngines">
718             <summary>
719             Gets the list of supported engines.
720             </summary>
721             <since_tizen> 3 </since_tizen>
722             <returns>
723             IEnumerable&lt;SupportedEngine&gt; list of supported engines.
724             </returns>
725             <privilege>
726             http://tizen.org/privilege/recorder
727             </privilege>
728             <feature>
729             http://tizen.org/feature/speech.recognition
730             http://tizen.org/feature/microphone
731             </feature>
732             <exception cref="T:System.InvalidOperationException">This exception can be due to operation failed.</exception>
733             <exception cref="T:System.OutOfMemoryException">This exception can be due to out of memory.</exception>
734             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
735             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
736         </member>
737         <member name="M:Tizen.Uix.Stt.SttClient.SetCredential(System.String)">
738             <summary>
739             Sets the application credential.
740             </summary>
741             <since_tizen> 3 </since_tizen>
742             <param name="credential">
743             The credential string.
744             </param>
745             <privilege>
746             http://tizen.org/privilege/recorder
747             </privilege>
748             <feature>
749             http://tizen.org/feature/speech.recognition
750             http://tizen.org/feature/microphone
751             </feature>
752             <exception cref="T:System.InvalidOperationException">
753             This exceptioncan be due to the following reasons:
754             1. Operation Failed
755             2. Invalid State
756             </exception>
757             <exception cref="T:System.OutOfMemoryException">This exception can be due to out of memory.</exception>
758             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
759             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
760             <exception cref="T:System.ArgumentException"> This can happen if Improper value is provided while setting the value. </exception>
761             <pre>
762             The state must be created.
763             </pre>
764         </member>
765         <member name="M:Tizen.Uix.Stt.SttClient.Prepare">
766             <summary>
767             Connects to the STT service asynchronously.
768             </summary>
769             <since_tizen> 3 </since_tizen>
770             <privilege>
771             http://tizen.org/privilege/recorder
772             </privilege>
773             <feature>
774             http://tizen.org/feature/speech.recognition
775             http://tizen.org/feature/microphone
776             </feature>
777             <exception cref="T:System.InvalidOperationException">This exception can be due to invalid state.</exception>
778             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
779             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
780             <pre>
781             The state must be created.
782             </pre>
783             <post>
784             If this function is successful, the STT state will be ready.
785             If this function is unsuccessful, ErrorOccurred event will be invoked.
786             </post>
787         </member>
788         <member name="M:Tizen.Uix.Stt.SttClient.Unprepare">
789             <summary>
790             Disconnects from the STT service.
791             </summary>
792             <since_tizen> 3 </since_tizen>
793             <privilege>
794             http://tizen.org/privilege/recorder
795             </privilege>
796             <feature>
797             http://tizen.org/feature/speech.recognition
798             http://tizen.org/feature/microphone
799             </feature>
800             <exception cref="T:System.InvalidOperationException">This exception can be due to invalid state.</exception>
801             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
802             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
803             <pre>
804             The state must be ready.
805             </pre>
806             <post>
807             If this function is successful, the STT state will be Created.
808             </post>
809         </member>
810         <member name="M:Tizen.Uix.Stt.SttClient.GetSupportedLanguages">
811             <summary>
812             Retrieves all the supported languages of the current engine.
813             The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code.
814             For example, "ko_KR" for Korean, "en_US" for American English.
815             </summary>
816             <since_tizen> 3 </since_tizen>
817             <privilege>
818             http://tizen.org/privilege/recorder
819             </privilege>
820             <returns>
821             List of strings for supported languages.
822             </returns>
823             <feature>
824             http://tizen.org/feature/speech.recognition
825             http://tizen.org/feature/microphone
826             </feature>
827             <exception cref="T:System.InvalidOperationException">
828             This exception can be due to the following reasons:
829             1. Engine Not Found.
830             2. Operation Failed.
831             </exception>
832             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
833             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
834         </member>
835         <member name="M:Tizen.Uix.Stt.SttClient.IsRecognitionTypeSupported(Tizen.Uix.Stt.RecognitionType)">
836             <summary>
837             Checks whether the recognition type is supported.
838             </summary>
839             <since_tizen> 3 </since_tizen>
840             <privilege>
841             http://tizen.org/privilege/recorder
842             </privilege>
843             <param name="type">
844             RecognitionType value.
845             </param>
846             <returns>
847             Bool value indicating whether the recognition type is supported.
848             </returns>
849             <feature>
850             http://tizen.org/feature/speech.recognition
851             http://tizen.org/feature/microphone
852             </feature>
853             <exception cref="T:System.InvalidOperationException">
854             This exception can be due to the following reasons:
855             1. Invalid State
856             2. Engine Not Found
857             3. Operation Failed
858             </exception>
859             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
860             <pre>
861             The state should be ready.
862             </pre>
863         </member>
864         <member name="M:Tizen.Uix.Stt.SttClient.SetSilenceDetection(Tizen.Uix.Stt.SilenceDetection)">
865             <summary>
866             Sets the silence detection.
867             </summary>
868             <since_tizen> 3 </since_tizen>
869             <privilege>
870             http://tizen.org/privilege/recorder
871             </privilege>
872             <param name="type">
873             SilenceDetection value.
874             </param>
875             <feature>
876             http://tizen.org/feature/speech.recognition
877             http://tizen.org/feature/microphone
878             </feature>
879             <exception cref="T:System.InvalidOperationException">
880             This exception can be due to the following reasons:
881             1. Invalid State
882             2. Not supported feature of current engine
883             3. Operation Failed
884             </exception>
885             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
886             <pre>
887             The state should be ready.
888             </pre>
889         </member>
890         <member name="M:Tizen.Uix.Stt.SttClient.SetStartSound(System.String)">
891             <summary>
892             Sets the sound to start recording.
893             Sound file type should be .wav type.
894             </summary>
895             <since_tizen> 3 </since_tizen>
896             <privilege>
897             http://tizen.org/privilege/recorder
898             </privilege>
899             <param name="filePath">
900             File path for the sound.
901             </param>
902             <feature>
903             http://tizen.org/feature/speech.recognition
904             http://tizen.org/feature/microphone
905             </feature>
906             <exception cref="T:System.InvalidOperationException">
907             This exception can be due to the following reasons:
908             1. Invalid State
909             2. Operation Failed
910             </exception>
911             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
912             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
913             <exception cref="T:System.ArgumentException"> If an Invalid Parameter is provided. </exception>
914             <pre>
915             The state should be ready.
916             </pre>
917         </member>
918         <member name="M:Tizen.Uix.Stt.SttClient.UnsetStartSound">
919             <summary>
920             Unsets the sound to start recording.
921             </summary>
922             <since_tizen> 3 </since_tizen>
923             <privilege>
924             http://tizen.org/privilege/recorder
925             </privilege>
926             <feature>
927             http://tizen.org/feature/speech.recognition
928             http://tizen.org/feature/microphone
929             </feature>
930             <exception cref="T:System.InvalidOperationException">
931             This exception can be due to the following reasons:
932             1. Invalid State
933             2. Operation Failed
934             </exception>
935             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
936             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
937             <pre>
938             The state should be ready.
939             </pre>
940         </member>
941         <member name="M:Tizen.Uix.Stt.SttClient.SetStopSound(System.String)">
942             <summary>
943             Sets the sound to stop recording.
944             Sound file type should be .wav type.
945             </summary>
946             <since_tizen> 3 </since_tizen>
947             <privilege>
948             http://tizen.org/privilege/recorder
949             </privilege>
950             <param name="filePath">
951             File Path for the sound.
952             </param>
953             <feature>
954             http://tizen.org/feature/speech.recognition
955             http://tizen.org/feature/microphone
956             </feature>
957             <exception cref="T:System.InvalidOperationException">
958             This exception can be due to the following reasons:
959             1. Invalid State
960             2. Operation Failed
961             </exception>
962             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
963             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
964             <exception cref="T:System.ArgumentException">This exception can be due to Invalid Parameter.</exception>
965             <pre>
966             The state should be ready.
967             </pre>
968         </member>
969         <member name="M:Tizen.Uix.Stt.SttClient.UnsetStopSound">
970             <summary>
971             Unsets the sound to stop recording.
972             </summary>
973             <since_tizen> 3 </since_tizen>
974             <privilege>
975             http://tizen.org/privilege/recorder
976             </privilege>
977             <feature>
978             http://tizen.org/feature/speech.recognition
979             http://tizen.org/feature/microphone
980             </feature>
981             <exception cref="T:System.InvalidOperationException">
982             This exception can be due to the following reasons:
983             1. Invalid State
984             2. Operation Failed
985             </exception>
986             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
987             <exception cref="T:System.UnauthorizedAccessException"> his exception can be due to permission denied.</exception>
988             <pre>
989             The state should be ready.
990             </pre>
991         </member>
992         <member name="M:Tizen.Uix.Stt.SttClient.Start(System.String,Tizen.Uix.Stt.RecognitionType)">
993             <summary>
994             Starts the recording and recognition asynchronously.
995             This function starts recording in the STT service and sends the recording data to the engine.
996             This work continues until stop, cancel, or silence is detected by engine.
997             </summary>
998             <since_tizen> 3 </since_tizen>
999             <privilege>
1000             http://tizen.org/privilege/recorder
1001             </privilege>
1002             <param name="language">
1003             The language selected.
1004             </param>
1005             <param name="type">
1006             The type for recognition.
1007             </param>
1008             <feature>
1009             http://tizen.org/feature/speech.recognition
1010             http://tizen.org/feature/microphone
1011             </feature>
1012             <exception cref="T:System.InvalidOperationException">
1013             This exception can be due to the following reasons:
1014             1. Invalid State
1015             2. Operation Failed
1016             3. Recorder Busy
1017             4. Progress to recording is not finished
1018             </exception>
1019             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
1020             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
1021             <exception cref="T:System.ArgumentException">This exception can be due to an invalid language.</exception>
1022             <pre>
1023             The state should be ready.
1024             </pre>
1025             <post>
1026             It will invoke the StateChanged event, if registered.
1027             If this function succeeds, the STT state will be recording.
1028             If you call this function again before the state changes, you will receive ErrorINProgressToRecording.
1029             </post>
1030         </member>
1031         <member name="M:Tizen.Uix.Stt.SttClient.Stop">
1032             <summary>
1033             Finishes the recording and starts recognition processing in the engine asynchronously.
1034             </summary>
1035             <since_tizen> 3 </since_tizen>
1036             <privilege>
1037             http://tizen.org/privilege/recorder
1038             </privilege>
1039             <feature>
1040             http://tizen.org/feature/speech.recognition
1041             http://tizen.org/feature/microphone
1042             </feature>
1043             <exception cref="T:System.InvalidOperationException">
1044             This exception can be due to the following reasons:
1045             1. Invalid State
1046             2. Operation Failed
1047             3. Progress to ready is not finished
1048             4. Progress to recording is not finished
1049             5. Progress to processing is not finished
1050             </exception>
1051             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
1052             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
1053             <pre>
1054             The state should be Recording.
1055             </pre>
1056             <post>
1057             It will invoke the StateChanged Event, if registered.
1058             If this function succeeds, the STT state will be processing.
1059             If you call this function again before the state changes, you will receive ErrorINProgressToProcessing.
1060             After processing of engine, the RecognitionResult event is invoked.
1061             </post>
1062         </member>
1063         <member name="M:Tizen.Uix.Stt.SttClient.Cancel">
1064             <summary>
1065             Cancels processing the recognition and recording asynchronously.
1066             This function cancels recording and the engine cancels recognition processing.
1067             After successful cancellation, the StateChanged event is invoked, otherwise if an error is occurs, the ErrorOccurred event is invoked.
1068             </summary>
1069             <since_tizen> 3 </since_tizen>
1070             <privilege>
1071             http://tizen.org/privilege/recorder
1072             </privilege>
1073             <feature>
1074             http://tizen.org/feature/speech.recognition
1075             http://tizen.org/feature/microphone
1076             </feature>
1077             <exception cref="T:System.InvalidOperationException">
1078             This exception can be due to the following reasons:
1079             1. Invalid State
1080             2. Operation Failed
1081             3. Progress to ready is not finished
1082             4. Progress to recording is not finished
1083             5. Progress to processing is not finished
1084             </exception>
1085             <exception cref="T:System.NotSupportedException">This exception can be due to STT not supported.</exception>
1086             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
1087             <pre>
1088             The state should be Recording or Processing.
1089             </pre>
1090             <post>
1091             It will invoke the StateChanged event, if registered.
1092             If this function succeeds, the STT state will be ready.
1093             If you call this function again before the state changes, you will receive ErrorINProgressToReady.
1094             </post>
1095         </member>
1096         <member name="M:Tizen.Uix.Stt.SttClient.Dispose">
1097             <summary>
1098             A method to release resources.
1099             </summary>
1100         </member>
1101         <member name="T:Tizen.Uix.Stt.SupportedEngine">
1102             <summary>
1103             This class provides the information related to STT engine.
1104             </summary>
1105             <since_tizen> 3 </since_tizen>
1106         </member>
1107         <member name="P:Tizen.Uix.Stt.SupportedEngine.EngineId">
1108             <summary>
1109             The engine ID.
1110             </summary>
1111             <since_tizen> 3 </since_tizen>
1112             <returns>
1113             The string engine ID.
1114             </returns>
1115         </member>
1116         <member name="P:Tizen.Uix.Stt.SupportedEngine.EngineName">
1117             <summary>
1118             The engine name.
1119             </summary>
1120             <since_tizen> 3 </since_tizen>
1121             <returns>
1122             The string engine name.
1123             </returns>
1124         </member>
1125     </members>
1126 </doc>