diff options
Diffstat (limited to 'docs/Classes/SDLSpeak.html')
| -rw-r--r-- | docs/Classes/SDLSpeak.html | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/docs/Classes/SDLSpeak.html b/docs/Classes/SDLSpeak.html index 03958a86b..9dec6e060 100644 --- a/docs/Classes/SDLSpeak.html +++ b/docs/Classes/SDLSpeak.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Speaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a <q>speech-sculpted</q> phrase.</p> +<p>Speaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a “speech-sculpted” phrase.</p> <p>Receipt of the Response indicates the completion of the Speak operation, regardless of how the Speak operation may have completed (i.e. successfully, interrupted, terminated, etc.).</p> @@ -30,9 +30,9 @@ <li>SystemContext: MAIN, MENU, VR</li></p> <p><b>Notes:</b> - <li>When <i>SDLAlert</i> is issued with MENU in effect, <i>SDLAlert</i> is queued and <q>played</q> when MENU interaction is completed (i.e. SystemContext reverts to MAIN). When <i>SDLAlert - </i> is issued with VR in effect, <i>SDLAlert</i> is queued and <q>played</q> when VR interaction is completed (i.e. SystemContext reverts to MAIN)</li> - <li>When both <i>SDLAlert</i> and Speak are queued during MENU or VR, they are <q>played</q> back in the order in which they were queued, with all existing rules for <q>collisions</q> still in effect</li></p> + <li>When <i>SDLAlert</i> is issued with MENU in effect, <i>SDLAlert</i> is queued and “played” when MENU interaction is completed (i.e. SystemContext reverts to MAIN). When <i>SDLAlert + </i> is issued with VR in effect, <i>SDLAlert</i> is queued and “played” when VR interaction is completed (i.e. SystemContext reverts to MAIN)</li> + <li>When both <i>SDLAlert</i> and Speak are queued during MENU or VR, they are “played” back in the order in which they were queued, with all existing rules for “collisions” still in effect</li></p> <p><b>Additional Notes:</b> <li>Total character limit depends on platform.</li> @@ -52,12 +52,12 @@ -initWithTTS: </h3> - <p>Undocumented</p> + <p>Convenience init to create a speak message</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">initWithTTS</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsText</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">initWithTTS</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsText</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -65,17 +65,27 @@ + <h4>Parameters</h4> + <dl> + <dt>ttsText</dt> + <dd><p>The text to speak</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An SDLSpeak object</p> + </div> <h3 id="section--initWithTTSChunks:"> -initWithTTSChunks: </h3> - <p>Undocumented</p> + <p>Convenience init to create a speak message</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">initWithTTSChunks</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</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">initWithTTSChunks</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -83,6 +93,15 @@ + <h4>Parameters</h4> + <dl> + <dt>ttsChunks</dt> + <dd><p>An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An SDLSpeak object</p> + </div> <h3 id="section-ttsChunks"> ttsChunks |