android::AudioStreamIn Class Reference

AudioStreamIn is the abstraction interface for the audio input hardware. More...

#include <AudioHardwareInterface.h>


Public Member Functions

virtual ~AudioStreamIn ()=0
virtual size_t bufferSize () const =0
 return the input buffer size allowed by audio driver
virtual int channelCount () const =0
 return the number of audio input channels
virtual int format () const =0
 return audio format in 8bit or 16bit PCM format - eg.
uint32_t frameSize () const
 return the frame size (number of bytes per sample).
virtual status_t setGain (float gain)=0
 set the input gain for the audio driver.
virtual ssize_t read (void *buffer, ssize_t bytes)=0
 read audio buffer in from audio driver
virtual status_t dump (int fd, const Vector< String16 > &args)=0
 dump the state of the audio input device
virtual status_t standby ()=0
 Put the audio hardware input into standby mode.

Detailed Description

AudioStreamIn is the abstraction interface for the audio input hardware.

It defines the various properties of the audio hardware input driver.

Definition at line 93 of file AudioHardwareInterface.h.


Constructor & Destructor Documentation

virtual android::AudioStreamIn::~AudioStreamIn (  )  [pure virtual]


Member Function Documentation

virtual size_t android::AudioStreamIn::bufferSize (  )  const [pure virtual]

return the input buffer size allowed by audio driver

virtual int android::AudioStreamIn::channelCount (  )  const [pure virtual]

return the number of audio input channels

virtual int android::AudioStreamIn::format (  )  const [pure virtual]

return audio format in 8bit or 16bit PCM format - eg.

AudioSystem:PCM_16_BIT

uint32_t android::AudioStreamIn::frameSize (  )  const [inline]

return the frame size (number of bytes per sample).

Definition at line 112 of file AudioHardwareInterface.h.

virtual status_t android::AudioStreamIn::setGain ( float  gain  )  [pure virtual]

set the input gain for the audio driver.

This method is for for future use

virtual ssize_t android::AudioStreamIn::read ( void *  buffer,
ssize_t  bytes 
) [pure virtual]

read audio buffer in from audio driver

virtual status_t android::AudioStreamIn::dump ( int  fd,
const Vector< String16 > &  args 
) [pure virtual]

dump the state of the audio input device

virtual status_t android::AudioStreamIn::standby (  )  [pure virtual]

Put the audio hardware input into standby mode.

Returns status based on include/utils/Errors.h


The documentation for this class was generated from the following file: