summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLVoiceCommand.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLVoiceCommand.html')
-rw-r--r--docs/Classes/SDLVoiceCommand.html19
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/Classes/SDLVoiceCommand.html b/docs/Classes/SDLVoiceCommand.html
index f552e590d..95bffce60 100644
--- a/docs/Classes/SDLVoiceCommand.html
+++ b/docs/Classes/SDLVoiceCommand.html
@@ -10,7 +10,7 @@
<h3>Overview</h3>
-<p>Undocumented</p>
+<p>Voice commands available for the user to speak and be recognized by the IVI&rsquo;s voice recognition engine.</p>
<section class="section task-group-section">
@@ -56,12 +56,14 @@
-initWithVoiceCommands:handler:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithVoiceCommands</span><span class="p">:(</span><span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="../Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
+ <span class="nf">initWithVoiceCommands</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span>
+ <span class="nf">handler</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -69,5 +71,16 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>voiceCommands</dt>
+ <dd><p>The strings the user can say to activate this voice command</p></dd>
+ <dt>handler</dt>
+ <dd><p>The handler that will be called when the command is activated</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>An SDLVoiceCommand object</p>
+ </div>
</section>