docs/structam_1_1am__NotificationConfiguration__s.html


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

<!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_NotificationConfiguration_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__NotificationConfiguration__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__NotificationConfiguration__s-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">am::am_NotificationConfiguration_s Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This struct holds information about the configuration for notifications.  
 <a href="structam_1_1am__NotificationConfiguration__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:ab3c479eda9f228cd981e217142ea84bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#ae29e007a0f5fc513c41d0814cc75fd13">am_CustomNotificationType_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__NotificationConfiguration__s.html#ab3c479eda9f228cd981e217142ea84bf">type</a></td></tr>
<tr class="memdesc:ab3c479eda9f228cd981e217142ea84bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The notification type of the notification.  <a href="#ab3c479eda9f228cd981e217142ea84bf">More...</a><br /></td></tr>
<tr class="separator:ab3c479eda9f228cd981e217142ea84bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a572962899f2aa344051a41eaebd71ddc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#a0ee627be6336efc1a44378ecdc972cd3">am_NotificationStatus_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__NotificationConfiguration__s.html#a572962899f2aa344051a41eaebd71ddc">status</a></td></tr>
<tr class="memdesc:a572962899f2aa344051a41eaebd71ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Notification status.  <a href="#a572962899f2aa344051a41eaebd71ddc">More...</a><br /></td></tr>
<tr class="separator:a572962899f2aa344051a41eaebd71ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc567830bd6c0d470b344a62d51bd5d0"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__NotificationConfiguration__s.html#abc567830bd6c0d470b344a62d51bd5d0">parameter</a></td></tr>
<tr class="memdesc:abc567830bd6c0d470b344a62d51bd5d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This gives additional information to the notification status.  <a href="#abc567830bd6c0d470b344a62d51bd5d0">More...</a><br /></td></tr>
<tr class="separator:abc567830bd6c0d470b344a62d51bd5d0"><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 holds information about the configuration for notifications. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01109">1109</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="abc567830bd6c0d470b344a62d51bd5d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int16_t am::am_NotificationConfiguration_s::parameter</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This gives additional information to the notification status. </p>
<p>Relation between notification status and the value: NS_PERIODIC - the period in ms NS_MINIMUM - the minimum value that triggers the notification NS_MAXIMUM - the maximum value that triggers the notifcation NS_CHANGE - the resolution of the change value </p>

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

</div>
</div>
<a class="anchor" id="a572962899f2aa344051a41eaebd71ddc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceam.html#a0ee627be6336efc1a44378ecdc972cd3">am_NotificationStatus_e</a> am::am_NotificationConfiguration_s::status</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The Notification status. </p>
<p>This can be periodic, min/max value based or even off for example </p>

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

</div>
</div>
<a class="anchor" id="ab3c479eda9f228cd981e217142ea84bf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceam.html#ae29e007a0f5fc513c41d0814cc75fd13">am_CustomNotificationType_t</a> am::am_NotificationConfiguration_s::type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The notification type of the notification. </p>

<p>Definition at line <a class="el" href="audiomanagertypes_8h_source.html#l01116">1116</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__NotificationConfiguration__s.html">am_NotificationConfiguration_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>