summaryrefslogtreecommitdiff
path: root/docs/structam_1_1am__Crossfader__s.html
blob: 2a61b193dba7ad11ed792da8a618c324f27cda6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<!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.11"/>
<title>AudioManager: am::am_Crossfader_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="navtreedata.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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">AudioManager
   &#160;<span id="projectnumber">7.6.6</span>
   </div>
   <div id="projectbrief">Native Application Runtime Environment</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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__Crossfader__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)">
</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> &#124;
<a href="structam_1_1am__Crossfader__s-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">am::am_Crossfader_s Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This struct describes the attribiutes of a crossfader.  
 <a href="structam_1_1am__Crossfader__s.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>&gt;</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:a6c6af4e70cb360d43095372dc33b1626"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aaf4c3deaf1b53aeac50503c75b4e5a31">am_crossfaderID_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a6c6af4e70cb360d43095372dc33b1626">crossfaderID</a></td></tr>
<tr class="memdesc:a6c6af4e70cb360d43095372dc33b1626"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the ID of the crossfader, it is unique in the system.  <a href="#a6c6af4e70cb360d43095372dc33b1626">More...</a><br /></td></tr>
<tr class="separator:a6c6af4e70cb360d43095372dc33b1626"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71302f7392da8e162f5eedf2714366e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#ac71302f7392da8e162f5eedf2714366e">name</a></td></tr>
<tr class="memdesc:ac71302f7392da8e162f5eedf2714366e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the crossfader.  <a href="#ac71302f7392da8e162f5eedf2714366e">More...</a><br /></td></tr>
<tr class="separator:ac71302f7392da8e162f5eedf2714366e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39d1f6023a79a1df29a941e0dee77ad9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a39d1f6023a79a1df29a941e0dee77ad9">sinkID_A</a></td></tr>
<tr class="memdesc:a39d1f6023a79a1df29a941e0dee77ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sinkID of the SinkA.  <a href="#a39d1f6023a79a1df29a941e0dee77ad9">More...</a><br /></td></tr>
<tr class="separator:a39d1f6023a79a1df29a941e0dee77ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a045ff126607c9885bb0d027570eb5710"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aac2b901ff83ee381fbe99913753e2416">am_sinkID_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a045ff126607c9885bb0d027570eb5710">sinkID_B</a></td></tr>
<tr class="memdesc:a045ff126607c9885bb0d027570eb5710"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sinkID of the SinkB.  <a href="#a045ff126607c9885bb0d027570eb5710">More...</a><br /></td></tr>
<tr class="separator:a045ff126607c9885bb0d027570eb5710"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5442753fb1a60b8d56c5a79b8989ed04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a2711516b1392ea02a7ed25fcd540a16a">am_sourceID_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a5442753fb1a60b8d56c5a79b8989ed04">sourceID</a></td></tr>
<tr class="memdesc:a5442753fb1a60b8d56c5a79b8989ed04"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sourceID of the crossfader source.  <a href="#a5442753fb1a60b8d56c5a79b8989ed04">More...</a><br /></td></tr>
<tr class="separator:a5442753fb1a60b8d56c5a79b8989ed04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31c5e07b53d3c7a8f943fef11395affa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#afc05253c20a9333f02f7a4b3f7762269">am_HotSink_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Crossfader__s.html#a31c5e07b53d3c7a8f943fef11395affa">hotSink</a></td></tr>
<tr class="memdesc:a31c5e07b53d3c7a8f943fef11395affa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This enum can have 3 states:  <a href="#a31c5e07b53d3c7a8f943fef11395affa">More...</a><br /></td></tr>
<tr class="separator:a31c5e07b53d3c7a8f943fef11395affa"><td class="memSeparator" colspan="2">&#160;</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 crossfader. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00560">560</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="a6c6af4e70cb360d43095372dc33b1626"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceam.html#aaf4c3deaf1b53aeac50503c75b4e5a31">am_crossfaderID_t</a> am::am_Crossfader_s::crossfaderID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the ID of the crossfader, 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 AudioManager daemon), 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#l00570">570</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>

</div>
</div>
<a class="anchor" id="a31c5e07b53d3c7a8f943fef11395affa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceam.html#afc05253c20a9333f02f7a4b3f7762269">am_HotSink_e</a> am::am_Crossfader_s::hotSink</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This enum can have 3 states: </p>
<p>HS_SINKA sinkA is the current hot one, sinkB is not audible HS_SINKB sinkB is the current hot one, sinkB is not audible HS_INTERMEDIATE the fader is stuck in between a cross-fading action. This could be due to an abort or an error. Before using the crossfader, it must be set to either HS_SINKA or HS_SINKB. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00599">599</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac71302f7392da8e162f5eedf2714366e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string am::am_Crossfader_s::name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The name of the crossfader. </p>
<p>Must be unique in the whole system. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00574">574</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>

</div>
</div>
<a class="anchor" id="a39d1f6023a79a1df29a941e0dee77ad9"></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_Crossfader_s::sinkID_A</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The sinkID of the SinkA. </p>
<p>Sinks shall be registered before registering the crossfader. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00579">579</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>

</div>
</div>
<a class="anchor" id="a045ff126607c9885bb0d027570eb5710"></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_Crossfader_s::sinkID_B</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The sinkID of the SinkB. </p>
<p>Sinks shall be registered before registering the crossfader. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00584">584</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5442753fb1a60b8d56c5a79b8989ed04"></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_Crossfader_s::sourceID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The sourceID of the crossfader source. </p>
<p>The source shall be registered before the crossfader. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00589">589</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__Crossfader__s.html">am_Crossfader_s</a></li>
    <li class="footer">Generated on Fri Feb 9 2018 14:50:30 for AudioManager by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>