The Voice control manager API provides functions for recording voice and giving responses for recognized voice commands to users.

Required Header

#include <voice_control_manager.h>

Overview

A main function of Voice Control Manager API records voice and gives responses for recognized voice commands. A Voice Control Manager application can start recording user's utterance and get responses from Voice Control engine service. The responses are dependent on the Voice Control engine service. For example, the engine service may send ASR(Automatic Speech Recognition) results or NLU(Natural Language Understanding) results. Also, it may send plural results. Therefore, the application can get various recognition results from the engine service and handle them by showing responses to users or controlling Voice Control applications. Like this, the Voice Control Manager application takes a role of controlling Voice Control applications. For this reason, developers who have an authority granted by Tizen platform can make the Voice Control Manager application.

To use of Voice Control Manager, use the following steps:
1. Initialize
2. Register callback functions for notifications
3. Connect to voice control service asynchronously. The state should be changed to Ready
4. Make command list as the following step and Step 4 is called repeatedly for each command which an application wants
4-1. Create command list handle
4-2. Create command handle
4-3. Set command and type for command handle
4-4. Add command handle to command list
5. Set command list for recognition
6. Get recognition results
7. Request the dialogue
8. If an application wants to finish voice control,
8-1. Destroy command and command list handle
8-2. Deinitialize
An application can obtain command handle from command list, and also get information from handle. The Voice Control API also notifies you (by callback mechanism) when the states of client and service are changed, command is recognized, current language is changed or error occurred. An application should register callback functions: vc_state_changed_cb(), vc_service_state_changed_cb(), vc_mgr_all_result_cb(), vc_mgr_pre_result_cb(), vc_result_cb(), vc_mgr_begin_speech_detected_cb(), vc_current_language_changed_cb(), vc_error_cb(), vc_mgr_dialog_request_cb(), vc_mgr_private_data_set_cb(), vc_mgr_private_data_requested_cb().

State Transitions

FUNCTION	PRE-STATE	POST-STATE	SYNC TYPE
vc_mgr_initialize()	None	Initialized	SYNC
vc_mgr_deinitialize()	None, Initialized, Ready	None	SYNC
vc_mgr_prepare()	Initialized	Ready	ASYNC
vc_mgr_unprepare()	Ready	Initialized	SYNC

State Dependent Function Calls

The following table shows state-dependent function calls. It is forbidden to call functions listed below in wrong states. Violation of this rule may result in an unpredictable behavior.

FUNCTION	VALID STATES	DESCRIPTION
vc_mgr_initialize()	None	All functions must be called after vc_mgr_initialize()
vc_mgr_deinitialize()	None, Initialized, Ready	This function should be called when an application want to finalize voice control manager using
vc_mgr_prepare()	Initialized	This function works asynchronously. If service start is failed, application gets the error callback.
vc_mgr_unprepare()	Ready
vc_mgr_foreach_supported_languages()	Initialized, Ready
vc_mgr_get_current_language()	Initialized, Ready
vc_mgr_get_state()	Initialized, Ready
vc_mgr_get_service_state()	Ready
vc_mgr_is_command_format_supported()	Ready
vc_mgr_set_command_list()	Ready
vc_mgr_unset_command_list()	Ready
vc_mgr_set_command_list_from_file()	Ready
vc_mgr_set_preloaded_commands_from_file()	Ready
vc_mgr_get_current_commands()	Ready	The service state should be VC_SERVICE_STATE_READY.
vc_mgr_set_audio_type()	Ready	The service state should be VC_SERVICE_STATE_READY.
vc_mgr_get_audio_type()	Ready	The service state should be VC_SERVICE_STATE_READY.
vc_mgr_set_recognition_mode()	Ready	The service state should be VC_SERVICE_STATE_READY.
vc_mgr_get_recognition_mode()	Ready
vc_mgr_set_private_data()	Ready
vc_mgr_get_private_data()	Ready
vc_mgr_do_action()	Ready
vc_mgr_start()	Ready	The service state should be VC_SERVICE_STATE_READY. If this function succeeds, the service state will be changed to VC_SERVICE_STATE_RECORDING.
vc_mgr_stop()	Ready	The service state should be VC_SERVICE_STATE_RECORDING. If this function succeeds, the service state will be changed to VC_SERVICE_STATE_PROCESSING.
vc_mgr_cancel()	Ready	The service state should be VC_SERVICE_STATE_RECORDING or VC_SERVICE_STATE_PROCESSING. If this function succeeds, the service state will be changed to VC_SERVICE_STATE_READY.
vc_mgr_get_recording_volume()	None, Initialized, Ready	The service state should be VC_SERVICE_STATE_RECORDING.
vc_mgr_set_selected_results()	None, Initialized, Ready
vc_mgr_get_error_message()	None, Initialized, Ready
vc_mgr_enable_command_type()	Ready
vc_mgr_disable_command_type()	Ready
vc_mgr_set_all_result_cb() vc_mgr_unset_all_result_cb() vc_mgr_set_pre_result_cb() vc_mgr_unset_pre_result_cb() vc_mgr_set_result_cb() vc_mgr_unset_result_cb() vc_mgr_set_state_changed_cb() vc_mgr_unset_state_changed_cb() vc_mgr_set_service_state_changed_cb() vc_mgr_unset_service_state_changed_cb() vc_mgr_set_speech_detected_cb() vc_mgr_unset_speech_detected_cb() vc_mgr_set_current_language_changed_cb() vc_mgr_unset_current_language_changed_cb() vc_mgr_set_error_cb() vc_mgr_unset_error_cb() vc_mgr_set_dialog_request_cb() vc_mgr_unset_dialog_request_cb() vc_mgr_set_private_data_set_cb() vc_mgr_unset_private_data_set_cb() vc_mgr_set_private_data_requested_cb() vc_mgr_unset_private_data_requested_cb()	Initialized	All callback function should be registered in Initialized state

Related Features

This API is related with the following features:

http://tizen.org/feature/microphone
http://tizen.org/feature/speech.control_manager
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.

