Add and Rearrange descriptions 22/282322/1
authorsooyeon <sooyeon.kim@samsung.com>
Mon, 8 Aug 2022 05:03:41 +0000 (14:03 +0900)
committerTizen AI <ai.tzn.sec@samsung.com>
Fri, 30 Sep 2022 01:50:14 +0000 (10:50 +0900)
Change-Id: I78f52786dbcb48d34b56ffd41ba47c41a7a6316c
Signed-off-by: sooyeon <sooyeon.kim@samsung.com>
include/vce.h

index 72f4f94..851dddd 100644 (file)
@@ -689,6 +689,7 @@ typedef struct {
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
  * @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
@@ -795,6 +796,9 @@ int vce_main(int argc, char** argv, vce_request_callback_s* callback);
 /**
  * @brief Sends the results to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * 
  * @param[in] event A result event
  * @param[in] result_id Result ids
  * @param[in] count Result count
@@ -819,6 +823,9 @@ int vce_send_result(vce_result_event_e event, int* result_id, int count, const c
 /**
  * @brief Sends the ASR result to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.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
@@ -835,6 +842,9 @@ int vce_send_asr_result(vce_asr_result_event_e event, const char* asr_result, vo
 /**
  * @brief Sends the NLG (Natural Language Generation) result to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.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
@@ -850,6 +860,8 @@ 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 @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.0)
  *
  * @param[in] engine_app_id A specific engine's app id
  * @param[in] event A specific engine result event
@@ -882,6 +894,9 @@ int vce_send_specific_engine_result(const char* engine_app_id, const char* event
  *          #VCE_ERROR_NOT_SUPPORTED_FEATURE \n
  *          #VCE_ERROR_TTS_FAILED.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * 
  * @param[in] error Error type
  * @param[in] msg Error message
  * @param[in] user_data The user data passed from set callback function
@@ -899,9 +914,8 @@ int vce_send_error(vce_error_e error, const char* msg, void* user_data);
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
- *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
- *            %http://tizen.org/privilege/datasharing (Since 7.0)
  * @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
@@ -920,9 +934,8 @@ int vce_set_private_data_set_cb(vce_private_data_set_cb callback_func);
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
- *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
- *            %http://tizen.org/privilege/datasharing (Since 7.0)
  * @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
@@ -1014,9 +1027,8 @@ int vce_get_command_count(vce_cmd_h vce_command, int* count);
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
- *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
- *            %http://tizen.org/privilege/datasharing (Since 7.0)
  * @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
@@ -1033,6 +1045,7 @@ int vce_get_audio_type(char** audio_type);
  * @privilege %http://tizen.org/privilege/recorder
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * 
  * @param[in] key Private key
  * @param[in] data Private data
  * @return 0 on success, otherwise a negative error value.
@@ -1054,6 +1067,7 @@ int vce_set_private_data(const char* key, const char* data);
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
  * @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.
@@ -1074,6 +1088,7 @@ int vce_get_private_data(const char* key, char** data);
  * @privilege %http://tizen.org/privilege/recorder
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * 
  * @return 0 on success, otherwise a negative error value.
  * @retval #VCE_ERROR_NONE Successful
  * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
@@ -1088,8 +1103,7 @@ int vce_start_recording(void);
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
- *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
- *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * 
  * @return 0 on success, otherwise a negative error value.
  * @retval #VCE_ERROR_NONE Successful
  * @retval #VCE_ERROR_NOT_SUPPORTED Not supported
@@ -1101,6 +1115,8 @@ int vce_stop_recording(void);
 /**
  * @brief Sends audio formats necessary for playing TTS feedback.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.0)
  *
  * @param[in] rate A sampling rate
  * @param[in] channel The audio channel
@@ -1118,6 +1134,8 @@ int vce_send_feedback_audio_format(int rate, vce_audio_channel_e channel, vce_au
 /**
  * @brief Sends audio streaming necessary for playing TTS feedback.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
+ *            %http://tizen.org/privilege/datasharing (Since 7.0)
  *
  * @param[in] event A feedback event
  * @param[in] buffer The feedback data