Tizen

Tizen.Uix.Tts.TtsClient class.<\/p>\n<\/li>\n<li>\nPrivate data<\/p>\nThe private data is a setting parameter for applying keys provided by the TTS engine. Using the <code>SetPrivateData()<\/code> method of the <code>Tizen.Uix.Tts.TtsClient<\/code> class, you can set the private data as the corresponding key of the TTS engine.<\/p>\n<\/li>\n<\/ul>\n<a name=\"info_tts\"><\/a><\/p>\n<h2 id=\"content-tts-information-retrieval\"><a href=https://samsungtizenos.com/"#content-tts-information-retrieval\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>TTS information retrieval<\/h2>\nYou can get the following information about TTS:<\/p>\n<ul>\n<li><a href=https://samsungtizenos.com/"#get\">Get the current TTS state<\/a>. The state is also applied as a precondition for each method.<\/li>\n<li>Get the current TTS service state. The service state is changed by the internal behavior of the TTS service.<\/li>\n<li>Get the default voice.\n<ul>\n<li>In TTS, the voice is defined as a combination of the language and the type, such as male or female.<\/li>\n<li>You can request the synthesis of the text with a specific voice, using the parameters of the <code>AddText()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class. However, if you do not set a specific voice, TTS synthesizes the text with the default voice.<\/li>\n<li>The user can change the default voice in the device settings by modifying the display language or the TTS default language status. If the display language is changed to a non-supported language, the TTS language is changed to UK English.<\/li>\n<\/ul>\n<\/li>\n<li>Get a list of supported voices to check whether the language and voice type you want are supported.<\/li>\n<li>Get the error message when the error event handler is invoked.<\/li>\n<li>Get private data from the TTS engine.<\/li>\n<\/ul>\n<h2 id=\"content-prerequisites\"><a href=https://samsungtizenos.com/"#content-prerequisites\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Prerequisites<\/h2>\nTo enable your application to use the TTS functionality, follow the steps below:<\/p>\n<ol>\n<li>\nTo use the methods and properties of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class, include it in your application:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>using<\/span> <\/span>Tizen<\/span>.<\/span>Uix<\/span>.<\/span>Tts<\/span>.<\/span>TtsClient<\/span>;<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nTo use the TTS library, create a TTS handle<\/p>\nThe TTS handle is used in other TTS methods as a parameter. After the handle creation, the TTS state changes to <code>Created<\/code>:<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nTTS is not thread-safe and depends on the Ecore main loop. Implement TTS within the Ecore main loop and do not use it in a thread.<\/p>\n<\/div>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>CreateTtsClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>TtsClient<\/span> <\/span>tts_inst<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>TtsClient<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nWhen you no longer need the TTS library, destroy the TTS handle by using the <code>Dispose()<\/code> method of the <code>Tizen.Uix.Tts.TtsClient<\/code> class:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>DestroyTtsClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>Dispose<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nDo not use the <code>Dispose()<\/code> method inside an event handler. Within an event handler, the <code>Dispose()<\/code> method fails and invokes the <code>OperationFailed<\/code> error with the <code>ErrorOccurred<\/code> event of the <code>Tizen.Uix.Tts.TtsClient<\/code> class.<\/p>\n<\/div>\n<\/li>\n<\/ol>\n<a name=\"set\"><\/a><\/p>\n<h2 id=\"content-register-event-handlers\"><a href=https://samsungtizenos.com/"#content-register-event-handlers\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Register event handlers<\/h2>\nTTS provides event handlers to get various information, such as state changes and the start or completion of an utterance.<\/p>\nYou can only register event handlers when the TTS state is <code>Created<\/code>.<\/p>\nEvent handlers can be set for the following events of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class:<\/p>\n<ul>\n<li>\nState changed<\/p>\nTo get a notification when the TTS state changes, register an event handler for the <code>StateChanged<\/code> event:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsStateChanged<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>StateChangedEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetStateChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the StateChanged event<\/span><\/span>\n tts_inst.StateChanged <\/span>+=<\/span> TtsStateChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n tts_inst.StateChanged <\/span>-=<\/span> TtsStateChanged;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nService State changed<\/p>\nTo get a notification when the TTS service state changes, register an event handler for the <code>ServiceStateChanged<\/code> event:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsServiceStateChanged<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>ServiceStateChangedEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetServiceStateChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the ServiceStateChanged event<\/span><\/span>\n tts_inst.ServiceStateChanged <\/span>+=<\/span> TtsServiceStateChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n tts_inst.ServiceStateChanged <\/span>-=<\/span> TtsServiceStateChanged;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nDefault voice changed<\/p>\nIn the TTS library, the voice includes the language used and the voice type, such as male or female. The default voice of the TTS is changed either when the system language is changed, or through the TTS settings. To get a notification of a voice change, register an event handler for the <code>DefaultVoiceChanged<\/code> event:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsDefaultVoiceChanged<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>DefaultVoiceChangedEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetDefaultVoiceChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the DefaultVoiceChanged event<\/span><\/span>\n tts_inst.DefaultVoiceChanged <\/span>+=<\/span> TtsDefaultVoiceChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n tts_inst.DefaultVoiceChanged <\/span>-=<\/span> TtsDefaultVoiceChanged;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nEngine changed<\/p>\nTo get a notification when the engine is changed by TTS, register an event handler for the <code>EngineChanged<\/code> event:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsEngineChanged<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>EngineChangedEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetEngineChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the EngineChanged event<\/span><\/span>\n tts_inst.EngineChanged <\/span>+=<\/span> TtsEngineChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n tts_inst.EngineChanged <\/span>-=<\/span> TtsEngineChanged;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nUtterance started or completed<\/p>\nIf you add text in TTS, that text is handled as an utterance and it obtains its own ID. After you request the TTS process to start, the text is synthesized by an engine and played. Each event handler is invoked in the following cases:<\/p>\n<div class=\"overflow-auto grid table-fixed\" data-table-container=\"data-table-container\"><table>\n<thead>\n<tr>\n<th align=\"center\">Event handler<\/th>\n<th align=\"center\">Invoked when<\/th>\n<th align=\"center\">TTS state<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td align=\"center\"><code>UtteranceStarted<\/code><\/td>\n<td align=\"center\">Playing the synthesized audio is started<\/td>\n<td align=\"center\"><code>Ready<\/code> > <code>Playing<\/code><\/td>\n<\/tr>\n<tr>\n<td align=\"center\"><code>UtteranceCompleted<\/code><\/td>\n<td align=\"center\">Playing the synthesized audio is finished<\/td>\n<td align=\"center\"><code>Playing<\/code> (The state is NOT changed until <code>Stop()<\/code> is called.)<\/td>\n<\/tr>\n<\/tbody>\n<\/table><\/div>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\n<code>UtteranceCompleted<\/code> is NOT invoked when the following occurs:<\/p>\n(1) Your application calls <code>Stop()<\/code>.<\/p>\n(2) Playing the synthesized audio is stopped by another application.<\/p>\nAlthough the <code>UtteranceCompleted<\/code> event handler is not invoked, a <code>StateChanged<\/code> event handler will be invoked. (The state will be changed from <code>Playing<\/code> to <code>Ready<\/code>.)<\/p>\n<\/div>\nTo get a notification when an utterance is started or completed, register event handlers for the <code>UtteranceStarted<\/code> and <code>UtteranceCompleted<\/code> events, respectively:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Utterance started event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsUtteranceStarted<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>UtteranceEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n\/\/\/ Utterance completed event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsUtteranceCompleted<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>UtteranceEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetUtteranceCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handlers for the UtteranceStarted and UtteranceCompleted events<\/span><\/span>\n tts_inst.UtteranceStarted <\/span>+=<\/span> TtsUtteranceStarted;<\/span><\/span>\n tts_inst.UtteranceCompleted <\/span>+=<\/span> TtsUtteranceCompleted;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handlers<\/span><\/span>\n tts_inst.UtteranceStarted <\/span>-=<\/span> TtsUtteranceStarted;<\/span><\/span>\n tts_inst.UtteranceCompleted <\/span>-=<\/span> TtsUtteranceCompleted;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nError<\/p>\nTo get a notification when an error occurs, register an event handler for the <code>ErrorOccurred<\/code> event:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsErrorOccurred<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>ErrorOccurredEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetErrorOccurredCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the ErrorOccurred event<\/span><\/span>\n tts_inst.ErrorOccurred <\/span>+=<\/span> TtsErrorOccurred;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n tts_inst.ErrorOccurred <\/span>-=<\/span> TtsErrorOccurred;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nSynthesized PCM<\/p>\nTo get a notification when a synthesized PCM data is received from a TTS service, register an event handler for <code>SynthesizedPcm<\/code> event:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>\/\/\/ Event handler<\/span><\/span>\nvoid<\/span> <\/span>TtsSynthesizedPcm<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>SynthesizedPcmEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetSynthesizedPcmCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the SynthesizedPcm event<\/span><\/span>\n tts_inst.SynthesizedPcm <\/span>+=<\/span> TtsSynthesizedPcm;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n tts_inst.SynthesizedPcm <\/span>-=<\/span> TtsSynthesizedPcm;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<\/ul>\n<a name=\"get\"><\/a><\/p>\n<h2 id=\"content-get-information\"><a href=https://samsungtizenos.com/"#content-get-information\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Get information<\/h2>\nTo obtain the current state, the supported voice list, and the current voice, follow the steps below:<\/p>\n<ul>\n<li>\nRetrieve the current TTS state by using the <code>CurrentState<\/code> property of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class.<\/p>\nThe TTS state is changed by various TTS methods, and it is applied as a precondition for each method:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>GetState<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>State<\/span> <\/span>current_state<\/span>;<\/span><\/span>\n current_state <\/span>=<\/span> TtsClient.CurrentState;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nRetrieve the current TTS service state by using the <code>CurrentServiceState<\/code> property of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>GetServiceState<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>ServiceState<\/span> <\/span>current_service_state<\/span>;<\/span><\/span>\n current_service_state <\/span>=<\/span> TtsClient.CurrentServiceState;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nObtain a list of TTS-supported voices by using the <code>GetSupportedVoices()<\/code> method of the <code>Tizen.Uix.Tts.TtsClient<\/code> class:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>GetSupportedVoice<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>List<\/span><<\/span>SupportedVoice<\/span>> <\/span>voicesList<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>List<\/span><<\/span>SupportedVoice<\/span>>();<\/span><\/span>\n voiceList <\/span>=<\/span> tts_inst.<\/span>GetSupportedVoices<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nGet the default voice by using the <code>DefaultVoice<\/code> property<\/p>\nTTS synthesizes the text using the default voice, if you do not set the language and the voice type as parameters of the <code>AddText()<\/code> method of the <code>Tizen.Uix.Tts.TtsClient<\/code> class:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>GetDefaultVoice<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>SupportedVoice<\/span> <\/span>default_voice<\/span> <\/span>=<\/span> tts_inst.DefaultVoice;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\nYou can get a notification about changes to the default voice by registering an event handler for the <code>DefaultVoiceChanged<\/code> event of the <code>Tizen.Uix.Tts.TtsClient<\/code> class.<\/p>\n<\/li>\n<\/ul>\n<a name=\"mode\"><\/a><\/p>\n<h2 id=\"content-get-and-set-the-mode\"><a href=https://samsungtizenos.com/"#content-get-and-set-the-mode\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Get and set the mode<\/h2>\nThere are 3 different TTS modes available. The main difference is audio mixing with other sources. The default mode is <code>Default<\/code>, used for normal applications, such as e-books. If you set this mode and play your text, it can be interrupted when other sounds, such as ringtone or other TTS sounds, are played.<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nThe <code>Notification<\/code> and <code>ScreenReader<\/code> modes are mixed with other sound sources, but they are used only for platform-specific features. Do not use them for normal applications.<\/p>\n<\/div>\nGet and set the mode in the <code>Created<\/code> state:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>SetMode<\/span>(<\/span>Mode<\/span> <\/span>mode<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.CurrentMode <\/span>=<\/span> mode;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>GetMode<\/span>(Mode* mode)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>*<\/span>mode <\/span>=<\/span> tts_inst.CurrentMode;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<a name=\"prepare\"><\/a><\/p>\n<h2 id=\"content-connect-and-disconnect-tts\"><a href=https://samsungtizenos.com/"#content-connect-and-disconnect-tts\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Connect and disconnect TTS<\/h2>\nTo operate TTS, follow these steps:<\/p>\n<ol>\n<li>\nAfter you create the TTS handle, connect the background TTS service with the <code>Prepare()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class.<\/p>\nThe TTS service synthesizes the text with the engine and plays the resulting sound data. The method is asynchronous and the TTS state changes to <code>Ready<\/code>:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>PrepareTtsClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>Prepare<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nIf the error event handler is invoked after calling the <code>Prepare()<\/code> method, TTS is not available.<\/p>\n<\/div>\n<\/li>\n<li>\nWhen the connection is no longer needed, use the <code>Unprepare()<\/code> method to disconnect TTS and change the TTS state to <code>Created<\/code>:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>UnprepareTtsClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>Unprepare<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<\/ol>\n<a name=\"engine\"><\/a><\/p>\n<h2 id=\"content-set-and-get-tts-engine-options\"><a href=https://samsungtizenos.com/"#content-set-and-get-tts-engine-options\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Set and get TTS engine options<\/h2>\nTo set and get TTS engine options, follow these steps:<\/p>\n<ul>\n<li>\nSet the credential<\/p>\nThe credential is a key to verify the authorization for using the TTS engine. The necessity of the credential depends on the engine. If the engine requests the credential, you can set it using the <code>SetCredential()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>SetCredential<\/span>(<\/span>string<\/span> <\/span>credential<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>SetCredential<\/span>(credential);<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nSet and get the private data<\/p>\nThe private data is a setting parameter for applying keys provided by the TTS engine. To set the private data and use the corresponding key of the engine, use the <code>SetPrivateData()<\/code> method:<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nThe key and data are determined by the TTS engine. To set and get the private data, see the engine instructions.<\/p>\n<\/div>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>SetPrivateData<\/span>(<\/span>string<\/span> <\/span>key<\/span>, <\/span>string<\/span> <\/span>data<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>SetPrivateData<\/span>(key, data);<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\nTo get the private data which corresponds to a specific key from the engine, use the <code>GetPrivateData()<\/code> method:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>GetPrivateData<\/span>(<\/span>string<\/span> <\/span>key<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>string<\/span> <\/span>privatedata<\/span>;<\/span><\/span>\n<\/span>\n privatedata <\/span>=<\/span> tts_inst.<\/span>GetPrivateData<\/span>(key);<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<\/ul>\n<a name=\"text\"><\/a><\/p>\n<h2 id=\"content-add-text\"><a href=https://samsungtizenos.com/"#content-add-text\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Add text<\/h2>\nTo add text, follow these steps:<\/p>\n<ul>\n<li>\nYou can request the TTS library to read your own text using the <code>AddText()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class. The TTS library manages added text using queues, so it is possible to add several texts simultaneously. Each obtained text receives an utterance ID, which is used for synthesizing and playing the sound data.<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nIf the added text is too long, some engines need a long time for synthesis. It is recommended to only use proper length text clips.<\/p>\n<\/div>\nIf the <code>language<\/code> parameter is <code>NULL<\/code>, the default language is used for synthesizing the text.<\/p>\nYou can add text to TTS at any point after the <code>Prepare()<\/code> method changes the TTS state to <code>Ready<\/code>:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>AddText<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>string<\/span> <\/span>text<\/span> <\/span>=<\/span> <\/span>"tutorial"<\/span>; <\/span>\/\/\/ Text to be read<\/span><\/span>\n <\/span>string<\/span> <\/span>language<\/span> <\/span>=<\/span> <\/span>"en_US"<\/span>; <\/span>\/\/\/ Language<\/span><\/span>\n <\/span>int<\/span> <\/span>voice_type<\/span> <\/span>=<\/span> Voice.Female; <\/span>\/\/\/ Voice type<\/span><\/span>\n <\/span>int<\/span> <\/span>speed<\/span> <\/span>=<\/span> <\/span>0<\/span>; <\/span>\/\/\/ Read speed; 0 for Auto<\/span><\/span>\n<\/span>\n tts_inst.<\/span>AddText<\/span>(text, language, voice_type, speed);<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nThere is a length limit for added text in the engine. To retrieve the maximum value, use the <code>MaxTextSize<\/code> property of the <code>Tizen.Uix.Tts.TtsClient<\/code> class in the <code>Ready<\/code> state:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>GetMaximumTextSize<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>int<\/span> <\/span>max_text_size<\/span> <\/span>=<\/span> tts_inst.MaxTextSize;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<\/ul>\n<a name=\"control\"><\/a><\/p>\n<h2 id=\"content-control-playback\"><a href=https://samsungtizenos.com/"#content-control-playback\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Control playback<\/h2>\nTo start, pause, and stop the playback, follow the steps below:<\/p>\n<ul>\n<li>\nTo start synthesizing the text added in the queue and play the resulting sound data in sequence, use the <code>Play()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient class.<\/p>\nThe TTS state is changed to <code>Playing<\/code>, and the playback continues until you call the <code>Stop()<\/code> or the <code>Pause()<\/code> method.<\/p>\nIf there is no text in the queue, TTS stays in the <code>Playing<\/code> state for text to be added. In that case, when text is added, TTS starts synthesizing and playing it immediately. There is no need to change the state to <code>Ready<\/code> by using the <code>Stop()<\/code> method even when there is no text in the queue. It will continue to stay in the <code>Playing<\/code> state:<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nIf the TTS state changed event handler is invoked, state change can occur without any controlling methods being called. In this case, the state change takes place only when other applications request TTS play, the audio session requests TTS pause or the TTS engine changes.<\/p>\n<\/div>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>Start<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>Play<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nTo pause the playback, use the <code>Pause()<\/code> method.<\/p>\nThe TTS state is changed to <code>Paused<\/code>. To resume playback, use the <code>Play()<\/code> method:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>Pause<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>Pause<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nTo stop the playback, use the <code>Stop()<\/code> method.<\/p>\nAll the texts in the queue are removed, and the TTS state is changed to <code>Ready<\/code>:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>Stop<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.<\/span>Stop<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nTo repeat the last added text, use the <code>Repeat()<\/code> method.<\/p>\nThe <code>Repeat()<\/code> method returns the information about the last added text and the TTS state is changed to <code>Playing<\/code>.<\/p>\nIf no text has been added before, an exception occurs. To handle the exception, contain a block of code as follow:<\/p>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>Repeat<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>string<\/span> <\/span>text<\/span> <\/span>=<\/span> <\/span>"tutorial"<\/span>; <\/span>\/\/\/ Text to be read<\/span><\/span>\n <\/span>string<\/span> <\/span>language<\/span> <\/span>=<\/span> <\/span>"en_US"<\/span>; <\/span>\/\/\/ Language<\/span><\/span>\n <\/span>int<\/span> <\/span>voice_type<\/span> <\/span>=<\/span> Voice.Female; <\/span>\/\/\/ Voice type<\/span><\/span>\n <\/span>int<\/span> <\/span>speed<\/span> <\/span>=<\/span> <\/span>0<\/span>; <\/span>\/\/\/ Read speed; 0 for Auto<\/span><\/span>\n<\/span>\n tts_inst.<\/span>AddText<\/span>(text, language, voice_type, speed);<\/span><\/span>\n tts_inst.<\/span>Play<\/span>();<\/span><\/span>\n<\/span>\n <\/span>..<\/span>.<\/span><\/span>\n<\/span>\n tts_inst.<\/span>Stop<\/span>();<\/span><\/span>\n <\/span>RepeatedText<\/span> <\/span>text<\/span> <\/span>=<\/span> tts_inst.<\/span>Repeat<\/span>();<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<\/ul>\n<a name=\"playing_mode\"><\/a><\/p>\n<h2 id=\"content-playing-mode\"><a href=https://samsungtizenos.com/"#content-playing-mode\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Playing mode<\/h2>\nPlaying mode determines which process, either TTS service or TTS client, plays the synthesized PCM data. Described below are the 2 different types of playing modes:<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nPlaying mode is different from TTS mode. Playing mode only determines a subject to play PCM data.<\/p>\n<\/div>\n<ul>\n<li><code>ByService<\/code>: TTS service plays the synthesized PCM data. If you do not set playing mode, it will be set as <code>ByService<\/code>.<\/li>\n<li><code>ByClient<\/code>: TTS client receives the synthesized PCM data from the TTS service and plays it directly.<\/li>\n<\/ul>\nTo decide between the client-side playback mode and the service-side playback mode, follow the step below:<\/p>\n<ul>\n<li>\nSet the playing mode<\/p>\nIf the application wants to play the PCM data directly instead of playing the one that the application requested for synthesis in the TTS service, you can set the playback mode to <code>ByClient<\/code>. If the playback mode is not set by the user, the TTS service will synthesize the text and play it using the default value <code>ByService<\/code>:<\/p>\n<div class=\"md-alert md-alert-note\">\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\"><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"\/><\/svg>Note<\/span>\nIf the playing mode is <code>ByService<\/code>, you don't need to set an event handler. It will be played automatically by the TTS service. If you set the mode to <code>ByClient<\/code>, you can receive the synthesized PCM data via <code>SynthesizedPcm<\/code> event and only change playing mode when TTS client state is <code>Created<\/code>. If you want to use both playing modes, it would be better to create 2 TTS handles.<\/p>\n<\/div>\n<pre class=\"shiki shiki-themes github-light github-dark\" style=\"background-color:#fff;--shiki-dark-bg:#24292e;color:#24292e;--shiki-dark:#e1e4e8;\"><code>void<\/span> <\/span>SetPlayingMode<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n tts_inst.PlayingMode <\/span>=<\/span> PlayingMode.ByClient;<\/span><\/span>\n }<\/span><\/span>\n <\/span>catch<\/span> (<\/span>Exception<\/span> <\/span>e<\/span>)<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Error handling<\/span><\/span>\n }<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<\/ul>\n<h2 id=\"content-related-information\"><a href=https://samsungtizenos.com/"#content-related-information\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Related information<\/h2>\n<ul>\n<li>\nDependencies<\/p>\n<ul>\n<li>Tizen 4.0 and Higher<\/li>\n<\/ul>\n<\/li>\n<li>\nAPI References<\/p>\n<ul>\n<li><a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Tts.TtsClient.md/">Tizen.Uix.Tts.TtsClient/n/n/n/n","table_of_content":"

Customize your cookie preferences

Necessary

Analytics