Licensed under the Apache License, Version 2.0 (the License); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Functions
int	vc_mgr_initialize (void)
	Initializes the voice control manager.
int	vc_mgr_deinitialize (void)
	Deinitializes the voice control manager.
int	vc_mgr_prepare (void)
	Connects the voice control service.
int	vc_mgr_unprepare (void)
	Disconnects the voice control service.
int	vc_mgr_foreach_supported_languages (vc_supported_language_cb callback, void *user_data)
	Retrieves all supported languages using callback function.
int	vc_mgr_get_current_language (char **language)
	Gets the current language set by user.
int	vc_mgr_get_state (vc_state_e *state)
	Gets the current state of voice control manager.
int	vc_mgr_get_service_state (vc_service_state_e *state)
	Gets the current state of voice control service.
int	vc_mgr_is_command_format_supported (int format, bool *support)
	Checks whether the command format is supported.
int	vc_mgr_set_command_list (vc_cmd_list_h vc_cmd_list)
	Sets all types of commands.
int	vc_mgr_unset_command_list (void)
	Unsets all types of commands.
int	vc_mgr_set_command_list_from_file (const char *file_path, int type)
	Sets commands from file.
int	vc_mgr_set_preloaded_commands_from_file (const char *file_path)
	Sets background commands of preloaded app from file.
int	vc_mgr_get_current_commands (vc_cmd_list_h *vc_cmd_list)
	Retrieves all available commands.
int	vc_mgr_set_audio_type (const char *audio_id)
	Sets a type of audio-in.
int	vc_mgr_get_audio_type (char **audio_id)
	Gets a type of audio-in.
int	vc_mgr_set_recognition_mode (vc_recognition_mode_e mode)
	Sets recognition mode.
int	vc_mgr_get_recognition_mode (vc_recognition_mode_e *mode)
	Gets recognition mode.
int	vc_mgr_set_private_data (const char key, const char data)
	Sets private data to VC engine.
int	vc_mgr_get_private_data (const char key, char *data)
	Gets private data from VC engine.
int	vc_mgr_do_action (vc_send_event_type_e type, char *send_event)
	Requests to do action as if utterance is spoken.
int	vc_mgr_send_specific_engine_request (const char engine_app_id, const char event, const char *request)
	Sends the specific engine request to the vc-service.
int	vc_mgr_start (bool exclusive_command_option)
	Starts recognition.
int	vc_mgr_stop (void)
	Stops recognition.
int	vc_mgr_cancel (void)
	Cancels recognition.
int	vc_mgr_get_recording_volume (float *volume)
	Gets the microphone volume during recording.
int	vc_mgr_set_selected_results (vc_cmd_list_h vc_cmd_list)
	Selects valid results from all results.
int	vc_mgr_set_all_result_cb (vc_mgr_all_result_cb callback, void *user_data)
	Sets a callback function for getting recognition result.
int	vc_mgr_unset_all_result_cb (void)
	Unsets the recognition result callback function.
int	vc_mgr_set_pre_result_cb (vc_mgr_pre_result_cb callback, void *user_data)
	Sets a callback function for getting pre recognition result.
int	vc_mgr_unset_pre_result_cb (void)
	Unsets the pre recognition result callback function.
int	vc_mgr_set_specific_engine_result_cb (vc_mgr_specific_engine_result_cb callback, void *user_data)
	Sets a callback function for getting specific engine result.
int	vc_mgr_unset_specific_engine_result_cb (void)
	Unsets the specific engine result callback function.
int	vc_mgr_set_result_cb (vc_result_cb callback, void *user_data)
	Sets a callback function for getting all types of recognition results.
int	vc_mgr_unset_result_cb (void)
	Unsets the callback function for getting all types of recognition results.
int	vc_mgr_set_state_changed_cb (vc_state_changed_cb callback, void *user_data)
	Sets a callback function to be called when state is changed.
int	vc_mgr_unset_state_changed_cb (void)
	Unsets the state changed callback function.
int	vc_mgr_set_service_state_changed_cb (vc_service_state_changed_cb callback, void *user_data)
	Sets a callback function to be called when service state is changed.
int	vc_mgr_unset_service_state_changed_cb (void)
	Unsets the service state changed callback function.
int	vc_mgr_set_speech_detected_cb (vc_mgr_begin_speech_detected_cb callback, void *user_data)
	Sets a callback function to be called when begin of speech is detected.
int	vc_mgr_unset_speech_detected_cb (void)
	Unsets the speech detected callback function.
int	vc_mgr_set_current_language_changed_cb (vc_current_language_changed_cb callback, void *user_data)
	Sets a callback function to be called when current language is changed.
int	vc_mgr_unset_current_language_changed_cb (void)
	Unsets the current language changed callback function.
int	vc_mgr_get_error_message (char **err_msg)
	Gets the current error message.
int	vc_mgr_set_error_cb (vc_error_cb callback, void *user_data)
	Sets a callback function to be called when an error occurred.
int	vc_mgr_unset_error_cb (void)
	Unsets the callback function to be called when an error occurred.
int	vc_mgr_set_dialog_request_cb (vc_mgr_dialog_request_cb callback, void *user_data)
	Sets a callback function to be called when dialog requests.
int	vc_mgr_unset_dialog_request_cb (void)
	Unsets the callback function to be called when dialog requests.
int	vc_mgr_enable_command_type (int cmd_type)
	Enables command type as candidate command.
int	vc_mgr_disable_command_type (int cmd_type)
	Disables command type as candidate command.
int	vc_mgr_set_private_data_set_cb (vc_mgr_private_data_set_cb callback, void *user_data)
	Sets a callback function to be called when engine set private data.
int	vc_mgr_unset_private_data_set_cb (void)
	Unsets the callback function to be called when engine set private data.
int	vc_mgr_set_private_data_requested_cb (vc_mgr_private_data_requested_cb callback, void *user_data)
	Sets a callback function to be called when engine request private data.
int	vc_mgr_unset_private_data_requested_cb (void)
	Unsets the callback function to be called when engine request private data.
