weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2026-08-07 05:30:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto commit by GitHub Actions Workflow

Browse Source
This commit is contained in:
MooseBotter
2026-03-22 15:34:41 +00:00
parent ac85dce00b
commit 0a4151cc15
26 changed files with 1390 additions and 863 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/Sound.SRS.html
+263 -51
View File
@@ -1918,6 +1918,30 @@ atis:Start()
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).Provider">MSRS.Provider</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).SRSTranslate">MSRS.SRSTranslate</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).SRSTranslateLanguage">MSRS.SRSTranslateLanguage</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).SRSTranslateProvider">MSRS.SRSTranslateProvider</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).SetAutoTranslate">MSRS:SetAutoTranslate(Provider, Language)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Auto-translate messages on-the-fly with Hound Translate services.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2080,6 +2104,12 @@ atis:Start()
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).SetTTSProviderGoogle">MSRS:SetTTSProviderGoogle()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Use Google to provide text-to-speech.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).SetTTSProviderKitten">MSRS:SetTTSProviderKitten()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Use Kitten to provide text-to-speech.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2191,21 +2221,27 @@ atis:Start()
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundSpeechTime">MSRS._HoundSpeechTime(MSRS, Message, Speed, UseGoogle, self)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundSpeechTime">MSRS:_HoundSpeechTime(Message, Speed, UseGoogle)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Hound speech time calculator.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundTestTone">MSRS._HoundTestTone(MSRS, Frequencies, Modulations, Coalition, self)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundTestTone">MSRS:_HoundTestTone(Frequencies, Modulations, Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Hound Test Tone function, sends a 2-second 440 Hz sine wave tone directly over SRS, bypassing the TTS engine entirely.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundTextToSpeech">MSRS:_HoundTextToSpeech(Message, Frequencies, Modulations, Volume, Label, Coalition, Point, Speed, Gender, Culture, Voice, UseGoogle, Speaker)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundTextToSpeech">MSRS:_HoundTextToSpeech(Message, Frequencies, Modulations, Volume, Label, Coalition, Point, Speed, Gender, Culture, Voice, UseGoogle, Speaker, Translated)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Hound TTS Function Wrapper</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS)._HoundTranslate">MSRS._HoundTranslate(Message, Parameters, CallbackFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Hound text translator.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3069,6 +3105,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.Provider).GOOGLE">MSRS.Provider.GOOGLE</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Google (<code>gcloud</code>).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.Provider).KITTEN">MSRS.Provider.KITTEN</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Kitten voice server. Only possible with Hound-TTS backend.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4178,6 +4220,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(MSRS).SRSTranslate" ><strong>MSRS.SRSTranslate</strong></a>
</div>
</div>
@@ -5538,6 +5591,66 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS).SetAutoTranslate" ><strong>MSRS:SetAutoTranslate(Provider, Language)</strong></a></h2>
</div>
<p>Auto-translate messages on-the-fly with Hound Translate services.</p>
<p>Tested with google cloud.</p>
<div id= "#Functions##SetAutoTranslate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>MSRS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Provider</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Provider to be used. Defaults to MSRS.Provider.GOOGLE. Options see <a href="https://github.com/uriba107/HoundTTS?tab=readme-ov-file">Hound Github</a></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Language</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Language to translate to, defaults to "de" (German). Takes <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</a> language codes.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(MSRS)">#MSRS</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -6725,6 +6838,39 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS).SetTTSProviderKitten" ><strong>MSRS:SetTTSProviderKitten()</strong></a></h2>
</div>
<p>Use Kitten to provide text-to-speech.</p>
<p>Only supported if used in combination with Hound-TTS as backend.</p>
<div id= "#Functions##SetTTSProviderKitten" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>MSRS</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(MSRS)">#MSRS</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -7689,7 +7835,7 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS)._HoundSpeechTime" ><strong>MSRS._HoundSpeechTime(MSRS, Message, Speed, UseGoogle, self)</strong></a></h2>
<h2><a id="#(MSRS)._HoundSpeechTime" ><strong>MSRS:_HoundSpeechTime(Message, Speed, UseGoogle)</strong></a></h2>
</div>
<p>Hound speech time calculator.</p>
@@ -7704,18 +7850,6 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
<p>MSRS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>MSRS</strong></strong>
</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
@@ -7755,16 +7889,6 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>self</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -7773,7 +7897,7 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS)._HoundTestTone" ><strong>MSRS._HoundTestTone(MSRS, Frequencies, Modulations, Coalition, self)</strong></a></h2>
<h2><a id="#(MSRS)._HoundTestTone" ><strong>MSRS:_HoundTestTone(Frequencies, Modulations, Coalition)</strong></a></h2>
</div>
<p>Hound Test Tone function, sends a 2-second 440 Hz sine wave tone directly over SRS, bypassing the TTS engine entirely.</p>
@@ -7788,18 +7912,6 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
<p>MSRS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>MSRS</strong></strong>
</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
@@ -7839,16 +7951,6 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>self</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -7857,7 +7959,7 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS)._HoundTextToSpeech" ><strong>MSRS:_HoundTextToSpeech(Message, Frequencies, Modulations, Volume, Label, Coalition, Point, Speed, Gender, Culture, Voice, UseGoogle, Speaker)</strong></a></h2>
<h2><a id="#(MSRS)._HoundTextToSpeech" ><strong>MSRS:_HoundTextToSpeech(Message, Frequencies, Modulations, Volume, Label, Coalition, Point, Speed, Gender, Culture, Voice, UseGoogle, Speaker, Translated)</strong></a></h2>
</div>
<p>Hound TTS Function Wrapper</p>
@@ -8034,7 +8136,20 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
<div class="w3-half">
<p>Speaker (Sub-Voice) for PIPER only</p>
<p>Speaker (Sub-Voice) for PIPER only.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Translated</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(INTERNAL, do not use!) Setting for the callback post translation.</p>
</div>
</div>
@@ -8050,6 +8165,81 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS)._HoundTranslate" ><strong>MSRS._HoundTranslate(Message, Parameters, CallbackFunction)</strong></a></h2>
</div>
<p>Hound text translator.</p>
<p>Use to translate a message into another language and hand the translation to a function.</p>
<div id= "#Functions##_HoundTranslate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>MSRS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Message to be translated.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Parameters</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Parameter table. Optional. Defaults to provider google and language "de". Takes ISO 639-1 language codes.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>CallbackFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function we hand the translated text to.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
MSRS._HoundTranslate("Two contacts, BULLSEYE 270 for 40",
{ provider = MSRS.Provider.GOOGLE, language = "de" },
function(translated, err)
if translated then
MESSAGE:New(translated,10):ToAll()
else
env.error("Translation failed: " .. tostring(err))
end
end)
</code></pre>
</div>
</div>
</div>
@@ -8317,6 +8507,17 @@ set the path to the exe file via <a href="##(MSRS).SetPath">MSRS.SetPath</a>.</p
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(MSRS).SRSTranslate" ><strong>MSRS.SRSTranslate</strong></a>
</div>
</div>
@@ -12535,6 +12736,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.Provider).KITTEN" ><strong>MSRS.Provider.KITTEN</strong></a>
<p>Kitten voice server. Only possible with Hound-TTS backend.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">