4 <name>Tizen.Uix.Tts</name>
7 <member name="T:Interop">
12 Partial interop class.
15 <member name="T:Interop.Libraries">
17 Partial libraries class.
20 <member name="T:Interop.Tts">
25 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.OutOfMemory" -->
26 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.IoError" -->
27 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.InvalidParameter" -->
28 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.OutOfNetwork" -->
29 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.TimedOut" -->
30 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.PermissionDenied" -->
31 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.NotSupported" -->
32 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.InvalidState" -->
33 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.InvalidVoice" -->
34 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.EngineNotFound" -->
35 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.OperationFailed" -->
36 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.AudioPolicyBlocked" -->
37 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.NotSupportedFeature" -->
38 <!-- Badly formed XML comment ignored for member "F:Interop.Tts.TtsError.ServiceReset" -->
39 <member name="T:Tizen.Uix.Tts.DefaultVoiceChangedEventArgs">
41 This class holds information related to the DefaultVoiceChanged event.
43 <since_tizen> 3 </since_tizen>
45 <member name="P:Tizen.Uix.Tts.DefaultVoiceChangedEventArgs.Previous">
47 The previous SupportedVoice.
49 <since_tizen> 3 </since_tizen>
51 <member name="P:Tizen.Uix.Tts.DefaultVoiceChangedEventArgs.Current">
53 The current SupportedVoice.
55 <since_tizen> 3 </since_tizen>
57 <member name="T:Tizen.Uix.Tts.EngineChangedEventArgs">
59 This class holds information related to the EngineChanged event.
61 <since_tizen> 3 </since_tizen>
63 <member name="P:Tizen.Uix.Tts.EngineChangedEventArgs.EngineId">
67 <since_tizen> 3 </since_tizen>
69 <member name="P:Tizen.Uix.Tts.EngineChangedEventArgs.NeedCredential">
71 The necessity of the credential.
73 <since_tizen> 3 </since_tizen>
75 <member name="P:Tizen.Uix.Tts.EngineChangedEventArgs.VoiceType">
79 <since_tizen> 3 </since_tizen>
81 <member name="T:Tizen.Uix.Tts.ErrorOccurredEventArgs">
83 This class holds information related to the TTS ErrorOccurred event.
85 <since_tizen> 3 </since_tizen>
87 <member name="P:Tizen.Uix.Tts.ErrorOccurredEventArgs.UtteranceId">
91 <since_tizen> 3 </since_tizen>
93 <member name="P:Tizen.Uix.Tts.ErrorOccurredEventArgs.ErrorValue">
97 <since_tizen> 3 </since_tizen>
99 <member name="P:Tizen.Uix.Tts.ErrorOccurredEventArgs.ErrorMessage">
101 Gets the current error message.
103 <since_tizen> 3 </since_tizen>
105 String error message.
108 <member name="T:Tizen.Uix.Tts.SpeedRange">
110 This class holds the speed range values.
112 <since_tizen> 3 </since_tizen>
114 <member name="P:Tizen.Uix.Tts.SpeedRange.Max">
116 The max speed range value.
118 <since_tizen> 3 </since_tizen>
120 <member name="P:Tizen.Uix.Tts.SpeedRange.Min">
122 The min speed range value.
124 <since_tizen> 3 </since_tizen>
126 <member name="P:Tizen.Uix.Tts.SpeedRange.Normal">
128 The normal speed range value.
130 <since_tizen> 3 </since_tizen>
132 <member name="T:Tizen.Uix.Tts.StateChangedEventArgs">
134 This class holds information related to the TTS StateChanged event.
136 <since_tizen> 3 </since_tizen>
138 <member name="P:Tizen.Uix.Tts.StateChangedEventArgs.Previous">
142 <since_tizen> 3 </since_tizen>
144 <member name="P:Tizen.Uix.Tts.StateChangedEventArgs.Current">
148 <since_tizen> 3 </since_tizen>
150 <member name="T:Tizen.Uix.Tts.SupportedVoice">
152 This class holds information about the supported voices.
154 <since_tizen> 3 </since_tizen>
156 <member name="P:Tizen.Uix.Tts.SupportedVoice.Language">
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).
160 <since_tizen> 3 </since_tizen>
162 <member name="T:Tizen.Uix.Tts.State">
164 Enumeration for the states.
166 <since_tizen> 3 </since_tizen>
168 <member name="F:Tizen.Uix.Tts.State.Created">
172 <since_tizen> 3 </since_tizen>
174 <member name="F:Tizen.Uix.Tts.State.Ready">
178 <since_tizen> 3 </since_tizen>
180 <member name="F:Tizen.Uix.Tts.State.Playing">
184 <since_tizen> 3 </since_tizen>
186 <member name="F:Tizen.Uix.Tts.State.Paused">
190 <since_tizen> 3 </since_tizen>
192 <member name="F:Tizen.Uix.Tts.State.Unavailable">
196 <since_tizen> 3 </since_tizen>
198 <member name="T:Tizen.Uix.Tts.Mode">
200 Enumeration for TTS mode.
202 <since_tizen> 3 </since_tizen>
204 <member name="F:Tizen.Uix.Tts.Mode.Default">
206 Default mode for normal application.
208 <since_tizen> 3 </since_tizen>
210 <member name="F:Tizen.Uix.Tts.Mode.Notification">
214 <since_tizen> 3 </since_tizen>
216 <member name="F:Tizen.Uix.Tts.Mode.ScreenReader">
220 <since_tizen> 3 </since_tizen>
222 <member name="T:Tizen.Uix.Tts.Error">
224 Enumeration for error values that can occur.
226 <since_tizen> 3 </since_tizen>
228 <member name="F:Tizen.Uix.Tts.Error.None">
230 Successful, no error.
232 <since_tizen> 3 </since_tizen>
234 <member name="F:Tizen.Uix.Tts.Error.OutOfMemory">
238 <since_tizen> 3 </since_tizen>
240 <member name="F:Tizen.Uix.Tts.Error.IoError">
244 <since_tizen> 3 </since_tizen>
246 <member name="F:Tizen.Uix.Tts.Error.InvalidParameter">
250 <since_tizen> 3 </since_tizen>
252 <member name="F:Tizen.Uix.Tts.Error.TimedOut">
254 No answer from the STT service.
256 <since_tizen> 3 </since_tizen>
258 <member name="F:Tizen.Uix.Tts.Error.OutOfNetwork">
262 <since_tizen> 3 </since_tizen>
264 <member name="F:Tizen.Uix.Tts.Error.PermissionDenied">
268 <since_tizen> 3 </since_tizen>
270 <member name="F:Tizen.Uix.Tts.Error.NotSupported">
274 <since_tizen> 3 </since_tizen>
276 <member name="F:Tizen.Uix.Tts.Error.InvalidState">
280 <since_tizen> 3 </since_tizen>
282 <member name="F:Tizen.Uix.Tts.Error.InvalidVoice">
286 <since_tizen> 3 </since_tizen>
288 <member name="F:Tizen.Uix.Tts.Error.EngineNotFound">
292 <since_tizen> 3 </since_tizen>
294 <member name="F:Tizen.Uix.Tts.Error.OperationFailed">
298 <since_tizen> 3 </since_tizen>
300 <member name="F:Tizen.Uix.Tts.Error.AudioPolicyBlocked">
302 Audio policy blocked.
304 <since_tizen> 3 </since_tizen>
306 <member name="T:Tizen.Uix.Tts.Voice">
308 Enumeration for the voice types.
310 <since_tizen> 3 </since_tizen>
312 <member name="F:Tizen.Uix.Tts.Voice.Auto">
314 The automatic voice type.
316 <since_tizen> 3 </since_tizen>
318 <member name="F:Tizen.Uix.Tts.Voice.Male">
322 <since_tizen> 3 </since_tizen>
324 <member name="F:Tizen.Uix.Tts.Voice.Female">
326 The female voice type.
328 <since_tizen> 3 </since_tizen>
330 <member name="F:Tizen.Uix.Tts.Voice.Child">
332 The child voice type.
334 <since_tizen> 3 </since_tizen>
336 <member name="T:Tizen.Uix.Tts.TtsClient">
338 You can use Text-To-Speech (TTS) API's to read sound data transformed by the engine from input texts.
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.
341 <since_tizen> 3 </since_tizen>
343 <member name="M:Tizen.Uix.Tts.TtsClient.#ctor">
345 Constructor to create a TTS instance.
347 <since_tizen> 3 </since_tizen>
349 http://tizen.org/feature/speech.synthesis
351 <exception cref="T:System.InvalidOperationException">
352 This exception can be due to the following reasons:
356 <exception cref="T:System.OutOfMemoryException">This exception can be due to out Of memory.</exception>
357 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
359 <member name="E:Tizen.Uix.Tts.TtsClient.StateChanged">
361 Event to be invoked when TTS state changes.
363 <since_tizen> 3 </since_tizen>
365 <member name="E:Tizen.Uix.Tts.TtsClient.UtteranceStarted">
367 Event to be invoked when the utterance starts.
369 <since_tizen> 3 </since_tizen>
371 <member name="E:Tizen.Uix.Tts.TtsClient.UtteranceCompleted">
373 Event to be invoked when the utterance completes.
375 <since_tizen> 3 </since_tizen>
377 <member name="E:Tizen.Uix.Tts.TtsClient.ErrorOccurred">
379 Event to be invoked when an error occurs.
381 <since_tizen> 3 </since_tizen>
383 <member name="E:Tizen.Uix.Tts.TtsClient.DefaultVoiceChanged">
385 Event to be invoked when an error occurs.
387 <since_tizen> 3 </since_tizen>
389 <member name="E:Tizen.Uix.Tts.TtsClient.EngineChanged">
391 Event to be invoked to detect engine change.
393 <since_tizen> 3 </since_tizen>
395 <member name="P:Tizen.Uix.Tts.TtsClient.DefaultVoice">
397 Gets the default voice set by the user.
399 <since_tizen> 3 </since_tizen>
401 The default voice in TTS.
404 The default voice SupportedVoice value.
407 <member name="P:Tizen.Uix.Tts.TtsClient.MaxTextSize">
409 Gets the maximum byte size for text.
411 <since_tizen> 3 </since_tizen>
413 The Maximum byte size for text.
416 The Default Voice SupportedVoice value, 0 if unable to get the value.
419 The State should be ready.
422 <member name="P:Tizen.Uix.Tts.TtsClient.CurrentState">
424 Gets the current TTS state.
426 <since_tizen> 3 </since_tizen>
428 The current state of TTS.
431 Current TTS State value.
434 <member name="P:Tizen.Uix.Tts.TtsClient.CurrentMode">
436 The TTS Mode can be set using this property.
438 <since_tizen> 3 </since_tizen>
440 The current TTS mode (default, screen-reader, notification).
445 <exception cref="T:System.InvalidOperationException">
446 This exception can be due to the following reasons while setting the value:
450 <exception cref="T:System.OutOfMemoryException">This exception can be due to out Of memory.</exception>
451 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
453 The State should be created.
456 <member name="M:Tizen.Uix.Tts.TtsClient.SetCredential(System.String)">
458 Sets the application credential.
460 <since_tizen> 3 </since_tizen>
461 <param name="credential">.
462 The credential string.
465 http://tizen.org/feature/speech.synthesis
467 <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>
468 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
469 <exception cref="T:System.ArgumentException">This exception can be due to improper value provided while setting the value.</exception>
471 The State should be created or ready.
474 <member name="M:Tizen.Uix.Tts.TtsClient.Prepare">
476 Connects to the TTS service asynchronously.
478 <since_tizen> 3 </since_tizen>
480 http://tizen.org/feature/speech.synthesis
482 <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>
483 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
485 The State must be Created.
488 If this function is successful, the TTS state will be ready.
489 If this function is unsuccessful, ErrorOccurred event will be invoked.
492 <member name="M:Tizen.Uix.Tts.TtsClient.Unprepare">
494 Disconnects from the STT service.
496 <since_tizen> 3 </since_tizen>
498 http://tizen.org/feature/speech.synthesis
500 <exception cref="T:System.InvalidOperationException">This exception can be due to an invalid state.</exception>
501 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
503 The state must be ready.
506 If this function is successful, the TTS state will be created.
509 <member name="M:Tizen.Uix.Tts.TtsClient.GetSupportedVoices">
511 Retrieves all supported voices of the current engine.
513 <since_tizen> 3 </since_tizen>
515 The list of SupportedVoice.
518 http://tizen.org/feature/speech.synthesis
520 <exception cref="T:System.InvalidOperationException">
521 This exception can be due to the following reasons:
525 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
527 <member name="M:Tizen.Uix.Tts.TtsClient.GetPrivateData(System.String)">
529 Gets the private data from TTS engine.
531 <since_tizen> 3 </since_tizen>
536 The data corresponding to the provided key.
539 http://tizen.org/feature/speech.synthesis
541 <exception cref="T:System.InvalidOperationException">
542 This exception can be due to the following reasons:
547 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
549 The state must be ready.
552 <member name="M:Tizen.Uix.Tts.TtsClient.SetPrivateData(System.String,System.String)">
554 Sets the private data to tts engine.
556 <since_tizen> 3 </since_tizen>
564 http://tizen.org/feature/speech.synthesis
566 <exception cref="T:System.InvalidOperationException">
567 This exception can be due to the following reasons:
572 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
573 <exception cref="T:System.ArgumentException">This exception can be due to improper value provided while setting the value.</exception>
575 The state must be ready.
578 <member name="M:Tizen.Uix.Tts.TtsClient.GetSpeedRange">
580 Gets the speed range.
582 <since_tizen> 3 </since_tizen>
584 The SpeedRange value.
587 http://tizen.org/feature/speech.synthesis
589 <exception cref="T:System.InvalidOperationException">
590 This exception can be due to the following reasons:
594 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
596 The state must be created.
599 <member name="M:Tizen.Uix.Tts.TtsClient.AddText(System.String,System.String,System.Int32,System.Int32)">
601 Adds a text to the queue.
603 <since_tizen> 3 </since_tizen>
605 Locale MUST be set for UTF-8 text validation check.
608 An input text based UTF-8.
610 <param name="language">
611 The language selected from the SupportedVoice.Language Property obtained from GetSupportedVoices()(e.g. 'NULL'(Automatic),'en_US').
613 <param name="voiceType">
614 The voice type selected from the SupportedVoice.VoiceType Property obtained from GetSupportedVoices().
617 A speaking speed (e.g.0 for Auto or the value from SpeedRange Property).
623 http://tizen.org/feature/speech.synthesis
625 <exception cref="T:System.InvalidOperationException">
626 This exception can be due to the following reasons:
631 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
632 <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
633 <exception cref="T:System.ArgumentException">This exception can be due to improper value provided while setting the value.</exception>
635 The state must be ready or playing or paused.
638 <member name="M:Tizen.Uix.Tts.TtsClient.Play">
640 Starts synthesizing voice from the text and plays the synthesized audio data.
642 <since_tizen> 3 </since_tizen>
644 http://tizen.org/feature/speech.synthesis
646 <exception cref="T:System.InvalidOperationException">
647 This exception can be due to the following reasons:
652 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
653 <exception cref="T:System.UnauthorizedAccessException">This exception can be due to permission denied.</exception>
655 The state must be ready or paused.
658 If this function succeeds, the TTS state will be playing.
661 <member name="M:Tizen.Uix.Tts.TtsClient.Stop">
663 Stops playing the utterance and clears the queue.
665 <since_tizen> 3 </since_tizen>
667 http://tizen.org/feature/speech.synthesis
669 <exception cref="T:System.InvalidOperationException">
670 This exception can be due to the following reasons:
674 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
676 The state must be ready or playing or paused.
679 If this function succeeds, the TTS state will be ready.
680 This function will remove all text added via AddText() and synthesized sound data.
683 <member name="M:Tizen.Uix.Tts.TtsClient.Pause">
685 Pauses the currently playing utterance.
687 <since_tizen> 3 </since_tizen>
689 http://tizen.org/feature/speech.synthesis
691 <exception cref="T:System.InvalidOperationException">
692 This exception can be due to the following reasons:
696 <exception cref="T:System.NotSupportedException">This exception can be due to TTS not supported.</exception>
698 The state must be playing.
701 If this function succeeds, the TTS state will be Paused.
704 <member name="M:Tizen.Uix.Tts.TtsClient.Dispose">
706 Method to release resources.
708 <since_tizen> 3 </since_tizen>
710 <member name="T:Tizen.Uix.Tts.UtteranceEventArgs">
712 This class holds information related to UtteranceStared and UtteranceCompleted events.
714 <since_tizen> 3 </since_tizen>
716 <member name="P:Tizen.Uix.Tts.UtteranceEventArgs.UtteranceId">
720 <since_tizen> 3 </since_tizen>