int	vc_mgr_set_feedback_audio_format_cb (vc_mgr_feedback_audio_format_cb callback, void *user_data)
	Sets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.
int	vc_mgr_unset_feedback_audio_format_cb (void)
	Unsets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.
int	vc_mgr_set_feedback_streaming_cb (vc_mgr_feedback_streaming_cb callback, void *user_data)
	Sets a callback function to be called when engine sends audio streaming for TTS feedback.
int	vc_mgr_unset_feedback_streaming_cb (void)
	Unsets a callback function to be called when engine sends audio streaming for TTS feedback.
int	vc_mgr_start_feedback (void)
	Starts getting TTS feedback streaming data from the buffer.
int	vc_mgr_stop_feedback (void)
	Stops getting and removes TTS feedback streaming data from the buffer.
int	vc_mgr_set_vc_tts_streaming_cb (vc_mgr_vc_tts_streaming_cb callback, void *user_data)
	Sets TTS streaming callback function.
int	vc_mgr_unset_vc_tts_streaming_cb (void)
	Unsets TTS streaming callback function.
int	vc_mgr_send_utterance_status (int pid, int utt_id, vc_tts_utterance_status_e utt_status)
	Sends the utterance status to the VC client.
int	vc_mgr_send_audio_streaming (vc_audio_streaming_event_e event, unsigned char *buffer, unsigned int len)
	Sends audio streaming to the engine service.
int	vc_mgr_set_audio_streaming_mode (vc_audio_streaming_mode_e mode)
	Sets audio streaming mode.
int	vc_mgr_change_background_volume (vc_background_volume_event_e event)
	Changes background volume.
int	vc_mgr_change_background_volume_by_ratio (double ratio)
	Changes background volume ratio.
int	vc_mgr_reset_background_volume (void)
	Resets background volume.
Typedefs
typedef bool(*	vc_mgr_all_result_cb )(vc_result_event_e event, vc_cmd_list_h vc_cmd_list, const char result, const char msg, void *user_data)
	Called when client gets the all recognition results from voice control service.
typedef void(*	vc_mgr_pre_result_cb )(vc_pre_result_event_e event, const char result, void user_data)
	Called when client gets the pre recognition results (partial ASR) from voice control service.
typedef void(*	vc_mgr_specific_engine_result_cb )(const char engine_app_id, const char event, const char result, void user_data)
	Called when client gets the specific engine's result from vc-service.
typedef void(*	vc_mgr_begin_speech_detected_cb )(void *user_data)
	Called when user speaking is detected.
typedef void(*	vc_mgr_dialog_request_cb )(int pid, const char disp_text, const char utt_text, bool continuous, void *user_data)
	Called when an application (VC client) requests dialog.
typedef int(*	vc_mgr_private_data_set_cb )(const char key, const char data, void *user_data)
	Called when engine sets private data to manager client.
typedef int(*	vc_mgr_private_data_requested_cb )(const char key, char data, void user_data)
	Called when engine requests private data from manager client.
typedef void(*	vc_mgr_feedback_audio_format_cb )(int rate, vc_audio_channel_e channel, vc_audio_type_e audio_type, void *user_data)
	Called when engine sends audio formats necessary for playing TTS feedback.
typedef void(*	vc_mgr_feedback_streaming_cb )(vc_feedback_event_e event, char buffer, int len, void user_data)
	Called when engine sends audio streaming for TTS feedback.
typedef void(*	vc_mgr_vc_tts_streaming_cb )(int pid, int utt_id, vc_feedback_event_e event, char buffer, int len, void user_data)
	Called when the vc client sends audio streaming for TTS feedback.
Defines
#define	VC_AUDIO_TYPE_BLUETOOTH "VC_AUDIO_ID_BLUETOOTH"
	Definition of Bluetooth audio-in type.
#define	VC_AUDIO_TYPE_WIFI "VC_AUDIO_ID_WIFI"
	Definition of Wi-Fi audio-in type.
#define	VC_COMMAND_TYPE_FOREGROUND 1
	Definition for foreground command type.
#define	VC_COMMAND_TYPE_BACKGROUND 2
	Definition for background command type.
#define	VC_COMMAND_TYPE_WIDGET 3
	Definition for widget command type.
#define	VC_COMMAND_TYPE_SYSTEM 4
	Definition for system command type.
#define	VC_COMMAND_TYPE_SYSTEM_BACKGROUND 5
	Definition for system background command type.
#define	VC_COMMAND_TYPE_EXCLUSIVE 6
	Definition for exclusive command type.
#define	VC_RESULT_MESSAGE_NONE "vc.result.message.none"
	Definition for none message.
#define	VC_RESULT_MESSAGE_ERROR_TOO_LOUD "vc.result.message.error.too.loud"
	Definition for failed recognition because the speech is too loud to listen.

Define Documentation

#define VC_AUDIO_TYPE_BLUETOOTH "VC_AUDIO_ID_BLUETOOTH"

Definition of Bluetooth audio-in type.

Since :: 5.0 Bluetooth audio type

#define VC_AUDIO_TYPE_WIFI "VC_AUDIO_ID_WIFI"

Definition of Wi-Fi audio-in type.

Since :: 5.0 Wi-Fi audio type

#define VC_COMMAND_TYPE_BACKGROUND 2

Definition for background command type.

Since :: 5.0

#define VC_COMMAND_TYPE_EXCLUSIVE 6

Definition for exclusive command type.

Since :: 5.0

#define VC_COMMAND_TYPE_FOREGROUND 1

Definition for foreground command type.

Since :: 5.0

#define VC_COMMAND_TYPE_SYSTEM 4

Definition for system command type.

Since :: 5.0

#define VC_COMMAND_TYPE_SYSTEM_BACKGROUND 5

Definition for system background command type.

Since :: 5.0

#define VC_COMMAND_TYPE_WIDGET 3

Definition for widget command type.

Since :: 5.0

#define VC_RESULT_MESSAGE_ERROR_TOO_LOUD "vc.result.message.error.too.loud"

Definition for failed recognition because the speech is too loud to listen.

