diff options
Diffstat (limited to 'docs/structam_1_1am__Source__s.html')
| -rw-r--r-- | docs/structam_1_1am__Source__s.html | 433 |
1 files changed, 433 insertions, 0 deletions
diff --git a/docs/structam_1_1am__Source__s.html b/docs/structam_1_1am__Source__s.html new file mode 100644 index 0000000..80c9b55 --- /dev/null +++ b/docs/structam_1_1am__Source__s.html @@ -0,0 +1,433 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>AudioManager: am::am_Source_s Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">AudioManager +  <span id="projectnumber">7.5.11</span> + </div> + <div id="projectbrief">Native Application Runtime Environment</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('structam_1_1am__Source__s.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-attribs">Public Attributes</a> | +<a href="structam_1_1am__Source__s-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::am_Source_s Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This struct describes the attribiutes of a source. + <a href="structam_1_1am__Source__s.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:ad224888802fabebefe6ff587412da9fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#ad224888802fabebefe6ff587412da9fd">sourceID</a></td></tr> +<tr class="memdesc:ad224888802fabebefe6ff587412da9fd"><td class="mdescLeft"> </td><td class="mdescRight">This is the ID of the source, it is unique in the system. <a href="#ad224888802fabebefe6ff587412da9fd">More...</a><br/></td></tr> +<tr class="separator:ad224888802fabebefe6ff587412da9fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a57854adc822ed77c6443ec2c745820af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a58a230b5da10699a7ce1b1f2a1c550e6">am_domainID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a57854adc822ed77c6443ec2c745820af">domainID</a></td></tr> +<tr class="memdesc:a57854adc822ed77c6443ec2c745820af"><td class="mdescLeft"> </td><td class="mdescRight">The domainID is the domain the source belongs to. <a href="#a57854adc822ed77c6443ec2c745820af">More...</a><br/></td></tr> +<tr class="separator:a57854adc822ed77c6443ec2c745820af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a85dbb09cc190834a1e10e6ac4ee5f6fb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a85dbb09cc190834a1e10e6ac4ee5f6fb">name</a></td></tr> +<tr class="memdesc:a85dbb09cc190834a1e10e6ac4ee5f6fb"><td class="mdescLeft"> </td><td class="mdescRight">The name of the source. <a href="#a85dbb09cc190834a1e10e6ac4ee5f6fb">More...</a><br/></td></tr> +<tr class="separator:a85dbb09cc190834a1e10e6ac4ee5f6fb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11aed737b64b5216b786f0804fc23a79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a8b8fc2ab1ac4d427ca85fe8549e6afd0">am_sourceClass_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a11aed737b64b5216b786f0804fc23a79">sourceClassID</a></td></tr> +<tr class="memdesc:a11aed737b64b5216b786f0804fc23a79"><td class="mdescLeft"> </td><td class="mdescRight">the sourceClassID, indicates the class the source is in. <a href="#a11aed737b64b5216b786f0804fc23a79">More...</a><br/></td></tr> +<tr class="separator:a11aed737b64b5216b786f0804fc23a79"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a15b7672dacb2e91fb56134766eb33a5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#af966cbbc3b1d6e637d81a46eaa7dd358">am_SourceState_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a15b7672dacb2e91fb56134766eb33a5d">sourceState</a></td></tr> +<tr class="memdesc:a15b7672dacb2e91fb56134766eb33a5d"><td class="mdescLeft"> </td><td class="mdescRight">The source state is an indication towards the source if it is actively heard or not. <a href="#a15b7672dacb2e91fb56134766eb33a5d">More...</a><br/></td></tr> +<tr class="separator:a15b7672dacb2e91fb56134766eb33a5d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:add220cb377b2e4943cafac1206056296"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a0ba72fdbafaa9e886e77aa4099c281ec">am_volume_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#add220cb377b2e4943cafac1206056296">volume</a></td></tr> +<tr class="memdesc:add220cb377b2e4943cafac1206056296"><td class="mdescLeft"> </td><td class="mdescRight">This is the volume of the source. <a href="#add220cb377b2e4943cafac1206056296">More...</a><br/></td></tr> +<tr class="separator:add220cb377b2e4943cafac1206056296"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9904977c28ce558db9c8aec2172de7b7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a9904977c28ce558db9c8aec2172de7b7">visible</a></td></tr> +<tr class="memdesc:a9904977c28ce558db9c8aec2172de7b7"><td class="mdescLeft"> </td><td class="mdescRight">This Boolean flag indicates whether a source is visible to the commandInterface or not. <a href="#a9904977c28ce558db9c8aec2172de7b7">More...</a><br/></td></tr> +<tr class="separator:a9904977c28ce558db9c8aec2172de7b7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abcc899d845aa22799119ac0807bacc7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structam_1_1am__Availability__s.html">am_Availability_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#abcc899d845aa22799119ac0807bacc7f">available</a></td></tr> +<tr class="memdesc:abcc899d845aa22799119ac0807bacc7f"><td class="mdescLeft"> </td><td class="mdescRight">This attribute reflects the availability of the source. <a href="#abcc899d845aa22799119ac0807bacc7f">More...</a><br/></td></tr> +<tr class="separator:abcc899d845aa22799119ac0807bacc7f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2e6ca4857b4e45bb5ecca3ac73a01563"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a9bce055a917900b33c7fa5666ec00e22">am_InterruptState_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a2e6ca4857b4e45bb5ecca3ac73a01563">interruptState</a></td></tr> +<tr class="memdesc:a2e6ca4857b4e45bb5ecca3ac73a01563"><td class="mdescLeft"> </td><td class="mdescRight">Some special sources can have special behaviors, the are so called "Low Level +Interrupts". <a href="#a2e6ca4857b4e45bb5ecca3ac73a01563">More...</a><br/></td></tr> +<tr class="separator:a2e6ca4857b4e45bb5ecca3ac73a01563"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab8f66d87b2c466afe29abd7d0038c1f8"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#ab8f66d87b2c466afe29abd7d0038c1f8">listSoundProperties</a></td></tr> +<tr class="memdesc:ab8f66d87b2c466afe29abd7d0038c1f8"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of soundProperties, that the source is capable of. <a href="#ab8f66d87b2c466afe29abd7d0038c1f8">More...</a><br/></td></tr> +<tr class="separator:ab8f66d87b2c466afe29abd7d0038c1f8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a161ce36395faa9faea7db1699c62c700"><td class="memItemLeft" align="right" valign="top">std::vector<br class="typebreak"/> +< <a class="el" href="namespaceam.html#a114262d77aae4ed1d2daa50a36155d3e">am_CustomConnectionFormat_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a161ce36395faa9faea7db1699c62c700">listConnectionFormats</a></td></tr> +<tr class="memdesc:a161ce36395faa9faea7db1699c62c700"><td class="mdescLeft"> </td><td class="mdescRight">This list holds information about the formats that the Source is capable of supporting when delivering audio. <a href="#a161ce36395faa9faea7db1699c62c700">More...</a><br/></td></tr> +<tr class="separator:a161ce36395faa9faea7db1699c62c700"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b62e48568f8b5ed78c82b1bcca138f7"><td class="memItemLeft" align="right" valign="top">std::vector<br class="typebreak"/> +< <a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a9b62e48568f8b5ed78c82b1bcca138f7">listMainSoundProperties</a></td></tr> +<tr class="memdesc:a9b62e48568f8b5ed78c82b1bcca138f7"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of the available mainSoundProperties. <a href="#a9b62e48568f8b5ed78c82b1bcca138f7">More...</a><br/></td></tr> +<tr class="separator:a9b62e48568f8b5ed78c82b1bcca138f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac0f66fac0b177a4196f6159d4c66fb5c"><td class="memItemLeft" align="right" valign="top">std::vector<br class="typebreak"/> +< <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#ac0f66fac0b177a4196f6159d4c66fb5c">listMainNotificationConfigurations</a></td></tr> +<tr class="memdesc:ac0f66fac0b177a4196f6159d4c66fb5c"><td class="mdescLeft"> </td><td class="mdescRight">The list of MainNotificationConfigurations. <a href="#ac0f66fac0b177a4196f6159d4c66fb5c">More...</a><br/></td></tr> +<tr class="separator:ac0f66fac0b177a4196f6159d4c66fb5c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a080cec59e7c0b8cd1d1daea73b17ac7a"><td class="memItemLeft" align="right" valign="top">std::vector<br class="typebreak"/> +< <a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Source__s.html#a080cec59e7c0b8cd1d1daea73b17ac7a">listNotificationConfigurations</a></td></tr> +<tr class="memdesc:a080cec59e7c0b8cd1d1daea73b17ac7a"><td class="mdescLeft"> </td><td class="mdescRight">The list of MainNotificationConfigurations. <a href="#a080cec59e7c0b8cd1d1daea73b17ac7a">More...</a><br/></td></tr> +<tr class="separator:a080cec59e7c0b8cd1d1daea73b17ac7a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This struct describes the attribiutes of a source. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01232">1232</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> +</div><h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="abcc899d845aa22799119ac0807bacc7f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structam_1_1am__Availability__s.html">am_Availability_s</a> am::am_Source_s::available</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This attribute reflects the availability of the source. </p> +<p>There are several reasons why a source could be not available for the moment. For example a CD player which has no CD entered in the slot can be unavailable, or a USB player with no or unreadable stick attached. Other scenarios involve the shutdown of a source because of overtemperature or over- & undervoltage. The availability consists of two informations:</p> +<p>Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01298">1298</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a57854adc822ed77c6443ec2c745820af"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a58a230b5da10699a7ce1b1f2a1c550e6">am_domainID_t</a> am::am_Source_s::domainID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The domainID is the domain the source belongs to. </p> +<p>A source can only be in one domain. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01247">1247</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a2e6ca4857b4e45bb5ecca3ac73a01563"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a9bce055a917900b33c7fa5666ec00e22">am_InterruptState_e</a> am::am_Source_s::interruptState</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Some special sources can have special behaviors, the are so called "Low Level +Interrupts". </p> +<p>Here the current status is documented. The information can be used by the AudioManagerController to react to the changes by for example lowering the volume of the mainSources. The two states are</p> +<p>IS_OFF: the interrupt is not active at the moment IS_INTERRUPTED: the interrupt is playing at the moment. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01308">1308</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a161ce36395faa9faea7db1699c62c700"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="namespaceam.html#a114262d77aae4ed1d2daa50a36155d3e">am_CustomConnectionFormat_t</a>> am::am_Source_s::listConnectionFormats</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This list holds information about the formats that the Source is capable of supporting when delivering audio. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01319">1319</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ac0f66fac0b177a4196f6159d4c66fb5c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a>> am::am_Source_s::listMainNotificationConfigurations</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The list of MainNotificationConfigurations. </p> +<p>These notifications work on the level of CommandInterface. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01330">1330</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9b62e48568f8b5ed78c82b1bcca138f7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="structam_1_1am__MainSoundProperty__s.html">am_MainSoundProperty_s</a>> am::am_Source_s::listMainSoundProperties</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the list of the available mainSoundProperties. </p> +<p>The principle is the same than with soundProperties, but they are only visible to the CommandInterface. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01325">1325</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a080cec59e7c0b8cd1d1daea73b17ac7a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="structam_1_1am__NotificationConfiguration__s.html">am_NotificationConfiguration_s</a>> am::am_Source_s::listNotificationConfigurations</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The list of MainNotificationConfigurations. </p> +<p>These notifications work on the level of RoutingInterface. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01335">1335</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ab8f66d87b2c466afe29abd7d0038c1f8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="structam_1_1am__SoundProperty__s.html">am_SoundProperty_s</a>> am::am_Source_s::listSoundProperties</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the list of soundProperties, that the source is capable of. </p> +<p>The soundProperties itself are project specific. For sources, a possible soundProperty could be navigation volume offset, for example. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01314">1314</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a85dbb09cc190834a1e10e6ac4ee5f6fb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string am::am_Source_s::name</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The name of the source. </p> +<p>Must be unique in the whole system. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01251">1251</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a11aed737b64b5216b786f0804fc23a79"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a8b8fc2ab1ac4d427ca85fe8549e6afd0">am_sourceClass_t</a> am::am_Source_s::sourceClassID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>the sourceClassID, indicates the class the source is in. </p> +<p>This information can be used by the Controller to implement different behaviour for different classes. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01257">1257</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ad224888802fabebefe6ff587412da9fd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a> am::am_Source_s::sourceID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the ID of the source, it is unique in the system. </p> +<p>There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID). </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01242">1242</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a15b7672dacb2e91fb56134766eb33a5d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#af966cbbc3b1d6e637d81a46eaa7dd358">am_SourceState_e</a> am::am_Source_s::sourceState</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The source state is an indication towards the source if it is actively heard or not. </p> +<p>The source can use this information to implement features like automatic spin down of CD's in case the CD is not the active source or AF following of a tuner that is not actively heard. The source state is set by the AudioManagerController.There are 3 possible states:</p> +<p>SS_ON: the source is active SS_OFF: the source is off SS_PAUSED: the source is paused and not active. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01269">1269</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9904977c28ce558db9c8aec2172de7b7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool am::am_Source_s::visible</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This Boolean flag indicates whether a source is visible to the commandInterface or not. </p> +<p>If the User must have the possibility to choose the source in the HMI, it must be visible. But there are also good reasons for invisible sources, for example if the source is part of a crossfader or gateway. HMI relevant changes in visible sources will be automatically reported by the daemon to the commandInterface. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01284">1284</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="add220cb377b2e4943cafac1206056296"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a0ba72fdbafaa9e886e77aa4099c281ec">am_volume_t</a> am::am_Source_s::volume</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the volume of the source. </p> +<p>It is set by the AudioManagerController. It is used to adopt different audiolevels in a system and mixing of sources (e.g. navigation hints & music). </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01275">1275</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/<a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespaceam.html">am</a></li><li class="navelem"><a class="el" href="structam_1_1am__Source__s.html">am_Source_s</a></li> + <li class="footer">Generated on Fri Sep 30 2016 14:27:22 for AudioManager by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |