Skip to content

Commit

Permalink
Merge pull request #100 from smartdevicelink/feature/tts_chunks_file_…
Browse files Browse the repository at this point in the history
…type

Add `FILE` type to SpeechCapabilities
  • Loading branch information
joeygrover authored Oct 2, 2018
2 parents eb2ffec + 55294d2 commit 79f8b01
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions MOBILE_API.xml
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,7 @@
<element name="LHPLUS_PHONEMES" />
<element name="PRE_RECORDED" />
<element name="SILENCE" />
<element name="FILE" since="5.0" />
</enum>

<enum name="VrCapabilities" since="1.0">
Expand Down Expand Up @@ -2162,16 +2163,16 @@
</struct>

<struct name="TTSChunk" since="1.0">
<description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description>
<description>A TTS chunk, that consists of text/phonemes to speak or the name of a file to play, and a TTS type (like text or SAPI)</description>
<param name="text" minlength="0" maxlength="500" type="String" mandatory="true">
<description>
The text or phonemes to speak.
The text or phonemes to speak, or the name of the audio file to play.
May not be empty.
</description>
</param>

<param name="type" type="SpeechCapabilities" mandatory="true">
<description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description>
<description>Describes whether the TTS chunk is plain text, a specific phoneme set, or an audio file. See SpeechCapabilities</description>
</param>
</struct>

Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ Contains information about the TTS capabilities.
|`LHPLUS_PHONEMES`||
|`PRE_RECORDED`||
|`SILENCE`||
|`FILE`||


### VrCapabilities
Expand Down Expand Up @@ -1806,14 +1807,14 @@ Contains information about on-screen preset capabilities.


### TTSChunk
A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)
A TTS chunk, that consists of text/phonemes to speak or the name of a file to play, and a TTS type (like text or SAPI)

##### Parameters

| Value | Type | Mandatory | Description |
| ---------- | ---------- |:-----------: |:-----------:|
|`text`|String|True|The text or phonemes to speak. May not be empty. |
|`type`|SpeechCapabilities|True|Describes, whether it is text or a specific phoneme set. See SpeechCapabilities|
|`text`|String|True|The text or phonemes to speak, or the name of the audio file to play. May not be empty. |
|`type`|SpeechCapabilities|True|Describes whether the TTS chunk is plain text, a specific phoneme set, or an audio file. See SpeechCapabilities|


### Turn
Expand Down

0 comments on commit 79f8b01

Please # to comment.