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
|
<h1>SDLHMILevel Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-+valueOf:">+valueOf:</a></li>
<li><a href="#section-+values">+values</a></li>
<li><a href="#section-+FULL">+FULL</a></li>
<li><a href="#section-+LIMITED">+LIMITED</a></li>
<li><a href="#section-+BACKGROUND">+BACKGROUND</a></li>
<li><a href="#section-+NONE">+NONE</a></li>
</ul>
<h3>Overview</h3>
<p>Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing <q>focus</q> to other applications (e.g. phone, other mobile applications, etc.)</p>
<p>@since SDL 1.0</p>
<section class="section task-group-section">
<h3 id="section-+valueOf:">
+valueOf:
</h3>
<p>Return HMILevel status (FULL, LIMITED, BACKGROUND, NONE)</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>value</dt>
<dd><p>String value to retrieve the object for</p>
</dd>
</dl>
<div>
<h4>Return Value</h4>
<p>Current HMI level</p>
</div>
<h3 id="section-+values">
+values
</h3>
<p>Store all possible SDLHMILevel values</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>an array with all possible HMILevel values inside</p>
</div>
<h3 id="section-+FULL">
+FULL
</h3>
<p>The application has full use of the SDL HMI. The app may output via TTS, display, or streaming audio and may gather input via VR, Menu, and button presses</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">FULL</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">full</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>the HMILevel with value of <em>FULL</em></p>
</div>
<h3 id="section-+LIMITED">
+LIMITED
</h3>
<p>This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application’s <i>Show</i> text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">LIMITED</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">limited</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>the HMILevel with value of <em>LIMITED</em></p>
</div>
<h3 id="section-+BACKGROUND">
+BACKGROUND
</h3>
<p>App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:</p>
<p>@discussion <ul>
<li>Operation : AddCommand</li>
<li>Operation : DeleteCommand</li>
<li>Operation : AddSubMenu</li>
<li>Operation : DeleteSubMenu</li>
<li>Operation : CreateInteractionChoiceSet</li>
<li>Operation : DeleteInteractionChoiceSet</li>
<li>Operation : SubscribeButton</li>
<li>Operation : UnsubscribeButton</li>
<li>Operation : Show</li>
<li>Operation : UnregisterAppInterface</li>
<li>Operation : ResetGlobalProperties</li>
<li>Operation : SetGlobalProperties</li>
</ul></p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">BACKGROUND</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">background</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>the HMILevel with value of <em>BACKGROUND</em></p>
</div>
<h3 id="section-+NONE">
+NONE
</h3>
<p>Application has been discovered by SDL, but it cannot send any requests or receive any notifications</p>
<p>@discussion An HMILevel of NONE can also mean that the user has exited the application by saying <q>exit appname</q> or selecting <q>exit</q> from the application’s menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SYNC, except UnregisterAppInterface</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">NONE</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">none</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>the HMILevel with value of <em>NONE</em></p>
</div>
</section>
|