Since :: 5.0

#define VC_RESULT_MESSAGE_NONE "vc.result.message.none"

Definition for none message.

Since :: 5.0

Typedef Documentation

typedef bool(* vc_mgr_all_result_cb)(vc_result_event_e event, vc_cmd_list_h vc_cmd_list, const char *result, const char *msg, void *user_data)

Called when client gets the all recognition results from voice control service.

Since :: 5.0

Remarks:: The vc_cmd_list should not be released. It is managed by the framework and will be released when invoking this callback is finished.
The result and msg are also managed by the framework and will be released when invoking this callback is finished.

Parameters:

[in]	event	The result event
[in]	vc_cmd_list	Command list handle
[in]	result	Command text
[in]	msg	Engine message (e.g. VC_RESULT_MESSAGE_NONE, VC_RESULT_MESSAGE_ERROR_TOO_LOUD)
[in]	user_data	The user data passed from the callback registration function

Returns:: true to release command to client,
false to wait for selecting command.

Precondition:: An application registers callback function using vc_mgr_set_all_result_cb().

See also:: vc_mgr_set_all_result_cb(); vc_mgr_unset_all_result_cb()

typedef void(* vc_mgr_begin_speech_detected_cb)(void *user_data)

Called when user speaking is detected.

Since :: 5.0

Parameters:

[in] user_data The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_speech_detected_cb().

See also:: vc_mgr_set_speech_detected_cb(); vc_mgr_unset_speech_detected_cb()

typedef void(* vc_mgr_dialog_request_cb)(int pid, const char *disp_text, const char *utt_text, bool continuous, void *user_data)

Called when an application (VC client) requests dialog.

Since :: 5.0

Remarks:: The disp_text and utt_text are managed by the framework and will be released when invoking this callback is finished.

Parameters:

[in]	pid	Pid of VC client to request dialog
[in]	disp_text	Text requested to be displayed
[in]	utt_text	Text requested to be spoken
[in]	continuous	Continue dialog session
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_dialog_request_cb().

See also:: vc_mgr_set_dialog_request_cb(); vc_mgr_unset_dialog_request_cb()

typedef void(* vc_mgr_feedback_audio_format_cb)(int rate, vc_audio_channel_e channel, vc_audio_type_e audio_type, void *user_data)

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

Since :: 5.0

Parameters:

[in]	rate	Audio sampling rate
[in]	channel	Audio channel (e.g. VC_AUDIO_CHANNEL_MONO, VC_AUDIO_CHANNEL_STEREO)
[in]	audio_type	Audio type (e.g. VC_AUDIO_TYPE_PCM_S16_LE, VC_AUDIO_TYPE_PCM_U8)
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_feedback_audio_format_cb().

See also:: vc_mgr_set_feedback_audio_format_cb(); vc_mgr_unset_feedback_audio_format_cb()

typedef void(* vc_mgr_feedback_streaming_cb)(vc_feedback_event_e event, char *buffer, int len, void *user_data)

Called when engine sends audio streaming for TTS feedback.

Since :: 5.0

Remarks:: The buffer must be released with free() by you when you no longer need it.

Parameters:

[in]	event	TTS feedback event (e.g. VC_FEEDBACK_EVENT_START, VC_FEEDBACK_EVENT_CONTINUE)
[in]	buffer	Audio streaming data
[in]	len	Length of the audio streaming data
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_feedback_streaming_cb().

See also:: vc_mgr_set_feedback_streaming_cb(); vc_mgr_unset_feedback_streaming_cb()

typedef void(* vc_mgr_pre_result_cb)(vc_pre_result_event_e event, const char *result, void *user_data)

Called when client gets the pre recognition results (partial ASR) from voice control service.

Since :: 5.0

Remarks:: The result is managed by the framework and will be released when invoking this callback is finished.

Parameters:

[in]	event	The pre result event
[in]	result	ASR text
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_pre_result_cb().

See also:: vc_mgr_set_pre_result_cb(); vc_mgr_unset_pre_result_cb()

typedef int(* vc_mgr_private_data_requested_cb)(const char *key, char **data, void *user_data)

Called when engine requests private data from manager client.

Since :: 5.0

Remarks:: The data should not be released. The data and key are managed by the framework and will be released when invoking this callback is finished.

Parameters:

[in]	key	Private key
[out]	data	Private data
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_private_data_requested_cb().

See also:: vc_mgr_set_private_data_requested_cb(); vc_mgr_unset_private_data_requested_cb()

typedef int(* vc_mgr_private_data_set_cb)(const char *key, const char *data, void *user_data)

Called when engine sets private data to manager client.

Since :: 5.0

Remarks:: The key and data are managed by the framework and will be released when invoking this callback is finished.

Parameters:

[in]	key	Private key
[in]	data	Private data
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_private_data_set_cb().

See also:: vc_mgr_set_private_data_set_cb(); vc_mgr_unset_private_data_set_cb()

typedef void(* vc_mgr_specific_engine_result_cb)(const char *engine_app_id, const char *event, const char *result, void *user_data)

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

Since :: 5.0

Remarks:: The engine_app_id, event and result are managed by the framework and will be released when invoking this callback is finished.

Parameters:

[in]	engine_app_id	The specific engine's app id
[in]	event	The specific engine event type
[in]	result	The specific engine result
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_specific_engine_result_cb().

See also:: vc_mgr_set_specific_engine_result_cb(); vc_mgr_unset_specific_engine_result_cb()

typedef void(* vc_mgr_vc_tts_streaming_cb)(int pid, int utt_id, vc_feedback_event_e event, char *buffer, int len, void *user_data)

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

Since :: 5.0

Remarks:: The buffer must be released with free() by you when you no longer need it.

Parameters:

[in]	pid	The process id of the vc client
[in]	utt_id	The utterance id
[in]	event	TTS feedback event (e.g. VC_FEEDBACK_EVENT_START, VC_FEEDBACK_EVENT_CONTINUE)
[in]	buffer	Audio streaming data
[in]	len	Length of the audio streaming data
[in]	user_data	The user data passed from the callback registration function

