remove description for unknown function that doesn't exist
[platform/core/uifw/tts.git] / server / ttsd_engine_agent.h
1 /*
2 *  Copyright (c) 2011-2016 Samsung Electronics Co., Ltd All Rights Reserved
3 *  Licensed under the Apache License, Version 2.0 (the "License");
4 *  you may not use this file except in compliance with the License.
5 *  You may obtain a copy of the License at
6 *  http://www.apache.org/licenses/LICENSE-2.0
7 *  Unless required by applicable law or agreed to in writing, software
8 *  distributed under the License is distributed on an "AS IS" BASIS,
9 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 *  See the License for the specific language governing permissions and
11 *  limitations under the License.
12 */
13
14
15 #ifndef __TTSD_ENGINE_AGENT_H_
16 #define __TTSD_ENGINE_AGENT_H_
17
18 #include "ttsd_main.h"
19 #include "ttsd_player.h"
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25
26 /*
27 * tts Engine Agent Interfaces
28 */
29
30 /** Init engine agent */
31 int ttsd_engine_agent_init(ttse_request_callback_s *callback);
32
33 /** Release engine agent */
34 int ttsd_engine_agent_release();
35
36 /** load current engine */
37 int ttsd_engine_agent_load_current_engine();
38
39 /** Set callbacks of the current engine */
40 int ttsd_engine_agent_set_private_data_set_cb(ttse_private_data_set_cb callback);
41 int ttsd_engine_agent_set_private_data_requested_cb(ttse_private_data_requested_cb callback);
42 int ttsd_engine_agent_set_activated_mode_changed_cb(ttse_activated_mode_changed_cb callback);
43 int ttsd_engine_agent_set_personal_tts_id_set_cb(ttse_set_personal_tts_id_cb callback);
44
45 /** Unload current engine */
46 int ttsd_engine_agent_unload_current_engine();
47
48 /** Get state of current engine to need network */
49 bool ttsd_engine_agent_need_network();
50
51 bool ttsd_engine_select_valid_voice(const char* lang, int type, char** out_lang, int* out_type);
52
53 bool ttsd_engine_agent_is_same_engine(const char* engine_id);
54
55 /** Get/Set app option */
56 int ttsd_engine_agent_set_default_engine(const char* engine_id);
57
58 int ttsd_engine_agent_set_default_voice(const char* language, int vctype);
59
60 int ttsd_engine_agent_set_default_speed(int speed);
61
62 int ttsd_engine_agent_set_default_pitch(int pitch);
63
64 int ttsd_engine_agent_set_personal_tts_id(const char* ptts_id);
65
66 int ttsd_engine_agent_is_credential_needed(unsigned int uid, bool* credential_needed);
67
68 int ttsd_engine_set_private_data(const char* key, const char* data);
69
70 int ttsd_engine_get_private_data(const char* key, char** data);
71
72 int ttsd_engine_check_app_agreed(const char* appid, bool* is_agreed);
73
74 int ttsd_engine_notify_activated_mode_changed(int activated_mode);
75
76 /*
77 * TTS Engine Interfaces for client
78 */
79
80 int ttsd_engine_load_voice(const char* lang, int vctype);
81
82 int ttsd_engine_unload_voice(const char* lang, int vctype);
83
84 int ttsd_engine_start_synthesis(const char* lang, int vctype, const char* text, int speed, const char* appid, const char* credential, void* user_param);
85
86 int ttsd_engine_cancel_synthesis();
87
88 int ttsd_engine_get_voice_list(GList** voice_list);
89
90 int ttsd_engine_get_default_voice(char** lang, int* vctype);
91
92
93
94 #ifdef __cplusplus
95 }
96 #endif
97
98 #endif /* __TTSD_ENGINE_AGENT_H_ */