android.speech.recognition.DeviceSpeaker Class Reference

Collaboration diagram for android.speech.recognition.DeviceSpeaker:

Collaboration graph
[legend]

List of all members.


Detailed Description

DeviceSpeaker used to playback audio samples.

Public Member Functions

virtual void start (AudioStreamProxy &audio, ReturnCode::Type &returnCode)=0
virtual void stop (ReturnCode::Type &returnCode)=0
virtual void setCodec (Codec::Type playbackCodec, ReturnCode::Type &returnCode)=0
virtual void setListener (DeviceSpeakerListenerProxy &listener, ReturnCode::Type &returnCode)=0

Static Public Member Functions

static UAPI_EXPORT
DeviceSpeakerProxy 
getInstance (ReturnCode::Type &returnCode)

Protected Member Functions

 DeviceSpeaker ()
virtual ~DeviceSpeaker ()

Static Protected Attributes

static DeviceSpeakerinstance

Friends

class DeviceSpeakerProxy

Constructor & Destructor Documentation

android.speech.recognition.DeviceSpeaker.DeviceSpeaker (  )  [protected]

Prevent construction.

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

Prevent destruction.


Member Function Documentation

static UAPI_EXPORT DeviceSpeakerProxy android.speech.recognition.DeviceSpeaker.getInstance ( ReturnCode::Type returnCode  )  [static]

Returns the device speaker instance.

Parameters:
returnCode the return code.
Returns:
an instance of a DeviceSpeaker class.

virtual void android.speech.recognition.DeviceSpeaker.start ( AudioStreamProxy &  audio,
ReturnCode::Type returnCode 
) [pure virtual]

Start audio playback.

Parameters:
audio the audio to play
returnCode INVALID_STATE if the component is already stated. ILLEGAL_ARGUMENT if the audio object is invalid. AUDIO_ALREADY_IN_USE if the audio is already in use by another component. END_OF_STREAM if the end of the audio stream has been reached.

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

Stops audio playback.

Returns:
SUCCESS if stop in progress
Parameters:
returnCode the return code

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

Sets the playback codec. This must be called before start is called.

Parameters:
playbackCodec the codec to use for the playback operation.
returnCode the return code.

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

Sets the microphone listener.

Parameters:
listener the device speaker listener.
returnCode the return code.


Member Data Documentation

DeviceSpeaker* android.speech.recognition.DeviceSpeaker.instance [static, protected]

Singleton instance.


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