Precondition:: An application registers callback function using vc_mgr_set_vc_tts_streaming_cb().

See also:: vc_mgr_set_vc_tts_streaming_cb(); vc_mgr_unset_vc_tts_streaming_cb()

Enumeration Type Documentation

enum vc_audio_streaming_event_e

Enumeration of audio streaming event.

Since :: 6.0

Enumerator:

VC_AUDIO_STREAMING_EVENT_FAIL	Failed
VC_AUDIO_STREAMING_EVENT_START	Start event
VC_AUDIO_STREAMING_EVENT_CONTINUE	Continue event
VC_AUDIO_STREAMING_EVENT_FINISH	Finish event

enum vc_audio_streaming_mode_e

Enumeration of audio streaming mode.

Since :: 6.0

Enumerator:

VC_AUDIO_STREAMING_MODE_VC_SERVICE	Use audio recording from VC service
VC_AUDIO_STREAMING_MODE_MULTI_ASSISTANT	Use audio streaming from multi-assistant
VC_AUDIO_STREAMING_MODE_OUTSIDE	Use audio streaming from outside

enum vc_background_volume_event_e

Enumeration of background volume event.

Since :: 6.0

Enumerator:

VC_BACKGROUND_VOLUME_EVENT_CHANGE_FOR_NEARFIELD	Background volume event for near-field
VC_BACKGROUND_VOLUME_EVENT_CHANGE_FOR_FARFIELD	Background volume event for far-field

enum vc_pre_result_event_e

Enumeration of pre result event.

Since :: 5.0

Enumerator:

VC_PRE_RESULT_EVENT_FINAL_RESULT	Pre-result event for final result
VC_PRE_RESULT_EVENT_PARTIAL_RESULT	Pre-result event for partial result
VC_PRE_RESULT_EVENT_ERROR	Pre-result event for error

enum vc_recognition_mode_e

Enumeration of recognition mode.

Since :: 5.0

Enumerator:

VC_RECOGNITION_MODE_STOP_BY_SILENCE	Default mode
VC_RECOGNITION_MODE_RESTART_AFTER_REJECT	Restart recognition after rejected result
VC_RECOGNITION_MODE_RESTART_CONTINUOUSLY	Continuously restart recognition - not support yet
VC_RECOGNITION_MODE_MANUAL	Start and stop manually without silence

enum vc_send_event_type_e

Enumeration of send event type.

Since :: 5.0

Enumerator:

VC_SEND_EVENT_TYPE_TEXT	Send text event to VC engine
VC_SEND_EVENT_TYPE_LIST_EVENT	Send list event to VC engine
VC_SEND_EVENT_TYPE_HAPTIC_EVENT	Send haptic event to VC engine

Function Documentation

int vc_mgr_cancel ( void )

Cancels recognition.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure
VC_ERROR_IN_PROGRESS_TO_READY	In progress to ready
VC_ERROR_IN_PROGRESS_TO_RECORDING	In progress to recording
VC_ERROR_IN_PROGRESS_TO_PROCESSING	In progress to processing

Precondition:: The service state should be VC_SERVICE_STATE_RECORDING or VC_SERVICE_STATE_PROCESSING.

Postcondition:: It will invoke vc_service_state_changed_cb(), if you register a callback with vc_service_state_changed_cb().
If this function succeeds, the service state will be VC_SERVICE_STATE_READY.

See also:: vc_mgr_start(); vc_mgr_stop(); vc_service_state_changed_cb()

int vc_mgr_change_background_volume ( vc_background_volume_event_e event )

Changes background volume.

Warning:: This is not for use by third-party applications.

Since :: 6.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/volume.set

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: If event is VC_BACKGROUND_VOLUME_EVENT_CHANGE_FOR_NEARFIELD, the background volume will be reduced by 70%. And, if event is VC_BACKGROUND_VOLUME_EVENT_CHANGE_FOR_FARFIELD, the background volume will be muted.

Parameters:

[in] event The background volume event

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The state should be VC_STATE_INITIALIZED or VC_STATE_READY.

See also:: vc_mgr_reset_background_volume(); vc_mgr_change_background_volume_by_ratio()

int vc_mgr_change_background_volume_by_ratio ( double ratio )

Changes background volume ratio.

Warning:: This is not for use by third-party applications.

Calling this function sets the background volume to a given percentage of its current value.

Since :: 6.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/volume.set

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in] ratio Current background volume ratio (Range 0.0 ~ 1.0)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The state should be VC_STATE_INITIALIZED or VC_STATE_READY.

See also:: vc_mgr_change_background_volume(); vc_mgr_reset_background_volume()

int vc_mgr_deinitialize ( void )

Deinitializes the voice control manager.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Postcondition:: If this function is called, the state will be VC_STATE_NONE.

See also:: vc_mgr_initialize()

int vc_mgr_disable_command_type ( int cmd_type )

Disables command type as candidate command.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in] cmd_type The command type (e.g. VC_COMMAND_TYPE_FOREGROUND, VC_COMMAND_TYPE_BACKGROUND, VC_COMMAND_TYPE_WIDGET, VC_COMMAND_TYPE_SYSTEM, VC_COMMAND_TYPE_SYSTEM_BACKGROUND, VC_COMMAND_TYPE_EXCLUSIVE)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_enable_command_type()

int vc_mgr_do_action	(	vc_send_event_type_e	type,
		char *	send_event
	)

Requests to do action as if utterance is spoken.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	type	Event type
[in]	send_event	The string for send event

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The service state should be VC_SERVICE_STATE_READY.

int vc_mgr_enable_command_type ( int cmd_type )

Enables command type as candidate command.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in] cmd_type The command type (e.g. VC_COMMAND_TYPE_FOREGROUND, VC_COMMAND_TYPE_BACKGROUND, VC_COMMAND_TYPE_WIDGET, VC_COMMAND_TYPE_SYSTEM, VC_COMMAND_TYPE_SYSTEM_BACKGROUND, VC_COMMAND_TYPE_EXCLUSIVE)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_disable_command_type()

