<!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 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 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="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>audio<br/>
<small>
[<a class="el" href="group__playerc__proxies.html">Device proxies</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>The audio proxy provides access to drivers supporting the audio_interface.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Audio device data. <a href="structplayerc__audio__t.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT <a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga08655ac264018435b38d2d17c70cd3fd">playerc_audio_create</a> (<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *client, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an audio proxy. <a href="#ga08655ac264018435b38d2d17c70cd3fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gae1d4ea7902153df22f08c319e4ef3d51">playerc_audio_destroy</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an audio proxy. <a href="#gae1d4ea7902153df22f08c319e4ef3d51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga4b8b8fa5f3c95907e76a0564456c60f8">playerc_audio_subscribe</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, int access)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the audio device. <a href="#ga4b8b8fa5f3c95907e76a0564456c60f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga973cb8a5a8bcf0e853b65a8f37090edc">playerc_audio_unsubscribe</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-subscribe from the audio device. <a href="#ga973cb8a5a8bcf0e853b65a8f37090edc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa85f9396e0a1366fca7e2ae1e15a8689"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_wav_play_cmd" ref="gaa85f9396e0a1366fca7e2ae1e15a8689" args="(playerc_audio_t *device, uint32_t data_count, uint8_t data[], uint32_t format)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gaa85f9396e0a1366fca7e2ae1e15a8689">playerc_audio_wav_play_cmd</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, uint32_t data_count, uint8_t data[], uint32_t format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command to play an audio block. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa817729aa6a61352922696ac633ab63f"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_wav_stream_rec_cmd" ref="gaa817729aa6a61352922696ac633ab63f" args="(playerc_audio_t *device, uint8_t state)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gaa817729aa6a61352922696ac633ab63f">playerc_audio_wav_stream_rec_cmd</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, uint8_t state)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command to set recording state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac24d060330dde0f073b6785388df4710"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_sample_play_cmd" ref="gac24d060330dde0f073b6785388df4710" args="(playerc_audio_t *device, int index)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gac24d060330dde0f073b6785388df4710">playerc_audio_sample_play_cmd</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command to play prestored sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad75d21337136c5944b006c7f88d8f5d5"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_seq_play_cmd" ref="gad75d21337136c5944b006c7f88d8f5d5" args="(playerc_audio_t *device, player_audio_seq_t *tones)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gad75d21337136c5944b006c7f88d8f5d5">playerc_audio_seq_play_cmd</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, <a class="el" href="structplayer__audio__seq.html">player_audio_seq_t</a> *tones)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command to play sequence of tones. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga24273fac625b05c2d78e6226433692b3"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_mixer_multchannels_cmd" ref="ga24273fac625b05c2d78e6226433692b3" args="(playerc_audio_t *device, player_audio_mixer_channel_list_t *levels)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga24273fac625b05c2d78e6226433692b3">playerc_audio_mixer_multchannels_cmd</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, <a class="el" href="structplayer__audio__mixer__channel__list.html">player_audio_mixer_channel_list_t</a> *levels)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command to set mixer levels for multiple channels. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab850a5449a9f2a1046c18492309a56e4"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_mixer_channel_cmd" ref="gab850a5449a9f2a1046c18492309a56e4" args="(playerc_audio_t *device, uint32_t index, float amplitude, uint8_t active)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gab850a5449a9f2a1046c18492309a56e4">playerc_audio_mixer_channel_cmd</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, uint32_t index, float amplitude, uint8_t active)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command to set mixer levels for a single channel. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga49c73811f9b4e9d83a5b83ea84e7f87c"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_wav_rec" ref="ga49c73811f9b4e9d83a5b83ea84e7f87c" args="(playerc_audio_t *device)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga49c73811f9b4e9d83a5b83ea84e7f87c">playerc_audio_wav_rec</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request to record a single audio block Value is returned into wav_data, block length is determined by device. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae7949c4c436f02a5a10b2c541455c37f"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_sample_load" ref="gae7949c4c436f02a5a10b2c541455c37f" args="(playerc_audio_t *device, int index, uint32_t data_count, uint8_t data[], uint32_t format)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gae7949c4c436f02a5a10b2c541455c37f">playerc_audio_sample_load</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, int index, uint32_t data_count, uint8_t data[], uint32_t format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request to load an audio sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70adc59a59eed0e6ff104ccb17a9bf19"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_sample_retrieve" ref="ga70adc59a59eed0e6ff104ccb17a9bf19" args="(playerc_audio_t *device, int index)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga70adc59a59eed0e6ff104ccb17a9bf19">playerc_audio_sample_retrieve</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request to retrieve an audio sample Data is stored in wav_data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf47adae53f5824a45c0056ff581e3c09"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_sample_rec" ref="gaf47adae53f5824a45c0056ff581e3c09" args="(playerc_audio_t *device, int index, uint32_t length)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gaf47adae53f5824a45c0056ff581e3c09">playerc_audio_sample_rec</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device, int index, uint32_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request to record new sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac1b8c2a536a80c8cd37f8c94b241ac34"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_get_mixer_levels" ref="gac1b8c2a536a80c8cd37f8c94b241ac34" args="(playerc_audio_t *device)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#gac1b8c2a536a80c8cd37f8c94b241ac34">playerc_audio_get_mixer_levels</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request mixer channel data result is stored in mixer_data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7aab4bc1ebe48bed4eac178382fc1165"></a><!-- doxytag: member="playerc_proxy_audio::playerc_audio_get_mixer_details" ref="ga7aab4bc1ebe48bed4eac178382fc1165" args="(playerc_audio_t *device)" -->
PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__audio.html#ga7aab4bc1ebe48bed4eac178382fc1165">playerc_audio_get_mixer_details</a> (<a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> *device)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request mixer channel details list result is stored in channel_details_list. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The audio proxy provides access to drivers supporting the audio_interface. </p>
<p>See the Player User Manual for a complete description of the drivers that support this interface. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga08655ac264018435b38d2d17c70cd3fd"></a><!-- doxytag: member="playerc.h::playerc_audio_create" ref="ga08655ac264018435b38d2d17c70cd3fd" args="(playerc_client_t *client, int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT <a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a>* playerc_audio_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> * </td>
<td class="paramname"> <em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an audio proxy. </p>
</div>
</div>
<a class="anchor" id="gae1d4ea7902153df22f08c319e4ef3d51"></a><!-- doxytag: member="playerc.h::playerc_audio_destroy" ref="gae1d4ea7902153df22f08c319e4ef3d51" args="(playerc_audio_t *device)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT void playerc_audio_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> * </td>
<td class="paramname"> <em>device</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy an audio proxy. </p>
</div>
</div>
<a class="anchor" id="ga4b8b8fa5f3c95907e76a0564456c60f8"></a><!-- doxytag: member="playerc.h::playerc_audio_subscribe" ref="ga4b8b8fa5f3c95907e76a0564456c60f8" args="(playerc_audio_t *device, int access)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_audio_subscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> * </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>access</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subscribe to the audio device. </p>
</div>
</div>
<a class="anchor" id="ga973cb8a5a8bcf0e853b65a8f37090edc"></a><!-- doxytag: member="playerc.h::playerc_audio_unsubscribe" ref="ga973cb8a5a8bcf0e853b65a8f37090edc" args="(playerc_audio_t *device)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PLAYERC_EXPORT int playerc_audio_unsubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structplayerc__audio__t.html">playerc_audio_t</a> * </td>
<td class="paramname"> <em>device</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Un-subscribe from the audio device. </p>
</div>
</div>
</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
770
