server/vcd_server.h

   1 /*
   2 * Copyright (c) 2011-2015 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 __VCD_SERVER_H_
  19 #define __VCD_SERVER_H_
  20
  21 #include "vcd_main.h"
  22 #include "vcd_client_data.h"
  23
  24 #include "vce.h"
  25 #include "vce_internal.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /*
  32 * Daemon functions
  33 */
  34 int vcd_initialize(vce_request_callback_s *callback);
  35
  36 bool vcd_finalize();
  37
  38 Eina_Bool vcd_cleanup_client_all(void *data);
  39
  40 int vcd_server_get_service_state();
  41
  42 int vcd_server_get_foreground();
  43
  44
  45 /*
  46 * For manager
  47 */
  48 int vcd_server_mgr_initialize(int pid, vcd_audio_streaming_mode_e mode);
  49
  50 int vcd_server_mgr_finalize(int pid);
  51
  52 int vcd_server_mgr_set_command(int pid);
  53
  54 int vcd_server_mgr_unset_command(int pid);
  55
  56 int vcd_server_mgr_set_demandable_client(int pid);
  57
  58 int vcd_server_mgr_set_audio_type(int pid, const char* audio_type);
  59
  60 int vcd_server_mgr_get_audio_type(int pid, char** audio_type);
  61
  62 int vcd_server_mgr_set_client_info(int pid);
  63
  64 int vcd_server_mgr_start(vcd_recognition_mode_e recognition_mode, bool exclusive_cmd, bool start_by_client);
  65
  66 int vcd_server_mgr_stop();
  67
  68 int vcd_server_mgr_cancel();
  69
  70 int vcd_server_mgr_result_select();
  71
  72 int vcd_server_mgr_set_domain(int pid, const char* domain);
  73
  74 int vcd_server_mgr_set_private_data(int pid, const char* key, const char* data);
  75
  76 int vcd_server_mgr_get_private_data(int pid, const char* key, char** data);
  77
  78 int vcd_server_mgr_do_action(int pid, int type, const char* action);
  79
  80 int vcd_server_mgr_set_disabled_command_type(int pid, int disabled_cmd_type);
  81
  82 int vcd_server_mgr_change_system_volume(int pid, vcd_system_volume_event_e system_volume_event);
  83
  84 /* for TTS feedback */
  85 int vcd_server_mgr_start_feedback(void);
  86
  87 int vcd_server_mgr_stop_feedback(void);
  88
  89 /* for Multi-assistant */
  90 int vcd_server_mgr_send_audio_streaming(int pid, int event, const char* buffer, unsigned int len);
  91
  92
  93 /*
  94 * For client
  95 */
  96 int vcd_server_initialize(int pid);
  97
  98 int vcd_server_finalize(int pid);
  99
 100 int vcd_server_set_command(int pid, vc_cmd_type_e cmd_type);
 101
 102 int vcd_server_unset_command(int pid, vc_cmd_type_e cmd_type);
 103
 104 int vcd_server_set_foreground(int pid, bool value);
 105
 106 int vcd_server_set_server_dialog(int pid, const char* app_id, const char* credential);
 107
 108 int vcd_server_dialog(int pid, const char* disp_text, const char* utt_text, int continuous);
 109
 110 int vcd_server_is_system_command_valid(int pid, bool* is_sys_cmd_valid);
 111
 112 #if 0
 113 int vcd_server_set_exclusive_command(int pid, bool value);
 114
 115 int vcd_server_request_start(int pid, bool stop_by_silence);
 116
 117 int vcd_server_request_stop(int pid);
 118
 119 int vcd_server_request_cancel(int pid);
 120 #endif
 121
 122 /*
 123 * For widget
 124 */
 125 int vcd_server_widget_initialize(int pid);
 126
 127 int vcd_server_widget_finalize(int pid);
 128
 129 int vcd_server_widget_start_recording(int pid, bool widget_command);
 130
 131 int vcd_server_widget_start(int pid, bool stop_by_silence);
 132
 133 int vcd_server_widget_stop(int pid);
 134
 135 int vcd_server_widget_cancel(int pid);
 136
 137 int vcd_server_widget_enable_asr_result(int pid, bool enable);
 138
 139 int vcd_server_set_language(const char* language);
 140
 141 int vcd_server_mgr_send_specific_engine_request(int pid, const char* engine_app_id, const char* event, const char* request);
 142
 143 int vcd_server_request_tts(int pid, const char* text, const char* language, int to_vcm, int* utt_id);
 144
 145 int vcd_server_cancel_tts(int pid, int utt_id);
 146
 147 int vcd_server_get_tts_audio_format(int pid, int* rate, int* channel, int* audio_type);
 148
 149 /*
 150 * For engine service
 151 */
 152 int vcd_send_result(vce_result_event_e event, int* result_id, int count, const char* all_result, const char* non_fixed_result, const char* nlu_result, const char* msg, int* user_info, void *user_data);
 153
 154 int vcd_send_asr_result(vce_asr_result_event_e event, const char* asr_result, void *user_data);
 155
 156 int vcd_send_specific_engine_result(const char* engine_app_id, const char* event, const char* result, void *user_info);
 157
 158 int vcd_send_nlg_result(const char* nlg_result, void *user_data);
 159
 160 int vcd_send_error(vce_error_e error, const char* msg, void *user_data);
 161
 162 int vcd_get_foreach_command(vce_cmd_h vce_command, vce_command_cb callback, void* user_data);
 163
 164 int vcd_get_command_count(vce_cmd_h vce_command, int* count);
 165
 166 int vcd_get_audio_type(char** audio_type);
 167
 168 int vcd_set_private_data(const char* key, const char* data);
 169
 170 int vcd_get_private_data(const char* key, char** data);
 171
 172 int vcd_start_recording();
 173
 174 int vcd_stop_recording();
 175
 176 int vcd_send_update_status(vce_update_event_e update_event, const char* msg);
 177
 178 int vcd_set_private_data_set_cb(vce_private_data_set_cb callback_func);
 179
 180 int vcd_set_private_data_requested_cb(vce_private_data_requested_cb callback_func);
 181
 182 int vcd_set_nlu_base_info_requested_cb(vce_nlu_base_info_requested_cb callback_func);
 183
 184 int vcd_set_specific_engine_request_cb(vce_specific_engine_request_cb callback_func);
 185
 186 int vcd_send_feedback_audio_format(int rate, vce_audio_channel_e channel, vce_audio_type_e audio_type);
 187
 188 int vcd_send_feedback_streaming(vce_feedback_event_e event, char* buffer, int len);
 189
 190 int vcd_set_request_tts_cb(vce_request_tts_cb callback_func, void* user_data);
 191
 192 int vcd_set_cancel_tts_cb(vce_cancel_tts_cb callback_func, void* user_data);
 193
 194 int vcd_set_tts_audio_format_request_cb(vce_tts_audio_format_request_cb callback_func, void* user_data);
 195
 196
 197 #ifdef __cplusplus
 198 }
 199 #endif
 200
 201 #endif /* __VCD_SERVER_H_ */