Tizen

Tizen.Uix.VoiceControl.VoiceControlClient class.<\/p>\n<\/li>\n<\/ol>\nThe following figure illustrates the voice control life-cycle states.<\/p>\nFigure: voice control (left) and voice control service (right) life-cycle states<\/strong><\/p>\n<img src=https://samsungtizenos.com/"media//csapi_voice_control.png/" alt=\"Voice control and voice control service life-cycle states\" \/><\/p>\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 voice control functionality, follow these steps:<\/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.VoiceControl.VoiceControlClient.md/">Tizen.Uix.VoiceControl.VoiceControlClient 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>VoiceControl<\/span>.<\/span>VoiceControlClient<\/span>;<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nInitialize the voice control with the <code>Initialize()<\/code> method of the <code>Tizen.Uix.VoiceControl.VoiceControlClient<\/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>initialize_voice_control<\/span>()<\/span><\/span>\n{<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\nIf the method call is successful, the voice control state changes to <code>Initialized<\/code> (the states are defined in the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.State.md/">Tizen.Uix.VoiceControl.State enumeration).<\/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 voice control feature is not thread-safe and depends on the Ecore main loop. Implement voice control within the Ecore main loop and do not use it in a thread.<\/p>\n<\/div>\n<\/li>\n<li>\nPrepare the voice control service with the <code>Prepare()<\/code> method of the <code>Tizen.Uix.VoiceControl.VoiceControlClient<\/code> class, which connects the background voice control daemon. The daemon records and recognizes audio data and converts sound to text:<\/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>prepare_vc<\/span>()<\/span><\/span>\n{<\/span><\/span>\n VoiceControlClient.<\/span>Prepare<\/span>();<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\nThe <code>Prepare()<\/code> method is asynchronous, and when the preparation succeeds, the voice control state changes from <code>Initialized<\/code> to <code>Ready<\/code>. If the <code>Prepare()<\/code> method fails, the error callback is triggered.<\/p>\n<\/li>\n<li>\nWhen the voice control is no longer needed, unprepare and deinitialize it:<\/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>unprepared_vc<\/span>()<\/span><\/span>\n{<\/span><\/span>\n VoiceControlClient.<\/span>Unprepare<\/span>();<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nvoid<\/span> <\/span>deinitialize_voice_control<\/span>()<\/span><\/span>\n{<\/span><\/span>\n VoiceControlClient.<\/span>Deinitialize<\/span>();<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\nWhen the <code>Unprepare()<\/code> method of the <code>Tizen.Uix.VoiceControl.VoiceControlClient<\/code> class succeeds, the voice control state changes from <code>Ready<\/code> to <code>Initialized<\/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>\nDo not call the <code>Deinitialize()<\/code> method of the <code>Tizen.Uix.VoiceControl.VoiceControlClient<\/code> class in a callback. Within a callback, the <code>Deinitialize()<\/code> method fails and returns <code>ErrorCode.OperationFailed<\/code>.<\/p>\n<\/div>\n<\/li>\n<\/ol>\n<a name=\"callback\"><\/a><\/p>\n<h2 id=\"content-manage-callbacks\"><a href=https://samsungtizenos.com/"#content-manage-callbacks\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Manage callbacks<\/h2>\nTo set and unset callbacks to get notifications about recognition results, state changes, and errors, follow these steps:<\/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>\nSet and unset all callbacks when the voice control state is <code>Initialized<\/code> (the states are defined in the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.State.md/">Tizen.Uix.VoiceControl.State enumeration).<\/p>\n<\/div>\n<ul>\n<li>\nSet the state change callback to be invoked when the voice control state changes:<\/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>\/\/\/ Callback<\/span><\/span>\nvoid<\/span> <\/span>VoiceControlStateChanged<\/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>\n\/\/\/ Set and unset<\/span><\/span>\nvoid<\/span> <\/span>SetUnsetStateChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n<\/span>\n \/\/\/ Set the callback for the StateChanged event<\/span><\/span>\n VoiceControlClient.StateChanged <\/span>+=<\/span> VoiceControlStateChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Unset the callback<\/span><\/span>\n VoiceControlClient.StateChanged <\/span>-=<\/span> VoiceControlStateChanged;<\/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 the service state change callback to be invoked when the voice control service state changes:<\/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>\/\/\/ Callback<\/span><\/span>\nvoid<\/span> <\/span>VoiceControlServiceStateChanged<\/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>\n\/\/\/ Set and unset<\/span><\/span>\nvoid<\/span> <\/span>SetUnsetServiceStateChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n<\/span>\n \/\/\/ Set the callback for the ServiceStateChanged event<\/span><\/span>\n VoiceControlClient.ServiceStateChanged <\/span>+=<\/span> VoiceControlServiceStateChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Unset the callback<\/span><\/span>\n VoiceControlClient.ServiceStateChanged <\/span>-=<\/span> VoiceControlServiceStateChanged;<\/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 the current language change callback to be invoked when the system or application language changes:<\/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>\/\/\/ Callback<\/span><\/span>\nvoid<\/span> <\/span>VoiceControlCurrentLanguageChanged<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>CurrentLanguageChangedEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n\/\/\/ Set and unset<\/span><\/span>\nvoid<\/span> <\/span>SetUnsetCurrentLanguageChangedCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n<\/span>\n \/\/\/ Set the callback for the CurrentLanguageChanged event<\/span><\/span>\n VoiceControlClient.CurrentLanguageChanged <\/span>+=<\/span> VoiceControlCurrentLanguageChanged;<\/span><\/span>\n<\/span>\n \/\/\/ Unset the callback<\/span><\/span>\n VoiceControlClient.CurrentLanguageChanged <\/span>-=<\/span> VoiceControlCurrentLanguageChanged;<\/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 the recognition result callback to be invoked when a voice command is recognized.<\/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 recognition result produces a reject event, the voice control service has rejected the recognized command. Make sure that the command does not conflict with other commands and there are no duplicated commands.<\/p>\n<\/div>\nTo get the command, use the methods of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.VoiceCommandList.md/">Tizen.Uix.VoiceControl.VoiceCommandList class, which represents a list of recognized commands. The <code>Command<\/code> property of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.VoiceCommand.md/">Tizen.Uix.VoiceControl.VoiceCommand class contains the recognized text:<\/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>\/\/\/ Callback<\/span><\/span>\nvoid<\/span> <\/span>VoiceControlRecognitionResult<\/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>\n\/\/\/ Set and unset<\/span><\/span>\nvoid<\/span> <\/span>SetUnsetRecognitionResultCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n<\/span>\n \/\/\/ Set the callback for the RecognitionResult event<\/span><\/span>\n VoiceControlClient.RecognitionResult <\/span>+=<\/span> VoiceControlRecognitionResult;<\/span><\/span>\n<\/span>\n \/\/\/ Unset the callback<\/span><\/span>\n VoiceControlClient.RecognitionResult <\/span>-=<\/span> VoiceControlRecognitionResult;<\/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 the error callback to be invoked when an error occurs in the voice control process:<\/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>\/\/\/ Callback<\/span><\/span>\nvoid<\/span> <\/span>VoiceControlErrorOccured<\/span>(<\/span>object<\/span> <\/span>sender<\/span>, <\/span>ErrorOccuredEventArgs<\/span> <\/span>e<\/span>)<\/span><\/span>\n{<\/span><\/span>\n \/\/\/ Your code<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n\/\/\/ Set and Unset<\/span><\/span>\nvoid<\/span> <\/span>SetUnsetErrorOccuredCb<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n<\/span>\n \/\/\/ Set the callback for the ErrorOccured event<\/span><\/span>\n VoiceControlClient.ErrorOccured <\/span>+=<\/span> VoiceControlErrorOccured;<\/span><\/span>\n<\/span>\n \/\/\/ Unset the callback<\/span><\/span>\n VoiceControlClient.ErrorOccured <\/span>-=<\/span> VoiceControlErrorOccured;<\/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=\"info\"><\/a><\/p>\n<h2 id=\"content-retrieve-voice-control-information\"><a href=https://samsungtizenos.com/"#content-retrieve-voice-control-information\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Retrieve voice control information<\/h2>\nTo get information about the current states, and current and supported languages, follow these steps:<\/p>\n<ul>\n<li>\nGet the current voice control state using the <code>State<\/code> property of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.VoiceControlClient.md/">Tizen.Uix.VoiceControl.VoiceControlClient class.<\/p>\nThe voice control state changes according to method calls when the voice control is, for example, initialized and prepared:<\/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>get_state<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>State<\/span> <\/span>current_state<\/span>;<\/span><\/span>\n current_state <\/span>=<\/span> VoiceControlClient.State;<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nGet the current voice control service state using the <code>ServiceState<\/code> property.<\/p>\nThe user controls the voice control service state. In a general scenario:<\/p>\n<ol>\n<li>The user starts recording for recognition by using a voice application, button, or voice trigger. If the start is successful, the voice control service state changes to <code>Recording<\/code> (the states are defined in the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.ServiceState.md/">Tizen.Uix.VoiceControl.ServiceState enumeration).<\/li>\n<li>After recording, the service state changes to <code>Processing<\/code> for recognition processing.<\/li>\n<li>After recognition is completed, the service state returns to <code>Ready<\/code>.<\/li>\n<\/ol>\nIf the application uses continuous recognition, the voice control service state can be changed from <code>Processing<\/code> directly to <code>Recording<\/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>get_service_state<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>ServiceState<\/span> <\/span>current_service_state<\/span>;<\/span><\/span>\n current_service_state <\/span>=<\/span> VoiceControlClient.ServiceState;<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre>\n<\/li>\n<li>\nGet the supported languages with a foreach method that triggers a separate callback for each language.<\/p>\nAs long as the callback returns <code>true<\/code>, the foreach method continues to loop over the supported languages:<\/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>get_supported_language<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n VoiceControlClient.<\/span>Initialize<\/span>();<\/span><\/span>\n<\/span>\n <\/span>List<\/span><<\/span>string<\/span>> <\/span>list<\/span> <\/span>=<\/span> (<\/span>List<\/span><<\/span>string<\/span>>)VoiceControlClient.<\/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>\nGet the current language with the <code>CurrentLanguage<\/code> property. The voice control recognition works for the current (default) language. Use the language change callback to be notified of language changes.<\/p>\n<\/li>\n<\/ul>\n<a name=\"commands\"><\/a><\/p>\n<h2 id=\"content-manage-commands\"><a href=https://samsungtizenos.com/"#content-manage-commands\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">\u00b6<\/a>Manage commands<\/h2>\nTo create a command list and commands, follow these steps:<\/p>\n<ol>\n<li>\nCreate a command list with a command list handle.<\/p>\nThe command list can include many commands, which each have a command text and type. The list can have both the <code>Foreground<\/code> and <code>Background<\/code> type commands (the types are defined in the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.CommandType.md/">Tizen.Uix.VoiceControl.CommandType enumeration. The foreground commands are valid when the application is in a visible state and the background commands are valid when the application is in a visible or invisible state.<\/p>\nYou can access the command list after you set it to the voice control and when you get the 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>create_command_list<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommandList<\/span> <\/span>list<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommandList<\/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>\nCreate a command.<\/p>\nFirst create a command handle, and then define the command and type:<\/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>create_command<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommand<\/span> <\/span>command<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommand<\/span>();<\/span><\/span>\n<\/span>\n command.Command <\/span>=<\/span> <\/span>"open"<\/span>;<\/span><\/span>\n command.Type <\/span>=<\/span> CommandType.Foreground;<\/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>\nAdd the command to the command list.<\/p>\nIf necessary, you can also remove commands from the command list:<\/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>add_command<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommandList<\/span> <\/span>list<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommandList<\/span>();<\/span><\/span>\n <\/span>VoiceCommand<\/span> <\/span>command<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommand<\/span>();<\/span><\/span>\n<\/span>\n command.Command <\/span>=<\/span> <\/span>"open"<\/span>;<\/span><\/span>\n command.Type <\/span>=<\/span> CommandType.Foreground;<\/span><\/span>\n<\/span>\n list.<\/span>Add<\/span>(command);<\/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>remove_command<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommand<\/span> <\/span>command<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommand<\/span>();<\/span><\/span>\n<\/span>\n command.Command <\/span>=<\/span> <\/span>"open"<\/span>;<\/span><\/span>\n command.Type <\/span>=<\/span> CommandType.Foreground;<\/span><\/span>\n<\/span>\n \/\/\/ Other actions<\/span><\/span>\n<\/span>\n list.<\/span>Remove<\/span>(command);<\/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 retrieve the commands you have added to the command list:<\/p>\n<ul>\n<li>\nYou can use the <code>GetAllCommands()<\/code> method of the <a href=https://samsungtizenos.com/"//application//dotnet//api//TizenFX//latest//api//Tizen.Uix.VoiceControl.VoiceCommandList.md/">Tizen.Uix.VoiceControl.VoiceCommandList class to get all commands from the command list:<\/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>foreach_command<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommandList<\/span> <\/span>VoiceControlCmdList<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommandList<\/span>();<\/span><\/span>\n <\/span>List<\/span><<\/span>VoiceCommand<\/span>> <\/span>list<\/span> <\/span>=<\/span> (<\/span>List<\/span><<\/span>VoiceCommand<\/span>>)VoiceControlCmdList.<\/span>GetAllCommands<\/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>\nYou can use the <code>Current<\/code> property of the <code>Tizen.Uix.VoiceControl.VoiceCommandList<\/code> class to get the current command in an output parameter:<\/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>\nWhen you get the command handle with the <code>VoiceCommandList.Current<\/code> property, do not release it. To release the command handle, call the <code>Remove()<\/code> method of the <code>VoiceCommandList<\/code> class before destroying the <code>VoiceCommand<\/code> object.<\/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>get_commands<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommand<\/span> <\/span>current_command<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommand<\/span>();<\/span><\/span>\n <\/span>VoiceCommandList<\/span> <\/span>cmd_list<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommandList<\/span>();<\/span><\/span>\n<\/span>\n \/\/\/ Other actions<\/span><\/span>\n<\/span>\n current_command <\/span>=<\/span> cmd_list.Current;<\/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<li>\nRegister the commands for recognition by setting the command list to the voice control.<\/p>\nIf you want to update registered commands, set the command list again with the updated commands:<\/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>set_command<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommandList<\/span> <\/span>list<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommandList<\/span>();<\/span><\/span>\n <\/span>VoiceCommand<\/span> <\/span>command<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommand<\/span>();<\/span><\/span>\n command.Command <\/span>=<\/span> <\/span>"test"<\/span>;<\/span><\/span>\n command.Type <\/span>=<\/span> CommandType.Foreground;<\/span><\/span>\n<\/span>\n list.<\/span>Add<\/span>(command);<\/span><\/span>\n<\/span>\n VoiceControlClient.<\/span>SetCommandList<\/span>(list, CommandType.Foreground);<\/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 no longer needed, unset the command list:<\/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>\/\/\/ Unset the command list<\/span><\/span>\nvoid<\/span> <\/span>unset_command<\/span>()<\/span><\/span>\n{<\/span><\/span>\n <\/span>try<\/span><\/span>\n {<\/span><\/span>\n <\/span>VoiceCommandList<\/span> <\/span>list<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommandList<\/span>();<\/span><\/span>\n <\/span>VoiceCommand<\/span> <\/span>command<\/span> <\/span>=<\/span> <\/span>new<\/span> <\/span>VoiceCommand<\/span>();<\/span><\/span>\n command.Command <\/span>=<\/span> <\/span>"test"<\/span>;<\/span><\/span>\n command.Type <\/span>=<\/span> CommandType.Foreground;<\/span><\/span>\n<\/span>\n list.<\/span>Add<\/span>(command);<\/span><\/span>\n<\/span>\n VoiceControlClient.<\/span>UnsetCommandList<\/span>(CommandType.Foreground);<\/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<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.VoiceControl.VoiceControlClient.md/">Tizen.Uix.VoiceControl.VoiceControlClient/n

Customize your cookie preferences

Necessary

Analytics