| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
| <title>Doxygen-Generated Content</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <style type="text/css"> |
| <!-- |
| .navigation { |
| display: none; |
| } |
| --> |
| </style> |
| </head> |
| <body> |
| <!-- Generated by Doxygen 1.5.6 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div class="tabs"> |
| <ul> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="functions.html"><span>Data Fields</span></a></li> |
| </ul> |
| </div> |
| <div class="navpath"><a class="el" href="namespaceandroid.html">android</a>::<a class="el" href="classandroid_1_1_audio_stream_in.html">AudioStreamIn</a> |
| </div> |
| </div> |
| <div class="contents"> |
| <h1>android::AudioStreamIn Class Reference</h1><!-- doxytag: class="android::AudioStreamIn" --><a class="el" href="classandroid_1_1_audio_stream_in.html" title="AudioStreamIn is the abstraction interface for the audio input hardware.">AudioStreamIn</a> is the abstraction interface for the audio input hardware. |
| <a href="#_details">More...</a> |
| <p> |
| <code>#include <<a class="el" href="_audio_hardware_interface_8h-source.html">AudioHardwareInterface.h</a>></code> |
| <p> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><td></td></tr> |
| <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#72067577568bbdd0163c1369fe80f101">~AudioStreamIn</a> ()=0</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#a458f9cde3edde82f256af7eaa7b2ddf">bufferSize</a> () const =0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">return the input buffer size allowed by audio driver <a href="#a458f9cde3edde82f256af7eaa7b2ddf"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#04f84006dd5f2e0a5e512897a039f851">channelCount</a> () const =0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">return the number of audio input channels <a href="#04f84006dd5f2e0a5e512897a039f851"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#4ade98c5243b9ed5f3a71a8f36e74b36">format</a> () const =0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">return audio format in 8bit or 16bit PCM format - eg. <a href="#4ade98c5243b9ed5f3a71a8f36e74b36"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#43d2c6b97806c005f0717a7bb6f7595c">frameSize</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">return the frame size (number of bytes per sample). <a href="#43d2c6b97806c005f0717a7bb6f7595c"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#339822afb3f2f2ac1b4c775d31d12440">setGain</a> (float gain)=0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">set the input gain for the audio driver. <a href="#339822afb3f2f2ac1b4c775d31d12440"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#7c313cbfbb47dafd90f3225bcd26e592">read</a> (void *buffer, ssize_t bytes)=0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">read audio buffer in from audio driver <a href="#7c313cbfbb47dafd90f3225bcd26e592"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#18c3760208bfb99498715a0d4977f675">dump</a> (int fd, const Vector< String16 > &args)=0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">dump the state of the audio input device <a href="#18c3760208bfb99498715a0d4977f675"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1_audio_stream_in.html#93fab46e8afdbaedd4d20cc6ee2b7c41">standby</a> ()=0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Put the audio hardware input into standby mode. <a href="#93fab46e8afdbaedd4d20cc6ee2b7c41"></a><br></td></tr> |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| <a class="el" href="classandroid_1_1_audio_stream_in.html" title="AudioStreamIn is the abstraction interface for the audio input hardware.">AudioStreamIn</a> is the abstraction interface for the audio input hardware. |
| <p> |
| It defines the various properties of the audio hardware input driver. |
| <p>Definition at line <a class="el" href="_audio_hardware_interface_8h-source.html#l00093">93</a> of file <a class="el" href="_audio_hardware_interface_8h-source.html">AudioHardwareInterface.h</a>.</p> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" name="72067577568bbdd0163c1369fe80f101"></a><!-- doxytag: member="android::AudioStreamIn::~AudioStreamIn" ref="72067577568bbdd0163c1369fe80f101" args="()=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual android::AudioStreamIn::~AudioStreamIn </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| |
| </div> |
| </div><p> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="a458f9cde3edde82f256af7eaa7b2ddf"></a><!-- doxytag: member="android::AudioStreamIn::bufferSize" ref="a458f9cde3edde82f256af7eaa7b2ddf" args="() const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual size_t android::AudioStreamIn::bufferSize </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td> const<code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| return the input buffer size allowed by audio driver |
| <p> |
| |
| </div> |
| </div><p> |
| <a class="anchor" name="04f84006dd5f2e0a5e512897a039f851"></a><!-- doxytag: member="android::AudioStreamIn::channelCount" ref="04f84006dd5f2e0a5e512897a039f851" args="() const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int android::AudioStreamIn::channelCount </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td> const<code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| return the number of audio input channels |
| <p> |
| |
| </div> |
| </div><p> |
| <a class="anchor" name="4ade98c5243b9ed5f3a71a8f36e74b36"></a><!-- doxytag: member="android::AudioStreamIn::format" ref="4ade98c5243b9ed5f3a71a8f36e74b36" args="() const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int android::AudioStreamIn::format </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td> const<code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| return audio format in 8bit or 16bit PCM format - eg. |
| <p> |
| AudioSystem:PCM_16_BIT |
| </div> |
| </div><p> |
| <a class="anchor" name="43d2c6b97806c005f0717a7bb6f7595c"></a><!-- doxytag: member="android::AudioStreamIn::frameSize" ref="43d2c6b97806c005f0717a7bb6f7595c" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t android::AudioStreamIn::frameSize </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| return the frame size (number of bytes per sample). |
| <p> |
| |
| <p>Definition at line <a class="el" href="_audio_hardware_interface_8h-source.html#l00112">112</a> of file <a class="el" href="_audio_hardware_interface_8h-source.html">AudioHardwareInterface.h</a>.</p> |
| |
| </div> |
| </div><p> |
| <a class="anchor" name="339822afb3f2f2ac1b4c775d31d12440"></a><!-- doxytag: member="android::AudioStreamIn::setGain" ref="339822afb3f2f2ac1b4c775d31d12440" args="(float gain)=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual status_t android::AudioStreamIn::setGain </td> |
| <td>(</td> |
| <td class="paramtype">float </td> |
| <td class="paramname"> <em>gain</em> </td> |
| <td> ) </td> |
| <td><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| set the input gain for the audio driver. |
| <p> |
| This method is for for future use |
| </div> |
| </div><p> |
| <a class="anchor" name="7c313cbfbb47dafd90f3225bcd26e592"></a><!-- doxytag: member="android::AudioStreamIn::read" ref="7c313cbfbb47dafd90f3225bcd26e592" args="(void *buffer, ssize_t bytes)=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual ssize_t android::AudioStreamIn::read </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"> <em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">ssize_t </td> |
| <td class="paramname"> <em>bytes</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| read audio buffer in from audio driver |
| <p> |
| |
| </div> |
| </div><p> |
| <a class="anchor" name="18c3760208bfb99498715a0d4977f675"></a><!-- doxytag: member="android::AudioStreamIn::dump" ref="18c3760208bfb99498715a0d4977f675" args="(int fd, const Vector< String16 > &args)=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual status_t android::AudioStreamIn::dump </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"> <em>fd</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const Vector< String16 > & </td> |
| <td class="paramname"> <em>args</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| dump the state of the audio input device |
| <p> |
| |
| </div> |
| </div><p> |
| <a class="anchor" name="93fab46e8afdbaedd4d20cc6ee2b7c41"></a><!-- doxytag: member="android::AudioStreamIn::standby" ref="93fab46e8afdbaedd4d20cc6ee2b7c41" args="()=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual status_t android::AudioStreamIn::standby </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| Put the audio hardware input into standby mode. |
| <p> |
| Returns status based on include/utils/Errors.h |
| </div> |
| </div><p> |
| <hr>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="_audio_hardware_interface_8h-source.html">AudioHardwareInterface.h</a></ul> |
| </div> |
| </body> |
| </html> |