From 51385be7f50aa634a935752e5d382a81f7e0806c Mon Sep 17 00:00:00 2001 From: Sejun Park Date: Fri, 19 Jul 2024 11:47:36 +0900 Subject: [PATCH] move unapproved api to internal header Change-Id: Ie5765428ee0656e04d6a5468f5d45140fcc2ee4a --- doc/uix_vc_doc.h | 5 ---- include/vce.h | 8 +++--- include/voice_control.h | 47 -------------------------------- include/voice_control_internal.h | 46 ++++++++++++++++++++++++++++++- 4 files changed, 49 insertions(+), 57 deletions(-) diff --git a/doc/uix_vc_doc.h b/doc/uix_vc_doc.h index 96a4b4a..a4f1a34 100644 --- a/doc/uix_vc_doc.h +++ b/doc/uix_vc_doc.h @@ -169,11 +169,6 @@ * * * - * vc_set_server_dialog() - * Ready - * - * - * * vc_request_dialog() * Ready * diff --git a/include/vce.h b/include/vce.h index 6f798b6..bdae3c3 100644 --- a/include/vce.h +++ b/include/vce.h @@ -288,7 +288,7 @@ 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(). + * @remarks This function should set commands via vce_get_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. @@ -300,8 +300,8 @@ typedef int (*vce_set_language_cb)(const char* language); * @retval #VCE_ERROR_NOT_SUPPORTED_FEATURE Not supported command type * @post vce_start_cb() is called after this function is successful. * @see vce_start_cb() - * @see vcd_foreach_command() - * @see vce_unset_commands() + * @see vce_get_foreach_command() + * @see vce_unset_commands_cb() * @see vce_get_command_count() */ typedef int (*vce_set_commands_cb)(vce_cmd_h vc_command); @@ -333,7 +333,7 @@ typedef int (*vce_unset_commands_cb)(void); * @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. + * @pre vce_set_commands_cb() is successful. * @see vce_set_recording_data_cb() * @see vce_stop_cb() * @see vce_cancel_cb() diff --git a/include/voice_control.h b/include/voice_control.h index 64973c8..2560883 100644 --- a/include/voice_control.h +++ b/include/voice_control.h @@ -286,53 +286,6 @@ int vc_get_system_command_list(vc_cmd_list_h* vc_sys_cmd_list); int vc_set_invocation_name(const char* name); -/** - * @brief Requests to set app id which is to want to ask the server dialogue. - * @details Using this function, the developer can request registering the application on vc framework. - * If developer requests to register @a app_id with @a credential which is valid, the application will be set on vc framework. - * and then, when the developer requests the dialogue using vc_request_dialog(), dialog from specific engine server will be played by vc framework. - * @since_tizen 5.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/recorder - * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework. - * However, getting app ID may be failed. - * @param[in] app_id App id which is to want to ask server dialog. - * @param[in] credential Credential key. - * @return @c 0 on success, - * otherwise a negative error value - * @retval #VC_ERROR_NONE Successful - * @retval #VC_ERROR_NOT_SUPPORTED Not supported - * @retval #VC_ERROR_PERMISSION_DENIED Permission denied - * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #VC_ERROR_INVALID_STATE Invalid state - * @pre The service state should be #VC_SERVICE_STATE_READY. - * @see vc_unset_server_dialog() - */ -int vc_set_server_dialog(const char* app_id, const char* credential); - - -/** - * @brief Requests to unset app id which is to not want to ask the server dialogue. - * @details Using this function, the developer can disable function to ask dialog based on server. - * @since_tizen 5.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/recorder - * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework. - * However, getting app ID may be failed. - * @param[in] app_id App id which is to not want to ask server dialog. - * @return @c 0 on success, - * otherwise a negative error value - * @retval #VC_ERROR_NONE Successful - * @retval #VC_ERROR_NOT_SUPPORTED Not supported - * @retval #VC_ERROR_PERMISSION_DENIED Permission denied - * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #VC_ERROR_INVALID_STATE Invalid state - * @pre The service state should be #VC_SERVICE_STATE_READY. - * @see vc_set_server_dialog() - */ -int vc_unset_server_dialog(const char* app_id); - - /** * @brief Requests to start the dialogue. * @details Using this function, the developer can request starting the dialogue to the framework. diff --git a/include/voice_control_internal.h b/include/voice_control_internal.h index 2e117b7..f9fe626 100644 --- a/include/voice_control_internal.h +++ b/include/voice_control_internal.h @@ -69,6 +69,51 @@ typedef bool (*vc_asr_result_cb)(vc_result_event_e event, const char* result, vo */ int vc_set_command_list_from_file(const char* file_path, int type); +/** + * @brief Requests to set app id which is to want to ask the server dialogue. + * @details Using this function, the developer can request registering the application on vc framework. + * If developer requests to register @a app_id with @a credential which is valid, the application will be set on vc framework. + * and then, when the developer requests the dialogue using vc_request_dialog(), dialog from specific engine server will be played by vc framework. + * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/recorder + * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework. + * However, getting app ID may be failed. + * @param[in] app_id App id which is to want to ask server dialog. + * @param[in] credential Credential key. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #VC_ERROR_NONE Successful + * @retval #VC_ERROR_NOT_SUPPORTED Not supported + * @retval #VC_ERROR_PERMISSION_DENIED Permission denied + * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #VC_ERROR_INVALID_STATE Invalid state + * @pre The service state should be #VC_SERVICE_STATE_READY. + * @see vc_unset_server_dialog() + */ +int vc_set_server_dialog(const char* app_id, const char* credential); + +/** + * @brief Requests to unset app id which is to not want to ask the server dialogue. + * @details Using this function, the developer can disable function to ask dialog based on server. + * @since_tizen 5.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/recorder + * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework. + * However, getting app ID may be failed. + * @param[in] app_id App id which is to not want to ask server dialog. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #VC_ERROR_NONE Successful + * @retval #VC_ERROR_NOT_SUPPORTED Not supported + * @retval #VC_ERROR_PERMISSION_DENIED Permission denied + * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #VC_ERROR_INVALID_STATE Invalid state + * @pre The service state should be #VC_SERVICE_STATE_READY. + * @see vc_set_server_dialog() + */ +int vc_unset_server_dialog(const char* app_id); + /** * @brief Connects the voice control service synchronously. * @since_tizen 4.0 @@ -87,7 +132,6 @@ int vc_set_command_list_from_file(const char* file_path, int type); */ int vc_prepare_sync(void); - #ifdef __cplusplus } #endif -- 2.34.1