* @return @c 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_OUT_OF_MEMORY Out of memory
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @post If this function is called, the state will be #VC_STATE_INITIALIZED.
* @see vc_deinitialize()
*/
* @return @c 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_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @see vc_initialize()
*/
int vc_deinitialize(void);
* @return @c 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_STATE Invalid state
* @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_INITIALIZED.
* @post If this function is called, the state will be #VC_STATE_READY.
* @see vc_unprepare()
* @return @c 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
+ * @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.
* @see vc_prepare()
* @return @c 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_OPERATION_FAILED Operation failure
* @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 or #VC_STATE_READY.
* @post This function invokes vc_supported_language_cb() repeatedly for getting languages.
* @see vc_supported_language_cb()
* @return @c 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_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 Not supported
* @pre The state should be #VC_STATE_INITIALIZED or #VC_STATE_READY.
* @see vc_foreach_supported_languages()
*/
* @return @c 0 on success,
* otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @see vc_state_changed_cb()
* @see vc_set_state_changed_cb()
*/
* @return @c 0 on success,
* otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
* @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
* @pre The state should be #VC_STATE_READY.
- * @see vc_request_start()
- * @see vc_request_stop()
- * @see vc_request_cancel()
* @see vc_set_service_state_changed_cb()
* @see vc_unset_service_state_changed_cb()
*/
* @privilege %http://tizen.org/privilege/recorder
* @remarks In the system command list, there are system commands predefined by product manufacturers. Those commands have the highest priority.
* Therefore, the user can not set any commands same with the system commands.
- * The @a vc_sys_cmd_list must be released using free() when it is no longer required.
+ * The @a vc_sys_cmd_list must be released using vc_cmd_list_destroy() when it is no longer required.
* @param[out] vc_sys_cmd_list System command list handle
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The service state should be #VC_SERVICE_STATE_READY.
- * @see vc_unset_command_list()
+ * @see vc_cmd_list_destroy()
*/
int vc_get_system_command_list(vc_cmd_list_h* vc_sys_cmd_list);
/**
* @brief Sets the invocation name.
- * @since_tizen 3.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/recorder
- * @remarks Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase.
+ * @details Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase.
* For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample".
* In order to activate the background command, users can say "Tizen Sample, Play music".
* The invocation name is dependent on the current language. For example, if the current language is "en_US"(English), the invocation name is also "en_US".
* If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized.
* This function should be called before vc_set_command_list().
+ * @since_tizen 3.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks If @a name is @c NULL, the invocation name will be unset.
* @param[in] name Invocation name that an application wants to be invoked by
* @return @c 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
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
* @pre The state should be #VC_STATE_READY.
* @see vc_set_command_list()
*/
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
+ * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework.
+ * However, getting app ID may be failed.
* @param[in] app_id App id which is to want to ask server dialog.
* @param[in] credential Credential key.
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The service state should be #VC_SERVICE_STATE_READY.
* @see vc_unset_server_dialog()
*/
* @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
+ * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework.
+ * However, getting app ID may be failed.
* @param[in] app_id App id which is to not want to ask server dialog.
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The service state should be #VC_SERVICE_STATE_READY.
* @see vc_set_server_dialog()
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @remarks If @a auto_start is @c true, the recognition will start again. In this case, it can be restarted up to 4 times.
+ * @a disp_text and @a utt_text allow @c NULL. However, it is not allowed to set both @a disp_text and @a utt_text as @c NULL.
* @param[in] disp_text Text to be displayed on the screen
* @param[in] utt_text Text to be spoken
* @param[in] auto_start A variable for setting whether the dialog session will be restarted automatically or not
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The service state should be #VC_SERVICE_STATE_READY.
*/
int vc_request_dialog(const char* disp_text, const char* utt_text, bool auto_start);
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_READY.
* @see vc_unset_command_list()
*/
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_READY.
* @see vc_set_command_list()
*/
* @return @c 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
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_READY.
* @see vc_result_cb()
*/
/**
- * @brief Registers a callback function for getting recognition result.
+ * @brief Sets a callback function for getting recognition result.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_result_cb()
* @see vc_unset_result_cb()
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 0 on success,
* otherwise a negative error value
* @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
* @retval #VC_ERROR_NOT_SUPPORTED 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_set_result_cb()
*/
/**
- * @brief Registers a callback function to be called when state is changed.
+ * @brief Sets a callback function to be called when service state is changed.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_service_state_changed_cb()
* @see vc_unset_service_state_changed_cb()
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_set_service_state_changed_cb()
*/
/**
- * @brief Registers a callback function to be called when state is changed.
+ * @brief Sets a callback function to be called when state is changed.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_state_changed_cb()
* @see vc_unset_state_changed_cb()
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_set_state_changed_cb()
*/
/**
- * @brief Registers a callback function to be called when current language is changed.
+ * @brief Sets a callback function to be called when current language is changed.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_current_language_changed_cb()
* @see vc_unset_current_language_changed_cb()
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_set_current_language_changed_cb()
*/
/**
- * @brief Registers a callback function to be called when an error occurred.
+ * @brief Sets a callback function to be called when an error occurred.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_error_cb()
* @see vc_unset_error_cb()
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @return @c 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
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
* @pre The state should be #VC_STATE_INITIALIZED.
* @see vc_set_error_cb()
*/
* @brief Sets the TTS utterance status callback function.
* @details Using this function, the developer can set the utterance status callback to be called
* when the VC manager client starts or stops playing TTS PCM data which was requested to be synthesized with the vc_tts_request() function.
- * This function is called when @a to_vc_manager in the vc_tts_request() function call is @c true.
+ * This function is called when to_vc_manager in the vc_tts_request() function call is @c true.
* @since_tizen 5.5
* @privlevel partner
* @privilege %http://tizen.org/privilege/voicecontrol.tts