* For example, "ko_KR" for Korean, "en_US" for American English.
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop \n @c false to break out of the loop
- * @pre vce_foreach_supported_languages() will invoke this callback.
- * @see vce_foreach_supported_languages()
+ * @pre vce_foreach_supported_languages_cb() will invoke this callback.
+ * @see vce_foreach_supported_languages_cb()
*/
typedef bool (*vce_supported_language_cb)(const char* language, void* user_data);
* @retval #VCE_ERROR_INVALID_STATE Invalid state
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported command type
- * @post vce_start() is called after this function is successful.
- * @see vce_start()
+ * @post vce_start_cb() is called after this function is successful.
+ * @see vce_start_cb()
* @see vcd_foreach_command()
* @see vce_unset_commands()
* @see vce_get_command_count()
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
* @pre vcd_foreach_command() is successful.
* @see vce_set_recording_data_cb()
- * @see vce_stop()
- * @see vce_cancel()
+ * @see vce_stop_cb()
+ * @see vce_cancel_cb()
*/
typedef int (*vce_start_cb)(bool stop_by_silence);
* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_INVALID_STATE Invalid state
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
- * @pre vce_start() is successful.
- * @see vce_start()
- * @see vce_cancel()
- * @see vce_stop()
+ * @pre vce_start_cb() is successful.
+ * @see vce_start_cb()
+ * @see vce_cancel_cb()
+ * @see vce_stop_cb()
*/
typedef int(*vce_set_recording_data_cb)(const void* data, unsigned int length, vce_speech_detect_e* speech_detected);
* @retval #VCE_ERROR_INVALID_STATE Invalid state
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
* @retval #VCE_ERROR_OUT_OF_NETWORK Out of network
- * @pre vce_set_recording_data() is successful.
- * @see vce_start()
- * @see vce_set_recording_data()
- * @see vce_result_cb()
- * @see vce_cancel()
+ * @pre vce_set_recording_data_cb() is successful.
+ * @see vce_start_cb()
+ * @see vce_set_recording_data_cb()
+ * @see vce_send_result()
+ * @see vce_cancel_cb()
*/
typedef int (*vce_stop_cb)(void);
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful.
* @retval #VCE_ERROR_INVALID_STATE Invalid state.
- * @pre vce_start() is successful.
- * @see vce_start()
- * @see vce_stop()
+ * @pre vce_start_cb() is successful.
+ * @see vce_start_cb()
+ * @see vce_stop_cb()
*/
typedef int (*vce_cancel_cb)(void);
* @param[in] credential Credential key.
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful.
- * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
* @retval #VCE_ERROR_PERMISSION_DENIED Permission denied.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
*/
typedef int (*vce_set_server_dialog_cb)(const char* app_id, const char* credential);
* @pre An application registers callback function using vce_set_tts_audio_format_request_cb().
*
* @see vce_set_tts_audio_format_request_cb()
- * @see vce_unset_tts_audio_format_request_cb()
+ * @see vce_unset_get_tts_audio_format_cb()
*/
typedef int (*vce_tts_audio_format_request_cb)(int* rate, int* channel, int* audio_type, void* user_data);
* @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
* @remarks You must register all callbacks except optional callbacks for operating VC engine.\n
* The following callbacks are optional callbacks : \n
- * - vce_private_data_set_cb \n
- * - vce_private_data_requested_cb \n
- * - vce_nlu_base_info_requested_cb \n
- * - vce_specific_engine_request_cb \n
+ * - vce_private_data_set_cb() \n
+ * - vce_private_data_requested_cb() \n
+ * - vce_nlu_base_info_requested_cb() \n
+ * - vce_specific_engine_request_cb() \n
* If you want to use the optional callbacks, you can set them using vce_set_private_data_set_cb(), vce_set_private_data_requested_cb(), vce_set_nlu_base_info_requested_cb(), and vce_set_specific_engine_request_cb() functions.
*
* @see vce_main()
* @param[in] callback The structure of engine request callback function
* @return This function returns @c zero on success, or negative with error code on failure
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
- * @pre The vce_get_engine_info() should be successful.
- * @see vce_get_engine_info()
- * @see vce_unload_engine()
+ * @pre The vce_get_info_cb() should be successful.
+ * @see vce_get_info_cb()
* @see vce_request_callback_s
* @code
#include <vce.h>
* @param[in] callback_func vce_private_data_set event callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
* @pre The vce_main() function should be invoked before this function is called.
* @param[in] callback_func vce_private_data_requested event callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
* @see vce_private_data_requested_cb()
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see vce_unset_specific_engine_request_cb()
*/
* @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
*
* @return 0 on success, otherwise a negative error value
- * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
*
* @see vce_set_specific_engine_request_cb()
*/
* @brief Retrieves all commands using callback function.
* @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
*
- * @param[in] vce_command The handle to be passed to the vce_set_commands() function
+ * @param[in] vce_command The handle to be passed to the vce_set_commands_cb() function
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
*
* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
* @retval #VCE_ERROR_INVALID_STATE Invalid state
* @post This function invokes vce_command_cb() repeatedly for getting commands.
- * @see vce_foreach_command_cb()
- * @see vce_set_commands()
+ * @see vce_command_cb()
+ * @see vce_set_commands_cb()
*/
int vce_get_foreach_command(vce_cmd_h vce_command, vce_command_cb callback, void* user_data);
* @brief Gets command length.
* @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
*
- * @param[in] vce_command The handle to be passed to the vce_set_commands() function
+ * @param[in] vce_command The handle to be passed to the vce_set_commands_cb() function
* @param[out] count The command count value
*
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful
* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
- * @see vce_set_commands()
+ * @see vce_set_commands_cb()
*/
int vce_get_command_count(vce_cmd_h vce_command, int* count);
* @param[in] audio_type Current audio type (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
* @return the value greater than 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
*/
int vce_get_audio_type(char** audio_type);
* @param[in] data Private data
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_INVALID_STATE Invalid state
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
*/
int vce_set_private_data(const char* key, const char* data);
* @param[out] data Private data
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_INVALID_STATE Invalid state
+ * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
*/
int vce_get_private_data(const char* key, char** data);
* @privilege %http://tizen.org/privilege/recorder
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
* @retval #VCE_ERROR_RECORDER_BUSY Busy recorder
*/
* @privilege %http://tizen.org/privilege/recorder
* @return 0 on success, otherwise a negative error value.
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_PERMISSION_DENIED Permission denied
* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
*/
int vce_stop_recording(void);
*
* @return 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see vce_request_tts_cb()
* @see vce_unset_request_tts_cb()
* @since_tizen 5.0
*
* @return 0 on success, otherwise a negative error value
- * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
*
* @see vce_set_request_tts_cb()
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see vce_cancel_tts_cb()
* @see vce_unset_cancel_tts_cb()
* @since_tizen 5.0
*
* @return 0 on success, otherwise a negative error value
- * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
*
* @see vce_set_cancel_tts_cb()
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
- * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see vce_tts_audio_format_request_cb()
* @see vce_unset_get_tts_audio_format_cb()
* @since_tizen 5.0
*
* @return 0 on success, otherwise a negative error value
- * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
*
- * @see vce_set_tts_audio_format_cb()
+ * @see vce_set_tts_audio_format_request_cb()
*/
int vce_unset_get_tts_audio_format_cb(void);
typedef void (*vc_mgr_pre_result_cb)(vc_pre_result_event_e event, const char *result, void *user_data);
/**
-* @brief Called when client gets the specific engine's result from vc-service.
-* @since_tizen 5.0
-*
-* @param[in] engine_app_id The specific engine's app id
-* @param[in] event The specific engine event type
-* @param[in] result The specific engine result
-* @param[in] user_data The user data passed from the callback registration function
-*
-* @pre An application registers callback function using vc_mgr_set_specific_engine_result_cb().
-*
-* @see vc_mgr_set_specific_engine_result_cb()
-* @see vc_mgr_unset_specific_engine_result_cb()
-*/
+ * @brief Called when client gets the specific engine's result from vc-service.
+ * @since_tizen 5.0
+ *
+ * @param[in] engine_app_id The specific engine's app id
+ * @param[in] event The specific engine event type
+ * @param[in] result The specific engine result
+ * @param[in] user_data The user data passed from the callback registration function
+ *
+ * @pre An application registers callback function using vc_mgr_set_specific_engine_result_cb().
+ *
+ * @see vc_mgr_set_specific_engine_result_cb()
+ * @see vc_mgr_unset_specific_engine_result_cb()
+ */
typedef void (*vc_mgr_specific_engine_result_cb)(const char* engine_app_id, const char* event, const char* result, void *user_data);
/**
/* for TTS feedback */
/**
- * @brief Called when engine sends audio formats necessary for playing TTS feedback
+ * @brief Called when engine sends audio formats necessary for playing TTS feedback.
* @since_tizen 5.0
*
* @param[in] rate Audio sampling rate
typedef void (*vc_mgr_feedback_audio_format_cb)(int rate, vc_audio_channel_e channel, vc_audio_type_e audio_type, void *user_data);
/**
- * @brief Called when engine sends audio streaming for TTS feedback
+ * @brief Called when engine sends audio streaming for TTS feedback.
* @since_tizen 5.0
*
* @remarks The @a buffer must be released with free() by you when you no longer need it.
typedef void (*vc_mgr_feedback_streaming_cb)(vc_feedback_event_e event, char* buffer, int len, void *user_data);
/**
- * @brief Called when the vc client sends audio streaming for TTS feedback
+ * @brief Called when the vc client sends audio streaming for TTS feedback.
* @since_tizen 5.0
*
* @remarks The @a buffer must be released with free() by you when you no longer need it.
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
* @retval #VC_ERROR_OPERATION_FAILED Operation fail
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_NONE.
* @post If this function is called, the state will be #VC_STATE_INITIALIZED.
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @post If this function is called, the state will be #VC_STATE_NONE.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
* @post If this function is called, the state will be #VC_STATE_READY.
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_READY.
* @post If this function is called, the state will be #VC_STATE_INITIALIZED.
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should NOT be #VC_SERVICE_STATE_NONE.
* @post This function invokes vc_supported_language_cb() for each supported language.
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should NOT be #VC_SERVICE_STATE_NONE.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should NOT be #VC_SERVICE_STATE_NONE.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY.
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY and the service state should be #VC_SERVICE_STATE_READY.
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY and the service state should be #VC_SERVICE_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY and the service state should be #VC_SERVICE_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY and the service state should be #VC_SERVICE_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The service state should be #VC_SERVICE_STATE_READY.
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The service state should be #VC_SERVICE_STATE_READY.
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The service state should be #VC_SERVICE_STATE_READY.
*/
int vc_mgr_do_action(vc_send_event_type_e type, char *send_event);
/**
-* @platform
-* @brief Sends the specific engine request to the vc-service.
-* @since_tizen 5.0
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @param[in] engine_app_id A specific engine's app id
-* @param[in] event A engine service user request event
-* @param[in] request A engine service user request text
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VC_ERROR_OPERATION_FAILED Operation failure
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*/
+ * @platform
+ * @brief Sends the specific engine request to the vc-service.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @param[in] engine_app_id A specific engine's app id
+ * @param[in] event A engine service user request event
+ * @param[in] request A engine service user request text
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ * @retval #VC_ERROR_OPERATION_FAILED Operation failure
+ */
int vc_mgr_send_specific_engine_request(const char* engine_app_id, const char* event, const char* request);
/**
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter.
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
* @retval #VC_ERROR_IN_PROGRESS_TO_RECORDING In progress to recording
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_READY and the service state should be #VC_SERVICE_STATE_READY.
* @post It will invoke vc_service_state_changed_cb(), if you register a callback with vc_service_state_changed_cb(). \n
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
* @retval #VC_ERROR_IN_PROGRESS_TO_READY In progress to ready
* @retval #VC_ERROR_IN_PROGRESS_TO_RECORDING In progress to recording
* @retval #VC_ERROR_IN_PROGRESS_TO_PROCESSING In progress to processing
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The service state should be #VC_SERVICE_STATE_RECORDING.
* @post It will invoke vc_service_state_changed_cb(), if you register a callback with vc_service_state_changed_cb(). \n
* @see vc_mgr_start()
* @see vc_mgr_cancel()
* @see vc_service_state_changed_cb()
- * @see vc_mgr_result_cb()
+ * @see vc_result_cb()
*/
int vc_mgr_stop(void);
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
* @retval #VC_ERROR_IN_PROGRESS_TO_READY In progress to ready
* @retval #VC_ERROR_IN_PROGRESS_TO_RECORDING In progress to recording
* @retval #VC_ERROR_IN_PROGRESS_TO_PROCESSING In progress to processing
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The service state should be #VC_SERVICE_STATE_RECORDING or #VC_SERVICE_STATE_PROCESSING.
* @post It will invoke vc_service_state_changed_cb(), if you register a callback with vc_service_state_changed_cb(). \n
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The service state should be #VC_SERVICE_STATE_RECORDING.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre vc_mgr_all_result_cb() should be called
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
int vc_mgr_unset_pre_result_cb(void);
/**
-* @brief Registers a callback function for getting specific engine result.
-* @since_tizen 5.0
-*
-* @param[in] callback Callback function to register
-* @param[in] user_data The user data to be passed to the callback function
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED Not supported
-*
-* @pre The state should be #VC_STATE_INITIALIZED.
-*
-* @see vc_mgr_unset_specific_engine_result_cb()
-*/
+ * @platform
+ * @brief Sets a callback function for getting specific engine result.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @param[in] callback Callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ *
+ * @see vc_mgr_unset_specific_engine_result_cb()
+ */
int vc_mgr_set_specific_engine_result_cb(vc_mgr_specific_engine_result_cb callback, void* user_data);
/**
-* @brief Unregisters the specific engine result callback function.
-* @since_tizen 5.0
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED Not supported
-*
-* @pre The state should be #VC_STATE_INITIALIZED.
-*
-* @see vc_mgr_set_specific_engine_result_cb()
-*/
+ * @brief Unsets the specific engine result callback function.
+ * @since_tizen 5.0
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ *
+ * @see vc_mgr_set_specific_engine_result_cb()
+ */
int vc_mgr_unset_specific_engine_result_cb(void);
/**
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval $VC_ERROR_OPERATION_FAILED Operation failure
* @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @see vc_error_cb()
*/
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_READY.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
- * @see vc_private_data_set_cb()
+ * @see vc_mgr_private_data_set_cb()
* @see vc_mgr_unset_private_data_set_cb()
*/
int vc_mgr_set_private_data_set_cb(vc_mgr_private_data_set_cb callback, void *user_data);
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
- * @see vc_private_data_requested_cb()
+ * @see vc_mgr_private_data_requested_cb()
* @see vc_mgr_unset_private_data_requested_cb()
*/
int vc_mgr_set_private_data_requested_cb(vc_mgr_private_data_requested_cb callback, void *user_data);
*
* @return 0 on success, otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
/* for TTS feedback */
/**
-* @platform
-* @brief Sets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.
-* @since_tizen 5.0
-*
-* @param[in] callback Callback function to set
-* @param[in] user_data The user data to be passed to the callback function
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*
-* @pre The state should be #VC_STATE_INITIALIZED.
-*
-* @see vc_mgr_feedback_audio_format_cb()
-* @see vc_mgr_unset_feedback_audio_format_cb()
-*/
+ * @platform
+ * @brief Sets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @param[in] callback Callback function to set
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ *
+ * @see vc_mgr_feedback_audio_format_cb()
+ * @see vc_mgr_unset_feedback_audio_format_cb()
+ */
int vc_mgr_set_feedback_audio_format_cb(vc_mgr_feedback_audio_format_cb callback, void* user_data);
/**
-* @platform
-* @brief Unsets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.
-* @since_tizen 5.0
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*
-* @pre The state should be #VC_STATE_INITIALIZED.
-*
-* @see vc_mgr_feedback_audio_format_cb()
-* @see vc_mgr_set_feedback_audio_format_cb()
-*/
+ * @platform
+ * @brief Unsets a callback function to be called when engine sends audio formats necessary for playing TTS feedback.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ *
+ * @see vc_mgr_feedback_audio_format_cb()
+ * @see vc_mgr_set_feedback_audio_format_cb()
+ */
int vc_mgr_unset_feedback_audio_format_cb(void);
/**
-* @platform
-* @brief Sets a callback function to be called when engine sends audio streaming for TTS feedback.
-* @since_tizen 5.0
-*
-* @param[in] callback Callback function to set
-* @param[in] user_data The user data to be passed to the callback function
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*
-* @pre The state should be #VC_STATE_INITIALIZED.
-*
-* @see vc_mgr_feedback_streaming_cb()
-* @see vc_mgr_unset_feedback_streaming_cb()
-*/
+ * @platform
+ * @brief Sets a callback function to be called when engine sends audio streaming for TTS feedback.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @param[in] callback Callback function to set
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ *
+ * @see vc_mgr_feedback_streaming_cb()
+ * @see vc_mgr_unset_feedback_streaming_cb()
+ */
int vc_mgr_set_feedback_streaming_cb(vc_mgr_feedback_streaming_cb callback, void* user_data);
/**
-* @platform
-* @brief Unsets a callback function to be called when engine sends audio streaming for TTS feedback.
-* @since_tizen 5.0
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*
-* @pre The state should be #VC_STATE_INITIALIZED.
-*
-* @see vc_mgr_feedback_streaming_cb()
-* @see vc_mgr_set_feedback_streaming_cb()
-*/
+ * @platform
+ * @brief Unsets a callback function to be called when engine sends audio streaming for TTS feedback.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ *
+ * @see vc_mgr_feedback_streaming_cb()
+ * @see vc_mgr_set_feedback_streaming_cb()
+ */
int vc_mgr_unset_feedback_streaming_cb(void);
/**
-* @platform
-* @brief Starts getting TTS feedback streaming data from the buffer.
-* @since_tizen 5.0
-*
-* @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().
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*
-* @pre The state should be #VC_STATE_READY. \n
-* 'vc_mgr_feedback_streaming_cb()' should be registered.
-*
-* @see vc_mgr_feedback_streaming_cb()
-* @see vc_mgr_set_feedback_streaming_cb()
-* @see vc_mgr_unset_feedback_streaming_cb()
-* @see vc_mgr_stop_feedback()
-*/
+ * @platform
+ * @brief Starts getting TTS feedback streaming data from the buffer.
+ * @since_tizen 5.0
+ *
+ * @privlevel 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().
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_READY. \n
+ * 'vc_mgr_feedback_streaming_cb()' should be registered.
+ *
+ * @see vc_mgr_feedback_streaming_cb()
+ * @see vc_mgr_set_feedback_streaming_cb()
+ * @see vc_mgr_unset_feedback_streaming_cb()
+ * @see vc_mgr_stop_feedback()
+ */
int vc_mgr_start_feedback(void);
/**
-* @platform
-* @brief Stops getting and removes TTS feedback streaming data from the buffer.
-* @since_tizen 5.0
-*
-* @privlevel platform
-* @privilege %http://tizen.org/privilege/voicecontrol.manager
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_INVALID_STATE Invalid state
-* @retval #VC_ERROR_PERMISSION_DENIED Permission denied
-* @retval #VC_ERROR_NOT_SUPPORTED VC not supported
-*
-* @pre The state should be #VC_STATE_READY.
-*
-* @see vc_mgr_feedback_streaming_cb()
-* @see vc_mgr_set_feedback_streaming_cb()
-* @see vc_mgr_unset_feedback_streaming_cb()
-* @see vc_mgr_start_feedback()
-*/
+ * @platform
+ * @brief Stops getting and removes TTS feedback streaming data from the buffer.
+ * @since_tizen 5.0
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/voicecontrol.manager
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
+ *
+ * @pre The state should be #VC_STATE_READY.
+ *
+ * @see vc_mgr_feedback_streaming_cb()
+ * @see vc_mgr_set_feedback_streaming_cb()
+ * @see vc_mgr_unset_feedback_streaming_cb()
+ * @see vc_mgr_start_feedback()
+ */
int vc_mgr_stop_feedback(void);
/**
* @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value
- * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*
* @privilege %http://tizen.org/privilege/voicecontrol.manager
*
* @return 0 on success, otherwise a negative error value
- * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_INVALID_STATE Invalid state
+ * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED VC not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #VC_STATE_INITIALIZED.
*