int vc_mgr_foreach_supported_languages	(	vc_supported_language_cb	callback,
		void *	user_data
	)

Retrieves all supported languages using callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OPERATION_FAILED	Operation failure
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should NOT be VC_SERVICE_STATE_NONE.

Postcondition:: This function invokes vc_supported_language_cb() for each supported language.

See also:: vc_supported_language_cb(); vc_mgr_get_current_language()

int vc_mgr_get_audio_type ( char ** audio_id )

Gets a type of audio-in.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: audio_id must be released using free() when it is no longer required.

Parameters:

[out] audio_id The audio id (e.g. VC_AUDIO_TYPE_BLUETOOTH or USB device ID)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY and the service state should be VC_SERVICE_STATE_READY.

See also:: vc_mgr_set_audio_type()

int vc_mgr_get_current_commands ( vc_cmd_list_h * vc_cmd_list )

Retrieves all available commands.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: If the function succeeds, vc_cmd_list must be released with vc_cmd_list_destroy(vc_cmd_list, true).

Parameters:

[out] vc_cmd_list The command list

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure

Precondition:: The state should be VC_STATE_READY and the service state should be VC_SERVICE_STATE_READY.

int vc_mgr_get_current_language ( char ** language )

Gets the current language set by user.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: If the function succeeds, language must be released with free() by you when you no longer need it.

Parameters:

[out] 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.

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Out of memory
VC_ERROR_OPERATION_FAILED	Operation failure
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should NOT be VC_SERVICE_STATE_NONE.

See also:: vc_mgr_foreach_supported_languages()

int vc_mgr_get_error_message ( char ** err_msg )

Gets the current error message.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: This function should be called during as vc error callback. If not, the error as operation failure will be returned.
If the function succeeds, err_msg must be released using free() when it is no longer required.

Parameters:

[out] err_msg The current error message

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure
VC_ERROR_OUT_OF_MEMORY	Out of memory

See also:: vc_error_cb()

int vc_mgr_get_private_data	(	const char *	key,
		char **	data
	)

Gets private data from VC engine.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: VC manager client can get private data from VC engine using this function. data must be released using free() when it is no longer required.

Parameters:

[in]	key	Private key
[out]	data	Private data

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The service state should be VC_SERVICE_STATE_READY.

int vc_mgr_get_recognition_mode ( vc_recognition_mode_e * mode )

Gets recognition mode.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[out] mode Recognition mode

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_set_recognition_mode()

int vc_mgr_get_recording_volume ( float * volume )

Gets the microphone volume during recording.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[out] volume Recording volume

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The service state should be VC_SERVICE_STATE_RECORDING.

See also:: vc_mgr_start()

int vc_mgr_get_service_state ( vc_service_state_e * state )

Gets the current state of voice control service.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[out] state The current state

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_start(); vc_mgr_stop(); vc_mgr_cancel(); vc_set_service_state_changed_cb(); vc_unset_service_state_changed_cb()

int vc_mgr_get_state ( vc_state_e * state )

Gets the current state of voice control manager.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[out] state The current state

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should NOT be VC_SERVICE_STATE_NONE.

See also:: vc_state_changed_cb(); vc_set_state_changed_cb()

int vc_mgr_initialize ( void )

Initializes the voice control manager.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: public

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

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: If the function succeeds, VC manager must be released with vc_mgr_deinitialize().

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_OUT_OF_MEMORY	Out of memory
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The state should be VC_STATE_NONE.

Postcondition:: If this function is called, the state will be VC_STATE_INITIALIZED.

See also:: vc_mgr_deinitialize()

int vc_mgr_is_command_format_supported	(	int	format,
		bool *	support
	)

Checks whether the command format is supported.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: The command formats are defined in Voice control command. (e.g. VC_COMMAND_FORMAT_FIXED, VC_COMMAND_FORMAT_FIXED_AND_NONFIXED, and so on). Please refer to Voice control command.

Parameters:

[in]	format	The command format
[out]	support	The result status `true` = supported, `false` = not supported

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

int vc_mgr_prepare ( void )

Connects the voice control service.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

Postcondition:: If this function is called, the state will be VC_STATE_READY.

See also:: vc_mgr_unprepare()

int vc_mgr_reset_background_volume ( void )

Resets background volume.

Warning:: This is not for use by third-party applications.

This function reverts all changes made by vc_mgr_change_background_volume() and vc_mgr_change_background_volume_by_ratio().

Since :: 6.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/volume.set

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The state should be VC_STATE_INITIALIZED or VC_STATE_READY.

See also:: vc_mgr_change_background_volume(); vc_mgr_change_background_volume_by_ratio()

int vc_mgr_send_audio_streaming	(	vc_audio_streaming_event_e	event,
		unsigned char *	buffer,
		unsigned int	len
	)

Sends audio streaming to the engine service.

Warning:: This is not for use by third-party applications.

Using this function, the developer can send audio streaming after vc_mgr_start() function is called.

Since :: 6.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	event	Audio streaming event (e.g. VC_AUDIO_STREAMING_EVENT_START, VC_AUDIO_STREAMING_EVENT_CONTINUE)
[in]	buffer	Audio streaming data
[in]	len	Length of the audio streaming data

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The state should be VC_SERVICE_STATE_RECORDING.

See also:: vc_mgr_set_audio_streaming_mode()

int vc_mgr_send_specific_engine_request	(	const char *	engine_app_id,
		const char *	event,
		const char *	request
	)

Sends the specific engine request to the vc-service.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	engine_app_id	A specific engine's app id
[in]	event	A engine service user request event
[in]	request	A engine service user request text

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure

int vc_mgr_send_utterance_status	(	int	pid,
		int	utt_id,
		vc_tts_utterance_status_e	utt_status
	)

Sends the utterance status to the VC client.

Warning:: This is not for use by third-party applications.

Since :: 6.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	pid	The process id of the VC client
[in]	utt_id	The utterance id
[in]	utt_status	The utterance status

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The service state should be VC_SERVICE_STATE_READY.

