Tizen

Tizen.Uix.Stt.SttClient class.<\/p>\n<\/li>\n<li>\nPrivate data<\/p>\nThe private data is a setting parameter for applying keys provided by the STT engine. Using the <code>SetPrivateData()<\/code> method of the <code>Tizen.Uix.Stt.SttClient<\/code> class, you can set the private data as the corresponding key of the STT engine.<\/p>\n<\/li>\n<\/ul>\n<a name=\"info_stt\"><\/a><\/p>\n<h2 id=\"content-stt-information-retrieval\"><a href=https://samsungtizenos.com/"#content-stt-information-retrieval\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>STT Information Retrieval<\/h2>\nYou can get the following information about STT by following these steps:<\/p>\n<ul>\n<li><a href=https://samsungtizenos.com/"#get\">Get the current STT state<\/a>. The state is also applied as a precondition for each method.<\/li>\n<li>Get the default language.\n<ul>\n<li>You can start recognition with the language that you want as a parameter of the <code>Start()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient class. However, if you do not set a specific language, STT starts recording and uses the default language for recognition.<\/li>\n<li>The user can change the default language in the device settings, by modifying the display language or the STT default language status. If the display language is changed to a non-supported one, the STT language is changed to UK English.<\/li>\n<\/ul>\n<\/li>\n<li>Get a list of the supported languages to check whether the language you want is supported.<\/li>\n<li>Get a list of the supported engines and the selection of current engines. Additional features, such as silence detection and partial result, are provided by specific engines.<\/li>\n<li>Get the error message when the error event handler is invoked.<\/li>\n<li>Get private data from the STT 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 STT functionality:<\/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.Stt.md/">Tizen.Uix.Stt namespace, 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>Stt<\/span>;<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nTo use the STT library and create an STT handle, create a new instance of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient class.<\/p>\nThe instance is used to launch other STT methods. After the instance has been created, the STT 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>\nSTT is not thread-safe and depends on the Ecore main loop. Implement STT 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>CreateSttClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>SttClient<\/span> <\/span>stt_inst<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>SttClient<\/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 STT library, destroy the STT client instance with the <code>Dispose()<\/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>DestroySttClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_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.Stt.SttClient<\/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>\nSTT provides event handlers to get various information, such as the recognition result, state changes, language changes, and errors.<\/p>\nYou can only register event handlers when the STT 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.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient class:<\/p>\n<ul>\n<li>\nState changed<\/p>\nTo get a notification when the STT stage 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>SttStateChanged<\/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 stt_inst.StateChanged <\/span>+=<\/span> SttStateChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n stt_inst.StateChanged <\/span>-=<\/span> SttStateChanged;<\/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 language changed<\/p>\nThe default language of STT is changed either when the system language is changed, or through the STT settings. To get a notification when the language changes, register an event handler for the <code>DefaultLanguageChanged<\/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>SttDefaultLanguageChanged<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>DefaultLanguageChangedEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetDefaultLanguageChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the DefaultLanguageChanged event<\/span><\/span>\n stt_inst.DefaultLanguageChanged <\/span>+=<\/span> SttDefaultLanguageChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n stt_inst.DefaultLanguageChanged <\/span>-=<\/span> SttDefaultLanguageChanged;<\/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>\nRecognition result<\/p>\nTo get the STT recognition result, register an event handler for the <code>RecognitionResult<\/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>SttRecognitionResult<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>RecognitionResultEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>SetUnsetRecognitionResultCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Register the event handler for the RecognitionResult event<\/span><\/span>\n stt_inst.RecognitionResult <\/span>+=<\/span> SttRecognitionResult;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n stt_inst.RecognitionResult <\/span>-=<\/span> SttRecognitionResult;<\/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 STT, 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>SttEngineChanged<\/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 stt_inst.EngineChanged <\/span>+=<\/span> SttEngineChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n stt_inst.EngineChanged <\/span>-=<\/span> SttEngineChanged;<\/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>SttErrorOccurred<\/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 stt_inst.ErrorOccurred <\/span>+=<\/span> SttErrorOccurred;<\/span><\/span>\n<\/span>\n \/\/\/ Deregister the event handler<\/span><\/span>\n stt_inst.ErrorOccurred <\/span>-=<\/span> SttErrorOccurred;<\/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 STT state, the list of supported languages, and the current language. Follow these steps:<\/p>\n<ul>\n<li>\nRetrieve the current STT state by using the <code>CurrentState<\/code> property of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient class.<\/p>\nThe STT state is changed by various STT 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>State<\/span> <\/span>current_state<\/span>;<\/span><\/span>\n current_state <\/span>=<\/span> SttClient.CurrentState;<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nRetrieve a list of languages supported by STT by using the <code>GetSupportedLanguages()<\/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>GetSupportedLanguage<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>List<\/span><<\/span>string<\/span>> <\/span>list<\/span> <\/span>=<\/span> (<\/span>List<\/span><<\/span>string<\/span>>)stt_inst.<\/span>GetSupportedLanguages<\/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>\nRetrieve the default language by using the <code>DefaultLanguage<\/code> property of the <code>Tizen.Uix.Stt.SttClient<\/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>GetDefaultLanguage<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>string<\/span> <\/span>default_lang<\/span> <\/span>=<\/span> stt_inst.DefaultLanguage;<\/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 default language changes by registering an event handler for the <code>DefaultLanguageChanged<\/code> event of the <code>Tizen.Uix.Stt.SttClient<\/code> class.<\/p>\n<\/li>\n<li>\nRetrieve a list of engines supported by STT by using the <code>GetSupportedEngines()<\/code> method of the <code>Tizen.Uix.Stt.SttClient<\/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>GetSupportedEngine<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>List<\/span><<\/span>SupportedEngine<\/span>> <\/span>list<\/span> <\/span>=<\/span> (<\/span>List<\/span><<\/span>SupportedEngine<\/span>>)stt_inst.<\/span>GetSupportedEngines<\/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>\nRetrieve or set the current engine for STT recognition by using the <code>Engine<\/code> property of the <code>Tizen.Uix.Stt.SttClient<\/code> class.<\/p>\nThe supported language, silence detection, and supported recognition types depend on the STT engine:<\/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>SetGetCurrentEngine<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>string<\/span> <\/span>current_engine_id<\/span> <\/span>=<\/span> <\/span>"stt-engine-default"<\/span>;<\/span><\/span>\n<\/span>\n \/\/\/ Set the current engine<\/span><\/span>\n stt_inst.Engine <\/span>=<\/span> current_engine_id;<\/span><\/span>\n<\/span>\n \/\/\/ Get the current engine<\/span><\/span>\n current_engine_id <\/span>=<\/span> stt_inst.Engine;<\/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>\nCheck whether a recognition type is supported by the current engine, by using the <code>IsRecognitionTypeSupported()<\/code> method of the <code>Tizen.Uix.Stt.SttClient<\/code> class. Use the values of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.RecognitionType.md/">Tizen.Uix.Stt.RecognitionType enumeration as a parameter.<\/p>\nThe normal recognition type, <code>Stt.RecognitionType.Free<\/code>, means that the whole recognition result is sent at the end of the recognition process. The <code>Stt.RecognitionType.Partial<\/code> recognition type is used to get a partial recognition result:<\/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>CheckSupportedRecognitionType<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>bool<\/span> <\/span>support<\/span>;<\/span><\/span>\n<\/span>\n support <\/span>=<\/span> stt_inst.<\/span>IsRecognitionTypeSupported<\/span>(Stt.RecognitionType.Partial);<\/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=\"prepare\"><\/a><\/p>\n<h2 id=\"content-connect-and-disconnect-stt\"><a href=https://samsungtizenos.com/"#content-connect-and-disconnect-stt\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Connect and disconnect STT<\/h2>\nTo operate STT, follow these steps:<\/p>\n<ol>\n<li>\nAfter you have initialized STT by creating the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient class instance, connect the background STT daemon with the <code>Prepare()<\/code> method of that class.<\/p>\nThe method is asynchronous and the STT 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>PrepareSttClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_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>Tizen.Uix.Stt.SttClient.Prepare()<\/code> method, STT is not available.<\/p>\n<\/div>\n<\/li>\n<li>\nWhen the connection is no longer needed, disconnect STT and change the STT state to <code>Created<\/code>, by using the <code>Unprepare()<\/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>UnprepareSttClient<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_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-stt-engine-ptions\"><a href=https://samsungtizenos.com/"#content-set-and-get-stt-engine-ptions\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Set and get STT engine ptions<\/h2>\nTo set and get STT 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 STT 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.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient 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 stt_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 STT 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 STT 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 stt_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> stt_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=\"option\"><\/a><\/p>\n<h2 id=\"content-set-options-and-control-recording\"><a href=https://samsungtizenos.com/"#content-set-options-and-control-recording\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Set options and control recording<\/h2>\nTo set the STT options and control recording, follow these steps:<\/p>\n<ul>\n<li>\nSet the silence detection.<\/p>\nAfter STT starts recognizing sound, some STT engines can detect silence when the sound input from the user ends. If silence detection is enabled, the STT library stops recognition automatically and sends the result. Otherwise, you can manually stop the recognition process using the <code>Stop()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.SttClient.md/">Tizen.Uix.Stt.SttClient class.<\/p>\nTo set the silence detection state, use the <code>SetSilenceDetection()<\/code> method, using values of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.Stt.SilenceDetection.md/">Tizen.Uix.Stt.SilenceDetection enumeration as a parameter. If you set the silence detection as <code>SilenceDetection.Auto<\/code>, STT works according to the global STT setting. This option must be set when STT is 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>SetSilenceDetection<\/span>(<\/span>SilenceDetection<\/span> <\/span>type<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n \/\/\/ Default type is SilenceDetection.Auto<\/span><\/span>\n stt_inst.<\/span>SetSilenceDetection<\/span>(type);<\/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 or unset the start sound.<\/p>\nTo play a sound before STT recognition starts, call the <code>SetStartSound()<\/code> method in the <code>Ready<\/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>\nThe sound file path must be a full path. Only WAV format sound files are supported.<\/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>SetStartSound<\/span>(<\/span>string<\/span> <\/span>filename<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_inst.<\/span>SetStartSound<\/span>(filename);<\/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 unset the recording start sound, use the <code>UnsetStartSound()<\/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>UnsetStartSound<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_inst.<\/span>UnsetStartSound<\/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>\nSet or unset the stop sound.<\/p>\nTo play a sound when STT recognition stops, use the <code>SetStopSound()<\/code> method in the <code>Ready<\/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>\nThe sound file path must be a full path. Only WAV format sound files are supported.<\/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>SetStopSound<\/span>(<\/span>string<\/span> <\/span>filename<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_inst.<\/span>SetStopSound<\/span>(filename);<\/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 unset the recording stop sound, use the <code>UnsetStopSound()<\/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>UnsetStopSound<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_inst.<\/span>UnsetStopSound<\/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 control the speech recognition:<\/p>\n<ul>\n<li>\nTo start recording, use the <code>Start()<\/code> method.<\/p>\nThe connected STT daemon starts recording, and the STT state is changed to <code>Recording<\/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 <code>Start()<\/code> method fails, check the error code and take appropriate action.<\/p>\n<\/div>\nThe language and recognition type must be supported by the current STT engine. If you set <code>NULL<\/code> as the language parameter, the STT default language is used based on the <code>DefaultLanguage<\/code> property of the currently-used <code>Tizen.Uix.Stt.SttClient<\/code> class instance:<\/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>Start<\/span>(<\/span>string<\/span> <\/span>language<\/span>, <\/span>RecognitionType<\/span> <\/span>type<\/span>)<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_inst.<\/span>Start<\/span>(language, type);<\/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>\nWhile STT recording is in progress, you can retrieve the current recording volume using the <code>RecordingVolume<\/code> property of the <code>Tizen.Uix.Stt.SttClient<\/code> class.<\/p>\nThe volume value is retrieved periodically with the short-term recorded sound data as dB (decibels). The STT volume normally has a negative value, and 0 is the maximum value:<\/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>GetVolume<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>float<\/span> <\/span>current_volume<\/span>;<\/span><\/span>\n<\/span>\n current_volume <\/span>=<\/span> stt_inst.RecordingVolume;<\/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 recording and get the recognition result, use the <code>Stop()<\/code> method.<\/p>\nThe recording stops and the STT state is changed to <code>Processing<\/code>. When the recognition result has been processed, the <code>RecognitionResult<\/code> event triggers, and the state changes back 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 stt_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 cancel the recording without getting the result, use the <code>Cancel()<\/code> method.<\/p>\nThe STT 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>Cancel<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n stt_inst.<\/span>Cancel<\/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<\/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.Stt.md/">Tizen.Uix.Stt/n

Customize your cookie preferences

Necessary

Analytics