diff options
Diffstat (limited to 'docs/classam_1_1IAmRoutingSend.html')
| -rw-r--r-- | docs/classam_1_1IAmRoutingSend.html | 1107 |
1 files changed, 1107 insertions, 0 deletions
diff --git a/docs/classam_1_1IAmRoutingSend.html b/docs/classam_1_1IAmRoutingSend.html new file mode 100644 index 0000000..9063153 --- /dev/null +++ b/docs/classam_1_1IAmRoutingSend.html @@ -0,0 +1,1107 @@ +<!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::IAmRoutingSend 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_1IAmRoutingSend.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_1IAmRoutingSend-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::IAmRoutingSend Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>This class implements everything from Audiomanager -> RoutingAdapter There are two rules that have to be kept in mind when implementing against this interface:<br/> +. + <a href="classam_1_1IAmRoutingSend.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="IAmRouting_8h_source.html">IAmRouting.h</a>></code></p> +<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:ad1f2443c1dae33eb6071c715caf54eec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmRoutingSend.html#ad1f2443c1dae33eb6071c715caf54eec">IAmRoutingSend</a> ()</td></tr> +<tr class="separator:ad1f2443c1dae33eb6071c715caf54eec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2252476d4ff4fd1e7a56e92048f12f6e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmRoutingSend.html#a2252476d4ff4fd1e7a56e92048f12f6e">~IAmRoutingSend</a> ()</td></tr> +<tr class="separator:a2252476d4ff4fd1e7a56e92048f12f6e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa3c35315ba28147126d6c9db571f8c0b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmRoutingSend.html#aa3c35315ba28147126d6c9db571f8c0b">getInterfaceVersion</a> (std::string &version) const =0</td></tr> +<tr class="memdesc:aa3c35315ba28147126d6c9db571f8c0b"><td class="mdescLeft"> </td><td class="mdescRight">This function returns the version of the interface. <a href="#aa3c35315ba28147126d6c9db571f8c0b">More...</a><br/></td></tr> +<tr class="separator:aa3c35315ba28147126d6c9db571f8c0b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b40a38d0091d7784bdedf3d91093b99"><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_1IAmRoutingSend.html#a9b40a38d0091d7784bdedf3d91093b99">startupInterface</a> (<a class="el" href="classam_1_1IAmRoutingReceive.html">IAmRoutingReceive</a> *routingreceiveinterface)=0</td></tr> +<tr class="memdesc:a9b40a38d0091d7784bdedf3d91093b99"><td class="mdescLeft"> </td><td class="mdescRight">starts up the interface. <a href="#a9b40a38d0091d7784bdedf3d91093b99">More...</a><br/></td></tr> +<tr class="separator:a9b40a38d0091d7784bdedf3d91093b99"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afd2ef6005caa8d7a45614343e1c451e8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmRoutingSend.html#afd2ef6005caa8d7a45614343e1c451e8">setRoutingReady</a> (const uint16_t handle)=0</td></tr> +<tr class="memdesc:afd2ef6005caa8d7a45614343e1c451e8"><td class="mdescLeft"> </td><td class="mdescRight">indicates that the routing now ready to be used. <a href="#afd2ef6005caa8d7a45614343e1c451e8">More...</a><br/></td></tr> +<tr class="separator:afd2ef6005caa8d7a45614343e1c451e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9e1c212a50f380f38f2be94ca336597e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1IAmRoutingSend.html#a9e1c212a50f380f38f2be94ca336597e">setRoutingRundown</a> (const uint16_t handle)=0</td></tr> +<tr class="memdesc:a9e1c212a50f380f38f2be94ca336597e"><td class="mdescLeft"> </td><td class="mdescRight">indicates that the routing plugins need to be prepared to switch the power off or be ready again. <a href="#a9e1c212a50f380f38f2be94ca336597e">More...</a><br/></td></tr> +<tr class="separator:a9e1c212a50f380f38f2be94ca336597e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac32fb8376178ca94085cb3676541881f"><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_1IAmRoutingSend.html#ac32fb8376178ca94085cb3676541881f">asyncAbort</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle)=0</td></tr> +<tr class="memdesc:ac32fb8376178ca94085cb3676541881f"><td class="mdescLeft"> </td><td class="mdescRight">aborts an asynchronous action. <a href="#ac32fb8376178ca94085cb3676541881f">More...</a><br/></td></tr> +<tr class="separator:ac32fb8376178ca94085cb3676541881f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed21a3ad01cfe62e39168e080ed7ecff"><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_1IAmRoutingSend.html#aed21a3ad01cfe62e39168e080ed7ecff">asyncConnect</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#aee5e4e9b864d3867a896b6cdceed6ff4">am_connectionID_t</a> connectionID, 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, const <a class="el" href="namespaceam.html#a114262d77aae4ed1d2daa50a36155d3e">am_CustomConnectionFormat_t</a> connectionFormat)=0</td></tr> +<tr class="memdesc:aed21a3ad01cfe62e39168e080ed7ecff"><td class="mdescLeft"> </td><td class="mdescRight">connects a source to a sink <a href="#aed21a3ad01cfe62e39168e080ed7ecff">More...</a><br/></td></tr> +<tr class="separator:aed21a3ad01cfe62e39168e080ed7ecff"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a13c67c43d494d69622ff8390d0ac670d"><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_1IAmRoutingSend.html#a13c67c43d494d69622ff8390d0ac670d">asyncDisconnect</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#aee5e4e9b864d3867a896b6cdceed6ff4">am_connectionID_t</a> connectionID)=0</td></tr> +<tr class="memdesc:a13c67c43d494d69622ff8390d0ac670d"><td class="mdescLeft"> </td><td class="mdescRight">disconnect a connection with given connectionID <a href="#a13c67c43d494d69622ff8390d0ac670d">More...</a><br/></td></tr> +<tr class="separator:a13c67c43d494d69622ff8390d0ac670d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a187da2405f7e675ddcab28c2306b4d54"><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_1IAmRoutingSend.html#a187da2405f7e675ddcab28c2306b4d54">asyncSetSinkVolume</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const <a class="el" href="namespaceam.html#a0ba72fdbafaa9e886e77aa4099c281ec">am_volume_t</a> volume, const <a class="el" href="namespaceam.html#a63a9882c5f86f7df779f260518ffb31f">am_CustomRampType_t</a> ramp, const <a class="el" href="namespaceam.html#a510513cf43299092b6c85250dbbef93f">am_time_t</a> time)=0</td></tr> +<tr class="memdesc:a187da2405f7e675ddcab28c2306b4d54"><td class="mdescLeft"> </td><td class="mdescRight">this method is used to set the volume of a sink. <a href="#a187da2405f7e675ddcab28c2306b4d54">More...</a><br/></td></tr> +<tr class="separator:a187da2405f7e675ddcab28c2306b4d54"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a54e1c82bce73f5f355fce119ae7cbb7c"><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_1IAmRoutingSend.html#a54e1c82bce73f5f355fce119ae7cbb7c">asyncSetSourceVolume</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, const <a class="el" href="namespaceam.html#a0ba72fdbafaa9e886e77aa4099c281ec">am_volume_t</a> volume, const <a class="el" href="namespaceam.html#a63a9882c5f86f7df779f260518ffb31f">am_CustomRampType_t</a> ramp, const <a class="el" href="namespaceam.html#a510513cf43299092b6c85250dbbef93f">am_time_t</a> time)=0</td></tr> +<tr class="memdesc:a54e1c82bce73f5f355fce119ae7cbb7c"><td class="mdescLeft"> </td><td class="mdescRight">sets the volume of a source. <a href="#a54e1c82bce73f5f355fce119ae7cbb7c">More...</a><br/></td></tr> +<tr class="separator:a54e1c82bce73f5f355fce119ae7cbb7c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a55957b77924e8c8fb358c5408e13f9e0"><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_1IAmRoutingSend.html#a55957b77924e8c8fb358c5408e13f9e0">asyncSetSourceState</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, const <a class="el" href="namespaceam.html#af966cbbc3b1d6e637d81a46eaa7dd358">am_SourceState_e</a> state)=0</td></tr> +<tr class="memdesc:a55957b77924e8c8fb358c5408e13f9e0"><td class="mdescLeft"> </td><td class="mdescRight">This function is used to set the source state of a particular source. <a href="#a55957b77924e8c8fb358c5408e13f9e0">More...</a><br/></td></tr> +<tr class="separator:a55957b77924e8c8fb358c5408e13f9e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab618f8f73047f99a397ae09f2e4dc117"><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_1IAmRoutingSend.html#ab618f8f73047f99a397ae09f2e4dc117">asyncSetSinkSoundProperties</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const std::vector< <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> > &listSoundProperties)=0</td></tr> +<tr class="memdesc:ab618f8f73047f99a397ae09f2e4dc117"><td class="mdescLeft"> </td><td class="mdescRight">this function sets the sinksoundproperty. <a href="#ab618f8f73047f99a397ae09f2e4dc117">More...</a><br/></td></tr> +<tr class="separator:ab618f8f73047f99a397ae09f2e4dc117"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1a56926a95fdb5c1f8128cf93ea4c8f3"><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_1IAmRoutingSend.html#a1a56926a95fdb5c1f8128cf93ea4c8f3">asyncSetSinkSoundProperty</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> sinkID, const <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> &soundProperty)=0</td></tr> +<tr class="memdesc:a1a56926a95fdb5c1f8128cf93ea4c8f3"><td class="mdescLeft"> </td><td class="mdescRight">this function sets the sinksoundproperty. <a href="#a1a56926a95fdb5c1f8128cf93ea4c8f3">More...</a><br/></td></tr> +<tr class="separator:a1a56926a95fdb5c1f8128cf93ea4c8f3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9597c5c072dc05a57b1278a93fd48252"><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_1IAmRoutingSend.html#a9597c5c072dc05a57b1278a93fd48252">asyncSetSourceSoundProperties</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, const std::vector< <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> > &listSoundProperties)=0</td></tr> +<tr class="memdesc:a9597c5c072dc05a57b1278a93fd48252"><td class="mdescLeft"> </td><td class="mdescRight">this function sets the sourcesoundproperty. <a href="#a9597c5c072dc05a57b1278a93fd48252">More...</a><br/></td></tr> +<tr class="separator:a9597c5c072dc05a57b1278a93fd48252"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8a63375af30b80030cea91d926042688"><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_1IAmRoutingSend.html#a8a63375af30b80030cea91d926042688">asyncSetSourceSoundProperty</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> sourceID, const <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> &soundProperty)=0</td></tr> +<tr class="memdesc:a8a63375af30b80030cea91d926042688"><td class="mdescLeft"> </td><td class="mdescRight">this function sets the sourcesoundproperty. <a href="#a8a63375af30b80030cea91d926042688">More...</a><br/></td></tr> +<tr class="separator:a8a63375af30b80030cea91d926042688"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4d00922dbed36d1836dec9832388e9ab"><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_1IAmRoutingSend.html#a4d00922dbed36d1836dec9832388e9ab">asyncCrossFade</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const <a class="el" href="namespaceam.html#aaf4c3deaf1b53aeac50503c75b4e5a31">am_crossfaderID_t</a> crossfaderID, const <a class="el" href="namespaceam.html#afc05253c20a9333f02f7a4b3f7762269">am_HotSink_e</a> hotSink, const <a class="el" href="namespaceam.html#a63a9882c5f86f7df779f260518ffb31f">am_CustomRampType_t</a> rampType, const <a class="el" href="namespaceam.html#a510513cf43299092b6c85250dbbef93f">am_time_t</a> time)=0</td></tr> +<tr class="memdesc:a4d00922dbed36d1836dec9832388e9ab"><td class="mdescLeft"> </td><td class="mdescRight">this function triggers crossfading. <a href="#a4d00922dbed36d1836dec9832388e9ab">More...</a><br/></td></tr> +<tr class="separator:a4d00922dbed36d1836dec9832388e9ab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa70db3ad187a06ec1333c21358987773"><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_1IAmRoutingSend.html#aa70db3ad187a06ec1333c21358987773">setDomainState</a> (const <a class="el" href="namespaceam.html#a58a230b5da10699a7ce1b1f2a1c550e6">am_domainID_t</a> domainID, const <a class="el" href="namespaceam.html#a2e1718a0cd2d37bd5f989402b89c34a5">am_DomainState_e</a> domainState)=0</td></tr> +<tr class="memdesc:aa70db3ad187a06ec1333c21358987773"><td class="mdescLeft"> </td><td class="mdescRight">this function is used for early and late audio functions to set the domain state <a href="#aa70db3ad187a06ec1333c21358987773">More...</a><br/></td></tr> +<tr class="separator:aa70db3ad187a06ec1333c21358987773"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad4761b14565a6dd9ea24fa21cafdf540"><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_1IAmRoutingSend.html#ad4761b14565a6dd9ea24fa21cafdf540">returnBusName</a> (std::string &BusName) const =0</td></tr> +<tr class="memdesc:ad4761b14565a6dd9ea24fa21cafdf540"><td class="mdescLeft"> </td><td class="mdescRight">this method is used to retrieve the busname during startup of the plugin. <a href="#ad4761b14565a6dd9ea24fa21cafdf540">More...</a><br/></td></tr> +<tr class="separator:ad4761b14565a6dd9ea24fa21cafdf540"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4b65c7722bdf888b1cb24b331b4eecea"><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_1IAmRoutingSend.html#a4b65c7722bdf888b1cb24b331b4eecea">asyncSetVolumes</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, const std::vector< <a class="el" href="structam_1_1am__Volumes__s.html">am_Volumes_s</a> > &listVolumes)=0</td></tr> +<tr class="memdesc:a4b65c7722bdf888b1cb24b331b4eecea"><td class="mdescLeft"> </td><td class="mdescRight">This command sets multiple source or and sink volumes within a domain at a time. <a href="#a4b65c7722bdf888b1cb24b331b4eecea">More...</a><br/></td></tr> +<tr class="separator:a4b65c7722bdf888b1cb24b331b4eecea"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aea5a145d496363f890b9103be4371962"><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_1IAmRoutingSend.html#aea5a145d496363f890b9103be4371962">asyncSetSinkNotificationConfiguration</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, 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> &notificationConfiguration)=0</td></tr> +<tr class="memdesc:aea5a145d496363f890b9103be4371962"><td class="mdescLeft"> </td><td class="mdescRight">sets the notification configuration of a sink. <a href="#aea5a145d496363f890b9103be4371962">More...</a><br/></td></tr> +<tr class="separator:aea5a145d496363f890b9103be4371962"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a95fb11f817aeda9247318d589cbb9c40"><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_1IAmRoutingSend.html#a95fb11f817aeda9247318d589cbb9c40">asyncSetSourceNotificationConfiguration</a> (const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> handle, 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> &notificationConfiguration)=0</td></tr> +<tr class="memdesc:a95fb11f817aeda9247318d589cbb9c40"><td class="mdescLeft"> </td><td class="mdescRight">sets the notification configuration of a source. <a href="#a95fb11f817aeda9247318d589cbb9c40">More...</a><br/></td></tr> +<tr class="separator:a95fb11f817aeda9247318d589cbb9c40"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a53dc66f59e728a3370f0fca132c212e7"><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_1IAmRoutingSend.html#a53dc66f59e728a3370f0fca132c212e7">resyncConnectionState</a> (const <a class="el" href="namespaceam.html#a58a230b5da10699a7ce1b1f2a1c550e6">am_domainID_t</a> domainID, std::vector< <a class="el" href="structam_1_1am__Connection__s.html">am_Connection_s</a> > &listOfExistingConnections)=0</td></tr> +<tr class="memdesc:a53dc66f59e728a3370f0fca132c212e7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a list of all current active connections from a domain. <a href="#a53dc66f59e728a3370f0fca132c212e7">More...</a><br/></td></tr> +<tr class="separator:a53dc66f59e728a3370f0fca132c212e7"><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 class implements everything from Audiomanager -> RoutingAdapter 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="IAmRouting_8h_source.html#l00357">357</a> of file <a class="el" href="IAmRouting_8h_source.html">IAmRouting.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="ad1f2443c1dae33eb6071c715caf54eec"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">am::IAmRoutingSend::IAmRoutingSend </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="IAmRouting_8h_source.html#l00361">361</a> of file <a class="el" href="IAmRouting_8h_source.html">IAmRouting.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a2252476d4ff4fd1e7a56e92048f12f6e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual am::IAmRoutingSend::~IAmRoutingSend </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="IAmRouting_8h_source.html#l00365">365</a> of file <a class="el" href="IAmRouting_8h_source.html">IAmRouting.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="ac32fb8376178ca94085cb3676541881f"></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::IAmRoutingSend::asyncAbort </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </td> + <td class="paramname"><em>handle</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>aborts an asynchronous action. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if handle was not found </dd></dl> + +</div> +</div> +<a class="anchor" id="aed21a3ad01cfe62e39168e080ed7ecff"></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::IAmRoutingSend::asyncConnect </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#aee5e4e9b864d3867a896b6cdceed6ff4">am_connectionID_t</a> </td> + <td class="paramname"><em>connectionID</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 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">const <a class="el" href="namespaceam.html#a114262d77aae4ed1d2daa50a36155d3e">am_CustomConnectionFormat_t</a> </td> + <td class="paramname"><em>connectionFormat</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 a sink </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_WRONG_FORMAT in case am_ConnectionFormat_e does not match </dd></dl> + +</div> +</div> +<a class="anchor" id="a4d00922dbed36d1836dec9832388e9ab"></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::IAmRoutingSend::asyncCrossFade </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#aaf4c3deaf1b53aeac50503c75b4e5a31">am_crossfaderID_t</a> </td> + <td class="paramname"><em>crossfaderID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#afc05253c20a9333f02f7a4b3f7762269">am_HotSink_e</a> </td> + <td class="paramname"><em>hotSink</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a63a9882c5f86f7df779f260518ffb31f">am_CustomRampType_t</a> </td> + <td class="paramname"><em>rampType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a510513cf43299092b6c85250dbbef93f">am_time_t</a> </td> + <td class="paramname"><em>time</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 triggers crossfading. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error </dd></dl> + +</div> +</div> +<a class="anchor" id="a13c67c43d494d69622ff8390d0ac670d"></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::IAmRoutingSend::asyncDisconnect </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#aee5e4e9b864d3867a896b6cdceed6ff4">am_connectionID_t</a> </td> + <td class="paramname"><em>connectionID</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>disconnect a connection with given connectionID </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if connection was not found </dd></dl> + +</div> +</div> +<a class="anchor" id="aea5a145d496363f890b9103be4371962"></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::IAmRoutingSend::asyncSetSinkNotificationConfiguration </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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>notificationConfiguration</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 notification configuration of a sink. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error. </dd></dl> + +</div> +</div> +<a class="anchor" id="ab618f8f73047f99a397ae09f2e4dc117"></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::IAmRoutingSend::asyncSetSinkSoundProperties </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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 std::vector< <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> > & </td> + <td class="paramname"><em>listSoundProperties</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 sets the sinksoundproperty. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range </dd></dl> + +</div> +</div> +<a class="anchor" id="a1a56926a95fdb5c1f8128cf93ea4c8f3"></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::IAmRoutingSend::asyncSetSinkSoundProperty </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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__SoundProperty__s.html">am_SoundProperty_s</a> & </td> + <td class="paramname"><em>soundProperty</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 sets the sinksoundproperty. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range </dd></dl> + +</div> +</div> +<a class="anchor" id="a187da2405f7e675ddcab28c2306b4d54"></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::IAmRoutingSend::asyncSetSinkVolume </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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#a0ba72fdbafaa9e886e77aa4099c281ec">am_volume_t</a> </td> + <td class="paramname"><em>volume</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a63a9882c5f86f7df779f260518ffb31f">am_CustomRampType_t</a> </td> + <td class="paramname"><em>ramp</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a510513cf43299092b6c85250dbbef93f">am_time_t</a> </td> + <td class="paramname"><em>time</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 the volume of a sink. </p> +<p>This function is used to drive ramps, to mute or unmute or directly set the value. The difference is made through the ramptype. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if new volume is out of range </dd></dl> + +</div> +</div> +<a class="anchor" id="a95fb11f817aeda9247318d589cbb9c40"></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::IAmRoutingSend::asyncSetSourceNotificationConfiguration </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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>notificationConfiguration</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 notification configuration of a source. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error. </dd></dl> + +</div> +</div> +<a class="anchor" id="a9597c5c072dc05a57b1278a93fd48252"></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::IAmRoutingSend::asyncSetSourceSoundProperties </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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 std::vector< <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> > & </td> + <td class="paramname"><em>listSoundProperties</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 sets the sourcesoundproperty. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range </dd></dl> + +</div> +</div> +<a class="anchor" id="a8a63375af30b80030cea91d926042688"></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::IAmRoutingSend::asyncSetSourceSoundProperty </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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__SoundProperty__s.html">am_SoundProperty_s</a> & </td> + <td class="paramname"><em>soundProperty</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 sets the sourcesoundproperty. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range </dd></dl> + +</div> +</div> +<a class="anchor" id="a55957b77924e8c8fb358c5408e13f9e0"></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::IAmRoutingSend::asyncSetSourceState </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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#af966cbbc3b1d6e637d81a46eaa7dd358">am_SourceState_e</a> </td> + <td class="paramname"><em>state</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 set the source state of a particular source. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error </dd></dl> + +</div> +</div> +<a class="anchor" id="a54e1c82bce73f5f355fce119ae7cbb7c"></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::IAmRoutingSend::asyncSetSourceVolume </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </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#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#a0ba72fdbafaa9e886e77aa4099c281ec">am_volume_t</a> </td> + <td class="paramname"><em>volume</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a63a9882c5f86f7df779f260518ffb31f">am_CustomRampType_t</a> </td> + <td class="paramname"><em>ramp</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a510513cf43299092b6c85250dbbef93f">am_time_t</a> </td> + <td class="paramname"><em>time</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 of a source. </p> +<p>This method is used to set the volume of a sink. This function is used to drive ramps, to mute or unmute or directly set the value. The difference is made through the ramptype. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of range. triggers the acknowledge ackSourceVolumeChange </dd></dl> + +</div> +</div> +<a class="anchor" id="a4b65c7722bdf888b1cb24b331b4eecea"></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::IAmRoutingSend::asyncSetVolumes </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structam_1_1am__Handle__s.html">am_Handle_s</a> </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::vector< <a class="el" href="structam_1_1am__Volumes__s.html">am_Volumes_s</a> > & </td> + <td class="paramname"><em>listVolumes</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 command sets multiple source or and sink volumes within a domain at a time. </p> +<p>It can be used to synchronize volume setting events. </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error. </dd></dl> + +</div> +</div> +<a class="anchor" id="aa3c35315ba28147126d6c9db571f8c0b"></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::IAmRoutingSend::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> + +</div> +</div> +<a class="anchor" id="a53dc66f59e728a3370f0fca132c212e7"></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::IAmRoutingSend::resyncConnectionState </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a58a230b5da10699a7ce1b1f2a1c550e6">am_domainID_t</a> </td> + <td class="paramname"><em>domainID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< <a class="el" href="structam_1_1am__Connection__s.html">am_Connection_s</a> > & </td> + <td class="paramname"><em>listOfExistingConnections</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>Retrieves a list of all current active connections from a domain. </p> +<p>This method is meant to be used if the audiomanager and a remote domain are out of sync. </p> + +</div> +</div> +<a class="anchor" id="ad4761b14565a6dd9ea24fa21cafdf540"></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::IAmRoutingSend::returnBusName </td> + <td>(</td> + <td class="paramtype">std::string & </td> + <td class="paramname"><em>BusName</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 method is used to retrieve the busname during startup of the plugin. </p> +<p>Needs to be implemented </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error </dd></dl> + +</div> +</div> +<a class="anchor" id="aa70db3ad187a06ec1333c21358987773"></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::IAmRoutingSend::setDomainState </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a58a230b5da10699a7ce1b1f2a1c550e6">am_domainID_t</a> </td> + <td class="paramname"><em>domainID</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a2e1718a0cd2d37bd5f989402b89c34a5">am_DomainState_e</a> </td> + <td class="paramname"><em>domainState</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 for early and late audio functions to set the domain state </p> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_UNKNOWN on error </dd></dl> + +</div> +</div> +<a class="anchor" id="afd2ef6005caa8d7a45614343e1c451e8"></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::IAmRoutingSend::setRoutingReady </td> + <td>(</td> + <td class="paramtype">const uint16_t </td> + <td class="paramname"><em>handle</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>indicates that the routing now ready to be used. </p> +<p>Should be used as trigger to register all sinks, sources, etc... </p> + +</div> +</div> +<a class="anchor" id="a9e1c212a50f380f38f2be94ca336597e"></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::IAmRoutingSend::setRoutingRundown </td> + <td>(</td> + <td class="paramtype">const uint16_t </td> + <td class="paramname"><em>handle</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>indicates that the routing plugins need to be prepared to switch the power off or be ready again. </p> + +</div> +</div> +<a class="anchor" id="a9b40a38d0091d7784bdedf3d91093b99"></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::IAmRoutingSend::startupInterface </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classam_1_1IAmRoutingReceive.html">IAmRoutingReceive</a> * </td> + <td class="paramname"><em>routingreceiveinterface</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>starts up the interface. </p> +<p>In the implementations, here is the best place for init routines. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/<a class="el" href="IAmRouting_8h_source.html">IAmRouting.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_1IAmRoutingSend.html">IAmRoutingSend</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> |