Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 82

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>AudioSample Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="AudioSample" -->
<p><a href="classAudioSample-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b48425f446986abf37bc5eacf7611c3"></a><!-- doxytag: member="AudioSample::AudioSample" ref="a4b48425f446986abf37bc5eacf7611c3" args="(const player_audio_wav_t *source)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>AudioSample</b> (const <a class="el" href="structplayer__audio__wav.html">player_audio_wav_t</a> *source)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa720313b3a4f110fe3f562595aa7aeda"></a><!-- doxytag: member="AudioSample::AudioSample" ref="aa720313b3a4f110fe3f562595aa7aeda" args="(const uint8_t *source, uint32_t length, uint16_t channels, uint32_t sr, uint16_t bps)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>AudioSample</b> (const uint8_t *source, uint32_t length, uint16_t channels, uint32_t sr, uint16_t bps)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81be1bebe9dea309bb4d9af5cb716952"></a><!-- doxytag: member="AudioSample::SetDataPosition" ref="a81be1bebe9dea309bb4d9af5cb716952" args="(uint32_t newPosition)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetDataPosition</b> (uint32_t newPosition)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6e257cbeb48323874126e1181879a52"></a><!-- doxytag: member="AudioSample::GetDataPosition" ref="af6e257cbeb48323874126e1181879a52" args="(void) const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetDataPosition</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57ea4b7810886ee5cd33f2876ec6d1b7"></a><!-- doxytag: member="AudioSample::GetDataLength" ref="a57ea4b7810886ee5cd33f2876ec6d1b7" args="(void) const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetDataLength</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af238154f5c6c524ec907e3a0e87967a9"></a><!-- doxytag: member="AudioSample::GetData" ref="af238154f5c6c524ec907e3a0e87967a9" args="(int frameCount, uint8_t *buffer)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetData</b> (int frameCount, uint8_t *buffer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f3dca273aaabd5b0232bc5ecd27480e"></a><!-- doxytag: member="AudioSample::ClearSample" ref="a7f3dca273aaabd5b0232bc5ecd27480e" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ClearSample</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abccea585e06ca6d8e6e44c2221b32218"></a><!-- doxytag: member="AudioSample::FillSilence" ref="abccea585e06ca6d8e6e44c2221b32218" args="(uint32_t time)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>FillSilence</b> (uint32_t time)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ac87b7e22e028488ef88cdde3bf53f1"></a><!-- doxytag: member="AudioSample::ToPlayer" ref="a2ac87b7e22e028488ef88cdde3bf53f1" args="(player_audio_wav_t *dest)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>ToPlayer</b> (<a class="el" href="structplayer__audio__wav.html">player_audio_wav_t</a> *dest)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00e842e5e88b746840007aac842309ed"></a><!-- doxytag: member="AudioSample::FromPlayer" ref="a00e842e5e88b746840007aac842309ed" args="(const player_audio_wav_t *source)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>FromPlayer</b> (const <a class="el" href="structplayer__audio__wav.html">player_audio_wav_t</a> *source)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3400a09c9cab697317f3068746aaf93f"></a><!-- doxytag: member="AudioSample::LoadFile" ref="a3400a09c9cab697317f3068746aaf93f" args="(const char *fileName)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>LoadFile</b> (const char *fileName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53dd7c8c534981c1284d0467a96ecdf4"></a><!-- doxytag: member="AudioSample::CloseFile" ref="a53dd7c8c534981c1284d0467a96ecdf4" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>CloseFile</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae32d10a20bb14fbe8352d888d9a2050c"></a><!-- doxytag: member="AudioSample::GetFilePath" ref="ae32d10a20bb14fbe8352d888d9a2050c" args="(void) const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetFilePath</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5a44c7866bb046735937d19c3be640d"></a><!-- doxytag: member="AudioSample::GetType" ref="aa5a44c7866bb046735937d19c3be640d" args="(void) const " -->
SampleType&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetType</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dc45b3e988bc9265bf010d62636c147"></a><!-- doxytag: member="AudioSample::SetType" ref="a9dc45b3e988bc9265bf010d62636c147" args="(SampleType val)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetType</b> (SampleType val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8609298c5f0679097780c71948479114"></a><!-- doxytag: member="AudioSample::GetNumChannels" ref="a8609298c5f0679097780c71948479114" args="(void) const " -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetNumChannels</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa34f4513092aa527cc345b5d4be2430c"></a><!-- doxytag: member="AudioSample::SetNumChannels" ref="aa34f4513092aa527cc345b5d4be2430c" args="(uint16_t val)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetNumChannels</b> (uint16_t val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08620c503040b1f750801b0d77344be1"></a><!-- doxytag: member="AudioSample::GetSampleRate" ref="a08620c503040b1f750801b0d77344be1" args="(void) const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetSampleRate</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6af8311a20399d2e43fd1e2e7c2f6723"></a><!-- doxytag: member="AudioSample::SetSampleRate" ref="a6af8311a20399d2e43fd1e2e7c2f6723" args="(uint32_t val)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetSampleRate</b> (uint32_t val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac28988f1eee96c8d5a3bca6bfd85c99"></a><!-- doxytag: member="AudioSample::GetByteRate" ref="aac28988f1eee96c8d5a3bca6bfd85c99" args="(void) const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetByteRate</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dce6e2e79bab6c2b4fa2b637c69f8fc"></a><!-- doxytag: member="AudioSample::GetBlockAlign" ref="a2dce6e2e79bab6c2b4fa2b637c69f8fc" args="(void) const " -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBlockAlign</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb60d3fc9b0525a49a1db9326a871927"></a><!-- doxytag: member="AudioSample::SetBlockAlign" ref="acb60d3fc9b0525a49a1db9326a871927" args="(uint16_t val)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetBlockAlign</b> (uint16_t val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab19cc3d50b12b46e10430ba535c4f251"></a><!-- doxytag: member="AudioSample::GetBitsPerSample" ref="ab19cc3d50b12b46e10430ba535c4f251" args="(void) const " -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBitsPerSample</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41ddacf963e45d6920d987fbadc0ac28"></a><!-- doxytag: member="AudioSample::SetBitsPerSample" ref="a41ddacf963e45d6920d987fbadc0ac28" args="(uint16_t val)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetBitsPerSample</b> (uint16_t val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ba9a473db0c40dfd077e7e6958d1836"></a><!-- doxytag: member="AudioSample::GetNumFrames" ref="a4ba9a473db0c40dfd077e7e6958d1836" args="(void) const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetNumFrames</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae06dee6ab0efd7e628627c7c33209591"></a><!-- doxytag: member="AudioSample::SameFormat" ref="ae06dee6ab0efd7e628627c7c33209591" args="(const AudioSample *rhs)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>SameFormat</b> (const <a class="el" href="classAudioSample.html">AudioSample</a> *rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b427b5f6dcc1623f43fd5a6abef07cb"></a><!-- doxytag: member="AudioSample::CopyFormat" ref="a4b427b5f6dcc1623f43fd5a6abef07cb" args="(const AudioSample *rhs)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>CopyFormat</b> (const <a class="el" href="classAudioSample.html">AudioSample</a> *rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace40b870cdeba3c5f51fde80e2ac7b20"></a><!-- doxytag: member="AudioSample::PrintWaveInfo" ref="ace40b870cdeba3c5f51fde80e2ac7b20" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrintWaveInfo</b> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47c659b82f94402d8dc6ac21b26010fb"></a><!-- doxytag: member="AudioSample::type" ref="a47c659b82f94402d8dc6ac21b26010fb" args="" -->
SampleType&nbsp;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a787bda1e524c0b32b9dbaa64a71062e9"></a><!-- doxytag: member="AudioSample::numChannels" ref="a787bda1e524c0b32b9dbaa64a71062e9" args="" -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>numChannels</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad660f727f66f21eee9207b2229a8fb46"></a><!-- doxytag: member="AudioSample::sampleRate" ref="ad660f727f66f21eee9207b2229a8fb46" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>sampleRate</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19e676ba351fc094251ec459b12c705d"></a><!-- doxytag: member="AudioSample::byteRate" ref="a19e676ba351fc094251ec459b12c705d" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>byteRate</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9941d96b645c9011680e53ac650be3a"></a><!-- doxytag: member="AudioSample::blockAlign" ref="aa9941d96b645c9011680e53ac650be3a" args="" -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>blockAlign</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e11900a831b6f638f4d4bef72b2c391"></a><!-- doxytag: member="AudioSample::bitsPerSample" ref="a8e11900a831b6f638f4d4bef72b2c391" args="" -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>bitsPerSample</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90598110fee0779beadff5c371f30c94"></a><!-- doxytag: member="AudioSample::numFrames" ref="a90598110fee0779beadff5c371f30c94" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>numFrames</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0ce4834520fc2180a29ab93216cb425"></a><!-- doxytag: member="AudioSample::position" ref="ae0ce4834520fc2180a29ab93216cb425" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>position</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d3e3d51d80432de1d0ea8b519c67e05"></a><!-- doxytag: member="AudioSample::waveFile" ref="a3d3e3d51d80432de1d0ea8b519c67e05" args="" -->
FILE *&nbsp;</td><td class="memItemRight" valign="bottom"><b>waveFile</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b8785c6aa61c60aff684bcaf3182a47"></a><!-- doxytag: member="AudioSample::filePath" ref="a4b8785c6aa61c60aff684bcaf3182a47" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>filePath</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f2be8ec33c747aad1dae03516da301b"></a><!-- doxytag: member="AudioSample::headerSize" ref="a1f2be8ec33c747aad1dae03516da301b" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>headerSize</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc1bbf316c89e32a1ed8241c692fe62b"></a><!-- doxytag: member="AudioSample::dataLength" ref="acc1bbf316c89e32a1ed8241c692fe62b" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>dataLength</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15ec3941060b35c92cdf0b541d6b7ceb"></a><!-- doxytag: member="AudioSample::data" ref="a15ec3941060b35c92cdf0b541d6b7ceb" args="" -->
uint8_t *&nbsp;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="audio__sample_8h_source.html">audio_sample.h</a></li>
<li>audio_sample.cc</li>
</ul>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional