* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
- * @remarks If the function succeeds, @a vc must be released with vc_deinitialize().
- * @return @c 0 on success,
+ * @remarks If the function succeeds, vc must be released with 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_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()
*/
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
- * @return @c 0 on success,
+ * @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_deinitialize()
+ * @see vc_initialize()
*/
int vc_deinitialize(void);
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
- * @return @c 0 on success,
+ * @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()
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
- * @return @c 0 on success,
+ * @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()
* @privilege %http://tizen.org/privilege/recorder
* @param[in] callback Callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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()
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
- * @remark If the function succeeds, @a language must be released with free() by you when you no longer need it.
+ * @remarks If the function succeeds, @a language must be released with free() by you when you no longer need it.
* @param[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
- * @return @c 0 on success,
+ * @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()
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @param[out] state The current state
- * @return @c 0 on success,
+ * @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()
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @param[out] state The current state
- * @return @c 0 on success,
+ * @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
- * @pre The state should be #VC_STATE_READY.
- * @see vc_request_start()
- * @see vc_request_stop()
- * @see vc_request_cancel()
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @pre The state should be #VC_STATE_READY.
* @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,
+ * @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,
+ * @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()
*/
/**
+ * @brief Requests to set app id which is to want to ask the server dialogue.
+ * @details Using this function, the developer can request registering the application on vc framework.
+ * If developer requests to register @a app_id with @a credential which is valid, the application will be set on vc framework.
+ * and then, when the developer requests the dialogue using vc_request_dialog(), dialog from specific engine server will be played by vc framework.
+ * @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
+ * @pre The service state should be #VC_SERVICE_STATE_READY.
+ * @see vc_unset_server_dialog()
+ */
+int vc_set_server_dialog(const char* app_id, const char* credential);
+
+
+/**
+ * @brief Requests to unset app id which is to not want to ask the server dialogue.
+ * @details Using this function, the developer can disable function to ask dialog based on server.
+ * @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
+ * @pre The service state should be #VC_SERVICE_STATE_READY.
+ * @see vc_set_server_dialog()
+ */
+int vc_unset_server_dialog(const char* app_id);
+
+
+/**
* @brief Requests to start the dialogue.
* @details Using this function, the developer can request starting the dialogue to the framework.
* When the developer requests the dialogue, two types of texts, @a disp_text and @a utt_text, can be sent by this function.
* @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,
+ * @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);
* The matched commands of command list should be set and they should include type and command text at least.
* @param[in] vc_cmd_list Command list handle
* @param[in] type Command type
- * @return @c 0 on success,
+ * @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()
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @param[in] type Command type
- * @return @c 0 on success,
+ * @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()
*/
* @privilege %http://tizen.org/privilege/recorder
* @param[in] callback Callback function to get recognition result
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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
* @param[in] callback Callback function to register
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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,
+ * @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
* @param[in] callback Callback function to register
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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,
+ * @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
* @param[in] callback Callback function to register
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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,
+ * @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
* @param[in] callback Callback function to register
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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,
+ * @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
* @param[in] callback Callback function to register
* @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
+ * @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,
+ * @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()
*/
int vc_unset_error_cb(void);
+/**
+ * @partner
+ * @brief Requests to send TTS streaming data, asynchronously.
+ * @details Using this function, the developer can request text to speech to the framework.
+ * When the developer requests the TTS with @a language, VC engine will send PCM data which is synthesized using VC engine's own persona.
+ * If @a to_vc_manager is true, the synthesized PCM data will be delivered to the VC manager, otherwise it will be delivered to the VC client
+ * For example, if @a text is "Alarm is set as 7 PM" and @a to_vc_manager is true, the PCM data corresponding "Alarm is set as 7 PM" will be delivered to VC manager client,
+ * and then it will be spoken in VC manager. If @a to_vc_manager is false, you will receive PCM data through the vc_tts_streaming_cb() callback function if it was set using vc_tts_set_streaming_cb().
+ * This function is executed asynchronously, so if there is an error while synthesizing, vc_error_cb() will be called.
+ * @since_tizen 5.5
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/voicecontrol.tts
+ * @param[in] text The text to be requested for TTS
+ * @param[in] language The 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
+ * @param[in] to_vc_manager The value for selection between VC client and VC manager\n
+ * If @c true, the synthesized PCM data will be delivered to the VC manager, otherwise it will be delivered to the VC client
+ * @param[out] utt_id The utterance id
+ * @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_OPERATION_FAILED Operation failure
+ * @pre The state should be #VC_STATE_READY.
+ * @see vc_tts_cancel()
+ */
+int vc_tts_request(const char* text, const char* language, bool to_vc_manager, int* utt_id);
+
+
+/**
+ * @partner
+ * @brief Requests to cancel TTS streaming data.
+ * @since_tizen 5.5
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/voicecontrol.tts
+ * @param[in] utt_id The utterance id
+ * @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
+ * @pre The state should be #VC_STATE_READY.
+ * @see vc_tts_request()
+ */
+int vc_tts_cancel(int utt_id);
+
+
+/**
+ * @partner
+ * @brief Gets the TTS audio details.
+ * @details Using this function, the developer can get details of synthesized audio data which is requested by vc_tts_request() function.
+ * @since_tizen 5.5
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/voicecontrol.tts
+ * @param[out] rate The audio sampling rate
+ * @param[out] channel The audio channel
+ * @param[out] audio_type The audio type
+ * @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
+ * @pre The state should be #VC_STATE_READY.
+ */
+int vc_tts_get_synthesized_audio_details(int* rate, vc_audio_channel_e* channel, vc_audio_type_e* audio_type);
+
+
+/**
+ * @partner
+ * @brief Sets the TTS streaming callback function.
+ * @since_tizen 5.5
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/voicecontrol.tts
+ * @param[in] callback The callback function
+ * @param[in] user_data The user data to be passed to the callback function
+ * @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
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ */
+int vc_tts_set_streaming_cb(vc_tts_streaming_cb callback, void* user_data);
+
+
+/**
+ * @partner
+ * @brief Unsets the TTS streaming callback function.
+ * @since_tizen 5.5
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/voicecontrol.tts
+ * @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
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ */
+int vc_tts_unset_streaming_cb(void);
+
+
+/**
+ * @partner
+ * @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 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
+ * @param[in] callback The callback function
+ * @param[in] user_data The user data to be passed to the callback function
+ * @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_OPERATION_FAILED Operation failure
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ */
+int vc_tts_set_utterance_status_cb(vc_tts_utterance_status_cb callback, void* user_data);
+
+
+/**
+ * @partner
+ * @brief Unsets the TTS utterance status callback function.
+ * @since_tizen 5.5
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/voicecontrol.tts
+ * @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
+ * @pre The state should be #VC_STATE_INITIALIZED.
+ */
+int vc_tts_unset_utterance_status_cb(void);
+
+
#ifdef __cplusplus
}
#endif
/**
- * @}@}
+ * @}
*/
#endif /* __VOICE_CONTROL_H__ */