* @file FUixSpeech.h
* @brief This is the header file for the %Speech namespace.
*
- * This header file contains the declarations and descriptions of the %Tizen::Uix::Speech namespace.
+ * This header file contains the declarations and descriptions of the %Speech namespace.
*/
#ifndef _FUIX_SPEECH_H_
/**
* @namespace Tizen::Uix::Speech
- * @brief This namespace contains the classes for the speech and its related functions.
- * @since 2.0
+ * @brief This namespace contains classes for speech and its related functions.
+ * @since 2.0
*
- * @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
- * @b Library : @b osp-speech-tts, @b osp-speech-stt
+ * @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
+ * @b Library: @b osp-speech-tts, @b osp-speech-stt @n
*
* The %Speech namespace provides easy and simplified speech recognition and synthesis methods. @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a> and
+ * For more information on the %Speech namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a> and
* <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
*
* The following diagram illustrates the relationships between the classes belonging to the %Speech namespace.
/**
* @interface ISpeechToTextEventListener
- * @brief This interface is a listener for speech recognition events.
+ * @brief This interface is a listener interface for speech recognition events.
*
- * @since 2.0
+ * @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
- * @b Library : @b osp-speech-stt
+ * @b Library: @b osp-speech-stt @n
*
* The %ISpeechToTextEventListener interface is a listener interface for speech recognition events.
- * It provides methods that are invoked by the voice engine when the status is changed, an
- * error or warning occurs or the result is received in the Speech-To-Text service. @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
+ * It provides methods that are invoked by the voice engine when the Speech-To-Text service undergoes a status change, returns an
+ * error or warning, or returns a result. @n
+ * For more information on the Speech-To-Text service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
*
*/
*
* @since 2.0
*
- * @param[in] error The reason for an error in the Speech-To-Text service
+ * @param[in] error The reason for the error in the Speech-To-Text service
*/
virtual void OnSpeechToTextErrorOccurred(Tizen::Uix::Speech::SpeechToTextError error) = 0;
/**
* @interface ITextToSpeechEventListener
- * @brief This interface is a listener for the speech synthesis events.
+ * @brief This interface is a listener interface for speech synthesis events.
*
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
- * @b Library : @b osp-speech-tts
+ * @b Library: @b osp-speech-tts @n
*
- * The %ITextToSpeechEventListener interface is a listener interface for the speech synthesis events.
- * It provides methods that are used to notify when the status is changed and an error occurs from the voice engine. @n
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
+ * The %ITextToSpeechEventListener interface is a listener interface for speech synthesis events.
+ * It provides methods that are invoked by the voice engine which notifies when the Text-To-Speech service undergoes a status
+ * change or returns an error. @n
+ * For more information on the Text-To-Speech service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
*/
class _OSP_EXPORT_ ITextToSpeechEventListener
*
* @since 2.0
*
- * @param[in] error The reason for an error in the Text-To-Speech service
+ * @param[in] error The reason for the error in the Text-To-Speech service
*/
virtual void OnTextToSpeechErrorOccurred(Tizen::Uix::Speech::TextToSpeechError error) = 0;
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
-* @b Library : @b osp-speech-stt
+* @b Library: @b osp-speech-stt @n
*
-* The %SpeechToText class converts spoken words into text.
-* @n
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
+* The %SpeechToText class converts spoken words into text. @n
+* For more information on the Speech-To-Text service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/speech_to_text.htm">Speech-To-Text</a>.
*
* The following example demonstrates how to use the %SpeechToText class. @n
* In the example, the Start() method is called after invoking the ISpeechToTextEventListener::OnSpeechToTextInitialized() method.
/**
* Initializes this instance of %SpeechToText with the specified @c listener.
*
- * @since 2.0
+ * @since 2.0
*
* @return An error code
* @param[in] listener An instance of ISpeechToTextEventListener
/**
* Initializes the Speech-To-Text service. @n
* The %Initialize() method is asynchronous. @n
- * The ISpeechToTextEventListener::OnSpeechToTextInitialized() is invoked when the service has been initialized.
- * @since 2.0
+ * The ISpeechToTextEventListener::OnSpeechToTextInitialized() method is invoked when the service has been initialized.
+ * @since 2.0
*
- * @feature %http://tizen.org/feature/speech.recognition
+ * @feature %http://tizen.org/feature/speech.recognition
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
* - Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
- * - This method must be called after Construct().
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * - This method must be called after the Construct() method.
*/
result Initialize(void);
/**
- * Starts recording the speech of a user and converts it to text.
+ * Starts recording the speech of the user and converts it into text.
*
* @since 2.0
*
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SERVICE_BUSY The recorder is busy.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
- * @exception E_INVALID_OPERATION The current status should be @c SPEECH_TO_TEXT_STATUS_READY.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
+ * @exception E_INVALID_OPERATION The current status is not ::SPEECH_TO_TEXT_STATUS_READY.
*/
result Start(void);
/**
- * Stops the recording and current Speech-To-Text service.
+ * Stops the recording and the current Speech-To-Text service.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
- * @exception E_INVALID_OPERATION The current status should be ::SPEECH_TO_TEXT_STATUS_RECORDING.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
+ * @exception E_INVALID_OPERATION The current status is not ::SPEECH_TO_TEXT_STATUS_RECORDING.
*/
result Stop(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
- * @exception E_INVALID_OPERATION The current status should be ::SPEECH_TO_TEXT_STATUS_RECORDING or ::SPEECH_TO_TEXT_STATUS_PROCESSING.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
+ * @exception E_INVALID_OPERATION The current status is neither ::SPEECH_TO_TEXT_STATUS_RECORDING nor
+ * ::SPEECH_TO_TEXT_STATUS_PROCESSING.
*/
result Cancel(void);
* @return An error code
* @param[in] locale The locale
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_LOCALE This locale is not supported.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_UNSUPPORTED_LOCALE The locale is not supported.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @see GetSupportedLocales()
*/
result SetLocale(const Tizen::Locales::Locale& locale);
*
* @since 2.0
*
- * @return A current locale
+ * @return The current locale
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Locales::Locale GetLocale(void) const;
/**
- * Checks whether a locale is supported or not.
+ * Checks if the locale is supported or not.
*
* @since 2.0
*
- * @return @c true if the locale is available, @n
+ * @return @c true if the locale is supported, @n
* else @c false
* @param[in] locale The locale
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
bool IsLocaleSupported(const Tizen::Locales::Locale& locale) const;
/**
* Gets the list of supported locales. @n
- * Each list's item has a pointer of Tizen::Locales::Locale value.
+ * Each list item has a pointer of Tizen::Locales::Locale value.
*
* @since 2.0
*
- * @return A list of locales
+ * @return The list of locales
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Base::Collection::IList* GetSupportedLocales(void) const;
/**
- * Sets the grammar for %SpeechToText.
+ * Sets the grammar for the Speech-To-Text service.
*
* @since 2.0
*
* @return An error code
- * @param[in] grammar A grammar
+ * @param[in] grammar The grammar
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
*/
result SetGrammar(SpeechToTextGrammar grammar);
*
* @since 2.0
*
- * @return The current grammar used by recognition
+ * @return The current grammar used for recognition
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
SpeechToTextGrammar GetGrammar(void) const;
/**
- * Sets the silence detection enabled or disabled.
+ * Sets the silence detection feature to enabled or disabled.
*
* @since 2.0
*
* @return An error code
- * @param[in] enable Set to @c true to enable the silence detection, @n
- * else @c false
+ * @param[in] enable The boolean value that enables or disables the silence detection feature
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
*/
result SetSilenceDetectionEnabled(bool enable);
/**
- * Checks whether the silence detection feature is enabled.
+ * Checks if the silence detection feature is enabled or not.
*
* @since 2.0
*
- * @return @c true if the silence detection is enabled, @n
+ * @return @c true if the silence detection feature is enabled, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
bool IsSilenceDetectionEnabled(void) const;
/**
- * Gets the current status.
+ * Gets the current status of the Speech-To-Text service.
*
* @since 2.0
*
- * @return current status
+ * @return The current status of the Speech-To-Text service
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
SpeechToTextStatus GetCurrentStatus(void) const;
/**
* @file FUixSpeechSpeechToTextTypes.h
- * @brief This is the header file for the common data types used by the SpeechToText class.
+ * @brief This is the header file for the common data types used by the %SpeechToText class.
*
* This header file contains the declarations of the common data types and constants used by the SpeechToText class.
*/
/**
* @enum SpeechToTextStatus
*
-* Defines the SpeechToText status.
+* Defines the status of the Speech-To-Text service.
*
* @since 2.0
*
*/
enum SpeechToTextStatus
{
- SPEECH_TO_TEXT_STATUS_NONE, /**< The none status */
+ SPEECH_TO_TEXT_STATUS_NONE, /**< No status */
SPEECH_TO_TEXT_STATUS_READY, /**< The ready status */
SPEECH_TO_TEXT_STATUS_RECORDING, /**< The recording status */
SPEECH_TO_TEXT_STATUS_PROCESSING /**< The recognition processing status */
/**
* @enum SpeechToTextGrammar
*
-* Defines the SpeechToText grammar.
+* Defines the grammar of the Speech-To-Text service.
*
* @since 2.0
*
enum SpeechToTextGrammar
{
SPEECH_TO_TEXT_GRAMMAR_FREE, /**< The key is used for general purpose dictation */
- SPEECH_TO_TEXT_GRAMMAR_WEB_SEARCH /**< The key is used for recognizing short phrases such as the ones used for %Web search */
+ SPEECH_TO_TEXT_GRAMMAR_WEB_SEARCH /**< The key is used for recognizing short phrases,
+ * such as the ones used for a web search */
};
/**
* @enum SpeechToTextError
*
-* Defines the errors in SpeechToText. @n
-* When an error occurs, the user can not receive any %SpeechToText result.
+* Defines the errors that occur in the Speech-To-Text service. @n
+* When an error occurs, the user does not receive any Speech-To-Text result.
*
* @since 2.0
*
*/
enum SpeechToTextError
{
- SPEECH_TO_TEXT_ERROR_OUT_OF_MEMORY, /**< The out of memory error */
+ SPEECH_TO_TEXT_ERROR_OUT_OF_MEMORY, /**< The out-of-memory error */
SPEECH_TO_TEXT_ERROR_IO_ERROR, /**< The I/O error */
SPEECH_TO_TEXT_ERROR_NETWORK_ERROR, /**< The network connection error */
- SPEECH_TO_TEXT_ERROR_TIME_OUT, /**< The timeout error */
+ SPEECH_TO_TEXT_ERROR_TIME_OUT, /**< The time-out error */
SPEECH_TO_TEXT_ERROR_SYSTEM_ERROR, /**< The system error */
SPEECH_TO_TEXT_ERROR_UNSUPPORTED_SERVICE /**< The unsupported service error */
};
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
-* @b Library : @b osp-speech-tts
+* @b Library: @b osp-speech-tts @n
*
* The %TextToSpeech class is used to convert normal language text into speech. @n
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
+* For more information on the Text-To-Speech service, see <a href="../org.tizen.native.appprogramming/html/guide/uix/text_to_speech.htm">Text-To-Speech</a>.
*
* The following example demonstrates how to use the %TextToSpeech class. @n
* In the example, the Speak() method is called after invoking the ITextToSpeechEventListener::OnTextToSpeechInitialized() method.
/**
* Initializes the Text-To-Speech service. @n
* The %Initialize() method is asynchronous. @n
- * The ITextToSpeechEventListener::OnTextToSpeechInitialized() is invoked when the service has been initialized.
+ * The ITextToSpeechEventListener::OnTextToSpeechInitialized() method is invoked when the service has been initialized.
*
* @since 2.0
*
- * @feature %http://tizen.org/feature/speech.synthesis
+ * @feature %http://tizen.org/feature/speech.synthesis
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
* - Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
- * - This method must be called after Construct().
+ * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * - This method must be called after the Construct() method.
*/
result Initialize(void);
/**
- * Starts the conversion of given text and starts playing the synthesized sound.
+ * Starts the conversion of the given text and plays the synthesized sound.
*
* @since 2.0
*
* @return An error code
- * @param[in] text A text string for synthesizing a speech
+ * @param[in] text The text string to synthesize the speech
* @param[in] requestMode The request mode
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
*/
result Speak(const Tizen::Base::String& text, TextToSpeechRequestMode requestMode = TEXT_TO_SPEECH_REQUEST_MODE_APPEND);
/**
- * Stops the synthesis or the sound on playing.
+ * Stops the synthesis of the sound being played.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
- * @exception E_INVALID_OPERATION The current status should be ::TEXT_TO_SPEECH_STATUS_PLAYING or ::TEXT_TO_SPEECH_STATUS_PAUSED.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
+ * @exception E_INVALID_OPERATION The current status is neither ::TEXT_TO_SPEECH_STATUS_PLAYING nor
+ * ::TEXT_TO_SPEECH_STATUS_PAUSED.
*/
result Stop(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
- * @exception E_INVALID_OPERATION The current status should be ::TEXT_TO_SPEECH_STATUS_PLAYING.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
+ * @exception E_INVALID_OPERATION The current status is not ::TEXT_TO_SPEECH_STATUS_PLAYING.
*/
result Pause(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
- * @exception E_INVALID_OPERATION The current status should be ::TEXT_TO_SPEECH_STATUS_PAUSED.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
+ * @exception E_INVALID_OPERATION The current status is not ::TEXT_TO_SPEECH_STATUS_PAUSED.
*/
result Resume(void);
* @return An error code
* @param[in] locale The current locale
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_LOCALE This locale is not supported.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_UNSUPPORTED_LOCALE The locale is not supported.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @see GetSupportedLocales()
*/
result SetLocale(const Tizen::Locales::Locale& locale);
*
* @since 2.0
*
- * @return A current locale
+ * @return The current locale
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Locales::Locale GetLocale(void) const;
/**
- * Checks whether a locale is supported.
+ * Checks if the locale is supported or not.
*
* @since 2.0
*
- * @return @c true if the locale is available, @n
+ * @return @c true if the locale is supported, @n
* else @c false
* @param[in] locale The locale
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
bool IsLocaleSupported(const Tizen::Locales::Locale& locale) const;
/**
* Gets the list of supported locales. @n
- * Each list's item has a pointer of Tizen::Locales::Locale value.
+ * Each list item has a pointer of Tizen::Locales::Locale value.
*
* @since 2.0
*
- * @return A list of locales
+ * @return The list of locales
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Base::Collection::IList* GetSupportedLocales(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] rate A speech rate
+ * @param[in] rate The speech rate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
*/
result SetSpeechRate(TextToSpeechSpeechRate rate);
/**
- * Gets the current status.
+ * Gets the current status of the Text-To-Speech service.
*
* @since 2.0
*
- * @return current status
+ * @return The current status of the Text-To-Speech service
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE TThis instance is not initialized as yet.
+ * @exception E_INVALID_STATE This instance has not been initialized yet.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
TextToSpeechStatus GetCurrentStatus(void) const;
/**
* @file FUixSpeechTextToSpeechTypes.h
- * @brief This is the header file for common data types used by the TextToSpeech class.
+ * @brief This is the header file for the common data types used by the %TextToSpeech class.
*
* This header file contains the declarations of the common data types and constants used by the TextToSpeech class.
*/
*/
enum TextToSpeechRequestMode
{
- TEXT_TO_SPEECH_REQUEST_MODE_APPEND, /**< The new request is added at the queue */
+ TEXT_TO_SPEECH_REQUEST_MODE_APPEND, /**< A new request is added to the queue */
TEXT_TO_SPEECH_REQUEST_MODE_REPLACE /**< All requests in the queue are dropped and replaced by the new request */
};
/**
* @enum TextToSpeechSpeechRate
*
- * Defines the level of the speech rate.
+ * Defines the speech rate level.
*
* @since 2.0
*
*/
enum TextToSpeechSpeechRate
{
- TEXT_TO_SPEECH_SPEECH_RATE_SYSTEM_SETTING, /**< The speech rate from system setting */
- TEXT_TO_SPEECH_SPEECH_RATE_VERY_SLOW, /**< The very slow speech rate */
- TEXT_TO_SPEECH_SPEECH_RATE_SLOW, /**< The slow speech rate*/
- TEXT_TO_SPEECH_SPEECH_RATE_NORMAL, /**< The normal speech rate */
- TEXT_TO_SPEECH_SPEECH_RATE_FAST, /**< The fast speech rate */
- TEXT_TO_SPEECH_SPEECH_RATE_VERY_FAST /**< The very fast speech rate */
+ TEXT_TO_SPEECH_SPEECH_RATE_SYSTEM_SETTING, /**< A speech rate from the system setting */
+ TEXT_TO_SPEECH_SPEECH_RATE_VERY_SLOW, /**< A very slow speech rate */
+ TEXT_TO_SPEECH_SPEECH_RATE_SLOW, /**< A slow speech rate */
+ TEXT_TO_SPEECH_SPEECH_RATE_NORMAL, /**< A normal speech rate */
+ TEXT_TO_SPEECH_SPEECH_RATE_FAST, /**< A fast speech rate */
+ TEXT_TO_SPEECH_SPEECH_RATE_VERY_FAST /**< A very fast speech rate */
};
/**
*/
enum TextToSpeechStatus
{
- TEXT_TO_SPEECH_STATUS_NONE, /**< The none status */
+ TEXT_TO_SPEECH_STATUS_NONE, /**< No status */
TEXT_TO_SPEECH_STATUS_READY, /**< The ready status */
TEXT_TO_SPEECH_STATUS_SYNTHESIZING, /**< The synthesizing status */
TEXT_TO_SPEECH_STATUS_PLAYING, /**< The playing status */
- TEXT_TO_SPEECH_STATUS_PAUSED /**< The paused status*/
+ TEXT_TO_SPEECH_STATUS_PAUSED /**< The paused status */
};
/**
*/
enum TextToSpeechError
{
- TEXT_TO_SPEECH_ERROR_OUT_OF_MEMORY, /**< The out of memory error */
+ TEXT_TO_SPEECH_ERROR_OUT_OF_MEMORY, /**< The out-of-memory error */
TEXT_TO_SPEECH_ERROR_IO_ERROR, /**< The I/O error */
TEXT_TO_SPEECH_ERROR_NETWORK_ERROR, /**< The network connection error */
- TEXT_TO_SPEECH_ERROR_TIME_OUT, /**< The timeout error */
+ TEXT_TO_SPEECH_ERROR_TIME_OUT, /**< The time-out error */
TEXT_TO_SPEECH_ERROR_SYSTEM_ERROR, /**< The system error */
TEXT_TO_SPEECH_ERROR_UNSUPPORTED_SERVICE /**< The unsupported service error */
};