android.speech.recognition.SpeechSynthesizer Class Reference

Inheritance diagram for android.speech.recognition.SpeechSynthesizer:

Inheritance graph
[legend]
Collaboration diagram for android.speech.recognition.SpeechSynthesizer:

Collaboration graph
[legend]

List of all members.


Detailed Description

This resource processes text markup provided by the client and generates a stream of synthesized speech in real-time

Public Types

enum  SpeechType {
  TEXT,
  URI,
  SSML
}

Public Member Functions

virtual void setListener (AudioSourceListenerProxy &listener, ReturnCode::Type &returnCode)=0
virtual void setCodec (Codec::Type synthesizeCodec, ReturnCode::Type &returnCode)=0
virtual void queue (SpeechSynthesizer::SpeechType speechType, const char *value, const char *language, ReturnCode::Type &returnCode)=0
virtual AudioStreamProxy createAudio (ReturnCode::Type &returnCode)=0
virtual void start (ReturnCode::Type &returnCode)=0
virtual void stop (ReturnCode::Type &returnCode)=0

Protected Member Functions

UAPI_EXPORT SpeechSynthesizer ()
virtual UAPI_EXPORT ~SpeechSynthesizer ()

Friends

class SpeechSynthesizerProxy

Member Enumeration Documentation

enum android::speech::recognition::SpeechSynthesizer::SpeechType

Enumerator:
TEXT  The speech to synthesize is plain text
URI  The speech to synthesize is located at this URI.
SSML  The speech to synthesize is SSML (markup language).
See also:
http://www.w3.org/TR/speech-synthesis/


Constructor & Destructor Documentation

UAPI_EXPORT android.speech.recognition.SpeechSynthesizer.SpeechSynthesizer (  )  [protected]

Prevent destruction.

virtual UAPI_EXPORT android.speech.recognition.SpeechSynthesizer.~SpeechSynthesizer (  )  [protected, virtual]

Prevent destruction.


Member Function Documentation

virtual void android.speech.recognition.SpeechSynthesizer.setListener ( AudioSourceListenerProxy &  listener,
ReturnCode::Type returnCode 
) [pure virtual]

Sets the synthesizer listener.

Parameters:
listener synthesizer listener
returnCode returns SUCCESS unless a fatal error occurs

virtual void android.speech.recognition.SpeechSynthesizer.setCodec ( Codec::Type  synthesizeCodec,
ReturnCode::Type returnCode 
) [pure virtual]

Sets the synthesized codec. This must be called before start() is invoked.

Parameters:
synthesizeCodec the codec in which the samples will be synthesized
returnCode the return code

virtual void android.speech.recognition.SpeechSynthesizer.queue ( SpeechSynthesizer::SpeechType  speechType,
const char *  value,
const char *  language,
ReturnCode::Type returnCode 
) [pure virtual]

Add speech to systhesize on the queue. All the items in the queue will be systhesized once "start()" is called.

Parameters:
speechType the speech input type
value the content of the speechType
language language contained in the "value" argument. Note that this only applies to TEXT type. If the type is TEXT is this parameter is set to NULL, the default value of "en-US" will be used. For other types, simply set this to NULL.
returnCode ILLEGAL_ARGUMENT if value is null

virtual AudioStreamProxy android.speech.recognition.AudioSource.createAudio ( ReturnCode::Type returnCode  )  [pure virtual, inherited]

Returns an object that contains audio samples.

Parameters:
returnCode the return code
Returns:
a pointer to an Audio object.
See also:
AudioStream

virtual void android.speech.recognition.AudioSource.start ( ReturnCode::Type returnCode  )  [pure virtual, inherited]

Starts collecting audio samples.

Parameters:
returnCode the return code

virtual void android.speech.recognition.AudioSource.stop ( ReturnCode::Type returnCode  )  [pure virtual, inherited]

Stops collecting audio samples.

Parameters:
returnCode the return code


Generated on Thu May 1 17:16:51 2008 for UAPI by  doxygen 1.5.3