diff options
Diffstat (limited to 'docs/structam_1_1am__Crossfader__s.html')
-rw-r--r-- | docs/structam_1_1am__Crossfader__s.html | 265 |
1 files changed, 265 insertions, 0 deletions
diff --git a/docs/structam_1_1am__Crossfader__s.html b/docs/structam_1_1am__Crossfader__s.html new file mode 100644 index 0000000..22bfccf --- /dev/null +++ b/docs/structam_1_1am__Crossfader__s.html @@ -0,0 +1,265 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>AudioManager: am::am_Crossfader_s Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">AudioManager +  <span id="projectnumber">7.5.11</span> + </div> + <div id="projectbrief">Native Application Runtime Environment</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('structam_1_1am__Crossfader__s.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-attribs">Public Attributes</a> | +<a href="structam_1_1am__Crossfader__s-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::am_Crossfader_s Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This struct describes the attribiutes of a crossfader. + <a href="structam_1_1am__Crossfader__s.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a6c6af4e70cb360d43095372dc33b1626"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aaf4c3deaf1b53aeac50503c75b4e5a31">am_crossfaderID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a6c6af4e70cb360d43095372dc33b1626">crossfaderID</a></td></tr> +<tr class="memdesc:a6c6af4e70cb360d43095372dc33b1626"><td class="mdescLeft"> </td><td class="mdescRight">This is the ID of the crossfader, it is unique in the system. <a href="#a6c6af4e70cb360d43095372dc33b1626">More...</a><br/></td></tr> +<tr class="separator:a6c6af4e70cb360d43095372dc33b1626"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac71302f7392da8e162f5eedf2714366e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#ac71302f7392da8e162f5eedf2714366e">name</a></td></tr> +<tr class="memdesc:ac71302f7392da8e162f5eedf2714366e"><td class="mdescLeft"> </td><td class="mdescRight">The name of the crossfader. <a href="#ac71302f7392da8e162f5eedf2714366e">More...</a><br/></td></tr> +<tr class="separator:ac71302f7392da8e162f5eedf2714366e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a39d1f6023a79a1df29a941e0dee77ad9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a39d1f6023a79a1df29a941e0dee77ad9">sinkID_A</a></td></tr> +<tr class="memdesc:a39d1f6023a79a1df29a941e0dee77ad9"><td class="mdescLeft"> </td><td class="mdescRight">The sinkID of the SinkA. <a href="#a39d1f6023a79a1df29a941e0dee77ad9">More...</a><br/></td></tr> +<tr class="separator:a39d1f6023a79a1df29a941e0dee77ad9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a045ff126607c9885bb0d027570eb5710"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a045ff126607c9885bb0d027570eb5710">sinkID_B</a></td></tr> +<tr class="memdesc:a045ff126607c9885bb0d027570eb5710"><td class="mdescLeft"> </td><td class="mdescRight">The sinkID of the SinkB. <a href="#a045ff126607c9885bb0d027570eb5710">More...</a><br/></td></tr> +<tr class="separator:a045ff126607c9885bb0d027570eb5710"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5442753fb1a60b8d56c5a79b8989ed04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a5442753fb1a60b8d56c5a79b8989ed04">sourceID</a></td></tr> +<tr class="memdesc:a5442753fb1a60b8d56c5a79b8989ed04"><td class="mdescLeft"> </td><td class="mdescRight">The sourceID of the crossfader source. <a href="#a5442753fb1a60b8d56c5a79b8989ed04">More...</a><br/></td></tr> +<tr class="separator:a5442753fb1a60b8d56c5a79b8989ed04"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a31c5e07b53d3c7a8f943fef11395affa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#afc05253c20a9333f02f7a4b3f7762269">am_HotSink_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a31c5e07b53d3c7a8f943fef11395affa">hotSink</a></td></tr> +<tr class="memdesc:a31c5e07b53d3c7a8f943fef11395affa"><td class="mdescLeft"> </td><td class="mdescRight">This enum can have 3 states: <a href="#a31c5e07b53d3c7a8f943fef11395affa">More...</a><br/></td></tr> +<tr class="separator:a31c5e07b53d3c7a8f943fef11395affa"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This struct describes the attribiutes of a crossfader. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00560">560</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> +</div><h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a6c6af4e70cb360d43095372dc33b1626"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aaf4c3deaf1b53aeac50503c75b4e5a31">am_crossfaderID_t</a> am::am_Crossfader_s::crossfaderID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the ID of the crossfader, it is unique in the system. </p> +<p>There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManager daemon), or it is a fixed (the project has to ensure the uniqueness of the ID). </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00570">570</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a31c5e07b53d3c7a8f943fef11395affa"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#afc05253c20a9333f02f7a4b3f7762269">am_HotSink_e</a> am::am_Crossfader_s::hotSink</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This enum can have 3 states: </p> +<p>HS_SINKA sinkA is the current hot one, sinkB is not audible HS_SINKB sinkB is the current hot one, sinkB is not audible HS_INTERMEDIATE the fader is stuck in between a cross-fading action. This could be due to an abort or an error. Before using the crossfader, it must be set to either HS_SINKA or HS_SINKB. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00599">599</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ac71302f7392da8e162f5eedf2714366e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string am::am_Crossfader_s::name</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The name of the crossfader. </p> +<p>Must be unique in the whole system. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00574">574</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a39d1f6023a79a1df29a941e0dee77ad9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> am::am_Crossfader_s::sinkID_A</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The sinkID of the SinkA. </p> +<p>Sinks shall be registered before registering the crossfader. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00579">579</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a045ff126607c9885bb0d027570eb5710"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> am::am_Crossfader_s::sinkID_B</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The sinkID of the SinkB. </p> +<p>Sinks shall be registered before registering the crossfader. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00584">584</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a5442753fb1a60b8d56c5a79b8989ed04"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> am::am_Crossfader_s::sourceID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The sourceID of the crossfader source. </p> +<p>The source shall be registered before the crossfader. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00589">589</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/<a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespaceam.html">am</a></li><li class="navelem"><a class="el" href="structam_1_1am__Crossfader__s.html">am_Crossfader_s</a></li> + <li class="footer">Generated on Fri Sep 30 2016 14:27:22 for AudioManager by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |