diff options
Diffstat (limited to 'docs/notifi.html')
| -rw-r--r-- | docs/notifi.html | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/docs/notifi.html b/docs/notifi.html new file mode 100644 index 0000000..ecafa00 --- /dev/null +++ b/docs/notifi.html @@ -0,0 +1,171 @@ +<!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: Notifications</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 class="current"><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><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><!-- 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('notifi.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="headertitle"> +<div class="title">Notifications </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><h1><a class="anchor" id="notifi_ex"></a> +What are notifications?</h1> +<p>The notification feature can be used to gather information from sources or sinks periodically or on certain thresholds.It can be used to implement a graphical spectrum for example or other information need to be passed back from sources or sinks.</p> +<h1><a class="anchor" id="notifi_overview"></a> +Overview</h1> +<div class="image"> +<img src="Notifications.png" alt="Notifications.png"/> +</div> +<h1><a class="anchor" id="notifi_command"></a> +CommandInterface</h1> +<p>all this methods have to do with MainNotifications (Information level between command and control)</p> +<ul> +<li><a class="el" href="classam_1_1IAmCommandSend.html#a31fdbbc5e084e6dd1aa4ed3983066932" title="This callback is called when a notificated value of a sink changes. ">am::IAmCommandSend::cbSinkNotification</a></li> +<li><a class="el" href="classam_1_1IAmCommandSend.html#a3e7137d3294cea3be6190659a1e66acc" title="This callback is called when a notifcated value of a source changes. ">am::IAmCommandSend::cbSourceNotification</a></li> +<li><a class="el" href="classam_1_1IAmCommandSend.html#aba05b8fcf0d8cb55dd933e101066aa82" title="This callback is triggered when a mainNotificationConfiguration is changed. ">am::IAmCommandSend::cbMainSinkNotificationConfigurationChanged</a></li> +<li><a class="el" href="classam_1_1IAmCommandSend.html#a3696ea4000db99d8492490297343f9fc" title="This callback is triggered when a mainNotificationConfiguration is changed. ">am::IAmCommandSend::cbMainSourceNotificationConfigurationChanged</a></li> +<li><a class="el" href="classam_1_1IAmCommandReceive.html#a12d306574c00d91fbb47c02019007a8f" title="Retrieves the list of MainNotifications for a source. ">am::IAmCommandReceive::getListMainSourceNotificationConfigurations</a></li> +<li><a class="el" href="classam_1_1IAmCommandReceive.html#a233ee03fe13a4a3b889e840840dd8a93" title="Retrieves the list of MainNotifications for a sink. ">am::IAmCommandReceive::getListMainSinkNotificationConfigurations</a></li> +<li><a class="el" href="classam_1_1IAmCommandReceive.html#a273bdf6ed69e3d4a36526c211041e699" title="sets a MainNotificationConfiuration. ">am::IAmCommandReceive::setMainSourceNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmCommandReceive.html#a8b4148bc0c77744fd6f87ff51157060a" title="sets a MainNotificationConfiuration. ">am::IAmCommandReceive::setMainSinkNotificationConfiguration</a> </li> +</ul> +<h1><a class="anchor" id="notifi_control"></a> +ControlInterface</h1> +<p>all this methods have to do with MainNotifications (Information level between command and control)</p> +<ul> +<li><a class="el" href="classam_1_1IAmControlSend.html#a9b297c03a6239be2c45bef687c0d4def" title="sets a user MainSinkNotificationConfiguration ">am::IAmControlSend::hookUserSetMainSinkNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmControlSend.html#aa6f94e59485a962830c7e957cfb1fe49" title="sets a user MainSourceNotificationConfiguration ">am::IAmControlSend::hookUserSetMainSourceNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmControlReceive.html#a55b0c17d87150f44659bf2bb8a668408" title="change the mainNotificationConfiguration of a sink ">am::IAmControlReceive::changeMainSinkNotificationConfigurationDB</a></li> +<li><a class="el" href="classam_1_1IAmControlReceive.html#a50c39182e78d8ab13b50dd285cb1dcf8" title="change the mainNotificationConfiguration of a source ">am::IAmControlReceive::changeMainSourceNotificationConfigurationDB</a></li> +<li><a class="el" href="classam_1_1IAmControlReceive.html#a2bc60ab809b10b62a701cae3803ddbee" title="Sends out the main notificiation of a sink. ">am::IAmControlReceive::sendMainSinkNotificationPayload</a></li> +<li><a class="el" href="classam_1_1IAmControlReceive.html#a0bc7f21ff1e73fb7c1ccf479a564ec30" title="Sends out the main notificiation of a source. ">am::IAmControlReceive::sendMainSourceNotificationPayload</a></li> +</ul> +<p>all this methods have to do with notifications (Information level between cotrol and routing)</p> +<ul> +<li><a class="el" href="classam_1_1IAmControlSend.html#a00be1fd1fa2aa657042e97b9533b6cbf" title="The acknowledge of the sink notification configuration. ">am::IAmControlSend::cbAckSetSinkNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmControlSend.html#a509053b30cd6310110dad0fc8bea819e" title="The acknowledge of the source notification configuration. ">am::IAmControlSend::cbAckSetSourceNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmControlSend.html#a47963dfe663b99d71172bb54d1e31e34" title="new sinkNotification data is there! ">am::IAmControlSend::hookSinkNotificationDataChanged</a></li> +<li><a class="el" href="classam_1_1IAmControlSend.html#a64f209d9dcbcd1cb5cce4ebbc8236fc1" title="new sourceNotification data is there! ">am::IAmControlSend::hookSourceNotificationDataChanged</a></li> +<li><a class="el" href="classam_1_1IAmControlReceive.html#a3fc916ba460523204db578e750e0422a" title="set a sink notification configuration ">am::IAmControlReceive::setSinkNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmControlReceive.html#ae92ad6769edd9d95d4fa86f8b760b672" title="set a source notification configuration ">am::IAmControlReceive::setSourceNotificationConfiguration</a> </li> +</ul> +<h1><a class="anchor" id="notifi_routing"></a> +RoutingInterface</h1> +<p>all this methods have to do with notifications (Information level between cotrol and routing)</p> +<ul> +<li><a class="el" href="classam_1_1IAmRoutingSend.html#aea5a145d496363f890b9103be4371962" title="sets the notification configuration of a sink. ">am::IAmRoutingSend::asyncSetSinkNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmRoutingSend.html#a95fb11f817aeda9247318d589cbb9c40" title="sets the notification configuration of a source. ">am::IAmRoutingSend::asyncSetSourceNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmRoutingReceive.html#aa908806a25e9cc12977097becb3ef40b" title="The acknowledge of the SinkNotificationConfiguration. ">am::IAmRoutingReceive::ackSinkNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmRoutingReceive.html#ac36edace9dd1574e5208b5073d3bf078" title="The acknowledge of the SourceNotificationConfiguration. ">am::IAmRoutingReceive::ackSourceNotificationConfiguration</a></li> +<li><a class="el" href="classam_1_1IAmRoutingReceive.html#a2038b03578f95ff9d5297914c011dbfb" title="is called whenever a notified value needs to be send ">am::IAmRoutingReceive::hookSinkNotificationDataChange</a></li> +<li><a class="el" href="classam_1_1IAmRoutingReceive.html#aacb97dd192686d5cd77ee80714245706" title="is called whenever a notified value needs to be send ">am::IAmRoutingReceive::hookSourceNotificationDataChange</a></li> +</ul> +<h1><a class="anchor" id="notifi_levels"></a> +Notification Levels</h1> +<p>For notifications it's the same as for the soundproperties: there are two levels of information. One is between the Command Interface and the Control Interface here it is in the duty of the controller to handle the notification data. The other one is between Control and Routing Interface. This could be used for example to route the information from a source to the command interface. </p> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> |