diff options
Diffstat (limited to 'docs/structam_1_1am__Sink__s.html')
| -rw-r--r-- | docs/structam_1_1am__Sink__s.html | 429 |
1 files changed, 429 insertions, 0 deletions
diff --git a/docs/structam_1_1am__Sink__s.html b/docs/structam_1_1am__Sink__s.html new file mode 100644 index 0000000..8a3df23 --- /dev/null +++ b/docs/structam_1_1am__Sink__s.html @@ -0,0 +1,429 @@ +<!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_Sink_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__Sink__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__Sink__s-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::am_Sink_s Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This struct describes the attribiutes of a sink. + <a href="structam_1_1am__Sink__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:a3b934f91d2925407db8e0bac0db94fb1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Sink__s.html#a3b934f91d2925407db8e0bac0db94fb1">sinkID</a></td></tr> +<tr class="memdesc:a3b934f91d2925407db8e0bac0db94fb1"><td class="mdescLeft"> </td><td class="mdescRight">This is the ID of the sink, it is unique in the system. <a href="#a3b934f91d2925407db8e0bac0db94fb1">More...</a><br/></td></tr> +<tr class="separator:a3b934f91d2925407db8e0bac0db94fb1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a15f5ed66ddc508c1ab4196b11a8ff031"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Sink__s.html#a15f5ed66ddc508c1ab4196b11a8ff031">name</a></td></tr> +<tr class="memdesc:a15f5ed66ddc508c1ab4196b11a8ff031"><td class="mdescLeft"> </td><td class="mdescRight">The name of the sink. <a href="#a15f5ed66ddc508c1ab4196b11a8ff031">More...</a><br/></td></tr> +<tr class="separator:a15f5ed66ddc508c1ab4196b11a8ff031"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8505cd0b29334007bd6dd5555f482cce"><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__Sink__s.html#a8505cd0b29334007bd6dd5555f482cce">domainID</a></td></tr> +<tr class="memdesc:a8505cd0b29334007bd6dd5555f482cce"><td class="mdescLeft"> </td><td class="mdescRight">The domainID is the domain the sink belongs to. <a href="#a8505cd0b29334007bd6dd5555f482cce">More...</a><br/></td></tr> +<tr class="separator:a8505cd0b29334007bd6dd5555f482cce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af13055c029c9ca7da3f6701e1b1af418"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a2aa2a1e9d9c5a5cc4cb48b5b9c9a222f">am_sinkClass_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Sink__s.html#af13055c029c9ca7da3f6701e1b1af418">sinkClassID</a></td></tr> +<tr class="memdesc:af13055c029c9ca7da3f6701e1b1af418"><td class="mdescLeft"> </td><td class="mdescRight">The sinkClassID references to a sinkClass. <a href="#af13055c029c9ca7da3f6701e1b1af418">More...</a><br/></td></tr> +<tr class="separator:af13055c029c9ca7da3f6701e1b1af418"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad34fd3d83d674ee842dc8f432295ffbd"><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__Sink__s.html#ad34fd3d83d674ee842dc8f432295ffbd">volume</a></td></tr> +<tr class="memdesc:ad34fd3d83d674ee842dc8f432295ffbd"><td class="mdescLeft"> </td><td class="mdescRight">This is the volume of the sink. <a href="#ad34fd3d83d674ee842dc8f432295ffbd">More...</a><br/></td></tr> +<tr class="separator:ad34fd3d83d674ee842dc8f432295ffbd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a330b3bebac302af2065b2999b089dcb0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Sink__s.html#a330b3bebac302af2065b2999b089dcb0">visible</a></td></tr> +<tr class="memdesc:a330b3bebac302af2065b2999b089dcb0"><td class="mdescLeft"> </td><td class="mdescRight">This Boolean flag indicates whether a sink is visible to the commandInterface or not. <a href="#a330b3bebac302af2065b2999b089dcb0">More...</a><br/></td></tr> +<tr class="separator:a330b3bebac302af2065b2999b089dcb0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acb1a98138ddb331e8cd739bb4de2ee75"><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__Sink__s.html#acb1a98138ddb331e8cd739bb4de2ee75">available</a></td></tr> +<tr class="memdesc:acb1a98138ddb331e8cd739bb4de2ee75"><td class="mdescLeft"> </td><td class="mdescRight">This attribute reflects the availability of the sink. <a href="#acb1a98138ddb331e8cd739bb4de2ee75">More...</a><br/></td></tr> +<tr class="separator:acb1a98138ddb331e8cd739bb4de2ee75"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a96e6c7aeaa5b2b6fc0c7767e78eea68f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#af9d68f1f1b0553906df4c90e9a860ffa">am_MuteState_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Sink__s.html#a96e6c7aeaa5b2b6fc0c7767e78eea68f">muteState</a></td></tr> +<tr class="memdesc:a96e6c7aeaa5b2b6fc0c7767e78eea68f"><td class="mdescLeft"> </td><td class="mdescRight">This attribute reflects the muteState of the sink. <a href="#a96e6c7aeaa5b2b6fc0c7767e78eea68f">More...</a><br/></td></tr> +<tr class="separator:a96e6c7aeaa5b2b6fc0c7767e78eea68f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae04b205707fd16f34745c039d47cda01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Sink__s.html#ae04b205707fd16f34745c039d47cda01">mainVolume</a></td></tr> +<tr class="memdesc:ae04b205707fd16f34745c039d47cda01"><td class="mdescLeft"> </td><td class="mdescRight">This is the representation of the Volume for the commandInterface. <a href="#ae04b205707fd16f34745c039d47cda01">More...</a><br/></td></tr> +<tr class="separator:ae04b205707fd16f34745c039d47cda01"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a63bd5bf471a66d23850b0192283c10f8"><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__Sink__s.html#a63bd5bf471a66d23850b0192283c10f8">listSoundProperties</a></td></tr> +<tr class="memdesc:a63bd5bf471a66d23850b0192283c10f8"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of soundProperties, that the sink is capable of. <a href="#a63bd5bf471a66d23850b0192283c10f8">More...</a><br/></td></tr> +<tr class="separator:a63bd5bf471a66d23850b0192283c10f8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af5692eedaf4886be06f92293cd474d3e"><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__Sink__s.html#af5692eedaf4886be06f92293cd474d3e">listConnectionFormats</a></td></tr> +<tr class="memdesc:af5692eedaf4886be06f92293cd474d3e"><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="#af5692eedaf4886be06f92293cd474d3e">More...</a><br/></td></tr> +<tr class="separator:af5692eedaf4886be06f92293cd474d3e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a61592d0d7c72c080914b0445163c5553"><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__Sink__s.html#a61592d0d7c72c080914b0445163c5553">listMainSoundProperties</a></td></tr> +<tr class="memdesc:a61592d0d7c72c080914b0445163c5553"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of the available mainSoundProperties. <a href="#a61592d0d7c72c080914b0445163c5553">More...</a><br/></td></tr> +<tr class="separator:a61592d0d7c72c080914b0445163c5553"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a722057619a74a8dd8822a24f0bb75434"><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__Sink__s.html#a722057619a74a8dd8822a24f0bb75434">listMainNotificationConfigurations</a></td></tr> +<tr class="memdesc:a722057619a74a8dd8822a24f0bb75434"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of the MainNotificationConfigurations. <a href="#a722057619a74a8dd8822a24f0bb75434">More...</a><br/></td></tr> +<tr class="separator:a722057619a74a8dd8822a24f0bb75434"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af334fe986af2145236a1d1ea9002fe00"><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__Sink__s.html#af334fe986af2145236a1d1ea9002fe00">listNotificationConfigurations</a></td></tr> +<tr class="memdesc:af334fe986af2145236a1d1ea9002fe00"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of the NotificationConfigurations. <a href="#af334fe986af2145236a1d1ea9002fe00">More...</a><br/></td></tr> +<tr class="separator:af334fe986af2145236a1d1ea9002fe00"><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 sink. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01137">1137</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="acb1a98138ddb331e8cd739bb4de2ee75"></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_Sink_s::available</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This attribute reflects the availability of the sink. </p> +<p>There are several reasons why a sink could be not available for the moment: for example the shutdown of a sink because of overtemperature or over- & undervoltage. The availability consists of two pieces of information:</p> +<p>Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01186">1186</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a8505cd0b29334007bd6dd5555f482cce"></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_Sink_s::domainID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The domainID is the domain the sink belongs to. </p> +<p>A sink can only be in one domain. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01156">1156</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af5692eedaf4886be06f92293cd474d3e"></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_Sink_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#l01209">1209</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a722057619a74a8dd8822a24f0bb75434"></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_Sink_s::listMainNotificationConfigurations</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the list of the MainNotificationConfigurations. </p> +<p>These notifications work on the level of command interface. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01220">1220</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a61592d0d7c72c080914b0445163c5553"></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_Sink_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#l01215">1215</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af334fe986af2145236a1d1ea9002fe00"></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_Sink_s::listNotificationConfigurations</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the list of the NotificationConfigurations. </p> +<p>These notifications work on the level of RoutingPlugins. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01225">1225</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a63bd5bf471a66d23850b0192283c10f8"></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_Sink_s::listSoundProperties</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the list of soundProperties, that the sink is capable of. </p> +<p>The soundProperties itself are project specific. For sinks, a possible soundProperty could be for example settings. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01204">1204</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ae04b205707fd16f34745c039d47cda01"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a834886e7c3e4a2d6745ef2b59b485b00">am_mainVolume_t</a> am::am_Sink_s::mainVolume</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the representation of the Volume for the commandInterface. </p> +<p>It is used by the HMI to set the volume of a sink, the AudioManagerController has to transform this into real source and sink volumes. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01198">1198</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a96e6c7aeaa5b2b6fc0c7767e78eea68f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#af9d68f1f1b0553906df4c90e9a860ffa">am_MuteState_e</a> am::am_Sink_s::muteState</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This attribute reflects the muteState of the sink. </p> +<p>The information is not the "real" state of the sink, but the HMI representation for he commandInterface controlled by the AudioManagerController. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01192">1192</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a15f5ed66ddc508c1ab4196b11a8ff031"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string am::am_Sink_s::name</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The name of the sink. </p> +<p>Must be unique in the whole system. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01151">1151</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af13055c029c9ca7da3f6701e1b1af418"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#a2aa2a1e9d9c5a5cc4cb48b5b9c9a222f">am_sinkClass_t</a> am::am_Sink_s::sinkClassID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The sinkClassID references to a sinkClass. </p> +<p>With the help of classification, rules can be setup to define the system behaviour. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01161">1161</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a3b934f91d2925407db8e0bac0db94fb1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a> am::am_Sink_s::sinkID</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the ID of the sink, it is unique in the system. </p> +<p>There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID). </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01147">1147</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a330b3bebac302af2065b2999b089dcb0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool am::am_Sink_s::visible</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This Boolean flag indicates whether a sink 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 sinks, for example if the sink is part of a crossfader or gateway. HMI relevant changes in visible sinks will be automatically reported by the daemon to the commandInterface. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01174">1174</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ad34fd3d83d674ee842dc8f432295ffbd"></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_Sink_s::volume</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This is the volume of the sink. </p> +<p>It is set by the AudioManagerController. </p> + +<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01165">1165</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__Sink__s.html">am_Sink_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> |