blob: deaa95d42c0148b63fb37726eb66c2fc4a7a9f87 (
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
|
<h1>SDLGlobalProperty 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-+HELPPROMPT">+HELPPROMPT</a></li>
<li><a href="#section-+TIMEOUTPROMPT">+TIMEOUTPROMPT</a></li>
<li><a href="#section-+VRHELPTITLE">+VRHELPTITLE</a></li>
<li><a href="#section-+VRHELPITEMS">+VRHELPITEMS</a></li>
<li><a href="#section-+MENUNAME">+MENUNAME</a></li>
<li><a href="#section-+MENUICON">+MENUICON</a></li>
<li><a href="#section-+KEYBOARDPROPERTIES">+KEYBOARDPROPERTIES</a></li>
</ul>
<h3>Overview</h3>
<p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).</p>
<p>@since SDL 1.0</p>
<section class="section task-group-section">
<h3 id="section-+valueOf:">
+valueOf:
</h3>
<p>Convert String to SDLGlobalProperty
- parameter: value The value of the string to get an object for
- returns: SDLGlobalProperty</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</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">valueOf</span><span class="p">(</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">SDLGlobalProperty</span><span class="o">!</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>value</dt>
<dd><p>The value of the string to get an object for</p>
</dd>
</dl>
<div>
<h4>Return Value</h4>
<p>SDLGlobalProperty</p>
</div>
<h3 id="section-+values">
+values
</h3>
<p>@abstract Store the enumeration of all possible SDLGlobalProperty
- returns: An array that store all possible SDLGlobalProperty</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">AnyObject</span><span class="p">]</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>An array that store all possible SDLGlobalProperty</p>
</div>
<h3 id="section-+HELPPROMPT">
+HELPPROMPT
</h3>
<p>@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction.
- returns: A SDLGlobalProperty with value of <em>HELPPROMPT</em></p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</span> <span class="o">*</span><span class="p">)</span><span class="n">HELPPROMPT</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="kt">HELPPROMPT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLGlobalProperty</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>A SDLGlobalProperty with value of <em>HELPPROMPT</em></p>
</div>
<h3 id="section-+TIMEOUTPROMPT">
+TIMEOUTPROMPT
</h3>
<p>@abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input.
- returns: A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</span> <span class="o">*</span><span class="p">)</span><span class="n">TIMEOUTPROMPT</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="kt">TIMEOUTPROMPT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLGlobalProperty</span><span class="o">!</span></code></pre>
<div>
<h4>Return Value</h4>
<p>A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p>
</div>
<h3 id="section-+VRHELPTITLE">
+VRHELPTITLE
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
<h3 id="section-+VRHELPITEMS">
+VRHELPITEMS
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
<h3 id="section-+MENUNAME">
+MENUNAME
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
<h3 id="section-+MENUICON">
+MENUICON
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
<h3 id="section-+KEYBOARDPROPERTIES">
+KEYBOARDPROPERTIES
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
</section>
|