int vc_mgr_set_all_result_cb	(	vc_mgr_all_result_cb	callback,
		void *	user_data
	)

Sets a callback function for getting recognition result.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: This callback must be set. Without this callback, the framework can not deliver the result of voice recognition to proper client.

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_all_result_cb(); vc_mgr_unset_all_result_cb()

int vc_mgr_set_audio_streaming_mode ( vc_audio_streaming_mode_e mode )

Sets audio streaming mode.

Warning:: This is not for use by third-party applications.

Since :: 6.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: The default audio streaming mode is VC_AUDIO_STREAMING_MODE_VC_SERVICE.
If you want to use other mode, you can set mode with vc_mgr_set_audio_streaming_mode().

Parameters:

[in] mode Audio streaming mode

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation fail

Precondition:: The state should be VC_STATE_INITIALIZED or VC_SERVICE_STATE_READY.

See also:: vc_mgr_send_audio_streaming()

int vc_mgr_set_audio_type ( const char * audio_id )

Sets a type of audio-in.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in] audio_id The audio type (e.g. VC_AUDIO_TYPE_BLUETOOTH or USB device ID)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure

Precondition:: The state should be VC_STATE_READY and the service state should be VC_SERVICE_STATE_READY.

See also:: vc_mgr_get_audio_type()

int vc_mgr_set_command_list ( vc_cmd_list_h vc_cmd_list )

Sets all types of commands.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: VC manager client can register all types of commands. The commands should include type, command text, format.

Parameters:

[in] vc_cmd_list The command list handle

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_unset_command_list()

int vc_mgr_set_command_list_from_file	(	const char *	file_path,
		int	type
	)

Sets commands from file.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: The commands should include type, command text, format.

Parameters:

[in]	file_path	The directory of a file which has command list
[in]	type	The command type (e.g. VC_COMMAND_TYPE_FOREGROUND, VC_COMMAND_TYPE_BACKGROUND, VC_COMMAND_TYPE_WIDGET, VC_COMMAND_TYPE_SYSTEM, VC_COMMAND_TYPE_SYSTEM_BACKGROUND, VC_COMMAND_TYPE_EXCLUSIVE)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_unset_command_list()

