android.speech.recognition.Microphone Class Reference

Inheritance diagram for android.speech.recognition.Microphone:

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

Collaboration graph
[legend]

List of all members.


Detailed Description

Records audio.

Public Member Functions

virtual void setCodec (Codec::Type recordingCodec, ReturnCode::Type &returnCode)=0
virtual void setListener (AudioSourceListenerProxy &listener, 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

Static Public Member Functions

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

Protected Member Functions

 Microphone ()
virtual ~Microphone ()

Static Protected Attributes

static Microphoneinstance

Friends

class MicrophoneProxy

Constructor & Destructor Documentation

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

Prevent construction.

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

Prevent destruction.


Member Function Documentation

static UAPI_EXPORT MicrophoneProxy android.speech.recognition.Microphone.getInstance ( ReturnCode::Type returnCode  )  [static]

Returns the microphone.

Parameters:
returnCode the return code.
Returns:
the microphone

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

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

Parameters:
recordingCodec the codec in which the samples will be recorded
returnCode the return code

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

Set the microphone listener.

Parameters:
listener the microphone listener
returnCode the return code

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


Member Data Documentation

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

singleton instance


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