/*
- * Copyright (c) 2011-2014 Samsung Electronics Co., Ltd All Rights Reserved
+ * Copyright (c) 2011-2016 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.
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
- * limitations under the License.
+ * limitations under the License.
*/
#ifndef __STT_FILE_H__
STT_FILE_ERROR_OPERATION_FAILED = -0x0100000 | 0x34, /**< Operation failed */
STT_FILE_ERROR_NOT_SUPPORTED_FEATURE = -0x0100000 | 0x35, /**< Not supported feature of current engine */
STT_FILE_ERROR_NOT_AGREE_SERVICE = -0x0100000 | 0x36 /**< Not agreed service of engine*/
-}stt_file_error_e;
+} stt_file_error_e;
/**
* @brief Enumerations of state.
STT_FILE_STATE_NONE = 0, /**< 'NONE' state */
STT_FILE_STATE_READY = 1, /**< 'READY' state */
STT_FILE_STATE_PROCESSING = 2, /**< 'PROCESSING' state */
-}stt_file_state_e;
+} stt_file_state_e;
/**
* @brief Enumerations of audio type.
STT_FILE_AUDIO_TYPE_RAW_S16 = 0, /**< Signed 16-bit audio sample */
STT_FILE_AUDIO_TYPE_RAW_U8, /**< Unsigned 8-bit audio sample */
STT_FILE_AUDIO_TYPE_MAX
-}stt_file_audio_type_e;
+} stt_file_audio_type_e;
/**
* @brief Enumerations of result event.
STT_FILE_RESULT_EVENT_FINAL_RESULT = 0, /**< Event when the recognition full or last result is ready */
STT_FILE_RESULT_EVENT_PARTIAL_RESULT, /**< Event when the recognition partial result is ready */
STT_FILE_RESULT_EVENT_ERROR /**< Event when the recognition has failed */
-}stt_file_result_event_e;
+} stt_file_result_event_e;
/**
* @brief Enumerations of result time callback event.
STT_FILE_RESULT_TIME_EVENT_BEGINNING = 0, /**< Event when the token is beginning type */
STT_FILE_RESULT_TIME_EVENT_MIDDLE = 1, /**< Event when the token is middle type */
STT_FILE_RESULT_TIME_EVENT_END = 2 /**< Event when the token is end type */
-}stt_file_result_time_event_e;
+} stt_file_result_time_event_e;
/**
-* @brief Recognition type : Continuous free dictation.
+* @brief Recognition type : Continuous free dictation.
*/
#define STT_RECOGNITION_TYPE_FREE_PARTIAL "stt.recognition.type.FREE.PARTIAL"
* @param[in] user_data User data passed from the stt_file_setting_foreach_supported_engines().
*
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop.
-* @pre stt_file_foreach_supported_engines() will invoke this callback.
+* @pre stt_file_foreach_supported_engines() will invoke this callback.
*
* @see stt_file_foreach_supported_engines()
*/
* @see stt_file_set_recognition_result_cb()
* @see stt_file_unset_recognition_result_cb()
*/
-typedef void (*stt_file_recognition_result_cb)(stt_file_result_event_e event, const char** data, int data_count,
+typedef void (*stt_file_recognition_result_cb)(stt_file_result_event_e event, const char** data, int data_count,
const char* msg, void *user_data);
/**
*
* @see stt_file_recognition_result_cb()
*/
-typedef bool (*stt_file_result_time_cb)(int index, stt_file_result_time_event_e event, const char* text,
+typedef bool (*stt_file_result_time_cb)(int index, stt_file_result_time_event_e event, const char* text,
long start_time, long end_time, void* user_data);
/**
-* @brief Called when the state of STT FILE is changed.
+* @brief Called when the state of STT FILE is changed.
*
* @param[in] previous A previous state
* @param[in] current A current state
typedef void (*stt_file_state_changed_cb)(stt_file_state_e previous, stt_file_state_e current, void* user_data);
/**
-* @brief Called to retrieve the supported languages.
+* @brief Called to retrieve the supported languages.
*
* @param[in] language A language is specified as an ISO 3166 alpha-2 two letter country-code \n
* followed by ISO 639-1 for the two-letter language code. \n
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop.
-* @pre stt_file_foreach_supported_languages() will invoke this callback.
+* @pre stt_file_foreach_supported_languages() will invoke this callback.
*
* @see stt_file_foreach_supported_languages()
*/
* @pre The state should be #STT_FILE_STATE_NONE.
* @post If this function is called, the STT state will be #STT_FILE_STATE_READY.
*
-* @see stt_file_deinitialize()
+* @see stt_file_deinitialize(void)
*/
-int stt_file_initialize();
+int stt_file_initialize(void);
/**
* @brief Deinitialize STT FILE.
* @pre The state should be #STT_FILE_STATE_READY.
* @post If this function is called, the STT FILE state will be #STT_FILE_STATE_NONE.
*
-* @see stt_file_initialize()
+* @see stt_file_initialize(void)
*/
-int stt_file_deinitialize();
+int stt_file_deinitialize(void);
/**
* @brief Gets the current state.
* @retval #STT_FILE_ERROR_OPERATION_FAILED Operation failure.
*
* @pre The state should be #STT_FILE_STATE_READY.
-* @post This function invokes stt_file_supported_engine_cb() repeatedly for getting engine information.
+* @post This function invokes stt_file_supported_engine_cb() repeatedly for getting engine information.
*
* @see stt_file_supported_engine_cb()
*/
* @retval #STT_FILE_ERROR_NONE Success.
* @retval #STT_FILE_ERROR_OUT_OF_MEMORY Out of memory.
* @retval #STT_FILE_ERROR_INVALID_PARAMETER Invalid parameter.
-* @retval #STT_FILE_ERROR_INVALID_STATE Invalid state.
+* @retval #STT_FILE_ERROR_INVALID_STATE Invalid state.
* @retval #STT_FILE_ERROR_OPERATION_FAILED Operation failure.
*
* @pre The state should be #STT_FILE_STATE_READY.
* @retval #STT_FILE_ERROR_INVALID_STATE Invalid state
*
* @pre The state should be #STT_FILE_STATE_READY.
-* @post This function invokes stt_file_supported_language_cb() repeatedly for getting languages.
+* @post This function invokes stt_file_supported_language_cb() repeatedly for getting languages.
*
* @see stt_file_supported_language_cb()
* @see stt_file_get_default_language()
*
* @see stt_file_cancel()
*/
-int stt_file_start(const char* language, const char* type, const char* filepath,
+int stt_file_start(const char* language, const char* type, const char* filepath,
stt_file_audio_type_e audio_type, int sample_rate);
/**
*
* @see stt_file_start()
*/
-int stt_file_cancel();
+int stt_file_cancel(void);
/**
* @retval #STT_FILE_ERROR_INVALID_STATE Invalid state
*
* @pre This function should be called in stt_file_recognition_result_cb().
-* @post This function invokes stt_file_result_time_cb() repeatedly for getting time information.
+* @post This function invokes stt_file_result_time_cb() repeatedly for getting time information.
*
* @see stt_file_result_time_cb()
* @see stt_file_recognition_result_cb()
*
* @see stt_file_set_recognition_result_cb()
*/
-int stt_file_unset_recognition_result_cb();
+int stt_file_unset_recognition_result_cb(void);
/**
* @brief Registers a callback function to be called when STT FILE state changes.
*
* @see stt_file_set_state_changed_cb()
*/
-int stt_file_unset_state_changed_cb();
+int stt_file_unset_state_changed_cb(void);
#ifdef __cplusplus
#endif
/**
- * @}@}
+ * @}
*/
#endif /* __STT_FILE_H__ */
projects / platform / core / uifw / stt.git / blobdiff