diff options
Diffstat (limited to 'docs/classam_1_1IAmCommandReceive.html')
| -rw-r--r-- | docs/classam_1_1IAmCommandReceive.html | 1251 |
1 files changed, 1251 insertions, 0 deletions
diff --git a/docs/classam_1_1IAmCommandReceive.html b/docs/classam_1_1IAmCommandReceive.html new file mode 100644 index 0000000..9e9fbbc --- /dev/null +++ b/docs/classam_1_1IAmCommandReceive.html @@ -0,0 +1,1251 @@ +<!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::IAmCommandReceive Class 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('classam_1_1IAmCommandReceive.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-methods">Public Member Functions</a> | +<a href="classam_1_1IAmCommandReceive-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::IAmCommandReceive Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>The interface towards the Controlling Instance (e.g HMI). + <a href="classam_1_1IAmCommandReceive.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="IAmCommand_8h_source.html">IAmCommand.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for am::IAmCommandReceive:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classam_1_1IAmCommandReceive.png" usemap="#am::IAmCommandReceive_map" alt=""/> + <map id="am::IAmCommandReceive_map" name="am::IAmCommandReceive_map"> +<area href="classam_1_1CAmCommandReceiver.html" title="This class realizes the command Interface. " alt="am::CAmCommandReceiver" shape="rect" coords="0,56,167,80"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ae5db817b614ec1c40f1571a2509dc599"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#ae5db817b614ec1c40f1571a2509dc599">IAmCommandReceive</a> ()</td></tr> +<tr class="separator:ae5db817b614ec1c40f1571a2509dc599"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3429e3f232a55089b95364f58c4c23d2"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a3429e3f232a55089b95364f58c4c23d2">~IAmCommandReceive</a> ()</td></tr> +<tr class="separator:a3429e3f232a55089b95364f58c4c23d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae9470c23036c6257bd31e3bbd36564d2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#ae9470c23036c6257bd31e3bbd36564d2">getInterfaceVersion</a> (std::string &version) const =0</td></tr> +<tr class="memdesc:ae9470c23036c6257bd31e3bbd36564d2"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the version of the interface. <a href="#ae9470c23036c6257bd31e3bbd36564d2">More...</a><br/></td></tr> +<tr class="separator:ae9470c23036c6257bd31e3bbd36564d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a32ea97524439c9ea79b6383aae35c773"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a32ea97524439c9ea79b6383aae35c773">connect</a> (const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, <a class="el" href="namespaceam.html#a33a5bb7641f58ab3a5f3b86400ad804c">am_mainConnectionID_t</a> &mainConnectionID)=0</td></tr> +<tr class="memdesc:a32ea97524439c9ea79b6383aae35c773"><td class="mdescLeft"> </td><td class="mdescRight">connects a source to sink <a href="#a32ea97524439c9ea79b6383aae35c773">More...</a><br/></td></tr> +<tr class="separator:a32ea97524439c9ea79b6383aae35c773"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afb43a65286b038159a6e4e7bf97f30ae"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#afb43a65286b038159a6e4e7bf97f30ae">disconnect</a> (const <a class="el" href="namespaceam.html#a33a5bb7641f58ab3a5f3b86400ad804c">am_mainConnectionID_t</a> mainConnectionID)=0</td></tr> +<tr class="memdesc:afb43a65286b038159a6e4e7bf97f30ae"><td class="mdescLeft"> </td><td class="mdescRight">disconnects a mainConnection <a href="#afb43a65286b038159a6e4e7bf97f30ae">More...</a><br/></td></tr> +<tr class="separator:afb43a65286b038159a6e4e7bf97f30ae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6d8dcd7277753859d655104f5ee7597e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a6d8dcd7277753859d655104f5ee7597e">setVolume</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const <a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> volume)=0</td></tr> +<tr class="memdesc:a6d8dcd7277753859d655104f5ee7597e"><td class="mdescLeft"> </td><td class="mdescRight">sets the volume for a sink <a href="#a6d8dcd7277753859d655104f5ee7597e">More...</a><br/></td></tr> +<tr class="separator:a6d8dcd7277753859d655104f5ee7597e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11fe6f5eb8f991f52725f050fec2bd59"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a11fe6f5eb8f991f52725f050fec2bd59">volumeStep</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const int16_t volumeStep)=0</td></tr> +<tr class="memdesc:a11fe6f5eb8f991f52725f050fec2bd59"><td class="mdescLeft"> </td><td class="mdescRight">This function is used to increment or decrement the current volume for a sink. <a href="#a11fe6f5eb8f991f52725f050fec2bd59">More...</a><br/></td></tr> +<tr class="separator:a11fe6f5eb8f991f52725f050fec2bd59"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8512dd96d42f3f36cd6a7e7590f5e930"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a8512dd96d42f3f36cd6a7e7590f5e930">setSinkMuteState</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const <a class="el" href="namespaceam.html#af9d68f1f1b0553906df4c90e9a860ffa">am_MuteState_e</a> muteState)=0</td></tr> +<tr class="memdesc:a8512dd96d42f3f36cd6a7e7590f5e930"><td class="mdescLeft"> </td><td class="mdescRight">sets the mute state of a sink <a href="#a8512dd96d42f3f36cd6a7e7590f5e930">More...</a><br/></td></tr> +<tr class="separator:a8512dd96d42f3f36cd6a7e7590f5e930"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ed9063ed677e215599f436c71cd5223"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a5ed9063ed677e215599f436c71cd5223">setMainSinkSoundProperty</a> (const <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> &soundProperty, const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID)=0</td></tr> +<tr class="memdesc:a5ed9063ed677e215599f436c71cd5223"><td class="mdescLeft"> </td><td class="mdescRight">This method is used to set sound properties, e.g. <a href="#a5ed9063ed677e215599f436c71cd5223">More...</a><br/></td></tr> +<tr class="separator:a5ed9063ed677e215599f436c71cd5223"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab611eb01227ba650f4a1338a4846ab6e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#ab611eb01227ba650f4a1338a4846ab6e">setMainSourceSoundProperty</a> (const <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> &soundProperty, const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID)=0</td></tr> +<tr class="memdesc:ab611eb01227ba650f4a1338a4846ab6e"><td class="mdescLeft"> </td><td class="mdescRight">This method is used to set sound properties, e.g. <a href="#ab611eb01227ba650f4a1338a4846ab6e">More...</a><br/></td></tr> +<tr class="separator:ab611eb01227ba650f4a1338a4846ab6e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a16004832350de519f2c6fb09470d713a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a16004832350de519f2c6fb09470d713a">setSystemProperty</a> (const <a class="el" href="structam_1_1am__SystemProperty__s.html">am_SystemProperty_s</a> &property)=0</td></tr> +<tr class="memdesc:a16004832350de519f2c6fb09470d713a"><td class="mdescLeft"> </td><td class="mdescRight">is used to set a specific system property. <a href="#a16004832350de519f2c6fb09470d713a">More...</a><br/></td></tr> +<tr class="separator:a16004832350de519f2c6fb09470d713a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11180cd5df8778e7049b3ca2f30c800d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a11180cd5df8778e7049b3ca2f30c800d">getListMainConnections</a> (std::vector< <a class="el" href="structam_1_1am__MainConnectionType__s.html">am_MainConnectionType_s</a> > &listConnections) const =0</td></tr> +<tr class="memdesc:a11180cd5df8778e7049b3ca2f30c800d"><td class="mdescLeft"> </td><td class="mdescRight">returns the actual list of MainConnections <a href="#a11180cd5df8778e7049b3ca2f30c800d">More...</a><br/></td></tr> +<tr class="separator:a11180cd5df8778e7049b3ca2f30c800d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad99dc95f0ea366cd556eb6f42b128fcc"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#ad99dc95f0ea366cd556eb6f42b128fcc">getListMainSinks</a> (std::vector< <a class="el" href="structam_1_1am__SinkType__s.html">am_SinkType_s</a> > &listMainSinks) const =0</td></tr> +<tr class="memdesc:ad99dc95f0ea366cd556eb6f42b128fcc"><td class="mdescLeft"> </td><td class="mdescRight">returns the actual list of Sinks <a href="#ad99dc95f0ea366cd556eb6f42b128fcc">More...</a><br/></td></tr> +<tr class="separator:ad99dc95f0ea366cd556eb6f42b128fcc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a983b6b672d958e79f2695bf17db51683"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a983b6b672d958e79f2695bf17db51683">getListMainSources</a> (std::vector< <a class="el" href="structam_1_1am__SourceType__s.html">am_SourceType_s</a> > &listMainSources) const =0</td></tr> +<tr class="memdesc:a983b6b672d958e79f2695bf17db51683"><td class="mdescLeft"> </td><td class="mdescRight">returns the actual list of Sources <a href="#a983b6b672d958e79f2695bf17db51683">More...</a><br/></td></tr> +<tr class="separator:a983b6b672d958e79f2695bf17db51683"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afdd62ebf3d709e312c95ebe36696bfc6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#afdd62ebf3d709e312c95ebe36696bfc6">getListMainSinkSoundProperties</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, std::vector< <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> > &listSoundProperties) const =0</td></tr> +<tr class="memdesc:afdd62ebf3d709e312c95ebe36696bfc6"><td class="mdescLeft"> </td><td class="mdescRight">This is used to retrieve all source sound properties related to a source. <a href="#afdd62ebf3d709e312c95ebe36696bfc6">More...</a><br/></td></tr> +<tr class="separator:afdd62ebf3d709e312c95ebe36696bfc6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9a413c102368ebe38ecad89b511d652c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a9a413c102368ebe38ecad89b511d652c">getListMainSourceSoundProperties</a> (const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, std::vector< <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> > &listSourceProperties) const =0</td></tr> +<tr class="memdesc:a9a413c102368ebe38ecad89b511d652c"><td class="mdescLeft"> </td><td class="mdescRight">This is used to retrieve all source sound properties related to a source. <a href="#a9a413c102368ebe38ecad89b511d652c">More...</a><br/></td></tr> +<tr class="separator:a9a413c102368ebe38ecad89b511d652c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3c022b7bb88fad2a1d5afde96e150abb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a3c022b7bb88fad2a1d5afde96e150abb">getListSourceClasses</a> (std::vector< <a class="el" href="structam_1_1am__SourceClass__s.html">am_SourceClass_s</a> > &listSourceClasses) const =0</td></tr> +<tr class="memdesc:a3c022b7bb88fad2a1d5afde96e150abb"><td class="mdescLeft"> </td><td class="mdescRight">This is used to retrieve SourceClass Information of all source classes. <a href="#a3c022b7bb88fad2a1d5afde96e150abb">More...</a><br/></td></tr> +<tr class="separator:a3c022b7bb88fad2a1d5afde96e150abb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4df3c83b76cc899b96e6c38ac5fdc31c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a4df3c83b76cc899b96e6c38ac5fdc31c">getListSinkClasses</a> (std::vector< <a class="el" href="structam_1_1am__SinkClass__s.html">am_SinkClass_s</a> > &listSinkClasses) const =0</td></tr> +<tr class="memdesc:a4df3c83b76cc899b96e6c38ac5fdc31c"><td class="mdescLeft"> </td><td class="mdescRight">This is used to retrieve SinkClass Information of all sink classes. <a href="#a4df3c83b76cc899b96e6c38ac5fdc31c">More...</a><br/></td></tr> +<tr class="separator:a4df3c83b76cc899b96e6c38ac5fdc31c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5281cf13e5344900363e0ae81d37d853"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a5281cf13e5344900363e0ae81d37d853">getListSystemProperties</a> (std::vector< <a class="el" href="structam_1_1am__SystemProperty__s.html">am_SystemProperty_s</a> > &listSystemProperties) const =0</td></tr> +<tr class="memdesc:a5281cf13e5344900363e0ae81d37d853"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a complete list of all systemProperties. <a href="#a5281cf13e5344900363e0ae81d37d853">More...</a><br/></td></tr> +<tr class="separator:a5281cf13e5344900363e0ae81d37d853"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae99e73a8c0ad4600c586aa26dd19ef89"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#ae99e73a8c0ad4600c586aa26dd19ef89">getTimingInformation</a> (const <a class="el" href="namespaceam.html#a33a5bb7641f58ab3a5f3b86400ad804c">am_mainConnectionID_t</a> mainConnectionID, <a class="el" href="namespaceam.html#ad94ba90e3c8f6bd7e51a15a811755167">am_timeSync_t</a> &delay) const =0</td></tr> +<tr class="memdesc:ae99e73a8c0ad4600c586aa26dd19ef89"><td class="mdescLeft"> </td><td class="mdescRight">returns the delay in ms that the audiopath for the given mainConnection has <a href="#ae99e73a8c0ad4600c586aa26dd19ef89">More...</a><br/></td></tr> +<tr class="separator:ae99e73a8c0ad4600c586aa26dd19ef89"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aea62c0d93f812a5db595d97fe5f34858"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#aea62c0d93f812a5db595d97fe5f34858">getDBusConnectionWrapper</a> (<a class="el" href="classam_1_1CAmDbusWrapper.html">CAmDbusWrapper</a> *&dbusConnectionWrapper) const =0</td></tr> +<tr class="memdesc:aea62c0d93f812a5db595d97fe5f34858"><td class="mdescLeft"> </td><td class="mdescRight">this function is used to retrieve a pointer to the dBusConnectionWrapper <a href="#aea62c0d93f812a5db595d97fe5f34858">More...</a><br/></td></tr> +<tr class="separator:aea62c0d93f812a5db595d97fe5f34858"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acf8e0ea44530723bda7340a1ceb8c5a4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#acf8e0ea44530723bda7340a1ceb8c5a4">getSocketHandler</a> (<a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> *&socketHandler) const =0</td></tr> +<tr class="memdesc:acf8e0ea44530723bda7340a1ceb8c5a4"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the pointer to the socketHandler. <a href="#acf8e0ea44530723bda7340a1ceb8c5a4">More...</a><br/></td></tr> +<tr class="separator:acf8e0ea44530723bda7340a1ceb8c5a4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a82797be749cf366575ad3b2ac39f35bd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a82797be749cf366575ad3b2ac39f35bd">confirmCommandReady</a> (const uint16_t handle, const <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> error)=0</td></tr> +<tr class="memdesc:a82797be749cf366575ad3b2ac39f35bd"><td class="mdescLeft"> </td><td class="mdescRight">asynchronous confirmation of setCommandReady. <a href="#a82797be749cf366575ad3b2ac39f35bd">More...</a><br/></td></tr> +<tr class="separator:a82797be749cf366575ad3b2ac39f35bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91abbf43e070dc01b841097c08a56226"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a91abbf43e070dc01b841097c08a56226">confirmCommandRundown</a> (const uint16_t handle, const <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> error)=0</td></tr> +<tr class="memdesc:a91abbf43e070dc01b841097c08a56226"><td class="mdescLeft"> </td><td class="mdescRight">asynchronous confirmation of setCommandRundown <a href="#a91abbf43e070dc01b841097c08a56226">More...</a><br/></td></tr> +<tr class="separator:a91abbf43e070dc01b841097c08a56226"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a233ee03fe13a4a3b889e840840dd8a93"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a233ee03fe13a4a3b889e840840dd8a93">getListMainSinkNotificationConfigurations</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, std::vector< <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> > &listMainNotificationConfigurations) const =0</td></tr> +<tr class="memdesc:a233ee03fe13a4a3b889e840840dd8a93"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of MainNotifications for a sink. <a href="#a233ee03fe13a4a3b889e840840dd8a93">More...</a><br/></td></tr> +<tr class="separator:a233ee03fe13a4a3b889e840840dd8a93"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a12d306574c00d91fbb47c02019007a8f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a12d306574c00d91fbb47c02019007a8f">getListMainSourceNotificationConfigurations</a> (const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, std::vector< <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> > &listMainNotificationConfigurations) const =0</td></tr> +<tr class="memdesc:a12d306574c00d91fbb47c02019007a8f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of MainNotifications for a source. <a href="#a12d306574c00d91fbb47c02019007a8f">More...</a><br/></td></tr> +<tr class="separator:a12d306574c00d91fbb47c02019007a8f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8b4148bc0c77744fd6f87ff51157060a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a8b4148bc0c77744fd6f87ff51157060a">setMainSinkNotificationConfiguration</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> &mainNotificationConfiguration)=0</td></tr> +<tr class="memdesc:a8b4148bc0c77744fd6f87ff51157060a"><td class="mdescLeft"> </td><td class="mdescRight">sets a MainNotificationConfiuration. <a href="#a8b4148bc0c77744fd6f87ff51157060a">More...</a><br/></td></tr> +<tr class="separator:a8b4148bc0c77744fd6f87ff51157060a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a273bdf6ed69e3d4a36526c211041e699"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a273bdf6ed69e3d4a36526c211041e699">setMainSourceNotificationConfiguration</a> (const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, const <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> &mainNotificationConfiguration)=0</td></tr> +<tr class="memdesc:a273bdf6ed69e3d4a36526c211041e699"><td class="mdescLeft"> </td><td class="mdescRight">sets a MainNotificationConfiuration. <a href="#a273bdf6ed69e3d4a36526c211041e699">More...</a><br/></td></tr> +<tr class="separator:a273bdf6ed69e3d4a36526c211041e699"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a90cf8d23b2be42709a997c7bf8ccfe9f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmCommandReceive.html#a90cf8d23b2be42709a997c7bf8ccfe9f">getVolume</a> (const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, <a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> &mainVolume) const =0</td></tr> +<tr class="memdesc:a90cf8d23b2be42709a997c7bf8ccfe9f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current volume for the sink directly out of the database. <a href="#a90cf8d23b2be42709a997c7bf8ccfe9f">More...</a><br/></td></tr> +<tr class="separator:a90cf8d23b2be42709a997c7bf8ccfe9f"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The interface towards the Controlling Instance (e.g HMI). </p> +<p>It handles the communication towards the HMI and other system components who need to interact with the audiomanagement. There are two rules that have to be kept in mind when implementing against this interface:<br/> +</p> +<dl class="section warning"><dt>Warning</dt><dd><ol type="1"> +<li>CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! <br/> +</li> +<li>YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.<br/> +</li> +</ol> +</dd></dl> +<p>Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-call pattern described on the wiki which also helps to implement calls that are forbidden.<br/> +For more information, please check <a class="el" href="classam_1_1CAmSerializer.html" title="magic class that does the serialization of functions calls The constructor must be called within the ...">CAmSerializer</a> </p> + +<p>Definition at line <a class="el" href="IAmCommand_8h_source.html#l00056">56</a> of file <a class="el" href="IAmCommand_8h_source.html">IAmCommand.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="ae5db817b614ec1c40f1571a2509dc599"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">am::IAmCommandReceive::IAmCommandReceive </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="IAmCommand_8h_source.html#l00060">60</a> of file <a class="el" href="IAmCommand_8h_source.html">IAmCommand.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a3429e3f232a55089b95364f58c4c23d2"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual am::IAmCommandReceive::~IAmCommandReceive </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="IAmCommand_8h_source.html#l00064">64</a> of file <a class="el" href="IAmCommand_8h_source.html">IAmCommand.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a82797be749cf366575ad3b2ac39f35bd"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void am::IAmCommandReceive::confirmCommandReady </td> + <td>(</td> + <td class="paramtype">const uint16_t </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td> + <td class="paramname"><em>error</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>asynchronous confirmation of setCommandReady. </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#adc6885dbe3520e6685035b0a89ffea7b">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a91abbf43e070dc01b841097c08a56226"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void am::IAmCommandReceive::confirmCommandRundown </td> + <td>(</td> + <td class="paramtype">const uint16_t </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td> + <td class="paramname"><em>error</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>asynchronous confirmation of setCommandRundown </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#af891b5714bde26daca7384758be25d5d">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a32ea97524439c9ea79b6383aae35c773"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::connect </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td> + <td class="paramname"><em>sourceID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceam.html#a33a5bb7641f58ab3a5f3b86400ad804c">am_mainConnectionID_t</a> & </td> + <td class="paramname"><em>mainConnectionID</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>connects a source to sink </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a62d8f5aee1e601d59f993c5a5561e234">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="afb43a65286b038159a6e4e7bf97f30ae"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::disconnect </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a33a5bb7641f58ab3a5f3b86400ad804c">am_mainConnectionID_t</a> </td> + <td class="paramname"><em>mainConnectionID</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>disconnects a mainConnection </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error. </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#aa24d0146f4e3c75e02d6c0152e246da1">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="aea62c0d93f812a5db595d97fe5f34858"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getDBusConnectionWrapper </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classam_1_1CAmDbusWrapper.html">CAmDbusWrapper</a> *& </td> + <td class="paramname"><em>dbusConnectionWrapper</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>this function is used to retrieve a pointer to the dBusConnectionWrapper </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a53edef0db4108a19ad395eb426dcc1b3">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="ae9470c23036c6257bd31e3bbd36564d2"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void am::IAmCommandReceive::getInterfaceVersion </td> + <td>(</td> + <td class="paramtype">std::string & </td> + <td class="paramname"><em>version</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This function returns the version of the interface. </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a1f38df5ee6645b0dd765a1bf28dd3f22">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a11180cd5df8778e7049b3ca2f30c800d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainConnections </td> + <td>(</td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__MainConnectionType__s.html">am_MainConnectionType_s</a> > & </td> + <td class="paramname"><em>listConnections</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>returns the actual list of MainConnections </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a59d10a7178e3227d0b8f415308c71179">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a233ee03fe13a4a3b889e840840dd8a93"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainSinkNotificationConfigurations </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> > & </td> + <td class="paramname"><em>listMainNotificationConfigurations</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Retrieves the list of MainNotifications for a sink. </p> +<p>Does not return the possible ones. </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a5e49b6d510658f1ccc2547ce5fc38dac">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="ad99dc95f0ea366cd556eb6f42b128fcc"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainSinks </td> + <td>(</td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__SinkType__s.html">am_SinkType_s</a> > & </td> + <td class="paramname"><em>listMainSinks</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>returns the actual list of Sinks </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#ab7dc13df4c7699dfdae5bcf6c4c1f7fa">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="afdd62ebf3d709e312c95ebe36696bfc6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainSinkSoundProperties </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> > & </td> + <td class="paramname"><em>listSoundProperties</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This is used to retrieve all source sound properties related to a source. </p> +<p>Returns a vector of the sound properties and values as pair </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a9f2313f8608c5cc7948f1406ec04beb7">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a12d306574c00d91fbb47c02019007a8f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainSourceNotificationConfigurations </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td> + <td class="paramname"><em>sourceID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> > & </td> + <td class="paramname"><em>listMainNotificationConfigurations</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Retrieves the list of MainNotifications for a source. </p> +<p>Does not return the possible ones. </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a953a590cf51c6a02d631c2d324d81d78">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a983b6b672d958e79f2695bf17db51683"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainSources </td> + <td>(</td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__SourceType__s.html">am_SourceType_s</a> > & </td> + <td class="paramname"><em>listMainSources</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>returns the actual list of Sources </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a59197bfc29443cbae19a26e9c10a4ba3">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a9a413c102368ebe38ecad89b511d652c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListMainSourceSoundProperties </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td> + <td class="paramname"><em>sourceID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> > & </td> + <td class="paramname"><em>listSourceProperties</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This is used to retrieve all source sound properties related to a source. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#aa21122ef14406f9454a9033c689bc660">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a4df3c83b76cc899b96e6c38ac5fdc31c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListSinkClasses </td> + <td>(</td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__SinkClass__s.html">am_SinkClass_s</a> > & </td> + <td class="paramname"><em>listSinkClasses</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This is used to retrieve SinkClass Information of all sink classes. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#aae42ce7867ffe512f973021b5677b879">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a3c022b7bb88fad2a1d5afde96e150abb"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListSourceClasses </td> + <td>(</td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__SourceClass__s.html">am_SourceClass_s</a> > & </td> + <td class="paramname"><em>listSourceClasses</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This is used to retrieve SourceClass Information of all source classes. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a2aaf5164223f9d180593a37e96945891">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a5281cf13e5344900363e0ae81d37d853"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getListSystemProperties </td> + <td>(</td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__SystemProperty__s.html">am_SystemProperty_s</a> > & </td> + <td class="paramname"><em>listSystemProperties</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Retrieves a complete list of all systemProperties. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#ac088319424792648863e320b78cad915">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="acf8e0ea44530723bda7340a1ceb8c5a4"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getSocketHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> *& </td> + <td class="paramname"><em>socketHandler</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This function returns the pointer to the socketHandler. </p> +<p>This can be used to integrate socket-based activites like communication with the mainloop of the AudioManager. returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support, </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a08731671113b46f54657e4849bb1e173">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="ae99e73a8c0ad4600c586aa26dd19ef89"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getTimingInformation </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a33a5bb7641f58ab3a5f3b86400ad804c">am_mainConnectionID_t</a> </td> + <td class="paramname"><em>mainConnectionID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceam.html#ad94ba90e3c8f6bd7e51a15a811755167">am_timeSync_t</a> & </td> + <td class="paramname"><em>delay</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>returns the delay in ms that the audiopath for the given mainConnection has </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on the database </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a05f8b40a07b3c234cd0935794e36a9b9">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a90cf8d23b2be42709a997c7bf8ccfe9f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::getVolume </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> & </td> + <td class="paramname"><em>mainVolume</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Returns the current volume for the sink directly out of the database. </p> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a011b02d5eddc693e5634583e0334e4a7">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a8b4148bc0c77744fd6f87ff51157060a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setMainSinkNotificationConfiguration </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> & </td> + <td class="paramname"><em>mainNotificationConfiguration</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>sets a MainNotificationConfiuration. </p> +<p>This can be used to turn on an off notifications an to change the mode of the configuration. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NON_EXISTENT if sinkID does not exists, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a7db57dfbc72f455545aa0d61013171d3">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a5ed9063ed677e215599f436c71cd5223"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setMainSinkSoundProperty </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> & </td> + <td class="paramname"><em>soundProperty</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This method is used to set sound properties, e.g. </p> +<p>Equalizer Values. Since the capabilities of the system can differ, the exact key value pairs can be extended in each product </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#aa3044c8587e0674bc107d607b6863b99">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a273bdf6ed69e3d4a36526c211041e699"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setMainSourceNotificationConfiguration </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td> + <td class="paramname"><em>sourceID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> & </td> + <td class="paramname"><em>mainNotificationConfiguration</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>sets a MainNotificationConfiuration. </p> +<p>This can be used to turn on an off notifications an to change the mode of the configuration. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NON_EXISTENT if sourceID does not exists, E_DATABASE_ERROR on error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a27b26681681cbceaa5d18253a0d6a644">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="ab611eb01227ba650f4a1338a4846ab6e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setMainSourceSoundProperty </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> & </td> + <td class="paramname"><em>soundProperty</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td> + <td class="paramname"><em>sourceID</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This method is used to set sound properties, e.g. </p> +<p>Equalizer Values. Since the capabilities of the system can differ, the exact key value pairs can be extended in each product </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a5275e9a3ed66acbe860729dd4665d7a1">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a8512dd96d42f3f36cd6a7e7590f5e930"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setSinkMuteState </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#af9d68f1f1b0553906df4c90e9a860ffa">am_MuteState_e</a> </td> + <td class="paramname"><em>muteState</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>sets the mute state of a sink </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK. </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#afae22041843c5349be16a6593d3ebb9c">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a16004832350de519f2c6fb09470d713a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setSystemProperty </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__SystemProperty__s.html">am_SystemProperty_s</a> & </td> + <td class="paramname"><em>property</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>is used to set a specific system property. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a33b0ab5fca8c82ce91b19f08c34471f8">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a6d8dcd7277753859d655104f5ee7597e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::setVolume </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> </td> + <td class="paramname"><em>volume</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>sets the volume for a sink </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#a6d47bc67473d75495260abe8c666fc7e">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<a class="anchor" id="a11fe6f5eb8f991f52725f050fec2bd59"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::IAmCommandReceive::volumeStep </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td> + <td class="paramname"><em>sinkID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const int16_t </td> + <td class="paramname"><em>volumeStep</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>This function is used to increment or decrement the current volume for a sink. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range. </dd></dl> + +<p>Implemented in <a class="el" href="classam_1_1CAmCommandReceiver.html#ad7a4c1fe5a2ecfaae5484a14d8820e58">am::CAmCommandReceiver</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/<a class="el" href="IAmCommand_8h_source.html">IAmCommand.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="classam_1_1IAmCommandReceive.html">IAmCommandReceive</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> |