/**
* @brief Enumerations of error codes.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
/**
* @brief Enumerations of audio type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_AUDIO_TYPE_PCM_S16_LE = 0, /**< Signed 16bit audio type, Little endian */
/**
* @brief Enumerations of callback event.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_RESULT_EVENT_SUCCESS = 0, /**< Event when the recognition full result is ready */
/**
* @brief Enumerations of command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_COMMAND_FORMAT_FIXED = 0, /**< Fixed command */
/**
* @brief Enumerations of speech detect.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_SPEECH_DETECT_NONE = 0, /**< No event */
/**
* @brief Enumerations of ASR result events.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_ASR_RESULT_EVENT_FINAL_RESULT = 0, /**< Event when the ASR result is last data or ASR result is only one result */
/**
* @brief Enumerations of audio channels.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_AUDIO_CHANNEL_MONO = 0, /**< 1 channel, mono */
/**
* @brief Enumeration for TTS feedback events.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef enum {
VCE_FEEDBACK_EVENT_FAIL = -1, /**< Failed */
/**
* @brief A structure of handle for VC command.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
typedef struct vce_cmd_s* vce_cmd_h;
/**
* @brief Definition for foreground command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_COMMAND_TYPE_FOREGROUND 1
/**
* @brief Definition for background command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_COMMAND_TYPE_BACKGROUND 2
/**
* @brief Definition for widget command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_COMMAND_TYPE_WIDGET 3
/**
* @brief Definition for system command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_COMMAND_TYPE_SYSTEM 4
/**
* @brief Definition for system background command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_COMMAND_TYPE_SYSTEM_BACKGROUND 5
/**
* @brief Definitions for exclusive command type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_COMMAND_TYPE_EXCLUSIVE 6
/**
* @brief Definition of bluetooth audio id.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_AUDIO_ID_BLUETOOTH "VC_AUDIO_ID_BLUETOOTH" /**< Bluetooth audio id */
/**
* @brief Definition of Wi-Fi audio id.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VCE_AUDIO_ID_WIFI "VC_AUDIO_ID_WIFI" /**< Wi-Fi audio id */
/**
* @brief Definition for none message.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#define VC_RESULT_MESSAGE_NONE "vc.result.message.none"
/**
* @brief Definition for failed recognition because the speech is too loud to listen.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*/
#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 @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Called when the engine service user initializes Voice Control (VC) engine.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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
/**
* @brief Called when the engine service user deinitializes VC engine.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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
/**
* @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
+ * @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.
/**
* @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
+ * @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
/**
* @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
+ * @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
/**
* @brief Called when the engine service user sets language.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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
/**
* @brief Called when the engine service user sets command list before recognition.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Called when the engine service user unsets command list for reset.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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
/**
* @brief Called when the engine service user starts recognition.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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,
/**
* @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
+ * @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.
/**
* @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
+ * @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
/**
* @brief Called when the engine service user cancels the recognition process.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Called when the engine service user sets audio recording type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @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
+ * @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.
/**
* @brief Called when the engine service user sets domain (agent or device type).
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Called when the engine service user requests essential value from NLU result.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @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
+ * @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.
/**
* @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
+ * @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.
/**
* @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
+ * @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.
/**
* @brief Called when the engine service user requests process text.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Called when the engine service user requests list event.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Called when the engine service user requests haptic event.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @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
+ * @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.
/**
* @brief Called to retrieve the commands.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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
/**
* @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
+ * @since_tizen 4.0
* @remarks You must register all callbacks except optional callbacks for operating VC engine.\n
* The following callbacks are optional callbacks : \n
* - vce_private_data_set_cb() \n
/**
* @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
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder \n
* %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
/**
* @brief Sends the results to the engine service user.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
/**
* @brief Sends the ASR result to the engine service user.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
/**
* @brief Sends the NLG (Natural Language Generation) result to the engine service user.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
/**
* @brief Sends the specific engine result to the engine service user.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
* #VCE_ERROR_PERMISSION_DENIED, \n
* #VCE_ERROR_NOT_SUPPORTED_FEATURE \n
* #VCE_ERROR_TTS_FAILED.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
/**
* @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
+ * @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.
/**
* @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
+ * @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.
/**
* @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
+ * @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
/**
* @brief Sets a callback function for getting the engine service request.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*
* @param[in] callback_func Callback function to register
*
/**
* @brief Unsets the engine service request callback function.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*
* @return 0 on success, otherwise a negative error value
* @retval #VCE_ERROR_NONE Successful
/**
* @brief Retrieves all commands using callback function.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*
* @param[in] vce_command The handle to be passed to the vce_set_commands_cb() function
* @param[in] callback The callback function to invoke
/**
* @brief Gets command length.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
*
* @param[in] vce_command The handle to be passed to the vce_set_commands_cb() function
* @param[out] count The command count value
/**
* @brief Gets current audio type.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @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.
/**
* @brief Sets private data to a voice manager client.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder \n
* %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
/**
* @brief Gets private data from a voice manager client.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder \n
* %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
/**
* @brief Starts recording voice.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder \n
* %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
/**
* @brief Stops recording voice.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
*
/**
* @brief Sends audio formats necessary for playing TTS feedback.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
/**
* @brief Sends audio streaming necessary for playing TTS feedback.
- * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 4.0
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0) \n
* %http://tizen.org/privilege/datasharing (Since 7.0)
projects / platform / core / uifw / voice-control.git / blobdiff