docs/Classes/SDLVoiceCommand.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

<h1>SDLVoiceCommand Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-voiceCommands">voiceCommands</a></li>
  <li><a href="#section-handler">handler</a></li>
  <li><a href="#section--initWithVoiceCommands:handler:">-initWithVoiceCommands:handler:</a></li>
</ul>

<h3>Overview</h3>

<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">
  <h3 id="section-voiceCommands">
      voiceCommands
  </h3>
  
  <p>The strings the user can say to activate this voice command</p>

  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">readonly</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="n">_Nonnull</span> <span class="n">voiceCommands</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  <h3 id="section-handler">
      handler
  </h3>
  
  <p>The handler that will be called when the command is activated</p>

  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  <h3 id="section--initWithVoiceCommands:handler:">
      -initWithVoiceCommands:handler:
  </h3>
  
  <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">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>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">],</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span></code></pre>

  
  <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>