Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_audio_stream_engine.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: CAudioStreamEngine Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CAudioStreamEngine Class Reference</h1><!-- doxytag: class="CAudioStreamEngine" -->
<p><a href="class_c_audio_stream_engine-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a4da8b5eecd664fea1aea40a95adc03fa">~CAudioStreamEngine</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#af71152acf3592c67fec809e00c7246ff">Play</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a7b74589268bba7a746628c9712d7567f">Record</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a6c3450de52c2fe602ed8dceaed90d6b3">Stop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a2cd495294ea2a4cadfd9816b60acd587">LoadAudioFileL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#af2c0f47a5bca2d3d960ea1433696b376">SaveAudioFileL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a939d7fb72ca466a389e413d680faafcd">SetEncodingL</a> (TBool aAmr)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a642c7bef4022a84b0235c87046e261fe">NewL</a> (<a class="el" href="class_c_audio_stream_app_ui.html">CAudioStreamAppUi</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_audio_stream_engine.html#a91672b67faf4b872f536dfa30a0cb087">NewLC</a> (<a class="el" href="class_c_audio_stream_app_ui.html">CAudioStreamAppUi</a> *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> application engine class. </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8h_source.html#l00029">29</a> of file <a class="el" href="_audio_stream_engine_8h_source.html">AudioStreamEngine.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4da8b5eecd664fea1aea40a95adc03fa"></a><!-- doxytag: member="CAudioStreamEngine::~CAudioStreamEngine" ref="a4da8b5eecd664fea1aea40a95adc03fa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CAudioStreamEngine::~CAudioStreamEngine </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a4da8b5eecd664fea1aea40a95adc03fa">~CAudioStreamEngine()</a></p>
<p>discussion Destroy the object and release all memory objects </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00106">106</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a642c7bef4022a84b0235c87046e261fe"></a><!-- doxytag: member="CAudioStreamEngine::NewL" ref="a642c7bef4022a84b0235c87046e261fe" args="(CAudioStreamAppUi *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> * CAudioStreamEngine::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_audio_stream_app_ui.html">CAudioStreamAppUi</a> * </td>
<td class="paramname"> <em>aAppUi</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a642c7bef4022a84b0235c87046e261fe">NewL()</a></p>
<p>discussion Create new <a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> object return a pointer to the created instance of <a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00037">37</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a91672b67faf4b872f536dfa30a0cb087"></a><!-- doxytag: member="CAudioStreamEngine::NewLC" ref="a91672b67faf4b872f536dfa30a0cb087" args="(CAudioStreamAppUi *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> * CAudioStreamEngine::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_audio_stream_app_ui.html">CAudioStreamAppUi</a> * </td>
<td class="paramname"> <em>aAppUi</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a91672b67faf4b872f536dfa30a0cb087">NewLC()</a></p>
<p>discussion Create new <a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> object return a pointer to the created instance of <a class="el" href="class_c_audio_stream_engine.html">CAudioStreamEngine</a> which has also been pushed to cleanup stack </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00044">44</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af71152acf3592c67fec809e00c7246ff"></a><!-- doxytag: member="CAudioStreamEngine::Play" ref="af71152acf3592c67fec809e00c7246ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAudioStreamEngine::Play </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#af71152acf3592c67fec809e00c7246ff">Play()</a></p>
<p>discussion Plays the audio data sample </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00143">143</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7b74589268bba7a746628c9712d7567f"></a><!-- doxytag: member="CAudioStreamEngine::Record" ref="a7b74589268bba7a746628c9712d7567f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAudioStreamEngine::Record </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a7b74589268bba7a746628c9712d7567f">Record()</a></p>
<p>discussion Records an audio data sample </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00171">171</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6c3450de52c2fe602ed8dceaed90d6b3"></a><!-- doxytag: member="CAudioStreamEngine::Stop" ref="a6c3450de52c2fe602ed8dceaed90d6b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAudioStreamEngine::Stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a6c3450de52c2fe602ed8dceaed90d6b3">Stop()</a></p>
<p>discussion Stops the playing/recording of the audio data </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00191">191</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2cd495294ea2a4cadfd9816b60acd587"></a><!-- doxytag: member="CAudioStreamEngine::LoadAudioFileL" ref="a2cd495294ea2a4cadfd9816b60acd587" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAudioStreamEngine::LoadAudioFileL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a2cd495294ea2a4cadfd9816b60acd587">LoadAudioFileL()</a></p>
<p>discussion Loads an audio data from a file </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00215">215</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af2c0f47a5bca2d3d960ea1433696b376"></a><!-- doxytag: member="CAudioStreamEngine::SaveAudioFileL" ref="af2c0f47a5bca2d3d960ea1433696b376" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAudioStreamEngine::SaveAudioFileL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#af2c0f47a5bca2d3d960ea1433696b376">SaveAudioFileL()</a></p>
<p>discussion Saves the audio data into a file </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00265">265</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a939d7fb72ca466a389e413d680faafcd"></a><!-- doxytag: member="CAudioStreamEngine::SetEncodingL" ref="a939d7fb72ca466a389e413d680faafcd" args="(TBool aAmr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAudioStreamEngine::SetEncodingL </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aAmr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_audio_stream_engine.html#a939d7fb72ca466a389e413d680faafcd">SetEncodingL()</a></p>
<p>discussion Sets the audio encoding to be used param aAmr If ETrue, AMR-NB encoding will be used, if EFalse, the platform's default encoding will be used </p>
<p>Definition at line <a class="el" href="_audio_stream_engine_8cpp_source.html#l00323">323</a> of file <a class="el" href="_audio_stream_engine_8cpp_source.html">AudioStreamEngine.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>