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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
<!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_Converter_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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 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__Converter__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> |
<a href="structam_1_1am__Converter__s-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">am::am_Converter_s Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This struct describes the attributes of a converter.
<a href="structam_1_1am__Converter__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:a380af10e17c4128cc2fb32114454be71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a21f8ea45717692cd82c42c222a6ee3c8">am_converterID_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Converter__s.html#a380af10e17c4128cc2fb32114454be71">converterID</a></td></tr>
<tr class="memdesc:a380af10e17c4128cc2fb32114454be71"><td class="mdescLeft"> </td><td class="mdescRight">This is the ID of the converter, it is unique in the system. <a href="#a380af10e17c4128cc2fb32114454be71">More...</a><br /></td></tr>
<tr class="separator:a380af10e17c4128cc2fb32114454be71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada0809e12f50c8ead2f3b527aa1b873a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Converter__s.html#ada0809e12f50c8ead2f3b527aa1b873a">name</a></td></tr>
<tr class="memdesc:ada0809e12f50c8ead2f3b527aa1b873a"><td class="mdescLeft"> </td><td class="mdescRight">The name of the converter. <a href="#ada0809e12f50c8ead2f3b527aa1b873a">More...</a><br /></td></tr>
<tr class="separator:ada0809e12f50c8ead2f3b527aa1b873a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee7bf298d5962d654d609b8c881d803a"><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__Converter__s.html#aee7bf298d5962d654d609b8c881d803a">sinkID</a></td></tr>
<tr class="memdesc:aee7bf298d5962d654d609b8c881d803a"><td class="mdescLeft"> </td><td class="mdescRight">The sinkID of the convertersink-end. <a href="#aee7bf298d5962d654d609b8c881d803a">More...</a><br /></td></tr>
<tr class="separator:aee7bf298d5962d654d609b8c881d803a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e66c234376aa4fce173cfdc3aebff82"><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__Converter__s.html#a7e66c234376aa4fce173cfdc3aebff82">sourceID</a></td></tr>
<tr class="memdesc:a7e66c234376aa4fce173cfdc3aebff82"><td class="mdescLeft"> </td><td class="mdescRight">The sourceID of the converter sink-end. <a href="#a7e66c234376aa4fce173cfdc3aebff82">More...</a><br /></td></tr>
<tr class="separator:a7e66c234376aa4fce173cfdc3aebff82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a129050d36e5f1710bed87e4490e7eb34"><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__Converter__s.html#a129050d36e5f1710bed87e4490e7eb34">domainID</a></td></tr>
<tr class="memdesc:a129050d36e5f1710bed87e4490e7eb34"><td class="mdescLeft"> </td><td class="mdescRight">This is the ID of the domain that registers the converter. <a href="#a129050d36e5f1710bed87e4490e7eb34">More...</a><br /></td></tr>
<tr class="separator:a129050d36e5f1710bed87e4490e7eb34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bcc326c4059a8edf73665f618bf6c75"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="namespaceam.html#a114262d77aae4ed1d2daa50a36155d3e">am_CustomConnectionFormat_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Converter__s.html#a1bcc326c4059a8edf73665f618bf6c75">listSourceFormats</a></td></tr>
<tr class="memdesc:a1bcc326c4059a8edf73665f618bf6c75"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of available formats on the source side of the converter. <a href="#a1bcc326c4059a8edf73665f618bf6c75">More...</a><br /></td></tr>
<tr class="separator:a1bcc326c4059a8edf73665f618bf6c75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15cc5a4dd74ae27aa51f18a89ce01a1a"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="namespaceam.html#a114262d77aae4ed1d2daa50a36155d3e">am_CustomConnectionFormat_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Converter__s.html#a15cc5a4dd74ae27aa51f18a89ce01a1a">listSinkFormats</a></td></tr>
<tr class="memdesc:a15cc5a4dd74ae27aa51f18a89ce01a1a"><td class="mdescLeft"> </td><td class="mdescRight">This is the list of available formats on the sink side of the gateway. <a href="#a15cc5a4dd74ae27aa51f18a89ce01a1a">More...</a><br /></td></tr>
<tr class="separator:a15cc5a4dd74ae27aa51f18a89ce01a1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab34ebf10f1a75f304f931788ffc1691d"><td class="memItemLeft" align="right" valign="top">std::vector< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__Converter__s.html#ab34ebf10f1a75f304f931788ffc1691d">convertionMatrix</a></td></tr>
<tr class="memdesc:ab34ebf10f1a75f304f931788ffc1691d"><td class="mdescLeft"> </td><td class="mdescRight">This is matrix holding information about the conversion capability of the converter, it's length is defined by the length(listSinkFormats) x length(listSourceFormats). <a href="#ab34ebf10f1a75f304f931788ffc1691d">More...</a><br /></td></tr>
<tr class="separator:ab34ebf10f1a75f304f931788ffc1691d"><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 attributes of a converter. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00606">606</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="a380af10e17c4128cc2fb32114454be71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceam.html#a21f8ea45717692cd82c42c222a6ee3c8">am_converterID_t</a> am::am_Converter_s::converterID</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the ID of the converter, 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#l00616">616</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab34ebf10f1a75f304f931788ffc1691d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<bool> am::am_Converter_s::convertionMatrix</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is matrix holding information about the conversion capability of the converter, it's length is defined by the length(listSinkFormats) x length(listSourceFormats). </p>
<p>If a SinkFormat can be converted into a SourceFormat, the vector will hold a 1, if no conversion is possible, a 0. The data is stored row orientated, where the rows are related to the sinksFormats and the columns to the sourceFormats. The first value will hold the conversion information from the first sourceFormat to the first sinkFormat for example and the seventh value the information about the 3rd sinkFormat to the 1st sourceFormat in case we would have 3 sourceFormats.</p>
<p>This matrix 110 011 000 111 001</p>
<p>reads as this: Source ** 1 2 3 </p><hr/>
<p> S 1* 1 1 0 i 2* 0 1 1 n 3* 0 0 0 k 4* 1 1 1 5* 0 0 1 </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00682">682</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="a129050d36e5f1710bed87e4490e7eb34"></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_Converter_s::domainID</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the ID of the domain that registers the converter. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00644">644</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="a15cc5a4dd74ae27aa51f18a89ce01a1a"></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_Converter_s::listSinkFormats</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the list of available formats on the sink side of the gateway. </p>
<p>It is not defined during the converter registration but copied from the sink registration. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00656">656</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1bcc326c4059a8edf73665f618bf6c75"></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_Converter_s::listSourceFormats</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the list of available formats on the source side of the converter. </p>
<p>It is not defined during the gateway registration but copied from the source registration. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00650">650</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="ada0809e12f50c8ead2f3b527aa1b873a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string am::am_Converter_s::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of the converter. </p>
<p>Must be unique in the whole system. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00620">620</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="aee7bf298d5962d654d609b8c881d803a"></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_Converter_s::sinkID</td>
</tr>
</table>
</div><div class="memdoc">
<p>The sinkID of the convertersink-end. </p>
<p>The sink is a full blown sink with connectionFormats, sinkClassIDs etc... It makes sense to register the sinks of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with the ones in the conversionMatrix. If the sink is located in the controllingDomain, the ID needs to be retrieved by registering the sink before registering the gateway. In case the sink is in a different domain, the ID needs to be retrieved via peeking. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00630">630</a> of file <a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e66c234376aa4fce173cfdc3aebff82"></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_Converter_s::sourceID</td>
</tr>
</table>
</div><div class="memdoc">
<p>The sourceID of the converter sink-end. </p>
<p>The sink is a full blown source with connectionFormats, sinkClassIDs etc... It makes sense to register the sources of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with the ones in the conversionMatrix. If the source is located in the controllingDomain, the ID needs to be retrieved by registering the source before registering the gateway. In case the source is in a different domain, the ID needs to be retrieved via peeking. </p>
<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l00640">640</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__Converter__s.html">am_Converter_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>
|