int vc_mgr_set_current_language_changed_cb	(	vc_current_language_changed_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when current language is changed.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_current_language_changed_cb(); vc_mgr_unset_current_language_changed_cb()

int vc_mgr_set_dialog_request_cb	(	vc_mgr_dialog_request_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when dialog requests.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_unset_dialog_request_cb()

int vc_mgr_set_error_cb	(	vc_error_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when an error occurred.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_error_cb(); vc_mgr_unset_error_cb()

int vc_mgr_set_feedback_audio_format_cb	(	vc_mgr_feedback_audio_format_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to set
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_feedback_audio_format_cb(); vc_mgr_unset_feedback_audio_format_cb()

int vc_mgr_set_feedback_streaming_cb	(	vc_mgr_feedback_streaming_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when engine sends audio streaming for TTS feedback.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to set
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_feedback_streaming_cb(); vc_mgr_unset_feedback_streaming_cb()

int vc_mgr_set_pre_result_cb	(	vc_mgr_pre_result_cb	callback,
		void *	user_data
	)

Sets a callback function for getting pre recognition result.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_pre_result_cb(); vc_mgr_unset_pre_result_cb()

int vc_mgr_set_preloaded_commands_from_file ( const char * file_path )

Sets background commands of preloaded app from file.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: The command type is valid for VC_COMMAND_TYPE_BACKGROUND. The commands should include type, command text, format.

Parameters:

[in] file_path The directory of a file which has command list

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_unset_command_list()

int vc_mgr_set_private_data	(	const char *	key,
		const char *	data
	)

Sets private data to VC engine.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: VC manager client can set private data to VC engine using this function.

Parameters:

[in]	key	Private key
[in]	data	Private data

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_OUT_OF_MEMORY	Not enough memory
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The service state should be VC_SERVICE_STATE_READY.

int vc_mgr_set_private_data_requested_cb	(	vc_mgr_private_data_requested_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when engine request private data.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_private_data_requested_cb(); vc_mgr_unset_private_data_requested_cb()

int vc_mgr_set_private_data_set_cb	(	vc_mgr_private_data_set_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when engine set private data.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_private_data_set_cb(); vc_mgr_unset_private_data_set_cb()

int vc_mgr_set_recognition_mode ( vc_recognition_mode_e mode )

Sets recognition mode.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in] mode Recognition mode (e.g. VC_RECOGNITION_MODE_STOP_BY_SILENCE is default value)

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY and the service state should be VC_SERVICE_STATE_READY.

See also:: vc_mgr_get_recognition_mode()

int vc_mgr_set_result_cb	(	vc_result_cb	callback,
		void *	user_data
	)

Sets a callback function for getting all types of recognition results.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_result_cb(); vc_mgr_unset_result_cb()

int vc_mgr_set_selected_results ( vc_cmd_list_h vc_cmd_list )

Selects valid results from all results.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: This function should be called when vc_mgr_all_result_cb() returns false. The vc_cmd_list can be NULL, in that case the function does nothing.

Parameters:

[in] vc_cmd_list The valid result list

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: vc_mgr_all_result_cb() should be called

See also:: vc_mgr_all_result_cb()

int vc_mgr_set_service_state_changed_cb	(	vc_service_state_changed_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when service state is changed.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_service_state_changed_cb(); vc_mgr_unset_service_state_changed_cb()

int vc_mgr_set_specific_engine_result_cb	(	vc_mgr_specific_engine_result_cb	callback,
		void *	user_data
	)

Sets a callback function for getting specific engine result.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	Not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_unset_specific_engine_result_cb()

int vc_mgr_set_speech_detected_cb	(	vc_mgr_begin_speech_detected_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when begin of speech is detected.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_begin_speech_detected_cb(); vc_mgr_unset_speech_detected_cb()

int vc_mgr_set_state_changed_cb	(	vc_state_changed_cb	callback,
		void *	user_data
	)

Sets a callback function to be called when state is changed.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	Callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_state_changed_cb(); vc_mgr_unset_state_changed_cb()

int vc_mgr_set_vc_tts_streaming_cb	(	vc_mgr_vc_tts_streaming_cb	callback,
		void *	user_data
	)

Sets TTS streaming callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Parameters:

[in]	callback	The callback function
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_vc_tts_streaming_cb(); vc_mgr_unset_vc_tts_streaming_cb()

int vc_mgr_start ( bool exclusive_command_option )

Starts recognition.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: The default recognition mode is VC_RECOGNITION_MODE_STOP_BY_SILENCE.
If you want to use other mode, you can set mode with vc_mgr_set_recognition_mode().

Parameters:

[in] exclusive_command_option Exclusive command option

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_PARAMETER	Invalid parameter.
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure
VC_ERROR_IN_PROGRESS_TO_RECORDING	In progress to recording

Precondition:: The state should be VC_STATE_READY and the service state should be VC_SERVICE_STATE_READY.

Postcondition:: It will invoke vc_service_state_changed_cb(), if you register a callback with vc_service_state_changed_cb().
If this function succeeds, the service state will be VC_SERVICE_STATE_RECORDING.

See also:: vc_mgr_stop(); vc_mgr_cancel(); vc_service_state_changed_cb(); vc_mgr_set_recognition_mode(); vc_mgr_get_recognition_mode()

int vc_mgr_start_feedback ( void )

Starts getting TTS feedback streaming data from the buffer.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: In order to get TTS feedback streaming data, the application should set 'vc_mgr_feedback_streaming_cb()' using vc_mgr_set_feedback_streaming_cb().

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.
'vc_mgr_feedback_streaming_cb()' should be registered.

See also:: vc_mgr_feedback_streaming_cb(); vc_mgr_set_feedback_streaming_cb(); vc_mgr_unset_feedback_streaming_cb(); vc_mgr_stop_feedback()

int vc_mgr_stop ( void )

Stops recognition.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state
VC_ERROR_OPERATION_FAILED	Operation failure
VC_ERROR_IN_PROGRESS_TO_READY	In progress to ready
VC_ERROR_IN_PROGRESS_TO_RECORDING	In progress to recording
VC_ERROR_IN_PROGRESS_TO_PROCESSING	In progress to processing

Precondition:: The service state should be VC_SERVICE_STATE_RECORDING.

Postcondition:: It will invoke vc_service_state_changed_cb(), if you register a callback with vc_service_state_changed_cb().
If this function succeeds, the service state will be VC_SERVICE_STATE_PROCESSING.

See also:: vc_mgr_start(); vc_mgr_cancel(); vc_service_state_changed_cb(); vc_result_cb()

int vc_mgr_stop_feedback ( void )

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

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_feedback_streaming_cb(); vc_mgr_set_feedback_streaming_cb(); vc_mgr_unset_feedback_streaming_cb(); vc_mgr_start_feedback()

int vc_mgr_unprepare ( void )

Disconnects the voice control service.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

Postcondition:: If this function is called, the state will be VC_STATE_INITIALIZED.

See also:: vc_mgr_prepare()

int vc_mgr_unset_all_result_cb ( void )

Unsets the recognition result callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_all_result_cb()

int vc_mgr_unset_command_list ( void )

Unsets all types of commands.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Remarks:: All previously registered commands will be unset.

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_READY.

See also:: vc_mgr_set_command_list()

int vc_mgr_unset_current_language_changed_cb ( void )

Unsets the current language changed callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_current_language_changed_cb()

int vc_mgr_unset_dialog_request_cb ( void )

Unsets the callback function to be called when dialog requests.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_dialog_request_cb()

int vc_mgr_unset_error_cb ( void )

Unsets the callback function to be called when an error occurred.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_error_cb()

int vc_mgr_unset_feedback_audio_format_cb ( void )

Unsets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_feedback_audio_format_cb(); vc_mgr_set_feedback_audio_format_cb()

int vc_mgr_unset_feedback_streaming_cb ( void )

Unsets a callback function to be called when engine sends audio streaming for TTS feedback.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_feedback_streaming_cb(); vc_mgr_set_feedback_streaming_cb()

int vc_mgr_unset_pre_result_cb ( void )

Unsets the pre recognition result callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_pre_result_cb()

int vc_mgr_unset_private_data_requested_cb ( void )

Unsets the callback function to be called when engine request private data.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_private_data_requested_cb()

int vc_mgr_unset_private_data_set_cb ( void )

Unsets the callback function to be called when engine set private data.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_private_data_set_cb()

int vc_mgr_unset_result_cb ( void )

Unsets the callback function for getting all types of recognition results.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_result_cb()

int vc_mgr_unset_service_state_changed_cb ( void )

Unsets the service state changed callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_service_state_changed_cb()

int vc_mgr_unset_specific_engine_result_cb ( void )

Unsets the specific engine result callback function.

Since :: 5.0

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	Not supported
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_specific_engine_result_cb()

int vc_mgr_unset_speech_detected_cb ( void )

Unsets the speech detected callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_speech_detected_cb()

int vc_mgr_unset_state_changed_cb ( void )

Unsets the state changed callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_set_state_changed_cb()

int vc_mgr_unset_vc_tts_streaming_cb ( void )

Unsets TTS streaming callback function.

Warning:: This is not for use by third-party applications.

Since :: 5.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/voicecontrol.manager

Returns:: 0 on success, otherwise a negative error value

Return values:

VC_ERROR_NONE	Successful
VC_ERROR_NOT_SUPPORTED	VC not supported
VC_ERROR_PERMISSION_DENIED	Permission denied
VC_ERROR_INVALID_STATE	Invalid state

Precondition:: The state should be VC_STATE_INITIALIZED.

See also:: vc_mgr_vc_tts_streaming_cb(); vc_mgr_set_vc_tts_streaming_cb()

Required Header

Overview

State Transitions

State Dependent Function Calls

Related Features

Functions

Typedefs

Defines

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation