summaryrefslogtreecommitdiffstats
path: root/include/tts/TtsEngine.h
diff options
context:
space:
mode:
authorJean-Michel Trivi <jmtrivi@google.com>2009-06-26 17:09:21 -0700
committerJean-Michel Trivi <jmtrivi@google.com>2009-06-29 09:52:17 -0700
commit3f81888a7213062f42a6893ff07e76fc43bdf447 (patch)
tree92ab8ca885a5468008fe6d80652e6a30adbf9c49 /include/tts/TtsEngine.h
parent955a6690f49e670ef0e03857f118f1ce79ace91e (diff)
downloadframeworks_native-3f81888a7213062f42a6893ff07e76fc43bdf447.zip
frameworks_native-3f81888a7213062f42a6893ff07e76fc43bdf447.tar.gz
frameworks_native-3f81888a7213062f42a6893ff07e76fc43bdf447.tar.bz2
Add in TTS engine interface the methods to query the availability for a language,
to set the synthesis audio format, to query the current language, country and variant setting.
Diffstat (limited to 'include/tts/TtsEngine.h')
-rw-r--r--include/tts/TtsEngine.h30
1 files changed, 20 insertions, 10 deletions
diff --git a/include/tts/TtsEngine.h b/include/tts/TtsEngine.h
index ca50a5e..21cb73b 100644
--- a/include/tts/TtsEngine.h
+++ b/include/tts/TtsEngine.h
@@ -133,16 +133,26 @@ public:
// @return TTS_SUCCESS, or TTS_FAILURE
virtual tts_result setLanguage(const char *lang, const char *country, const char *variant);
- // Retrieve the currently set language, or an empty "value" if no language
- // has been set.
- // @param[out] value pointer to the retrieved language value
- // @param[inout] iosize in: stores the size available to store the language
- // value in *value
- // out: stores the size required to hold the language
- // value if getLanguage() returned
- // TTS_PROPERTY_SIZE_TOO_SMALL, unchanged otherwise.
- // @return TTS_SUCCESS, or TTS_PROPERTY_SIZE_TOO_SMALL, or TTS_FAILURE
- virtual tts_result getLanguage(char *value, size_t *iosize);
+ // Retrieve the currently set language, country and variant, or empty strings if none of
+ // parameters have been set. Language and country are represented by their 3-letter ISO code
+ // @param[out] pointer to the retrieved 3-letter code language value
+ // @param[out] pointer to the retrieved 3-letter code country value
+ // @param[out] pointer to the retrieved variant value
+ // @return TTS_SUCCESS, or TTS_FAILURE
+ virtual tts_result getLanguage(char *language, char *country, char *variant);
+
+ // Notifies the engine what audio parameters should be used for the synthesis.
+ // This is meant to be used as a hint, the engine implementation will set the output values
+ // to those of the synthesis format, based on a given hint.
+ // @param[inout] encoding in: the desired audio sample format
+ // out: the format used by the TTS engine
+ // @param[inout] rate in: the desired audio sample rate
+ // out: the sample rate used by the TTS engine
+ // @param[inout] channels in: the desired number of audio channels
+ // out: the number of channels used by the TTS engine
+ // @return TTS_SUCCESS, or TTS_FAILURE
+ virtual tts_result setAudioFormat(AudioSystem::audio_format& encoding, uint32_t& rate,
+ int& channels);
// Set a property for the the TTS engine
// "size" is the maximum size of "value" for properties "property"