/*
-* Copyright (c) 2011-2017 Samsung Electronics Co., Ltd All Rights Reserved
-*
-* Licensed under the Apache License, Version 2.0 (the License);
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an AS IS BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Copyright (c) 2011-2017 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
#ifndef __VCE_H__
#include <tizen.h>
/**
-* @addtogroup CAPI_UIX_VOICE_CONTROL_ENGINE_MODULE
-* @{
-*/
+ * @addtogroup CAPI_UIX_VOICE_CONTROL_ENGINE_MODULE
+ * @{
+ */
#ifdef __cplusplus
extern "C" {
#endif
/**
-* @brief Enumerations of error codes.
-* @since_tizen 4.0
-*/
+ * @brief Enumerations of error codes.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef enum {
VCE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
VCE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of Memory */
} vce_error_e;
/**
-* @brief Enumerations of audio type.
-* @since_tizen 4.0
-*/
+ * @brief Enumerations of audio type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef enum {
VCE_AUDIO_TYPE_PCM_S16_LE = 0, /**< Signed 16bit audio type, Little endian */
VCE_AUDIO_TYPE_PCM_U8 /**< Unsigned 8bit audio type */
} vce_audio_type_e;
/**
-* @brief Enumerations of callback event.
-* @since_tizen 4.0
-*/
+ * @brief Enumerations of callback event.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef enum {
VCE_RESULT_EVENT_SUCCESS = 0, /**< Event when the recognition full result is ready */
VCE_RESULT_EVENT_REJECTED, /**< Event when the recognition result is rejected */
} vce_result_event_e;
/**
-* @brief Enumerations of command type.
-* @since_tizen 4.0
-*/
+ * @brief Enumerations of command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef enum {
VCE_COMMAND_FORMAT_FIXED = 0, /**< Fixed command */
VCE_COMMAND_FORMAT_FIXED_AND_VFIXED, /**< Fixed command + variable-fixed command */
} vce_command_format_e;
/**
-* @brief Enumerations of speech detect.
-* @since_tizen 4.0
-*/
+ * @brief Enumerations of speech detect.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef enum {
VCE_SPEECH_DETECT_NONE = 0, /**< No event */
VCE_SPEECH_DETECT_BEGIN, /**< Begin of speech detected */
} vce_speech_detect_e;
/**
-* @brief Enumerations of ASR result events.
-* @since_tizen 4.0
-*/
+ * @brief Enumerations of ASR result events.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef enum {
VCE_ASR_RESULT_EVENT_FINAL_RESULT = 0, /**< Event when the ASR result is last data or ASR result is only one result */
VCE_ASR_RESULT_EVENT_PARTIAL_RESULT, /**< Event when the ASR result exist, not first and not last */
/**
* @brief Enumerations of audio channels.
- * @since_tizen 4.0
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
VCE_AUDIO_CHANNEL_MONO = 0, /**< 1 channel, mono */
/**
* @brief Enumeration for TTS feedback events.
- * @since_tizen 4.0
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
VCE_FEEDBACK_EVENT_FAIL = -1, /**< Failed */
/**
-* @brief A structure of handle for VC command.
-* @since_tizen 4.0
-*/
+ * @brief A structure of handle for VC command.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
typedef struct vce_cmd_s* vce_cmd_h;
/**
-* @brief Definition for foreground command type.
-* @since_tizen 4.0
-*/
+ * @brief Definition for foreground command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_COMMAND_TYPE_FOREGROUND 1
/**
-* @brief Definition for background command type.
-* @since_tizen 4.0
-*/
+ * @brief Definition for background command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_COMMAND_TYPE_BACKGROUND 2
/**
-* @brief Definition for widget command type.
-* @since_tizen 4.0
-*/
+ * @brief Definition for widget command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_COMMAND_TYPE_WIDGET 3
/**
-* @brief Definition for system command type.
-* @since_tizen 4.0
-*/
+ * @brief Definition for system command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_COMMAND_TYPE_SYSTEM 4
/**
-* @brief Definition for system background command type.
-* @since_tizen 4.0
-*/
+ * @brief Definition for system background command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_COMMAND_TYPE_SYSTEM_BACKGROUND 5
/**
-* @brief Definitions for exclusive command type.
-* @since_tizen 4.0
-*/
+ * @brief Definitions for exclusive command type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_COMMAND_TYPE_EXCLUSIVE 6
/**
-* @brief Definition of bluetooth audio id.
-* @since_tizen 4.0
-*/
+ * @brief Definition of bluetooth audio id.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_AUDIO_ID_BLUETOOTH "VC_AUDIO_ID_BLUETOOTH" /**< Bluetooth audio id */
/**
-* @brief Definition of Wi-Fi audio id.
-* @since_tizen 4.0
-*/
+ * @brief Definition of Wi-Fi audio id.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VCE_AUDIO_ID_WIFI "VC_AUDIO_ID_WIFI" /**< Wi-Fi audio id */
/**
-* @brief Definition for none message.
-* @since_tizen 4.0
-*/
+ * @brief Definition for none message.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VC_RESULT_MESSAGE_NONE "vc.result.message.none"
/**
-* @brief Definition for failed recognition because the speech is too loud to listen.
-* @since_tizen 4.0
-*/
+ * @brief Definition for failed recognition because the speech is too loud to listen.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ */
#define VC_RESULT_MESSAGE_ERROR_TOO_LOUD "vc.result.message.error.too.loud"
/**
-* @brief Called when VC engine informs the engine service user about whole supported languages.
-* @details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
-* @since_tizen 4.0
-* @remarks This callback function is called by vce_foreach_supported_languages_cb() to retrieve the whole supported language list.
-* The @a user_data must be transferred from vce_foreach_supported_languages_cb().
-* The @a language can be used only in the callback. To use outside, make a copy.
-* @param[in] 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 \n
-* 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()
-*/
+ * @brief Called when VC engine informs the engine service user about whole supported languages.
+ * @details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is called by vce_foreach_supported_languages_cb() to retrieve the whole supported language list.
+ * The @a user_data must be transferred from vce_foreach_supported_languages_cb().
+ * The @a language can be used only in the callback. To use outside, make a copy.
+ * @param[in] 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 \n
+ * 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()
+ */
typedef bool (*vce_supported_language_cb)(const char* language, void* user_data);
/**
-* @brief Called when the engine service user initializes Voice Control (VC) engine.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_INVALID_STATE Already initialized
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
-* @see vce_deinitialize_cb()
-*/
+ * @brief Called when the engine service user initializes Voice Control (VC) engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_INVALID_STATE Already initialized
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failed
+ * @see vce_deinitialize_cb()
+ */
typedef int (*vce_initialize_cb)(void);
/**
-* @brief Called when the engine service user deinitializes VC engine.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_STATE Not initialized
-* @see vce_initialize_cb()
-*/
+ * @brief Called when the engine service user deinitializes VC engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_STATE Not initialized
+ * @see vce_initialize_cb()
+ */
typedef int (*vce_deinitialize_cb)(void);
/**
-* @brief Called when the engine service user requests the recording format of VC engine.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* The @a audio_id can be used only in the callback. To use outside, make a copy.
-* The @a types is managed by the platform and will be released when this callback function is completed.
-* The @a rate is managed by the platform and will be released when this callback function is completed.
-* The @a channels is managed by the platform and will be released when this callback function is completed.
-* @param[in] audio_id The audio device id. (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
-* @param[out] types The format used by the recorder.
-* @param[out] rate The sample rate used by the recorder.
-* @param[out] channels The number of channels used by the recorder.
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Not initialized
-*/
+ * @brief Called when the engine service user requests the recording format of VC engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * The @a audio_id can be used only in the callback. To use outside, make a copy.
+ * The @a types is managed by the platform and will be released when this callback function is completed.
+ * The @a rate is managed by the platform and will be released when this callback function is completed.
+ * The @a channels is managed by the platform and will be released when this callback function is completed.
+ * @param[in] audio_id The audio device id. (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
+ * @param[out] types The format used by the recorder.
+ * @param[out] rate The sample rate used by the recorder.
+ * @param[out] channels The number of channels used by the recorder.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Not initialized
+ */
typedef int (*vce_get_recording_format_cb)(const char* audio_id, vce_audio_type_e* types, int* rate, int* channels);
/**
-* @brief Called when the engine service user retrieves all supported languages of VC engine.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* @param[in] callback a callback function
-* @param[in] user_data The user data to be passed to the callback function
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_INVALID_STATE Not initialized
-* @post This function invokes vce_supported_language_cb() repeatedly for getting supported languages.
-*
-* @see vce_supported_language_cb()
-*/
+ * @brief Called when the engine service user retrieves all supported languages of VC engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * @param[in] callback a callback function
+ * @param[in] user_data The user data to be passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_INVALID_STATE Not initialized
+ * @post This function invokes vce_supported_language_cb() repeatedly for getting supported languages.
+ *
+ * @see vce_supported_language_cb()
+ */
typedef int (*vce_foreach_supported_languages_cb)(vce_supported_language_cb callback, void* user_data);
/**
-* @brief Called when the engine service user checks whether a language is supported or not.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* The @a language can be used only in the callback. To use outside, make a copy.
-* @param[in] language A language
-* @return @c true = supported, \n @c false = not supported.
-*/
+ * @brief Called when the engine service user checks whether a language is supported or not.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * The @a language can be used only in the callback. To use outside, make a copy.
+ * @param[in] language A language
+ * @return @c true = supported, \n @c false = not supported.
+ */
typedef bool (*vce_is_language_supported_cb)(const char* language);
/**
-* @brief Called when the engine service user sets language.
-* @since_tizen 4.0
-* @remarks The @a language can be used only in the callback. To use outside, make a copy.
-* @param[in] language A language.
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_LANGUAGE Invalid language
-* @retval #VCE_ERROR_INVALID_STATE Not initialized
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
-*/
+ * @brief Called when the engine service user sets language.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a language can be used only in the callback. To use outside, make a copy.
+ * @param[in] language A language.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_LANGUAGE Invalid language
+ * @retval #VCE_ERROR_INVALID_STATE Not initialized
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
+ */
typedef int (*vce_set_language_cb)(const char* language);
/**
-* @brief Called when the engine service user sets command list before recognition.
-* @since_tizen 4.0
-* @remarks This function should set commands via vcd_foreach_command().
-* The @a vc_command should not be released.
-* The @a vc_command can be used only in the callback. To use outside, make a copy.
-* @param[in] vc_command command handle. The @a vc_command can be used only in the callback. To use outside, make a copy.
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @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()
-* @see vcd_foreach_command()
-* @see vce_unset_commands()
-* @see vce_get_command_count()
-*/
+ * @brief Called when the engine service user sets command list before recognition.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This function should set commands via vcd_foreach_command().
+ * The @a vc_command should not be released.
+ * The @a vc_command can be used only in the callback. To use outside, make a copy.
+ * @param[in] vc_command command handle. The @a vc_command can be used only in the callback. To use outside, make a copy.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @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()
+ * @see vcd_foreach_command()
+ * @see vce_unset_commands()
+ * @see vce_get_command_count()
+ */
typedef int (*vce_set_commands_cb)(vce_cmd_h vc_command);
/**
-* @brief Called when the engine service user unsets command list for reset.
-* @since_tizen 4.0
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_INVALID_STATE Invalid state
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
-* @see vce_set_commands_cb()
-*/
+ * @brief Called when the engine service user unsets command list for reset.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_INVALID_STATE Invalid state
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
+ * @see vce_set_commands_cb()
+ */
typedef int (*vce_unset_commands_cb)(void);
/**
-* @brief Called when the engine service user starts recognition.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* @param[in] stop_by_silence Silence detection option.
-* @c true to detect the silence,
-* @c false not to detect the silence
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_INVALID_STATE Invalid state
-* @retval #VCE_ERROR_INVALID_LANGUAGE Invalid language
-* @retval #VCE_ERROR_OUT_OF_NETWORK Out of network
-* @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()
-*/
+ * @brief Called when the engine service user starts recognition.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * @param[in] stop_by_silence Silence detection option.
+ * @c true to detect the silence,
+ * @c false not to detect the silence
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_INVALID_STATE Invalid state
+ * @retval #VCE_ERROR_INVALID_LANGUAGE Invalid language
+ * @retval #VCE_ERROR_OUT_OF_NETWORK Out of network
+ * @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()
+ */
typedef int (*vce_start_cb)(bool stop_by_silence);
/**
-* @brief Called when the engine service user sets recording data for speech recognition from recorder.
-* @since_tizen 4.0
-* @remarks This function should be returned immediately after recording data copy.
-* The @a data can be used only in the callback. To use outside, make a copy.
-* The @a speech_detected should not be released. This is managed by the platform.
-* @param[in] data A recording data
-* @param[in] length A length of recording data
-* @param[out] speech_detected The status of speech (e.g. #VCE_SPEECH_DETECT_BEGIN or #VCE_SPEECH_DETECT_END). The @a speech_detected can be used only in the callback. To use outside, make a copy.
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @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()
-*/
+ * @brief Called when the engine service user sets recording data for speech recognition from recorder.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This function should be returned immediately after recording data copy.
+ * The @a data can be used only in the callback. To use outside, make a copy.
+ * The @a speech_detected should not be released. This is managed by the platform.
+ * @param[in] data A recording data
+ * @param[in] length A length of recording data
+ * @param[out] speech_detected The status of speech (e.g. #VCE_SPEECH_DETECT_BEGIN or #VCE_SPEECH_DETECT_END). The @a speech_detected can be used only in the callback. To use outside, make a copy.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @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()
+ */
typedef int(*vce_set_recording_data_cb)(const void* data, unsigned int length, vce_speech_detect_e* speech_detected);
/**
-* @brief Called when the engine service user stops to get the result of recognition.
-* @since_tizen 4.0
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @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()
-*/
+ * @brief Called when the engine service user stops to get the result of recognition.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @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()
+ */
typedef int (*vce_stop_cb)(void);
/**
-* @brief Called when the engine service user cancels the recognition process.
-* @since_tizen 4.0
-* @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()
-*/
+ * @brief Called when the engine service user cancels the recognition process.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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()
+ */
typedef int (*vce_cancel_cb)(void);
/**
-* @brief Called when the engine service user sets audio recording type.
-* @since_tizen 4.0
-* @remarks The @a audio_type can be used only in the callback. To use outside, make a copy.
-* @param[in] audio_type Current audio type (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user sets audio recording type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a audio_type can be used only in the callback. To use outside, make a copy.
+ * @param[in] audio_type Current audio type (e.g. #VCE_AUDIO_ID_BLUETOOTH or #VCE_AUDIO_ID_WIFI)
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_set_audio_type_cb)(const char* audio_type);
/**
-* @brief Called when the engine service user sets app id which is want to ask server dialog.
-* @since_tizen 4.0
-* @remarks The @a app_id and @a credential can be used only in the callback. To use outside, make a copy.
-* @param[in] app_id App id which is to want to ask server dialog.
-* @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.
-*/
+ * @brief Called when the engine service user sets app id which is want to ask server dialog.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a app_id and @a credential can be used only in the callback. To use outside, make a copy.
+ * @param[in] app_id App id which is to want to ask server dialog.
+ * @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.
+ */
typedef int (*vce_set_server_dialog_cb)(const char* app_id, const char* credential);
/**
-* @brief Called when the engine service user sets domain (agent or device type).
-* @since_tizen 4.0
-* @remarks The @a domain can be used only in the callback. To use outside, make a copy.
-* @param[in] domain Agent (e.g. "music", "news", etc) or device type (e.g. "tv", "mobile", etc) corresponding to the command
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
-*/
+ * @brief Called when the engine service user sets domain (agent or device type).
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a domain can be used only in the callback. To use outside, make a copy.
+ * @param[in] domain Agent (e.g. "music", "news", etc) or device type (e.g. "tv", "mobile", etc) corresponding to the command
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
+ */
typedef int (*vce_set_domain_cb)(const char* domain);
/**
-* @brief Called when the engine service user requests essential value from NLU result.
-* @since_tizen 4.0
-* @remarks The @a key can be used only in the callback. To use outside, make a copy.
-* The @a value is managed by the platform and will be released when this callback function is completed.
-* @param[in] key NLU base info key.
-* @param[out] value NLU base info value.
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user requests essential value from NLU result.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a key can be used only in the callback. To use outside, make a copy.
+ * The @a value is managed by the platform and will be released when this callback function is completed.
+ * @param[in] key NLU base info key.
+ * @param[out] value NLU base info value.
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_nlu_base_info_requested_cb)(const char* key, char** value);
/**
-* @brief Called when client gets the specific engine's request from the engine service user.
-* @since_tizen 4.0
-* @remarks The @a engine_app_id is managed by the platform and will be released when this callback function is completed.
-* The @a event is managed by the platform and will be released when this callback function is completed.
-* The @a request is managed by the platform and will be released when this callback function is completed.
-*
-* @param[in] engine_app_id The specific engine's app id
-* @param[in] event The specific engine event type
-* @param[in] request The specific engine request
-*
-* @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
-*
-* @pre An application registers callback function using vce_set_specific_engine_request_cb().
-*
-* @see vce_set_specific_engine_request_cb()
-* @see vce_unset_specific_engine_request_cb()
-*/
+ * @brief Called when client gets the specific engine's request from the engine service user.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a engine_app_id is managed by the platform and will be released when this callback function is completed.
+ * The @a event is managed by the platform and will be released when this callback function is completed.
+ * The @a request is managed by the platform and will be released when this callback function is completed.
+ *
+ * @param[in] engine_app_id The specific engine's app id
+ * @param[in] event The specific engine event type
+ * @param[in] request The specific engine request
+ *
+ * @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
+ *
+ * @pre An application registers callback function using vce_set_specific_engine_request_cb().
+ *
+ * @see vce_set_specific_engine_request_cb()
+ * @see vce_unset_specific_engine_request_cb()
+ */
typedef int (*vce_specific_engine_request_cb)(const char* engine_app_id, const char* event, const char* request);
/**
-* @brief Called when the engine service user sets private data between app and engine.
-* @since_tizen 4.0
-* @remarks The @a key, @a data can be used only in the callback. To use outside, make a copy.
-* @param[in] key Private key.
-* @param[in] data Private data.
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user sets private data between app and engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a key, @a data can be used only in the callback. To use outside, make a copy.
+ * @param[in] key Private key.
+ * @param[in] data Private data.
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_private_data_set_cb)(const char* key, const char* data);
/**
-* @brief Called when the engine service user requests private data between app and engine.
-* @since_tizen 4.0
-* @remarks The @a key can be used only in the callback. To use outside, make a copy.
-* The @a data is managed by the platform and will be released when this callback function is completed.
-* @param[in] key Private key.
-* @param[out] data Private data.
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user requests private data between app and engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a key can be used only in the callback. To use outside, make a copy.
+ * The @a data is managed by the platform and will be released when this callback function is completed.
+ * @param[in] key Private key.
+ * @param[out] data Private data.
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_private_data_requested_cb)(const char* key, char** data);
/**
-* @brief Called when the engine service user requests process text.
-* @since_tizen 4.0
-* @remarks The @a text can be used only in the callback. To use outside, make a copy.
-* @param[in] text Requested text
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user requests process text.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a text can be used only in the callback. To use outside, make a copy.
+ * @param[in] text Requested text
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_process_text_cb)(const char* text);
/**
-* @brief Called when the engine service user requests list event.
-* @since_tizen 4.0
-* @remarks The @a event can be used only in the callback. To use outside, make a copy.
-* @param[in] event Requested list event
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user requests list event.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a event can be used only in the callback. To use outside, make a copy.
+ * @param[in] event Requested list event
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_process_list_event_cb)(const char* event);
/**
-* @brief Called when the engine service user requests haptic event.
-* @since_tizen 4.0
-* @remarks The @a event can be used only in the callback. To use outside, make a copy.
-* @param[in] event Requested haptic event
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful.
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
-*/
+ * @brief Called when the engine service user requests haptic event.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a event can be used only in the callback. To use outside, make a copy.
+ * @param[in] event Requested haptic event
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful.
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature.
+ */
typedef int (*vce_process_haptic_event_cb)(const char* event);
/**
-* @brief Called when the engine service user requests the base information of VC engine.
-* @since_tizen 4.0
-* @remarks This callback function is mandatory and must be registered using vce_main().
-* The @a engine_uuid is managed by the platform and will be released when this callback function is completed.
-* The @a engine_name is managed by the platform and will be released when this callback function is completed.
-* The @a engine_settings_app_id is managed by the platform and will be released when this callback function is completed.
-* The @a use_network is managed by the platform and will be released when this callback function is completed.
-* In order to upload the engine to Tizen Appstore, both the service app and the UI app (engine settings) are necessary.
-* Therefore, @a engine_settings_app_id should be set to the application ID of the UI application.
-* If there is no UI application, then @a engine_settings_app_id should be set to NULL.
-* @param[out] engine_uuid The engine id
-* @param[out] engine_name The engine name
-* @param[out] engine_settings_app_id The ID of the engine settings application (the UI application)
-* @param[out] use_network @c true to need network @c false not to need network.
-* @return @c 0 on success, otherwise a negative error code on failure
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-*/
+ * @brief Called when the engine service user requests the base information of VC engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks This callback function is mandatory and must be registered using vce_main().
+ * The @a engine_uuid is managed by the platform and will be released when this callback function is completed.
+ * The @a engine_name is managed by the platform and will be released when this callback function is completed.
+ * The @a engine_settings_app_id is managed by the platform and will be released when this callback function is completed.
+ * The @a use_network is managed by the platform and will be released when this callback function is completed.
+ * In order to upload the engine to Tizen Appstore, both the service app and the UI app (engine settings) are necessary.
+ * Therefore, @a engine_settings_app_id should be set to the application ID of the UI application.
+ * If there is no UI application, then @a engine_settings_app_id should be set to NULL.
+ * @param[out] engine_uuid The engine id
+ * @param[out] engine_name The engine name
+ * @param[out] engine_settings_app_id The ID of the engine settings application (the UI application)
+ * @param[out] use_network @c true to need network @c false not to need network.
+ * @return @c 0 on success, otherwise a negative error code on failure
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ */
typedef int (*vce_get_info_cb)(char** engine_uuid, char** engine_name, char** engine_settings_app_id, bool* use_network);
/**
-* @brief Called to retrieve the commands.
-* @since_tizen 4.0
-* @remarks The @a command, @a param can be used only in the callback. To use outside, make a copy.
-* @param[in] id command id
-* @param[in] type command type
-* @param[in] format command format
-* @param[in] command command text
-* @param[in] param parameter text
-* @param[in] domain command domain
-* @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_get_foreach_command() will invoke this callback.
-* @see vce_get_foreach_command()
-*/
+ * @brief Called to retrieve the commands.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a command, @a param can be used only in the callback. To use outside, make a copy.
+ * @param[in] id command id
+ * @param[in] type command type
+ * @param[in] format command format
+ * @param[in] command command text
+ * @param[in] param parameter text
+ * @param[in] domain command domain
+ * @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_get_foreach_command() will invoke this callback.
+ * @see vce_get_foreach_command()
+ */
typedef bool (*vce_command_cb)(int id, int type, int format, const char* command, const char* param, int domain, void* user_data);
/**
-* @brief A structure for the VC engine functions.
-* @details This structure contains essential callback functions for operating VC engine.
-* @since_tizen 4.0
-* @remarks These functions ar mandatory for operating VC engine. Therefore, all functions MUST be implemented.
-*/
+ * @brief A structure for the VC engine functions.
+ * @details This structure contains essential callback functions for operating VC engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks These functions ar mandatory for operating VC engine. Therefore, all functions MUST be implemented.
+ */
typedef struct {
int version; /**< Version */
} vce_request_callback_s;
/**
-* @brief Starts the main function for Voice Control (VC) engine.
-* @details This function is the main function for operating VC engine.
-* @since_tizen 4.0
-* @privlevel public
-* @privilege %http://tizen.org/privilege/recorder
-* @remarks The service_app_main() should be used for working the engine after this function.
-* @param[in] argc The argument count(original)
-* @param[in] argv The argument(original)
-* @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_OPERATION_FAILED Operation failed
-* @pre The vce_get_engine_info() should be successful.
-* @see vce_get_engine_info()
-* @see vce_unload_engine()
-* @see vce_request_callback_s
-* @code
+ * @brief Starts the main function for Voice Control (VC) engine.
+ * @details This function is the main function for operating VC engine.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks The service_app_main() should be used for working the engine after this function.
+ * @param[in] argc The argument count(original)
+ * @param[in] argv The argument(original)
+ * @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_OPERATION_FAILED Operation failed
+ * @pre The vce_get_engine_info() should be successful.
+ * @see vce_get_engine_info()
+ * @see vce_unload_engine()
+ * @see vce_request_callback_s
+ * @code
#include <vce.h>
// Required callback functions - MUST BE IMPLEMENTED
return service_app_main(argc, argv, &event_callback, ad);
}
-* @endcode
-*/
+ * @endcode
+ */
int vce_main(int argc, char** argv, vce_request_callback_s* callback);
/**
-* @brief Sends the results to the engine service user.
-* @since_tizen 4.0
-* @param[in] event A result event
-* @param[in] result_id Result ids
-* @param[in] count Result count
-* @param[in] all_result All result text
-* @param[in] non_fixed_result Non-fixed command result text
-* @param[in] nlu_result NLU result text
-* @param[in] msg Engine message (e.g. #VC_RESULT_MESSAGE_NONE, #VC_RESULT_MESSAGE_ERROR_TOO_LOUD)
-* @param[out] user_info A user info (e.g. If ASR result is consumed, the value is 0x01. If not, the value is 0x00.)
-* @param[in] user_data The user data passed from set 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_OUT_OF_MEMORY Out of Memory
-* @retval #VCE_ERROR_INVALID_STATE Invalid state
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @pre The vce_main() function should be invoked before this function is called.
-* vce_stop_cb() will invoke this callback.
-* @see vce_stop_cb()
-*/
+ * @brief Sends the results to the engine service user.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @param[in] event A result event
+ * @param[in] result_id Result ids
+ * @param[in] count Result count
+ * @param[in] all_result All result text
+ * @param[in] non_fixed_result Non-fixed command result text
+ * @param[in] nlu_result NLU result text
+ * @param[in] msg Engine message (e.g. #VC_RESULT_MESSAGE_NONE, #VC_RESULT_MESSAGE_ERROR_TOO_LOUD)
+ * @param[out] user_info A user info (e.g. If ASR result is consumed, the value is 0x01. If not, the value is 0x00.)
+ * @param[in] user_data The user data passed from set 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_OUT_OF_MEMORY Out of Memory
+ * @retval #VCE_ERROR_INVALID_STATE Invalid state
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @pre The vce_main() function should be invoked before this function is called.
+ * vce_stop_cb() will invoke this callback.
+ * @see vce_stop_cb()
+ */
int vce_send_result(vce_result_event_e event, int* result_id, int count, const char* all_result, const char* non_fixed_result, const char* nlu_result, const char* msg, int* user_info, void* user_data);
/**
-* @brief Sends the ASR result to the engine service user.
-* @since_tizen 4.0
-* @param[in] event A asr result event
-* @param[in] asr_result A asr result text
-* @param[in] user_data The user data passed from the start
-* @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_OUT_OF_MEMORY Out of Memory
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @pre The vce_main() function should be invoked before this function is called.
-* @see vce_start_cb()
-*/
+ * @brief Sends the ASR result to the engine service user.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @param[in] event A asr result event
+ * @param[in] asr_result A asr result text
+ * @param[in] user_data The user data passed from the start
+ * @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_OUT_OF_MEMORY Out of Memory
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @pre The vce_main() function should be invoked before this function is called.
+ * @see vce_start_cb()
+ */
int vce_send_asr_result(vce_asr_result_event_e event, const char* asr_result, void* user_data);
/**
-* @brief Sends the NLG (Natural Language Generation) result to the engine service user.
-* @since_tizen 4.0
-* @param[in] nlg_result A nlg result
-* @param[in] user_data The user data passed from the start
-* @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_OUT_OF_MEMORY Out of Memory
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @pre The vce_main() function should be invoked before this function is called.
-* @see vce_start_cb()
-*/
+ * @brief Sends the NLG (Natural Language Generation) result to the engine service user.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @param[in] nlg_result A nlg result
+ * @param[in] user_data The user data passed from the start
+ * @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_OUT_OF_MEMORY Out of Memory
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @pre The vce_main() function should be invoked before this function is called.
+ * @see vce_start_cb()
+ */
int vce_send_nlg_result(const char* nlg_result, void* user_data);
/**
-* @brief Sends the specific engine result to the engine service user.
-* @since_tizen 4.0
-*
-* @param[in] engine_app_id A specific engine's app id
-* @param[in] event A specific engine result event
-* @param[in] result A specific engine result text
-* @param[in] user_info The user info passed from the start
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @pre The vce_main() function should be invoked before this function is called.
-*/
+ * @brief Sends the specific engine result to the engine service user.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ *
+ * @param[in] engine_app_id A specific engine's app id
+ * @param[in] event A specific engine result event
+ * @param[in] result A specific engine result text
+ * @param[in] user_info The user info passed from the start
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @pre The vce_main() function should be invoked before this function is called.
+ */
int vce_send_specific_engine_result(const char* engine_app_id, const char* event, const char* result, void *user_info);
/**
-* @brief Sends the error to the engine service user.
-* @details The following error codes can be delivered. \n
-* #VCE_ERROR_NONE, \n
-* #VCE_ERROR_OUT_OF_MEMORY, \n
-* #VCE_ERROR_IO_ERROR, \n
-* #VCE_ERROR_INVALID_PARAMETER, \n
-* #VCE_ERROR_OUT_OF_NETWORK, \n
-* #VCE_ERROR_RECORDER_BUSY, \n
-* #VCE_ERROR_NOT_SUPPORTED, \n
-* #VCE_ERROR_INVALID_STATE, \n
-* #VCE_ERROR_INVALID_LANGUAGE, \n
-* #VCE_ERROR_OPERATION_FAILED, \n
-* #VCE_ERROR_PERMISSION_DENIED, \n
-* #VCE_ERROR_NOT_SUPPORTED_FEATURE.
-* @since_tizen 4.0
-* @param[in] error Error type
-* @param[in] msg Error message
-* @param[in] user_data The user data passed from set 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_OUT_OF_MEMORY Out of Memory
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @pre The vce_main() function should be invoked before this function is called.
-*/
+ * @brief Sends the error to the engine service user.
+ * @details The following error codes can be delivered. \n
+ * #VCE_ERROR_NONE, \n
+ * #VCE_ERROR_OUT_OF_MEMORY, \n
+ * #VCE_ERROR_IO_ERROR, \n
+ * #VCE_ERROR_INVALID_PARAMETER, \n
+ * #VCE_ERROR_OUT_OF_NETWORK, \n
+ * #VCE_ERROR_RECORDER_BUSY, \n
+ * #VCE_ERROR_NOT_SUPPORTED, \n
+ * #VCE_ERROR_INVALID_STATE, \n
+ * #VCE_ERROR_INVALID_LANGUAGE, \n
+ * #VCE_ERROR_OPERATION_FAILED, \n
+ * #VCE_ERROR_PERMISSION_DENIED, \n
+ * #VCE_ERROR_NOT_SUPPORTED_FEATURE.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @param[in] error Error type
+ * @param[in] msg Error message
+ * @param[in] user_data The user data passed from set 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_OUT_OF_MEMORY Out of Memory
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @pre The vce_main() function should be invoked before this function is called.
+ */
int vce_send_error(vce_error_e error, const char* msg, void* user_data);
/**
-* @brief Sets a callback function for setting the private data to the engine service.
-* @since_tizen 4.0
-* @privlevel public
-* @privilege %http://tizen.org/privilege/recorder
-* @remarks The vce_private_data_set_cb() function is called when the engine service user sets the private data to the engine service.
-* @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_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.
-* @see vce_private_data_set_cb()
-*/
+ * @brief Sets a callback function for setting the private data to the engine service.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks The vce_private_data_set_cb() function is called when the engine service user sets the private data to the engine service.
+ * @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_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.
+ * @see vce_private_data_set_cb()
+ */
int vce_set_private_data_set_cb(vce_private_data_set_cb callback_func);
/**
-* @brief Sets a callback function for requesting the private data to the engine service.
-* @since_tizen 4.0
-* @privlevel public
-* @privilege %http://tizen.org/privilege/recorder
-* @remarks The vce_private_data_requested_cb() function is called when the engine service user requests the private data to the engine service.
-* @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_OPERATION_FAILED Operation failure
-* @see vce_private_data_requested_cb()
-*/
+ * @brief Sets a callback function for requesting the private data to the engine service.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks The vce_private_data_requested_cb() function is called when the engine service user requests the private data to the engine service.
+ * @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_OPERATION_FAILED Operation failure
+ * @see vce_private_data_requested_cb()
+ */
int vce_set_private_data_requested_cb(vce_private_data_requested_cb callback_func);
/**
-* @brief Sets a callback function for requesting the NLU base information to the engine service.
-* @since_tizen 4.0
-* @remarks The vce_nlu_base_info_requested_cb() function is called when the engine service user requests the NLU base information to the engine service.
-* @param[in] callback_func vce_nlu_base_info_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_OPERATION_FAILED Operation failure
-* @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
-* @see vce_nlu_base_info_requested_cb()
-*/
+ * @brief Sets a callback function for requesting the NLU base information to the engine service.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @remarks The vce_nlu_base_info_requested_cb() function is called when the engine service user requests the NLU base information to the engine service.
+ * @param[in] callback_func vce_nlu_base_info_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_OPERATION_FAILED Operation failure
+ * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature
+ * @see vce_nlu_base_info_requested_cb()
+ */
int vce_set_nlu_base_info_requested_cb(vce_nlu_base_info_requested_cb callback_func);
/**
-* @brief Sets a callback function for getting the engine service request.
-* @since_tizen 4.0
-*
-* @param[in] callback_func Callback function to register
-*
-* @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
-*
-* @see vce_unset_specific_engine_request_cb()
-*/
+ * @brief Sets a callback function for getting the engine service request.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ *
+ * @param[in] callback_func Callback function to register
+ *
+ * @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
+ *
+ * @see vce_unset_specific_engine_request_cb()
+ */
int vce_set_specific_engine_request_cb(vce_specific_engine_request_cb callback_func);
/**
-* @brief Unsets the engine service request callback function.
-* @since_tizen 4.0
-*
-* @return 0 on success, otherwise a negative error value
-* @retval #VC_ERROR_NONE Successful
-* @retval #VC_ERROR_NOT_SUPPORTED Not supported
-*
-* @see vce_set_specific_engine_request_cb()
-*/
+ * @brief Unsets the engine service request callback function.
+ * @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
+ *
+ * @see vce_set_specific_engine_request_cb()
+ */
int vce_unset_specific_engine_request_cb(void);
/**
-* @brief Retrieves all commands using callback function.
-* @since_tizen 4.0
-*
-* @param[in] vce_command The handle to be passed to the vce_set_commands() function
-* @param[in] callback The callback function to invoke
-* @param[in] user_data The user data to be passed to the callback function
-*
-* @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
-* @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()
-*/
+ * @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] callback The callback function to invoke
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @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
+ * @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()
+ */
int vce_get_foreach_command(vce_cmd_h vce_command, vce_command_cb callback, void* user_data);
/**
-* @brief Gets command length.
-* @since_tizen 4.0
-*
-* @param[in] vce_command The handle to be passed to the vce_set_commands() 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()
-*/
+ * @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[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()
+ */
int vce_get_command_count(vce_cmd_h vce_command, int* count);
/**
-* @brief Gets current audio type.
-* @since_tizen 4.0
-* @privlevel public
-* @privilege %http://tizen.org/privilege/recorder
-* @remarks The @a audio_type must be released using free() when it is no longer required.
-* @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
-*/
+ * @brief Gets current audio type.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks The @a audio_type must be released using free() when it is no longer required.
+ * @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
+ */
int vce_get_audio_type(char** audio_type);
/**
-* @brief Sets private data to a voice manager client.
-* @since_tizen 4.0
-* @privlevel public
-* @privilege %http://tizen.org/privilege/recorder
-* @param[in] key Private key
-* @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_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_OPERATION_FAILED Operation failed
-*/
+ * @brief Sets private data to a voice manager client.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @param[in] key Private key
+ * @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_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_OPERATION_FAILED Operation failed
+ */
int vce_set_private_data(const char* key, const char* data);
/**
-* @brief Gets private data from a voice manager client.
-* @since_tizen 4.0
-* @privlevel public
-* @privilege %http://tizen.org/privilege/recorder
-* @remarks The @a data must be released using free() when it is no longer required.
-* @param[in] key Private key
-* @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_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_INVALID_STATE Invalid state
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failed
-*/
+ * @brief Gets private data from a voice manager client.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks The @a data must be released using free() when it is no longer required.
+ * @param[in] key Private key
+ * @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_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_INVALID_STATE Invalid state
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failed
+ */
int vce_get_private_data(const char* key, char** data);
/**
-* @brief Starts recording voice.
-* @since_tizen 4.0
-* @privlevel public
-* @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_OPERATION_FAILED Operation failure
-* @retval #VCE_ERROR_RECORDER_BUSY Busy recorder
-*/
+ * @brief Starts recording voice.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @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_OPERATION_FAILED Operation failure
+ * @retval #VCE_ERROR_RECORDER_BUSY Busy recorder
+ */
int vce_start_recording(void);
/**
-* @brief Stops recording voice.
-* @since_tizen 4.0
-* @privlevel public
-* @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_OPERATION_FAILED Operation failure
-*/
+ * @brief Stops recording voice.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
+ * @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_OPERATION_FAILED Operation failure
+ */
int vce_stop_recording(void);
-/* for TTS feeadback */
-/**
-* @brief Sends audio formats necessary for playing TTS feedback.
-* @since_tizen 4.0
-*
-* @param[in] rate A sampling rate
-* @param[in] channel The audio channel
-* @param[in] audio_type The audio type
-*
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
-*/
+/**
+ * @brief Sends audio formats necessary for playing TTS feedback.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ *
+ * @param[in] rate A sampling rate
+ * @param[in] channel The audio channel
+ * @param[in] audio_type The audio type
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
+ */
int vce_send_feedback_audio_format(int rate, vce_audio_channel_e channel, vce_audio_type_e audio_type);
/**
-* @brief Sends audio streaming necessary for playing TTS feedback.
-* @since_tizen 4.0
-*
-* @param[in] event A feedback event
-* @param[in] buffer The feedback data
-* @param[in] len The length of the feedback data
-*
-* @return 0 on success, otherwise a negative error value.
-* @retval #VCE_ERROR_NONE Successful
-* @retval #VCE_ERROR_NOT_SUPPORTED Not supported
-* @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #VCE_ERROR_OPERATION_FAILED Operation failure
-* @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
-*/
+ * @brief Sends audio streaming necessary for playing TTS feedback.
+ * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ *
+ * @param[in] event A feedback event
+ * @param[in] buffer The feedback data
+ * @param[in] len The length of the feedback data
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #VCE_ERROR_NONE Successful
+ * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VCE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VCE_ERROR_OPERATION_FAILED Operation failure
+ * @retval #VCE_ERROR_OUT_OF_MEMORY Out of Memory
+ */
int vce_send_feedback_streaming(vce_feedback_event_e event, char* buffer, int len);
#endif
/**
-* @}
-*/
+ * @}
+ */
#endif /* __VCE_H__ */
projects / platform / core / uifw / voice-control.git / commitdiff