From c49976e84511d16bad04c0c2bdc147656725b403 Mon Sep 17 00:00:00 2001 From: Ji-hoon Lee Date: Mon, 30 Sep 2019 21:31:11 +0900 Subject: [PATCH] Update API documentation Change-Id: I5b5c08fd907e3947e0a78c70c734f9b1b6343c32 --- common/ma_defs.h | 4 +- common/ma_main.h | 4 +- doc/uix_ma_doc.h | 144 +++++++++++++++-------------- include/multi_assistant.h | 5 +- include/multi_assistant_common.h | 4 +- include/multi_assistant_settings.h | 4 +- include/multi_assistant_ui.h | 4 +- 7 files changed, 88 insertions(+), 81 deletions(-) diff --git a/common/ma_defs.h b/common/ma_defs.h index 3ffe16b..9c3d197 100644 --- a/common/ma_defs.h +++ b/common/ma_defs.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. diff --git a/common/ma_main.h b/common/ma_main.h index f5214da..ad5af7a 100644 --- a/common/ma_main.h +++ b/common/ma_main.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. diff --git a/doc/uix_ma_doc.h b/doc/uix_ma_doc.h index f20b35f..98327fa 100644 --- a/doc/uix_ma_doc.h +++ b/doc/uix_ma_doc.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. @@ -26,39 +26,6 @@ * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_HEADER Required Header * \#include
* - * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_OVERVIEW Overview - * A main function of Voice Control API register command and gets notification for recognition result. - * Applications can add their own commands and be provided result when their command is recognized by user voice input. - * To use of Voice Control, use the following steps:
- * 1. Initialize
- * 2. Register callback functions for notifications
- * 3. Connect to voice control service asynchronously. The state should be changed to Ready
- * 4. Make command list as the following step and Step 4 is called repeatedly for each command which an application wants
- * 4-1. Create command list handle
- * 4-2. Create command handle
- * 4-3. Set command and type for command handle
- * 4-4. Add command handle to command list
- * 5. Set command list for recognition
- * 6. Set an invocation name for an application
- * 7. Get recognition results
- * 8. Request the dialogue
- * 9. If an application wants to finish voice control,
- * 9-1. Destroy command and command list handle
- * 9-2. Deinitialize
- * An application can obtain command handle from command list, and also get information from handle. - * The Voice Control API also notifies you (by callback mechanism) when the states of client and service are changed, - * command is recognized, current language is changed or error occurred. - * An application should register callback functions: vc_state_changed_cb(), vc_service_state_changed_cb(), vc_result_cb(), - * vc_current_language_changed_cb(), vc_error_cb(). - * - * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_STATE_DIAGRAM State Diagram - * The following diagram shows the life cycle and the states of the Voice Control. - * - * @image html capi_uix_voice_control_state_diagram.png " " - * The following diagram shows the states of Voice Control service. - * - * @image html capi_uix_voice_control_service_state_diagram.png "" - * * @section CAPI_UIX_MULTI_ASSISTANT_MODULE_STATE_TRANSITIONS State Transitions * * @@ -68,25 +35,25 @@ * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * @@ -104,92 +71,133 @@ * * * -* +* * -* +* * * -* +* * -* +* * * -* +* * * * * -* +* * * * * -* +* * * * * -* +* * * * * -* -* +* +* * * * -* -* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* +* * * * -* +* * * * * -* +* * * * * -* +* * * * * -* +* * * * * -* +* * * * * -* +* * * * * -* +* * * * * * +* ma_set_state_changed_cb()
+* ma_unset_state_changed_cb()
+* ma_set_error_cb()
+* ma_unset_error_cb() +* ma_set_language_changed_cb()
+* ma_unset_language_changed_cb() +* ma_set_audio_streaming_cb()
+* ma_unset_audio_streaming_cb() +* ma_set_active_state_changed_cb()
+* ma_unset_active_state_changed_cb() +* ma_set_wakeup_engine_command_cb()
+* ma_unset_wakeup_engine_command_cb() +* ma_set_preprocessing_information_changed_cb()
+* ma_unset_preprocessing_information_changed_cb() +* ma_set_audio_streaming_data_section_changed_cb()
+* ma_unset_audio_streaming_data_section_changed_cb() * * * diff --git a/include/multi_assistant.h b/include/multi_assistant.h index 7eba706..c8661db 100644 --- a/include/multi_assistant.h +++ b/include/multi_assistant.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. @@ -530,7 +530,6 @@ int ma_assistant_info_get_enabled_status(ma_assistant_info_h handle, bool* statu /** * @brief Gets the recording audio source type. * @since_tizen 5.5 - * @privlevel public * * @remarks You must release @a type using free(). * @param[out] type The audio source type diff --git a/include/multi_assistant_common.h b/include/multi_assistant_common.h index abc4a9a..033f347 100644 --- a/include/multi_assistant_common.h +++ b/include/multi_assistant_common.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. diff --git a/include/multi_assistant_settings.h b/include/multi_assistant_settings.h index 7c35335..b9c1f47 100644 --- a/include/multi_assistant_settings.h +++ b/include/multi_assistant_settings.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. diff --git a/include/multi_assistant_ui.h b/include/multi_assistant_ui.h index 5270665..5441e35 100644 --- a/include/multi_assistant_ui.h +++ b/include/multi_assistant_ui.h @@ -1,5 +1,5 @@ -/** - * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved +/* + * Copyright (c) 2011-2019 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. -- 2.34.1
SYNC TYPE
vc_initialize()ma_initialize()NoneInitializedSYNC
vc_deinitialize()ma_deinitialize()InitializedNoneSYNC
vc_prepare()ma_prepare()InitializedReadyASYNC
vc_unprepare()ma_unprepare()ReadyInitializedSYNCDESCRIPTION
vc_initialize()ma_initialize()NoneAll functions must be called after vc_initialize()All functions must be called after ma_initialize()
vc_deinitialize()ma_deinitialize()Initialized, ReadyThis function should be called when an application want to finalize voice control usingThis function should be called when finished using multi-assistant
vc_prepare()ma_prepare()InitializedThis function works asynchronously. If service start is failed, application gets the error callback.
vc_unprepare()ma_unprepare()Ready
vc_foreach_supported_languages()ma_get_state()Initialized, Ready
vc_get_current_language()ma_get_current_language()Initialized, Ready
vc_get_state()Initialized, Readyma_get_recording_audio_format()Ready
vc_get_service_state()Initialized, Readyma_send_asr_result()Ready
ma_send_result()Ready
ma_send_recognition_result()Ready
ma_start_receiving_audio_streaming_data()Ready
ma_stop_receiving_audio_streaming_data()Ready
ma_update_voice_feedback_state()Ready
ma_send_assistant_specific_command()Ready
ma_assistant_info_foreach_assistants()Ready
vc_get_result()ma_assistant_info_get_app_id()Ready
vc_get_system_command_list()ma_assistant_info_get_enabled_status()Ready
vc_set_command_list()ma_get_recording_audio_source_type()Ready
vc_unset_command_list()ma_set_background_volume()Ready
vc_set_invocation_name()ma_set_preprocessing_allow_mode()Ready
vc_set_server_dialog()ma_send_preprocessing_result()Ready
vc_request_dialog()ma_set_wake_word_audio_require_flag()Ready
-* vc_set_result_cb()
-* vc_unset_result_cb()
-* vc_set_state_changed_cb()
-* vc_unset_state_changed_cb()
-* vc_set_service_state_changed_cb()
-* vc_unset_service_state_changed_cb()
-* vc_set_current_language_changed_cb()
-* vc_unset_current_language_changed_cb()
-* vc_set_error_cb()
-* vc_unset_error_cb()		Initialized All callback function should be registered in Initialized state