Merge "Cleanup VC-manager internal functions" into tizen
[platform/core/uifw/voice-control.git] / include / vce_internal.h
1 /*
2  * Copyright (c) 2011-2018 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 #ifndef __VCE_INTERNAL_H__
19 #define __VCE_INTERNAL_H__
20
21 #include <tizen.h>
22
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /**
29  * @brief A structure for the VC engine functions.
30  * @details This structure contains essential callback functions for operating VC engine.
31  * @since_tizen 4.0
32  * @remarks These functions are optional for operating VC engine.
33  */
34 typedef struct {
35         /* Optional callbacks */
36         vce_request_tts_cb                                      request_tts;
37         void*                                                           request_tts_user_data;
38         vce_cancel_tts_cb                                       cancel_tts;
39         void*                                                           cancel_tts_user_data;
40         vce_tts_audio_format_request_cb         get_tts_audio_format;
41         void*                                                           get_tts_audio_format_user_data;
42
43         vce_private_data_set_cb                         private_data_set;
44         vce_private_data_requested_cb           private_data_request;
45         vce_nlu_base_info_requested_cb          nlu_base_info_request;
46         vce_specific_engine_request_cb          specific_engine_request;
47 } vce_internal_request_callback_s;
48
49 /**
50  * @brief Enumeration for TTS feedback events.
51  * @since_tizen 5.0
52  */
53 typedef enum {
54         VCE_UPDATE_EVENT_FAIL = -1,    /**< Failed */
55         VCE_UPDATE_EVENT_START = 1,    /**< Start event */
56         VCE_UPDATE_EVENT_FINISH = 2    /**< Finish event */
57 } vce_update_event_e;
58
59 int vce_send_update_status(vce_update_event_e update_event, const char* msg);
60
61
62 #ifdef __cplusplus
63 }
64 #endif
65
66 /**
67 * @}
68 */
69
70 #endif /* __VCE_INTERNAL_H__ */