2 * Copyright (c) 2011-2016 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef __TTS_INTERNAL_H__
19 #define __TTS_INTERNAL_H__
31 * @brief Sets server tts.
32 * @details Using this API, the application can ask server tts with a credential.
33 * The credential is a key to verify the authorization about using the engine based on server, not embeded engine.
34 * If the application sets the credential, it will be able to use functions of the server engine entirely.
35 * @since_tizen @if MOBILE 3.0
37 * @remarks The necessity of the credential depends on the engine. In case of the engine which is basically embedded in Tizen, the credential is not necessary so far.
38 * However, if the user wants to apply the 3rd party's engine, the credential may be necessary. In that case, please follow the policy provided by the corresponding engine.
40 * @param[in] tts The TTS handle
41 * @param[in] credential The credential
43 * @return 0 on success, otherwise a negative error value
44 * @retval #TTS_ERROR_NONE Success
45 * @retval #TTS_ERROR_INVALID_STATE Invalid state
46 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
47 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
48 * @retval #TTS_ERROR_OUT_OF_MEMORY TTS Out of memory
50 * @pre The state should be #TTS_STATE_CREATED or #TTS_STATE_READY.
54 int tts_set_server_tts(tts_h tts, const char* credential);
65 #endif /* __TTS_INTERNAL_H__ */