<!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="headertitle">
<h1>audio<br/>
<small>
[<a class="el" href="group__interfaces.html">Interface specifications</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>Interface to an audio system.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gac28aca069f953b7097b2539ba60853ea">PLAYER_AUDIO_DATA_WAV_REC</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#gac28aca069f953b7097b2539ba60853ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga59bdb45c4c6b8529b8f215a4e50435fb">PLAYER_AUDIO_DATA_SEQ</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: seq_data, recorded sequence of notes. <a href="#ga59bdb45c4c6b8529b8f215a4e50435fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaab39032b117a836bee5e56de96b611c7">PLAYER_AUDIO_DATA_MIXER_CHANNEL</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: mixer_channel_data, audio channel levels. <a href="#gaab39032b117a836bee5e56de96b611c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaa543cd9e3e11dbef31d35e8982113c49">PLAYER_AUDIO_DATA_STATE</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: state_data, driver state data (eg playing, stopped, ...). <a href="#gaa543cd9e3e11dbef31d35e8982113c49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga948ee3baf77ce31d0485b2b95678e1d9">PLAYER_AUDIO_CMD_WAV_PLAY</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: wav_play_cmd, play a raw data block, in structure player_audio_wav_t. <a href="#ga948ee3baf77ce31d0485b2b95678e1d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaacb5a88ca1add361786b79574bfd23ba">PLAYER_AUDIO_CMD_WAV_STREAM_REC</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: wav_stream_rec_cmd, start/stop recording, data will be returned as data blocks. <a href="#gaacb5a88ca1add361786b79574bfd23ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gae756641898babf9d2f51dd0e2c2385e7">PLAYER_AUDIO_CMD_SAMPLE_PLAY</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: sample_play_cmd, play a pre stored audio sample. <a href="#gae756641898babf9d2f51dd0e2c2385e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga6a340cbbca661b850062db7bd09d3751">PLAYER_AUDIO_CMD_SEQ_PLAY</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: seq_play_cmd, play a sequence of tones. <a href="#ga6a340cbbca661b850062db7bd09d3751"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga9363821c49c00f79cb5fdd7193d4fa97">PLAYER_AUDIO_CMD_MIXER_CHANNEL</a> 5</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: mixer_channel_cmd, audio channel levels. <a href="#ga9363821c49c00f79cb5fdd7193d4fa97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gadf759ecb0ec8b27a4b603a5be652b3f7">PLAYER_AUDIO_REQ_WAV_REC</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: wav_rec_req, record a fixed size data block, in structure player_audio_wav_t. <a href="#gadf759ecb0ec8b27a4b603a5be652b3f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaf612caf32ca4991d88801017cd3da345">PLAYER_AUDIO_REQ_SAMPLE_LOAD</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: sample_load_req, store a sample. <a href="#gaf612caf32ca4991d88801017cd3da345"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga5fc1cd23e50cfe20995a1309d2c5b682">PLAYER_AUDIO_REQ_SAMPLE_RETRIEVE</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: sample_retrieve_req, retrieve a stored sample. <a href="#ga5fc1cd23e50cfe20995a1309d2c5b682"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga60edda4334dc61d9091d7bb421245154">PLAYER_AUDIO_REQ_SAMPLE_REC</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: sample_rec_req, record a new sample. <a href="#ga60edda4334dc61d9091d7bb421245154"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaaad4011851411a403087171c701e4658">PLAYER_AUDIO_REQ_MIXER_CHANNEL_LIST</a> 5</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: mixer_channel_list_req, request the list of channels. <a href="#gaaad4011851411a403087171c701e4658"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gab7c4f3543fe2c58e0f082e1d359ce281">PLAYER_AUDIO_REQ_MIXER_CHANNEL_LEVEL</a> 6</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: mixer_channel_level_req, request the channel levels. <a href="#gab7c4f3543fe2c58e0f082e1d359ce281"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3c9a6ef2acd22c014689b3b4a4d141fd"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_STATE_STOPPED" ref="ga3c9a6ef2acd22c014689b3b4a4d141fd" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga3c9a6ef2acd22c014689b3b4a4d141fd">PLAYER_AUDIO_STATE_STOPPED</a> 0x00</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classDriver.html" title="Base class for all drivers.">Driver</a> states. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga12359b3cbb5b0969a87a15a06f9541af">PLAYER_AUDIO_STATE_PLAYING</a> 0x01</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga12359b3cbb5b0969a87a15a06f9541af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga537922760622a87a67c4feb109536bb6">PLAYER_AUDIO_STATE_RECORDING</a> 0x02</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga537922760622a87a67c4feb109536bb6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga2804e1aedad4bba5ae890a132930f287">PLAYER_AUDIO_DESCRIPTION_BITS</a> 0xFF</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Audio formats. <a href="#ga2804e1aedad4bba5ae890a132930f287"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gafec8325697a46dd1ad9e245a590b375a">PLAYER_AUDIO_BITS</a> 0x03</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#gafec8325697a46dd1ad9e245a590b375a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga289a3a3117a9db6d88c3a5f119785c14"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_8BIT" ref="ga289a3a3117a9db6d88c3a5f119785c14" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga289a3a3117a9db6d88c3a5f119785c14">PLAYER_AUDIO_8BIT</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">8 bit <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabad27debd05268d1087286375dc5e2bd"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_16BIT" ref="gabad27debd05268d1087286375dc5e2bd" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gabad27debd05268d1087286375dc5e2bd">PLAYER_AUDIO_16BIT</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">16 bit <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf6d8e29765b6848dbe0938aa8156d03f"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_24BIT" ref="gaf6d8e29765b6848dbe0938aa8156d03f" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaf6d8e29765b6848dbe0938aa8156d03f">PLAYER_AUDIO_24BIT</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">24 bit <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6687a289181739af960bda6087c865c0"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_MONO" ref="ga6687a289181739af960bda6087c865c0" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga6687a289181739af960bda6087c865c0">PLAYER_AUDIO_MONO</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mono. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad2672bf4619f80cd2db9df391dbbdc0a"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_STEREO" ref="gad2672bf4619f80cd2db9df391dbbdc0a" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gad2672bf4619f80cd2db9df391dbbdc0a">PLAYER_AUDIO_STEREO</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stereo. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3062562924b08de6e48302002f7715cc"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_FREQ" ref="ga3062562924b08de6e48302002f7715cc" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga3062562924b08de6e48302002f7715cc">PLAYER_AUDIO_FREQ</a> 0x18</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga17a771ae04a3cf9280b45e3dbb0b2dd6">PLAYER_AUDIO_FREQ_44k</a> 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga17a771ae04a3cf9280b45e3dbb0b2dd6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaffe99ddff5443a8f83634ee905d515bf">PLAYER_AUDIO_FREQ_11k</a> 8</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#gaffe99ddff5443a8f83634ee905d515bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaec425601a9173d6784e6a22100ae23a8">PLAYER_AUDIO_FREQ_22k</a> 16</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#gaec425601a9173d6784e6a22100ae23a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gae6bdf1a6ee289655671226c33d10c07f">PLAYER_AUDIO_FREQ_48k</a> 24</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#gae6bdf1a6ee289655671226c33d10c07f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5f77b087fc4c60ef84f986a86240952b"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_FORMAT_BITS" ref="ga5f77b087fc4c60ef84f986a86240952b" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga5f77b087fc4c60ef84f986a86240952b">PLAYER_AUDIO_FORMAT_BITS</a> 0xFF00</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">AUDIO format. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga9d0175a1ea90769a243a756ec2877cbf">PLAYER_AUDIO_FORMAT_NULL</a> 0x0000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga9d0175a1ea90769a243a756ec2877cbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga6522fb1f814c4104bc78ad3546b31b45">PLAYER_AUDIO_FORMAT_RAW</a> 0x0100</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga6522fb1f814c4104bc78ad3546b31b45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaab180425b6872aa6af5b8ad11a49bf8f">PLAYER_AUDIO_FORMAT_MP3</a> 0x0200</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#gaab180425b6872aa6af5b8ad11a49bf8f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga77d16e81d8862c86ea7264c8b34fcd97">PLAYER_AUDIO_FORMAT_OGG</a> 0x0300</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga77d16e81d8862c86ea7264c8b34fcd97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga6ebc9605bef2f41ee240ec9df10a080b">PLAYER_AUDIO_FORMAT_FLAC</a> 0x0400</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga6ebc9605bef2f41ee240ec9df10a080b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga726a47a943b62566cbe3f57ed392cdc2">PLAYER_AUDIO_FORMAT_AAC</a> 0x0500</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: wav_rec_data, recorded data block. <a href="#ga726a47a943b62566cbe3f57ed392cdc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf1137df3e5c11ab81bedff5e0bc2b479"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_MIXER_CHANNEL_TYPE_INPUT" ref="gaf1137df3e5c11ab81bedff5e0bc2b479" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaf1137df3e5c11ab81bedff5e0bc2b479">PLAYER_AUDIO_MIXER_CHANNEL_TYPE_INPUT</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input audio channel. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0c2b3fa4f4f10350c898b012910ded82"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_MIXER_CHANNEL_TYPE_OUTPUT" ref="ga0c2b3fa4f4f10350c898b012910ded82" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga0c2b3fa4f4f10350c898b012910ded82">PLAYER_AUDIO_MIXER_CHANNEL_TYPE_OUTPUT</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output audio channel. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6b40db26233a00c6e4118cdc6094d0a1"></a><!-- doxytag: member="interface_audio::PLAYER_AUDIO_MIXER_CHANNEL_TYPE_SPECIAL" ref="ga6b40db26233a00c6e4118cdc6094d0a1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga6b40db26233a00c6e4118cdc6094d0a1">PLAYER_AUDIO_MIXER_CHANNEL_TYPE_SPECIAL</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special audio channel. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__audio__wav.html">player_audio_wav</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data: Raw audio data. <a href="#ga87594b52262b9606dc2d417806d20890"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__seq__item.html">player_audio_seq_item</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga0917decaceb8074d0a3754bd4bbb2b26">player_audio_seq_item_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player audio sequence item. <a href="#ga0917decaceb8074d0a3754bd4bbb2b26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__audio__seq.html">player_audio_seq</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga9871015c2c1065373556f21a36675bc5">player_audio_seq_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player audio sequence. <a href="#ga9871015c2c1065373556f21a36675bc5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__mixer__channel.html">player_audio_mixer_channel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga788b51f5c3df660c6cdfb4e9806b7804">player_audio_mixer_channel_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player mixer channel. <a href="#ga788b51f5c3df660c6cdfb4e9806b7804"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__mixer__channel__list.html">player_audio_mixer_channel_list</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gaa777f841a9576b8b454477b5c328e0a7">player_audio_mixer_channel_list_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player mixer channels. <a href="#gaa777f841a9576b8b454477b5c328e0a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__mixer__channel__detail.html">player_audio_mixer_channel_detail</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gab3b950d728a00875a7e0916f067c53df">player_audio_mixer_channel_detail_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player mixer channel detail. <a href="#gab3b950d728a00875a7e0916f067c53df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__mixer__channel__list__detail.html">player_audio_mixer_channel_list_detail</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga28725cf9c5328097e5f2a40d4892820b">player_audio_mixer_channel_list_detail_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player mixer channels. <a href="#ga28725cf9c5328097e5f2a40d4892820b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__audio__sample.html">player_audio_sample</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga3b5a2c5f2627a4fb59a08f17c253271c">player_audio_sample_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player audio sample. <a href="#ga3b5a2c5f2627a4fb59a08f17c253271c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__sample__item.html">player_audio_sample_item</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga51dad85cc113717f8915e0109c11b98d">player_audio_sample_item_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player audio sample selection. <a href="#ga51dad85cc113717f8915e0109c11b98d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__audio__sample__rec__req.html">player_audio_sample_rec_req</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#gac399f654d6b457806792b745669ea306">player_audio_sample_rec_req_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player audio sample record request. <a href="#gac399f654d6b457806792b745669ea306"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__audio__state.html">player_audio_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__audio.html#ga20f3e412501933b40db5fabda70fe52b">player_audio_state_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Player audio driver state. <a href="#ga20f3e412501933b40db5fabda70fe52b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface to an audio system. </p>
<p>The <code>audio</code> interface is used to control sound hardware.</p>
<p>The inteface provides four sets of functionality:</p>
<ul>
<li>raw wav playback and recording</li>
<li>sample playback (and loading)</li>
<li>sequencer support (tone playback and recording)</li>
<li>mixer interface (control of sound levels) </li>
</ul>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gafec8325697a46dd1ad9e245a590b375a"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_BITS" ref="gafec8325697a46dd1ad9e245a590b375a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_BITS 0x03</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga9363821c49c00f79cb5fdd7193d4fa97"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_CMD_MIXER_CHANNEL" ref="ga9363821c49c00f79cb5fdd7193d4fa97" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_CMD_MIXER_CHANNEL 5</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command subtype: mixer_channel_cmd, audio channel levels. </p>
<p>data is a <a class="el" href="group__interface__audio.html#gaa777f841a9576b8b454477b5c328e0a7">player_audio_mixer_channel_list_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gae756641898babf9d2f51dd0e2c2385e7"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_CMD_SAMPLE_PLAY" ref="gae756641898babf9d2f51dd0e2c2385e7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_CMD_SAMPLE_PLAY 3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command subtype: sample_play_cmd, play a pre stored audio sample. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga51dad85cc113717f8915e0109c11b98d">player_audio_sample_item_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="ga6a340cbbca661b850062db7bd09d3751"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_CMD_SEQ_PLAY" ref="ga6a340cbbca661b850062db7bd09d3751" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_CMD_SEQ_PLAY 4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command subtype: seq_play_cmd, play a sequence of tones. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga9871015c2c1065373556f21a36675bc5">player_audio_seq_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga948ee3baf77ce31d0485b2b95678e1d9"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_CMD_WAV_PLAY" ref="ga948ee3baf77ce31d0485b2b95678e1d9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_CMD_WAV_PLAY 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command subtype: wav_play_cmd, play a raw data block, in structure player_audio_wav_t. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gaacb5a88ca1add361786b79574bfd23ba"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_CMD_WAV_STREAM_REC" ref="gaacb5a88ca1add361786b79574bfd23ba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_CMD_WAV_STREAM_REC 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command subtype: wav_stream_rec_cmd, start/stop recording, data will be returned as data blocks. </p>
<p>data is a <a class="el" href="group__utility__structs.html#gacd840679cb887c729ded4948957f8b0c">player_bool_t</a> </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gaab39032b117a836bee5e56de96b611c7"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_DATA_MIXER_CHANNEL" ref="gaab39032b117a836bee5e56de96b611c7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_DATA_MIXER_CHANNEL 3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: mixer_channel_data, audio channel levels. </p>
<p>data is a <a class="el" href="group__interface__audio.html#gaa777f841a9576b8b454477b5c328e0a7">player_audio_mixer_channel_list_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga59bdb45c4c6b8529b8f215a4e50435fb"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_DATA_SEQ" ref="ga59bdb45c4c6b8529b8f215a4e50435fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_DATA_SEQ 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: seq_data, recorded sequence of notes. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga9871015c2c1065373556f21a36675bc5">player_audio_seq_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gaa543cd9e3e11dbef31d35e8982113c49"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_DATA_STATE" ref="gaa543cd9e3e11dbef31d35e8982113c49" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_DATA_STATE 4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: state_data, driver state data (eg playing, stopped, ...). </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga20f3e412501933b40db5fabda70fe52b">player_audio_state_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gac28aca069f953b7097b2539ba60853ea"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_DATA_WAV_REC" ref="gac28aca069f953b7097b2539ba60853ea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_DATA_WAV_REC 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga2804e1aedad4bba5ae890a132930f287"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_DESCRIPTION_BITS" ref="ga2804e1aedad4bba5ae890a132930f287" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_DESCRIPTION_BITS 0xFF</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Audio formats. </p>
<p>Raw Audio bit flags </p>
</div>
</div>
<a class="anchor" id="ga726a47a943b62566cbe3f57ed392cdc2"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FORMAT_AAC" ref="ga726a47a943b62566cbe3f57ed392cdc2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FORMAT_AAC 0x0500</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga6ebc9605bef2f41ee240ec9df10a080b"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FORMAT_FLAC" ref="ga6ebc9605bef2f41ee240ec9df10a080b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FORMAT_FLAC 0x0400</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gaab180425b6872aa6af5b8ad11a49bf8f"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FORMAT_MP3" ref="gaab180425b6872aa6af5b8ad11a49bf8f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FORMAT_MP3 0x0200</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga9d0175a1ea90769a243a756ec2877cbf"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FORMAT_NULL" ref="ga9d0175a1ea90769a243a756ec2877cbf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FORMAT_NULL 0x0000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga77d16e81d8862c86ea7264c8b34fcd97"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FORMAT_OGG" ref="ga77d16e81d8862c86ea7264c8b34fcd97" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FORMAT_OGG 0x0300</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga6522fb1f814c4104bc78ad3546b31b45"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FORMAT_RAW" ref="ga6522fb1f814c4104bc78ad3546b31b45" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FORMAT_RAW 0x0100</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gaffe99ddff5443a8f83634ee905d515bf"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FREQ_11k" ref="gaffe99ddff5443a8f83634ee905d515bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FREQ_11k 8</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gaec425601a9173d6784e6a22100ae23a8"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FREQ_22k" ref="gaec425601a9173d6784e6a22100ae23a8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FREQ_22k 16</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga17a771ae04a3cf9280b45e3dbb0b2dd6"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FREQ_44k" ref="ga17a771ae04a3cf9280b45e3dbb0b2dd6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FREQ_44k 0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gae6bdf1a6ee289655671226c33d10c07f"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_FREQ_48k" ref="gae6bdf1a6ee289655671226c33d10c07f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_FREQ_48k 24</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="gab7c4f3543fe2c58e0f082e1d359ce281"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_REQ_MIXER_CHANNEL_LEVEL" ref="gab7c4f3543fe2c58e0f082e1d359ce281" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_REQ_MIXER_CHANNEL_LEVEL 6</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request subtype: mixer_channel_level_req, request the channel levels. </p>
<p>data is a <a class="el" href="group__interface__audio.html#gaa777f841a9576b8b454477b5c328e0a7">player_audio_mixer_channel_list_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gaaad4011851411a403087171c701e4658"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_REQ_MIXER_CHANNEL_LIST" ref="gaaad4011851411a403087171c701e4658" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_REQ_MIXER_CHANNEL_LIST 5</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request subtype: mixer_channel_list_req, request the list of channels. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga28725cf9c5328097e5f2a40d4892820b">player_audio_mixer_channel_list_detail_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gaf612caf32ca4991d88801017cd3da345"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_REQ_SAMPLE_LOAD" ref="gaf612caf32ca4991d88801017cd3da345" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_REQ_SAMPLE_LOAD 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request subtype: sample_load_req, store a sample. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga3b5a2c5f2627a4fb59a08f17c253271c">player_audio_sample_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="ga60edda4334dc61d9091d7bb421245154"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_REQ_SAMPLE_REC" ref="ga60edda4334dc61d9091d7bb421245154" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_REQ_SAMPLE_REC 4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request subtype: sample_rec_req, record a new sample. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga51dad85cc113717f8915e0109c11b98d">player_audio_sample_item_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="ga5fc1cd23e50cfe20995a1309d2c5b682"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_REQ_SAMPLE_RETRIEVE" ref="ga5fc1cd23e50cfe20995a1309d2c5b682" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_REQ_SAMPLE_RETRIEVE 3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request subtype: sample_retrieve_req, retrieve a stored sample. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga3b5a2c5f2627a4fb59a08f17c253271c">player_audio_sample_t</a> structure </p>
<p>Referenced by <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gadf759ecb0ec8b27a4b603a5be652b3f7"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_REQ_WAV_REC" ref="gadf759ecb0ec8b27a4b603a5be652b3f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_REQ_WAV_REC 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request subtype: wav_rec_req, record a fixed size data block, in structure player_audio_wav_t. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga12359b3cbb5b0969a87a15a06f9541af"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_STATE_PLAYING" ref="ga12359b3cbb5b0969a87a15a06f9541af" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_STATE_PLAYING 0x01</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<a class="anchor" id="ga537922760622a87a67c4feb109536bb6"></a><!-- doxytag: member="player_interfaces.h::PLAYER_AUDIO_STATE_RECORDING" ref="ga537922760622a87a67c4feb109536bb6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_AUDIO_STATE_RECORDING 0x02</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data subtype: wav_rec_data, recorded data block. </p>
<p>data is a <a class="el" href="group__interface__audio.html#ga87594b52262b9606dc2d417806d20890">player_audio_wav_t</a> structure </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gab3b950d728a00875a7e0916f067c53df"></a><!-- doxytag: member="player_interfaces.h::player_audio_mixer_channel_detail_t" ref="gab3b950d728a00875a7e0916f067c53df" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__mixer__channel__detail.html">player_audio_mixer_channel_detail</a> <a class="el" href="structplayer__audio__mixer__channel__detail.html">player_audio_mixer_channel_detail_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player mixer channel detail. </p>
<p>Describes the state of a mixer channel </p>
</div>
</div>
<a class="anchor" id="ga28725cf9c5328097e5f2a40d4892820b"></a><!-- doxytag: member="player_interfaces.h::player_audio_mixer_channel_list_detail_t" ref="ga28725cf9c5328097e5f2a40d4892820b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__mixer__channel__list__detail.html">player_audio_mixer_channel_list_detail</a> <a class="el" href="structplayer__audio__mixer__channel__list__detail.html">player_audio_mixer_channel_list_detail_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player mixer channels. </p>
<p>Describes the state of a set of mixer channels details </p>
</div>
</div>
<a class="anchor" id="gaa777f841a9576b8b454477b5c328e0a7"></a><!-- doxytag: member="player_interfaces.h::player_audio_mixer_channel_list_t" ref="gaa777f841a9576b8b454477b5c328e0a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__mixer__channel__list.html">player_audio_mixer_channel_list</a> <a class="el" href="structplayer__audio__mixer__channel__list.html">player_audio_mixer_channel_list_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player mixer channels. </p>
<p>Describes the state of a set of mixer channels </p>
</div>
</div>
<a class="anchor" id="ga788b51f5c3df660c6cdfb4e9806b7804"></a><!-- doxytag: member="player_interfaces.h::player_audio_mixer_channel_t" ref="ga788b51f5c3df660c6cdfb4e9806b7804" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__mixer__channel.html">player_audio_mixer_channel</a> <a class="el" href="structplayer__audio__mixer__channel.html">player_audio_mixer_channel_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player mixer channel. </p>
<p>Describes the state of a mixer channel </p>
</div>
</div>
<a class="anchor" id="ga51dad85cc113717f8915e0109c11b98d"></a><!-- doxytag: member="player_interfaces.h::player_audio_sample_item_t" ref="ga51dad85cc113717f8915e0109c11b98d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__sample__item.html">player_audio_sample_item</a> <a class="el" href="structplayer__audio__sample__item.html">player_audio_sample_item_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player audio sample selection. </p>
<p>Describes a pre-stored audio sample index </p>
</div>
</div>
<a class="anchor" id="gac399f654d6b457806792b745669ea306"></a><!-- doxytag: member="player_interfaces.h::player_audio_sample_rec_req_t" ref="gac399f654d6b457806792b745669ea306" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__sample__rec__req.html">player_audio_sample_rec_req</a> <a class="el" href="structplayer__audio__sample__rec__req.html">player_audio_sample_rec_req_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player audio sample record request. </p>
<p>Request to record a sample and store it locally. </p>
</div>
</div>
<a class="anchor" id="ga3b5a2c5f2627a4fb59a08f17c253271c"></a><!-- doxytag: member="player_interfaces.h::player_audio_sample_t" ref="ga3b5a2c5f2627a4fb59a08f17c253271c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__sample.html">player_audio_sample</a> <a class="el" href="structplayer__audio__sample.html">player_audio_sample_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player audio sample. </p>
<p>Describes an audio sample, if the index is set to -1 the next available slot is used and the index is returned in the response. </p>
</div>
</div>
<a class="anchor" id="ga0917decaceb8074d0a3754bd4bbb2b26"></a><!-- doxytag: member="player_interfaces.h::player_audio_seq_item_t" ref="ga0917decaceb8074d0a3754bd4bbb2b26" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__seq__item.html">player_audio_seq_item</a> <a class="el" href="structplayer__audio__seq__item.html">player_audio_seq_item_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player audio sequence item. </p>
<p>This describes a single sequence element, the link field is used for chord type playback when a series of notes are to be played together. Set link to true for all but the last notes to be player together. </p>
</div>
</div>
<a class="anchor" id="ga9871015c2c1065373556f21a36675bc5"></a><!-- doxytag: member="player_interfaces.h::player_audio_seq_t" ref="ga9871015c2c1065373556f21a36675bc5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__seq.html">player_audio_seq</a> <a class="el" href="structplayer__audio__seq.html">player_audio_seq_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player audio sequence. </p>
<p>Describes a sequence of notes to be played or which have been recieved </p>
</div>
</div>
<a class="anchor" id="ga20f3e412501933b40db5fabda70fe52b"></a><!-- doxytag: member="player_interfaces.h::player_audio_state_t" ref="ga20f3e412501933b40db5fabda70fe52b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__state.html">player_audio_state</a> <a class="el" href="structplayer__audio__state.html">player_audio_state_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Player audio driver state. </p>
<p>Describes the current state of the audio driver. Usually only sent when state changes. </p>
</div>
</div>
<a class="anchor" id="ga87594b52262b9606dc2d417806d20890"></a><!-- doxytag: member="player_interfaces.h::player_audio_wav_t" ref="ga87594b52262b9606dc2d417806d20890" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__audio__wav.html">player_audio_wav</a> <a class="el" href="structplayer__audio__wav.html">player_audio_wav_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data: Raw audio data. </p>
<p>This data is used in the PLAYER_AUDIO_CMD_WAV_PLAY, and returned as PLAYER_AUDIO_DATA_WAV_REC when stream recording is enabled </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
>
681
