STT_ERROR_IN_PROGRESS_TO_READY = TIZEN_ERROR_STT | 0x07, /**< Progress to ready is not finished */
STT_ERROR_IN_PROGRESS_TO_RECORDING = TIZEN_ERROR_STT | 0x08, /**< Progress to recording is not finished */
STT_ERROR_IN_PROGRESS_TO_PROCESSING = TIZEN_ERROR_STT | 0x09, /**< Progress to processing is not finished */
- STT_ERROR_RECORDING_TIMED_OUT = TIZEN_ERROR_STT | 0x10 /**< Recording timed out */
+ STT_ERROR_RECORDING_TIMED_OUT = TIZEN_ERROR_STT | 0x10, /**< Recording timed out */
+ STT_ERROR_SERVICE_RESET = TIZEN_ERROR_STT | 0x11 /**< Service reset */
} stt_error_e;
/**
/**
* @brief Called when the engine is changed.
- * @since_tizen 3.0
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*
* @param[in] stt The STT handle
* @param[in] engine_id Engine id
* @param[in] language The default language
- * @param[in] support_silence support silence detection
- * @param[in] need_credential necessity of credential
+ * @param[in] support_silence Whether the silence detection is supported or not
+ * @param[in] need_credential The necessity of credential
* @param[in] user_data The user data passed from the callback registration function
*
* @see stt_set_engine_changed_cb()
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @post If this function is called, the STT state will be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @see stt_create()
*/
* @retval #STT_ERROR_INVALID_STATE STT Not initialized
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
* @post This function invokes stt_supported_engine_cb() repeatedly for getting engine information.
* @retval #STT_ERROR_INVALID_STATE STT Not initialized
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_STATE STT Not initialized
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
/**
* @brief Sets the app credential.
- * @since_tizen 3.0
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
*
* @return 0 on success, otherwise a negative error value
* @retval #STT_ERROR_NONE Success
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED or #STT_STATE_READY.
*
/**
* @brief Sets the private data to stt engine.
- * @since_tizen 3.0
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*
* @param[in] stt The STT handle
* @param[in] key The field name of private data
/**
* @brief Gets the private data from stt engine.
- * @since_tizen 3.0
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*
* @param[in] stt The STT handle
* @param[in] key The field name of private data
- * @param[out] data The data
+ * @param[out] data The data field of private data
+ *
+ * @remarks The @a data must be released using free() when it is no longer required.
*
* @return 0 on success, otherwise a negative error value
* @retval #STT_ERROR_NONE Successful
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
* @post If this function is successful, the STT state will be #STT_STATE_READY. \n
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
* @post If this function is called, the STT state will be #STT_STATE_CREATED.
* @return 0 on success, otherwise a negative error value
* @retval #STT_ERROR_NONE Successful
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_ENGINE_NOT_FOUND No available engine
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @post This function invokes stt_supported_language_cb() repeatedly for getting languages.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @see stt_foreach_supported_languages()
*/
* @retval #STT_ERROR_NONE Successful
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @see stt_start()
* @see stt_stop()
/**
* @brief Gets the current error message.
- * @since_tizen 3.0
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/recorder
* @remarks This function should be called during an stt error callback. If not, the error as operation failure will be returned. \n
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @see stt_set_error_cb()
* @see stt_unset_error_cb()
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
*/
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED_FEATURE Not supported feature of current engine
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
*/
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
*/
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
*/
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
*/
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_READY.
*/
* @retval #STT_ERROR_RECORDER_BUSY Recorder busy
* @retval #STT_ERROR_INVALID_LANGUAGE Invalid language
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
* @retval #STT_ERROR_IN_PROGRESS_TO_RECORDING Progress to recording is not finished
*
* @pre The state should be #STT_STATE_READY.
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
* @retval #STT_ERROR_IN_PROGRESS_TO_READY Progress to ready is not finished
* @retval #STT_ERROR_IN_PROGRESS_TO_RECORDING Progress to recording is not finished
* @retval #STT_ERROR_IN_PROGRESS_TO_PROCESSING Progress to processing is not finished
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
* @retval #STT_ERROR_IN_PROGRESS_TO_READY Progress to ready is not finished
* @retval #STT_ERROR_IN_PROGRESS_TO_RECORDING Progress to recording is not finished
* @retval #STT_ERROR_IN_PROGRESS_TO_PROCESSING Progress to processing is not finished
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_RECORDING.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_OPERATION_FAILED Operation failure
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre This function should be called in stt_recognition_result_cb().
* @post This function invokes stt_result_time_cb() repeatedly for getting time information.
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
* @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #STT_ERROR_INVALID_STATE Invalid state
* @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre The state should be #STT_STATE_CREATED.
*
*/
int stt_unset_default_language_changed_cb(stt_h stt);
+/**
+ * @brief Registers a callback function to detect the engine change.
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ *
+ * @param[in] stt The STT handle
+ * @param]in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #STT_ERROR_NONE Successful
+ * @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STT_ERROR_INVALID_STATE Invalid state
+ * @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @pre The state should be #STT_STATE_CREATED.
+ *
+ * @see stt_engine_changed_cb()
+ * @see stt_unset_engine_changed_cb()
+*/
+int stt_set_engine_changed_cb(stt_h stt, stt_engine_changed_cb callback, void* user_data);
+
+/**
+ * @brief Unregisters the callback function.
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ *
+ * @param[in] stt The STT handle
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #STT_ERROR_NONE Successful
+ * @retval #STT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STT_ERROR_INVALID_STATE Invalid state
+ * @retval #STT_ERROR_NOT_SUPPORTED STT NOT supported
+ * @retval #STT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @pre The state should be #STT_STATE_CREATED.
+ *
+ * @see stt_set_engine_changed_cb()
+*/
+int stt_unset_engine_changed_cb(stt_h stt);
+
+
#ifdef __cplusplus
}
#endif