Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Uix.Tts.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Uix.Tts</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         </member>\r
15         <member name="T:Interop.Libraries">\r
16             <summary>\r
17             Partial libraries class.\r
18             </summary>\r
19         </member>\r
20         <member name="T:Interop.Tts">\r
21             <summary>\r
22             Tts interop class.\r
23             </summary>\r
24         </member>\r
25         <!-- "F:Interop.Tts.TtsError.OutOfMemory" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
26         <!-- "F:Interop.Tts.TtsError.IoError" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
27         <!-- "F:Interop.Tts.TtsError.InvalidParameter" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
28         <!-- "F:Interop.Tts.TtsError.OutOfNetwork" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
29         <!-- "F:Interop.Tts.TtsError.TimedOut" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
30         <!-- "F:Interop.Tts.TtsError.PermissionDenied" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
31         <!-- "F:Interop.Tts.TtsError.NotSupported" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
32         <!-- "F:Interop.Tts.TtsError.InvalidState" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
33         <!-- "F:Interop.Tts.TtsError.InvalidVoice" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
34         <!-- "F:Interop.Tts.TtsError.EngineNotFound" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
35         <!-- "F:Interop.Tts.TtsError.OperationFailed" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
36         <!-- "F:Interop.Tts.TtsError.AudioPolicyBlocked" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
37         <!-- "F:Interop.Tts.TtsError.NotSupportedFeature" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
38         <!-- "F:Interop.Tts.TtsError.ServiceReset" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
39         <member name="T:Tizen.Uix.Tts.DefaultVoiceChangedEventArgs">\r
40             <summary>\r
41             This class holds information related to the DefaultVoiceChanged event.\r
42             </summary>\r
43             <since_tizen> 3 </since_tizen>\r
44         </member>\r
45         <member name="P:Tizen.Uix.Tts.DefaultVoiceChangedEventArgs.Previous">\r
46             <summary>\r
47             The previous SupportedVoice.\r
48             </summary>\r
49             <since_tizen> 3 </since_tizen>\r
50         </member>\r
51         <member name="P:Tizen.Uix.Tts.DefaultVoiceChangedEventArgs.Current">\r
52             <summary>\r
53             The current SupportedVoice.\r
54             </summary>\r
55             <since_tizen> 3 </since_tizen>\r
56         </member>\r
57         <member name="T:Tizen.Uix.Tts.EngineChangedEventArgs">\r
58             <summary>\r
59             This class holds information related to the EngineChanged event.\r
60             </summary>\r
61             <since_tizen> 3 </since_tizen>\r
62         </member>\r
63         <member name="P:Tizen.Uix.Tts.EngineChangedEventArgs.EngineId">\r
64             <summary>\r
65             The engine ID.\r
66             </summary>\r
67             <since_tizen> 3 </since_tizen>\r
68         </member>\r
69         <member name="P:Tizen.Uix.Tts.EngineChangedEventArgs.NeedCredential">\r
70             <summary>\r
71             The necessity of the credential.\r
72             </summary>\r
73             <since_tizen> 3 </since_tizen>\r
74         </member>\r
75         <member name="P:Tizen.Uix.Tts.EngineChangedEventArgs.VoiceType">\r
76             <summary>\r
77             The supported voice.\r
78             </summary>\r
79             <since_tizen> 3 </since_tizen>\r
80         </member>\r
81         <member name="T:Tizen.Uix.Tts.ErrorOccurredEventArgs">\r
82             <summary>\r
83             This class holds information related to the TTS ErrorOccurred event.\r
84             </summary>\r
85             <since_tizen> 3 </since_tizen>\r
86         </member>\r
87         <member name="P:Tizen.Uix.Tts.ErrorOccurredEventArgs.UtteranceId">\r
88             <summary>\r
89             The utterance ID.\r
90             </summary>\r
91             <since_tizen> 3 </since_tizen>\r
92         </member>\r
93         <member name="P:Tizen.Uix.Tts.ErrorOccurredEventArgs.ErrorValue">\r
94             <summary>\r
95             The error value.\r
96             </summary>\r
97             <since_tizen> 3 </since_tizen>\r
98         </member>\r
99         <member name="P:Tizen.Uix.Tts.ErrorOccurredEventArgs.ErrorMessage">\r
100             <summary>\r
101             Gets the current error message.\r
102             </summary>\r
103             <since_tizen> 3 </since_tizen>\r
104             <returns>\r
105             String error message.\r
106             </returns>\r
107         </member>\r
108         <member name="T:Tizen.Uix.Tts.SpeedRange">\r
109             <summary>\r
110             This class holds the speed range values.\r
111             </summary>\r
112             <since_tizen> 3 </since_tizen>\r
113         </member>\r
114         <member name="P:Tizen.Uix.Tts.SpeedRange.Max">\r
115             <summary>\r
116             The max speed range value.\r
117             </summary>\r
118             <since_tizen> 3 </since_tizen>\r
119         </member>\r
120         <member name="P:Tizen.Uix.Tts.SpeedRange.Min">\r
121             <summary>\r
122             The min speed range value.\r
123             </summary>\r
124             <since_tizen> 3 </since_tizen>\r
125         </member>\r
126         <member name="P:Tizen.Uix.Tts.SpeedRange.Normal">\r
127             <summary>\r
128             The normal speed range value.\r
129             </summary>\r
130             <since_tizen> 3 </since_tizen>\r
131         </member>\r
132         <member name="T:Tizen.Uix.Tts.StateChangedEventArgs">\r
133             <summary>\r
134             This class holds information related to the TTS StateChanged event.\r
135             </summary>\r
136             <since_tizen> 3 </since_tizen>\r
137         </member>\r
138         <member name="P:Tizen.Uix.Tts.StateChangedEventArgs.Previous">\r
139             <summary>\r
140             The previous state.\r
141             </summary>\r
142             <since_tizen> 3 </since_tizen>\r
143         </member>\r
144         <member name="P:Tizen.Uix.Tts.StateChangedEventArgs.Current">\r
145             <summary>\r
146             The current state.\r
147             </summary>\r
148             <since_tizen> 3 </since_tizen>\r
149         </member>\r
150         <member name="T:Tizen.Uix.Tts.SupportedVoice">\r
151             <summary>\r
152             This class holds information about the supported voices.\r
153             </summary>\r
154             <since_tizen> 3 </since_tizen>\r
155         </member>\r
156         <member name="P:Tizen.Uix.Tts.SupportedVoice.Language">\r
157             <summary>\r
158             Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English).\r
159             </summary>\r
160             <since_tizen> 3 </since_tizen>\r
161         </member>\r
162         <member name="T:Tizen.Uix.Tts.State">\r
163             <summary>\r
164             Enumeration for the states.\r
165             </summary>\r
166             <since_tizen> 3 </since_tizen>\r
167         </member>\r
168         <member name="F:Tizen.Uix.Tts.State.Created">\r
169             <summary>\r
170              Created state.\r
171             </summary>\r
172             <since_tizen> 3 </since_tizen>\r
173         </member>\r
174         <member name="F:Tizen.Uix.Tts.State.Ready">\r
175             <summary>\r
176             Ready state.\r
177             </summary>\r
178             <since_tizen> 3 </since_tizen>\r
179         </member>\r
180         <member name="F:Tizen.Uix.Tts.State.Playing">\r
181             <summary>\r
182             Playing state.\r
183             </summary>\r
184             <since_tizen> 3 </since_tizen>\r
185         </member>\r
186         <member name="F:Tizen.Uix.Tts.State.Paused">\r
187             <summary>\r
188             Paused state.\r
189             </summary>\r
190             <since_tizen> 3 </since_tizen>\r
191         </member>\r
192         <member name="F:Tizen.Uix.Tts.State.Unavailable">\r
193             <summary>\r
194             Unavailable state.\r
195             </summary>\r
196             <since_tizen> 3 </since_tizen>\r
197         </member>\r
198         <member name="T:Tizen.Uix.Tts.Mode">\r
199             <summary>\r
200             Enumeration for TTS mode.\r
201             </summary>\r
202             <since_tizen> 3 </since_tizen>\r
203         </member>\r
204         <member name="F:Tizen.Uix.Tts.Mode.Default">\r
205             <summary>\r
206             Default mode for normal application.\r
207             </summary>\r
208             <since_tizen> 3 </since_tizen>\r
209         </member>\r
210         <member name="F:Tizen.Uix.Tts.Mode.Notification">\r
211             <summary>\r
212             Notification mode.\r
213             </summary>\r
214             <since_tizen> 3 </since_tizen>\r
215         </member>\r
216         <member name="F:Tizen.Uix.Tts.Mode.ScreenReader">\r
217             <summary>\r
218             Accessibility mode.\r
219             </summary>\r
220             <since_tizen> 3 </since_tizen>\r
221         </member>\r
222         <member name="T:Tizen.Uix.Tts.Error">\r
223             <summary>\r
224             Enumeration for error values that can occur.\r
225             </summary>\r
226             <since_tizen> 3 </since_tizen>\r
227         </member>\r
228         <member name="F:Tizen.Uix.Tts.Error.None">\r
229             <summary>\r
230             Successful, no error.\r
231             </summary>\r
232             <since_tizen> 3 </since_tizen>\r
233         </member>\r
234         <member name="F:Tizen.Uix.Tts.Error.OutOfMemory">\r
235             <summary>\r
236             Out of memory.\r
237             </summary>\r
238             <since_tizen> 3 </since_tizen>\r
239         </member>\r
240         <member name="F:Tizen.Uix.Tts.Error.IoError">\r
241             <summary>\r
242             I/O error.\r
243             </summary>\r
244             <since_tizen> 3 </since_tizen>\r
245         </member>\r
246         <member name="F:Tizen.Uix.Tts.Error.InvalidParameter">\r
247             <summary>\r
248             Invalid parameter.\r
249             </summary>\r
250             <since_tizen> 3 </since_tizen>\r
251         </member>\r
252         <member name="F:Tizen.Uix.Tts.Error.TimedOut">\r
253             <summary>\r
254             No answer from the STT service.\r
255             </summary>\r
256             <since_tizen> 3 </since_tizen>\r
257         </member>\r
258         <member name="F:Tizen.Uix.Tts.Error.OutOfNetwork">\r
259             <summary>\r
260             Network is down.\r
261             </summary>\r
262             <since_tizen> 3 </since_tizen>\r
263         </member>\r
264         <member name="F:Tizen.Uix.Tts.Error.PermissionDenied">\r
265             <summary>\r
266             Permission denied.\r
267             </summary>\r
268             <since_tizen> 3 </since_tizen>\r
269         </member>\r
270         <member name="F:Tizen.Uix.Tts.Error.NotSupported">\r
271             <summary>\r
272             STT not supported.\r
273             </summary>\r
274             <since_tizen> 3 </since_tizen>\r
275         </member>\r
276         <member name="F:Tizen.Uix.Tts.Error.InvalidState">\r
277             <summary>\r
278             Invalid state.\r
279             </summary>\r
280             <since_tizen> 3 </since_tizen>\r
281         </member>\r
282         <member name="F:Tizen.Uix.Tts.Error.InvalidVoice">\r
283             <summary>\r
284             Invalid voice.\r
285             </summary>\r
286             <since_tizen> 3 </since_tizen>\r
287         </member>\r
288         <member name="F:Tizen.Uix.Tts.Error.EngineNotFound">\r
289             <summary>\r
290             No available engine.\r
291             </summary>\r
292             <since_tizen> 3 </since_tizen>\r
293         </member>\r
294         <member name="F:Tizen.Uix.Tts.Error.OperationFailed">\r
295             <summary>\r
296             Operation failed.\r
297             </summary>\r
298             <since_tizen> 3 </since_tizen>\r
299         </member>\r
300         <member name="F:Tizen.Uix.Tts.Error.AudioPolicyBlocked">\r
301             <summary>\r
302             Audio policy blocked.\r
303             </summary>\r
304             <since_tizen> 3 </since_tizen>\r
305         </member>\r
306         <member name="T:Tizen.Uix.Tts.Voice">\r
307             <summary>\r
308             Enumeration for the voice types.\r
309             </summary>\r
310             <since_tizen> 3 </since_tizen>\r
311         </member>\r
312         <member name="F:Tizen.Uix.Tts.Voice.Auto">\r
313             <summary>\r
314             The automatic voice type.\r
315             </summary>\r
316             <since_tizen> 3 </since_tizen>\r
317         </member>\r
318         <member name="F:Tizen.Uix.Tts.Voice.Male">\r
319             <summary>\r
320             The male voice type.\r
321             </summary>\r
322             <since_tizen> 3 </since_tizen>\r
323         </member>\r
324         <member name="F:Tizen.Uix.Tts.Voice.Female">\r
325             <summary>\r
326             The female voice type.\r
327             </summary>\r
328             <since_tizen> 3 </since_tizen>\r
329         </member>\r
330         <member name="F:Tizen.Uix.Tts.Voice.Child">\r
331             <summary>\r
332             The child voice type.\r
333             </summary>\r
334             <since_tizen> 3 </since_tizen>\r
335         </member>\r
336         <member name="T:Tizen.Uix.Tts.TtsClient">\r
337             <summary>\r
338             You can use Text-To-Speech (TTS) API's to read sound data transformed by the engine from input texts.\r
339             Applications can add input-text to queue for reading continuously and control the player that can play, pause, and stop sound data synthesized from text.\r
340             </summary>\r
341             <since_tizen> 3 </since_tizen>\r
342         </member>\r
343         <member name="M:Tizen.Uix.Tts.TtsClient.#ctor">\r
344             <summary>\r
345             Constructor to create a TTS instance.\r
346             </summary>\r
347             <since_tizen> 3 </since_tizen>\r
348             <feature>\r
349             http://tizen.org/feature/speech.synthesis\r
350             </feature>\r
351             <exception cref="T:System.InvalidOperationException">\r
352             This exception can be due to the following reasons:\r
353             1. Operation Failed\r
354             2. Engine Not Found\r
355             </exception>\r
356             <exception cref="T:System.OutOfMemoryException">This exception can be due to out Of memory.</exception>\r
357             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
358         </member>\r
359         <member name="E:Tizen.Uix.Tts.TtsClient.StateChanged">\r
360             <summary>\r
361             Event to be invoked when TTS state changes.\r
362             </summary>\r
363             <since_tizen> 3 </since_tizen>\r
364         </member>\r
365         <member name="E:Tizen.Uix.Tts.TtsClient.UtteranceStarted">\r
366             <summary>\r
367             Event to be invoked when the utterance starts.\r
368             </summary>\r
369             <since_tizen> 3 </since_tizen>\r
370         </member>\r
371         <member name="E:Tizen.Uix.Tts.TtsClient.UtteranceCompleted">\r
372             <summary>\r
373             Event to be invoked when the utterance completes.\r
374             </summary>\r
375             <since_tizen> 3 </since_tizen>\r
376         </member>\r
377         <member name="E:Tizen.Uix.Tts.TtsClient.ErrorOccurred">\r
378             <summary>\r
379             Event to be invoked when an error occurs.\r
380             </summary>\r
381             <since_tizen> 3 </since_tizen>\r
382         </member>\r
383         <member name="E:Tizen.Uix.Tts.TtsClient.DefaultVoiceChanged">\r
384             <summary>\r
385             Event to be invoked when an error occurs.\r
386             </summary>\r
387             <since_tizen> 3 </since_tizen>\r
388         </member>\r
389         <member name="E:Tizen.Uix.Tts.TtsClient.EngineChanged">\r
390             <summary>\r
391             Event to be invoked to detect engine change.\r
392             </summary>\r
393             <since_tizen> 3 </since_tizen>\r
394         </member>\r
395         <member name="P:Tizen.Uix.Tts.TtsClient.DefaultVoice">\r
396             <summary>\r
397             Gets the default voice set by the user.\r
398             </summary>\r
399             <since_tizen> 3 </since_tizen>\r
400             <value>\r
401             The default voice in TTS.\r
402             </value>\r
403             <returns>\r
404             The default voice SupportedVoice value.\r
405             </returns>\r
406         </member>\r
407         <member name="P:Tizen.Uix.Tts.TtsClient.MaxTextSize">\r
408             <summary>\r
409             Gets the maximum byte size for text.\r
410             </summary>\r
411             <since_tizen> 3 </since_tizen>\r
412             <value>\r
413             The Maximum byte size for text.\r
414             </value>\r
415             <returns>\r
416             The Default Voice SupportedVoice value, 0 if unable to get the value.\r
417             </returns>\r
418             <pre>\r
419             The State should be ready.\r
420             </pre>\r
421         </member>\r
422         <member name="P:Tizen.Uix.Tts.TtsClient.CurrentState">\r
423             <summary>\r
424             Gets the current TTS state.\r
425             </summary>\r
426             <since_tizen> 3 </since_tizen>\r
427             <value>\r
428             The current state of TTS.\r
429             </value>\r
430             <returns>\r
431             Current TTS State value.\r
432             </returns>\r
433         </member>\r
434         <member name="P:Tizen.Uix.Tts.TtsClient.CurrentMode">\r
435             <summary>\r
436             The TTS Mode can be set using this property.\r
437             </summary>\r
438             <since_tizen> 3 </since_tizen>\r
439             <value>\r
440             The current TTS mode (default, screen-reader, notification).\r
441             </value>\r
442             <returns>\r
443             The Mode value.\r
444             </returns>\r
445             <exception cref="T:System.InvalidOperationException">\r
446             This exception can be due to the following reasons while setting the value:\r
447             1. Operation Failed\r
448             2. Engine Not Found\r
449             </exception>\r
450             <exception cref="T:System.OutOfMemoryException">This exception can be due to out Of memory.</exception>\r
451             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
452             <pre>\r
453             The State should be created.\r
454             </pre>\r
455         </member>\r
456         <member name="M:Tizen.Uix.Tts.TtsClient.SetCredential(System.String)">\r
457             <summary>\r
458             Sets the application credential.\r
459             </summary>\r
460             <since_tizen> 3 </since_tizen>\r
461             <param name="credential">.\r
462             The credential string.\r
463             </param>\r
464             <feature>\r
465             http://tizen.org/feature/speech.synthesis\r
466             </feature>\r
467             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
468             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
469             <exception cref="T:System.ArgumentException">This exception can be due to improper value provided while setting the value.</exception>\r
470             <pre>\r
471             The State should be created or ready.\r
472             </pre>\r
473         </member>\r
474         <member name="M:Tizen.Uix.Tts.TtsClient.Prepare">\r
475             <summary>\r
476             Connects to the TTS service asynchronously.\r
477             </summary>\r
478             <since_tizen> 3 </since_tizen>\r
479             <feature>\r
480             http://tizen.org/feature/speech.synthesis\r
481             </feature>\r
482             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
483             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
484             <pre>\r
485             The State must be Created.\r
486             </pre>\r
487             <post>\r
488             If this function is successful, the TTS state will be ready.\r
489             If this function is unsuccessful, ErrorOccurred event will be invoked.\r
490             </post>\r
491         </member>\r
492         <member name="M:Tizen.Uix.Tts.TtsClient.Unprepare">\r
493             <summary>\r
494             Disconnects from the STT service.\r
495             </summary>\r
496             <since_tizen> 3 </since_tizen>\r
497             <feature>\r
498             http://tizen.org/feature/speech.synthesis\r
499             </feature>\r
500             <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>\r
501             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
502             <pre>\r
503             The state must be ready.\r
504             </pre>\r
505             <post>\r
506             If this function is successful, the TTS state will be created.\r
507             </post>\r
508         </member>\r
509         <member name="M:Tizen.Uix.Tts.TtsClient.GetSupportedVoices">\r
510             <summary>\r
511             Retrieves all supported voices of the current engine.\r
512             </summary>\r
513             <since_tizen> 3 </since_tizen>\r
514             <returns>\r
515             The list of SupportedVoice.\r
516             </returns>\r
517             <feature>\r
518             http://tizen.org/feature/speech.synthesis\r
519             </feature>\r
520             <exception cref="T:System.InvalidOperationException">\r
521             This exception can be due to the following reasons:\r
522             1. Engine Not Found\r
523             2. Operation Failed\r
524             </exception>\r
525             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
526         </member>\r
527         <member name="M:Tizen.Uix.Tts.TtsClient.GetPrivateData(System.String)">\r
528             <summary>\r
529             Gets the private data from TTS engine.\r
530             </summary>\r
531             <since_tizen> 3 </since_tizen>\r
532             <param name="key">\r
533             The key string.\r
534             </param>\r
535             <returns>\r
536             The data corresponding to the provided key.\r
537             </returns>\r
538             <feature>\r
539             http://tizen.org/feature/speech.synthesis\r
540             </feature>\r
541             <exception cref="T:System.InvalidOperationException">\r
542             This exception can be due to the following reasons:\r
543             1. Invalid State\r
544             2. Engine Not found\r
545             3. Operation Failure\r
546             </exception>\r
547             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
548             <pre>\r
549             The state must be ready.\r
550             </pre>\r
551         </member>\r
552         <member name="M:Tizen.Uix.Tts.TtsClient.SetPrivateData(System.String,System.String)">\r
553             <summary>\r
554             Sets the private data to tts engine.\r
555             </summary>\r
556             <since_tizen> 3 </since_tizen>\r
557             <param name="key">\r
558             The key string.\r
559             </param>\r
560             <param name="data">\r
561             The data string.\r
562             </param>\r
563             <feature>\r
564             http://tizen.org/feature/speech.synthesis\r
565             </feature>\r
566             <exception cref="T:System.InvalidOperationException">\r
567             This exception can be due to the following reasons:\r
568             1. Invalid State\r
569             2. Engine Not found\r
570             3. Operation Failure\r
571             </exception>\r
572             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
573             <exception cref="T:System.ArgumentException">This exception can be due to improper value provided while setting the value.</exception>\r
574             <pre>\r
575             The state must be ready.\r
576             </pre>\r
577         </member>\r
578         <member name="M:Tizen.Uix.Tts.TtsClient.GetSpeedRange">\r
579             <summary>\r
580             Gets the speed range.\r
581             </summary>\r
582             <since_tizen> 3 </since_tizen>\r
583             <returns>\r
584             The SpeedRange value.\r
585             </returns>\r
586             <feature>\r
587             http://tizen.org/feature/speech.synthesis\r
588             </feature>\r
589             <exception cref="T:System.InvalidOperationException">\r
590             This exception can be due to the following reasons:\r
591             1. Invalid State\r
592             2. Operation Failure\r
593             </exception>\r
594             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
595             <pre>\r
596             The state must be created.\r
597             </pre>\r
598         </member>\r
599         <member name="M:Tizen.Uix.Tts.TtsClient.AddText(System.String,System.String,System.Int32,System.Int32)">\r
600             <summary>\r
601             Adds a text to the queue.\r
602             </summary>\r
603             <since_tizen> 3 </since_tizen>\r
604             <remarks>\r
605             Locale MUST be set for UTF-8 text validation check.\r
606             </remarks>\r
607             <param name="text">\r
608             An input text based UTF-8.\r
609             </param>\r
610             <param name="language">\r
611             The language selected from the SupportedVoice.Language Property obtained from GetSupportedVoices()(e.g. 'NULL'(Automatic),'en_US').\r
612             </param>\r
613             <param name="voiceType">\r
614             The voice type selected from the SupportedVoice.VoiceType Property obtained from GetSupportedVoices().\r
615             </param>\r
616             <param name="speed">\r
617             A speaking speed (e.g.0 for Auto or the value from SpeedRange Property).\r
618             </param>\r
619             <returns>\r
620             The utterance ID.\r
621             </returns>\r
622             <feature>\r
623             http://tizen.org/feature/speech.synthesis\r
624             </feature>\r
625             <exception cref="T:System.InvalidOperationException">\r
626             This exception can be due to the following reasons:\r
627             1. Invalid State\r
628             2. Operation Failure\r
629             3. Invalid Voice\r
630             </exception>\r
631             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
632             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
633             <exception cref="T:System.ArgumentException">This exception can be due to improper value provided while setting the value.</exception>\r
634             <pre>\r
635             The state must be ready or playing or paused.\r
636             </pre>\r
637         </member>\r
638         <member name="M:Tizen.Uix.Tts.TtsClient.Play">\r
639             <summary>\r
640             Starts synthesizing voice from the text and plays the synthesized audio data.\r
641             </summary>\r
642             <since_tizen> 3 </since_tizen>\r
643             <feature>\r
644             http://tizen.org/feature/speech.synthesis\r
645             </feature>\r
646             <exception cref="T:System.InvalidOperationException">\r
647             This exception can be due to the following reasons:\r
648             1. Invalid State\r
649             2. Operation Failure\r
650             3. Out of Network\r
651             </exception>\r
652             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
653             <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>\r
654             <pre>\r
655             The state must be ready or paused.\r
656             </pre>\r
657             <post>\r
658             If this function succeeds, the TTS state will be playing.\r
659             </post>\r
660         </member>\r
661         <member name="M:Tizen.Uix.Tts.TtsClient.Stop">\r
662             <summary>\r
663             Stops playing the utterance and clears the queue.\r
664             </summary>\r
665             <since_tizen> 3 </since_tizen>\r
666             <feature>\r
667             http://tizen.org/feature/speech.synthesis\r
668             </feature>\r
669             <exception cref="T:System.InvalidOperationException">\r
670             This exception can be due to the following reasons:\r
671             1. Invalid Stat\r
672             2. Operation Failure\r
673             </exception>\r
674             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
675             <pre>\r
676             The state must be ready or playing or paused.\r
677             </pre>\r
678             <post>\r
679             If this function succeeds, the TTS state will be ready.\r
680             This function will remove all text added via AddText() and synthesized sound data.\r
681             </post>\r
682         </member>\r
683         <member name="M:Tizen.Uix.Tts.TtsClient.Pause">\r
684             <summary>\r
685             Pauses the currently playing utterance.\r
686             </summary>\r
687             <since_tizen> 3 </since_tizen>\r
688             <feature>\r
689             http://tizen.org/feature/speech.synthesis\r
690             </feature>\r
691             <exception cref="T:System.InvalidOperationException">\r
692             This exception can be due to the following reasons:\r
693             1. Invalid State\r
694             2. Operation Failure\r
695             </exception>\r
696             <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>\r
697             <pre>\r
698             The state must be playing.\r
699             </pre>\r
700             <post>\r
701             If this function succeeds, the TTS state will be Paused.\r
702             </post>\r
703         </member>\r
704         <member name="M:Tizen.Uix.Tts.TtsClient.Dispose">\r
705             <summary>\r
706             Method to release resources.\r
707             </summary>\r
708             <since_tizen> 3 </since_tizen>\r
709         </member>\r
710         <member name="T:Tizen.Uix.Tts.UtteranceEventArgs">\r
711             <summary>\r
712             This class holds information related to UtteranceStared and UtteranceCompleted events.\r
713             </summary>\r
714             <since_tizen> 3 </since_tizen>\r
715         </member>\r
716         <member name="P:Tizen.Uix.Tts.UtteranceEventArgs.UtteranceId">\r
717             <summary>\r
718             The utterance ID.\r
719             </summary>\r
720             <since_tizen> 3 </since_tizen>\r
721         </member>\r
722     </members>\r
723 </doc>\r