diff options
Diffstat (limited to 'docs/structam_1_1am__SinkType__s.html')
| -rw-r--r-- | docs/structam_1_1am__SinkType__s.html | 262 |
1 files changed, 262 insertions, 0 deletions
diff --git a/docs/structam_1_1am__SinkType__s.html b/docs/structam_1_1am__SinkType__s.html new file mode 100644 index 0000000..381e76c --- /dev/null +++ b/docs/structam_1_1am__SinkType__s.html @@ -0,0 +1,262 @@ +<!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_SinkType_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__SinkType__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__SinkType__s-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::am_SinkType_s Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>this type holds all information of sinks relevant to the HMI + <a href="structam_1_1am__SinkType__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:a6455a141536f5b7b676c5a5caabf872d"><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__SinkType__s.html#a6455a141536f5b7b676c5a5caabf872d">sinkID</a></td></tr> +<tr class="memdesc:a6455a141536f5b7b676c5a5caabf872d"><td class="mdescLeft"> </td><td class="mdescRight">This is the ID of the sink, it is unique in the system. <a href="#a6455a141536f5b7b676c5a5caabf872d">More...</a><br/></td></tr> +<tr class="separator:a6455a141536f5b7b676c5a5caabf872d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa23a69a5e0069804f3181f5d3141774a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__SinkType__s.html#aa23a69a5e0069804f3181f5d3141774a">name</a></td></tr> +<tr class="memdesc:aa23a69a5e0069804f3181f5d3141774a"><td class="mdescLeft"> </td><td class="mdescRight">The name of the sink. <a href="#aa23a69a5e0069804f3181f5d3141774a">More...</a><br/></td></tr> +<tr class="separator:aa23a69a5e0069804f3181f5d3141774a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a281aeb5a017aecb15957f0222f17927c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structam_1_1am__Availability__s.html">am_Availability_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__SinkType__s.html#a281aeb5a017aecb15957f0222f17927c">availability</a></td></tr> +<tr class="memdesc:a281aeb5a017aecb15957f0222f17927c"><td class="mdescLeft"> </td><td class="mdescRight">This attribute reflects the availability of the sink. <a href="#a281aeb5a017aecb15957f0222f17927c">More...</a><br/></td></tr> +<tr class="separator:a281aeb5a017aecb15957f0222f17927c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a95273c6978fbef5be4a59b1534212495"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__SinkType__s.html#a95273c6978fbef5be4a59b1534212495">volume</a></td></tr> +<tr class="memdesc:a95273c6978fbef5be4a59b1534212495"><td class="mdescLeft"> </td><td class="mdescRight">This is the representation of the Volume for the commandInterface. <a href="#a95273c6978fbef5be4a59b1534212495">More...</a><br/></td></tr> +<tr class="separator:a95273c6978fbef5be4a59b1534212495"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a55f9813d5f9d3cfab81dc740d15ee53e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#af9d68f1f1b0553906df4c90e9a860ffa">am_MuteState_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__SinkType__s.html#a55f9813d5f9d3cfab81dc740d15ee53e">muteState</a></td></tr> +<tr class="separator:a55f9813d5f9d3cfab81dc740d15ee53e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a573880f00ed279120ded986e6b832235"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a2aa2a1e9d9c5a5cc4cb48b5b9c9a222f">am_sinkClass_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__SinkType__s.html#a573880f00ed279120ded986e6b832235">sinkClassID</a></td></tr> +<tr class="memdesc:a573880f00ed279120ded986e6b832235"><td class="mdescLeft"> </td><td class="mdescRight">The sinkClassID references to a sinkClass. <a href="#a573880f00ed279120ded986e6b832235">More...</a><br/></td></tr> +<tr class="separator:a573880f00ed279120ded986e6b832235"><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 type holds all information of sinks relevant to the HMI </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00945">945</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="a281aeb5a017aecb15957f0222f17927c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structam_1_1am__Availability__s.html">am_Availability_s</a> am::am_SinkType_s::availability</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This attribute reflects the availability of the sink. </p> +<p>There are several reasons why a sink could be not available for the moment: for example the shutdown of a sink because of overtemperature or over- & undervoltage. The availability consists of two pieces of information:</p> +<p>Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00971">971</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a55f9813d5f9d3cfab81dc740d15ee53e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#af9d68f1f1b0553906df4c90e9a860ffa">am_MuteState_e</a> am::am_SinkType_s::muteState</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00978">978</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="aa23a69a5e0069804f3181f5d3141774a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string am::am_SinkType_s::name</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The name of the sink. </p> +<p>Must be unique in the whole system. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00959">959</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a573880f00ed279120ded986e6b832235"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a2aa2a1e9d9c5a5cc4cb48b5b9c9a222f">am_sinkClass_t</a> am::am_SinkType_s::sinkClassID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The sinkClassID references to a sinkClass. </p> +<p>With the help of classification, rules can be setup to define the system behaviour. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00983">983</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a6455a141536f5b7b676c5a5caabf872d"></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_SinkType_s::sinkID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the ID of the sink, 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 AudioManagerDaemon), 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#l00955">955</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a95273c6978fbef5be4a59b1534212495"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> am::am_SinkType_s::volume</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the representation of the Volume for the commandInterface. </p> +<p>It is used by the HMI to set the volume of a sink, the AudioManagerController has to transform this into real source and sink volumes. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00977">977</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__SinkType__s.html">am_SinkType_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> |