Class VoiceControlManagerClient

Definition

Namespace:: Tizen.Uix.VoiceControlManager

Assembly:: Tizen.Uix.VoiceControlManager.dll

API Level:: 6

Voice Control Manager Class


                C#
                
                    Copy
                    
                
            
public static class VoiceControlManagerClient : object

Inheritance: Object

VoiceControlManagerClient

Properties

View Source

AudioType

Sets or Gets the Audio In Type. The Values of the strings can be "VC_AUDIO_ID_BLUETOOTH" or "VC_AUDIO_ID_MSF"

Declaration


                C#
                
                    Copy
                    
                
            
public static string AudioType { get; set; }

Property Value

Type	Description
String

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

View Source

CurrentLanguage

Gets the current language. A language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. For example, "ko_KR" for Korean, "en_US" for American English. An empty string is returned in case of some internal error.

Declaration


                C#
                
                    Copy
                    
                
            
public static string CurrentLanguage { get; }

Property Value

Type	Description
String	The current language in voice control.

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized or ready.

View Source

RecognitionMode

Sets or Gets the recognition mode.

Declaration


                C#
                
                    Copy
                    
                
            
public static RecognitionModeType RecognitionMode { get; set; }

Property Value

Type	Description
RecognitionModeType

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

View Source

RecordingVolume

Gets the microphone volume during recording.

Declaration


                C#
                
                    Copy
                    
                
            
public static float RecordingVolume { get; }

Property Value

Type	Description
Single

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The Service State must be Recording.

View Source

ServiceState

Gets the current state of the voice control service.

Declaration


                C#
                
                    Copy
                    
                
            
public static ServiceState ServiceState { get; }

Property Value

Type	Description
ServiceState	The current state of the voice control service.

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be ready.

View Source

State

Gets the current state of the voice control client.

Declaration


                C#
                
                    Copy
                    
                
            
public static State State { get; }

Property Value

Type	Description
State	The current state of the voice control client.

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized or ready.

Methods

View Source

Cancel()

Cancels recognition.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Cancel()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Recording or Processing.

Postcondition: The Service State will become Ready.

View Source

ClearCommands()

Clears commands.

Declaration


                C#
                
                    Copy
                    
                
            
public static void ClearCommands()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

Deinitialize()

Deinitialize the voice control manager.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Deinitialize()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Postcondition: The State will be None.

View Source

DisableCommandType(CommandType)

Disable command type as candidate command.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DisableCommandType(CommandType cmdType)

Parameters

Type	Name	Description
CommandType	cmdType	Command Type

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

DoAction(SendEventType, String)

Request to do action as if utterence is spoken.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DoAction(SendEventType type, string sendEvent)

Parameters

Type	Name	Description
SendEventType	type	Event type
String	sendEvent	The string for send event

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

View Source

EnableCommandType(CommandType)

Enable command type as candidate command.

Declaration


                C#
                
                    Copy
                    
                
            
public static void EnableCommandType(CommandType cmdType)

Parameters

Type	Name	Description
CommandType	cmdType	Command Type

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

GetCurrentCommands()

Retrieves all available commands.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<VoiceCommand> GetCurrentCommands()

Returns

Type	Description
IEnumerable<VoiceCommand>	The Command List else null in case of no System Commands

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

GetPrivateData(String)

Gets private data between app and engine.

Declaration


                C#
                
                    Copy
                    
                
            
public static string GetPrivateData(string key)

Parameters

Type	Name	Description
String	key	Private key

Returns

Type	Description
String	Private data

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

View Source

GetSupportedLanguages()

Retrieves all the supported languages. A language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. For example, "ko_KR" for Korean, "en_US" for American English.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<string> GetSupportedLanguages()

Returns

Type	Description
IEnumerable<String>	List of strings for supported languages.

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be ready or initialized.

View Source

Initialize()

Initialize voice control manager.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Initialize()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Postcondition: The State will be Initialized.

View Source

IsSupportedCommandFormat(CommandFormat)

Checks whether the command format is supported.

Declaration


                C#
                
                    Copy
                    
                
            
public static bool IsSupportedCommandFormat(CommandFormat format)

Parameters

Type	Name	Description
CommandFormat	format	The command format

Returns

Type	Description
Boolean	The result status, true if supported

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

View Source

Prepare()

Connects the voice control service.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Prepare()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized.

Postcondition: The state must be ready.

View Source

SendSpecificEngineRequest(String, String, String)

Sends the specific engine request to the vc-service.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SendSpecificEngineRequest(string engineAppId, string evt, string request)

Parameters

Type	Name	Description
String	engineAppId	A specific engine's app id
String	evt	A engine service user request event
String	request	A engine service user request text

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

View Source

SetCommands(VoiceCommandsGroup)

Sets system or exclusive commands.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SetCommands(VoiceCommandsGroup commands)

Parameters

Type	Name	Description
VoiceCommandsGroup	commands	Command list

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

SetCommandsFromFile(String, CommandType)

Sets commands from file.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SetCommandsFromFile(string path, CommandType type)

Parameters

Type	Name	Description
String	path	File Path
CommandType	type	Command type

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

SetPrivateData(String, String)

Sets private data between app and engine.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SetPrivateData(string key, string data)

Parameters

Type	Name	Description
String	key	Private key
String	data	Private data

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

View Source

SetPrivateDataProviderDelegate(VoiceControlManagerClient.PrivateDataProvider)

Sets the delegate for setting private data.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SetPrivateDataProviderDelegate(VoiceControlManagerClient.PrivateDataProvider privateDataDelegate)

Parameters

Type	Name	Description
VoiceControlManagerClient.PrivateDataProvider	privateDataDelegate	The delegate for setting private data

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

View Source

SetRecognizedCommandsSelectionDelegate(VoiceControlManagerClient.SelectRecognizedCommandsDelegate)

Sets the delegate for setting valid commands.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SetRecognizedCommandsSelectionDelegate(VoiceControlManagerClient.SelectRecognizedCommandsDelegate recognizedCommandsDelegate)

Parameters

Type	Name	Description
VoiceControlManagerClient.SelectRecognizedCommandsDelegate	recognizedCommandsDelegate	The delegate for setting valid commands.

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

View Source

Start(Boolean)

Starts recognition.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Start(bool exclusiveCommandOption)

Parameters

Type	Name	Description
Boolean	exclusiveCommandOption	Exclusive command option

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Ready.

Postcondition: The Service State will become Recording.

View Source

StartFeedback()

Starts getting TTS feedback streaming data from the buffer.

Declaration


                C#
                
                    Copy
                    
                
            
public static void StartFeedback()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

Stop()

Stop recognition.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Stop()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State must be Recording.

Postcondition: The Service State will become Processing.

View Source

StopFeedback()

Stops getting and removes TTS feedback streaming data from the buffer.

Declaration


                C#
                
                    Copy
                    
                
            
public static void StopFeedback()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Ready

View Source

Unprepare()

Disconnects the voice control service.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Unprepare()

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be ready.

Postcondition: The state must be initialized.

Events

View Source

AllRecognitionResultReceived

Called when client gets the all recognition results from vc-daemon.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<AllRecognitionResultEventArgs> AllRecognitionResultReceived

Event Type

Type	Description
EventHandler<AllRecognitionResultEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

ConversationRequested

Event to be called when conversation requests.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<ConversationRequestedEventArgs> ConversationRequested

Event Type

Type	Description
EventHandler<ConversationRequestedEventArgs>

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

CurrentLanguageChanged

Event to be invoked when the default language changes.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<CurrentLanguageChangedEventArgs> CurrentLanguageChanged

Event Type

Type	Description
EventHandler<CurrentLanguageChangedEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized.

View Source

ErrorOccurred

Event to be invoked when an error occurs.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<ErrorOccurredEventArgs> ErrorOccurred

Event Type

Type	Description
EventHandler<ErrorOccurredEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized.

View Source

FeedbackAudioFormatChanged

Called when engine sends audio formats necessary for playing TTS feedback.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<FeedbackAudioFormatEventArgs> FeedbackAudioFormatChanged

Event Type

Type	Description
EventHandler<FeedbackAudioFormatEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

FeedbackStreaming

Called when engine sends audio streaming for TTS feedback.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<FeedbackStreamingEventArgs> FeedbackStreaming

Event Type

Type	Description
EventHandler<FeedbackStreamingEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

PreRecognitionResultUpdated

Called when client gets the pre recognition results(partial ASR) from vc-daemon.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<PreRecognitionResultUpdatedEventArgs> PreRecognitionResultUpdated

Event Type

Type	Description
EventHandler<PreRecognitionResultUpdatedEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

PrivateDataUpdated

Called when engine sets private data to manager client.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<PrivateDataUpdatedEventArgs> PrivateDataUpdated

Event Type

Type	Description
EventHandler<PrivateDataUpdatedEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

RecognitionResultUpdated

Event to be invoked when the recognition is done.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<RecognitionResultUpdatedEventArgs> RecognitionResultUpdated

Event Type

Type	Description
EventHandler<RecognitionResultUpdatedEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

ServiceStateChanged

Event to be invoked when the VoiceControl service state changes.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged

Event Type

Type	Description
EventHandler<ServiceStateChangedEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized.

View Source

SpecificEngineResult

Called when client gets the specific engine's result from vc-service.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<SpecificEngineResultEventArgs> SpecificEngineResult

Event Type

Type	Description
EventHandler<SpecificEngineResultEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

SpeechDetected

Called when user speaking is detected.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<EventArgs> SpeechDetected

Event Type

Type	Description
EventHandler<EventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The State should be Initialized

View Source

StateChanged

Event to be invoked when the VoiceControl client state changes.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<StateChangedEventArgs> StateChanged

Event Type

Type	Description
EventHandler<StateChangedEventArgs>

API Level: 6

Privilege Level: platform

Privilege: http://tizen.org/privilege/voicecontrol.managerhttp://tizen.org/privilege/recorder

Feature: http://tizen.org/feature/speech.control_managerhttp://tizen.org/feature/microphone

Precondition: The state must be initialized.

View Source

VcTtsStreaming

Called when the vc client sends audio streaming for TTS feedback.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<VcTtsStreamingEventArgs> VcTtsStreaming

Event Type

Type	Description
EventHandler<VcTtsStreamingEventArgs>