MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-11-08 09:22:56 +00:00
parent 3df472f4c7
commit e96207624b
24 changed files with 925 additions and 399 deletions

View File

@@ -1712,8 +1712,6 @@ By enabling this it also allows you to utilize SSML in your text for added flexi
For more information on setting up a cloud account, visit: https://cloud.google.com/text-to-speech
Google's supported SSML reference: https://cloud.google.com/text-to-speech/docs/ssml</p>
<p><strong>NOTE on using GOOGLE TTS with SRS:</strong> You need to have the C# library installed in your SRS folder for Google to work.
You can obtain it e.g. here: <a href="https://www.nuget.org/packages/Grpc.Core">NuGet</a></p>
<p><strong>Pro-Tipp</strong> - use the command line with power shell to call DCS-SR-ExternalAudio.exe - it will tell you what is missing. <br/>
and also the Google Console error, in case you have missed a step in setting up your Google TTS. <br/>
@@ -1722,10 +1720,15 @@ Plays a message on 255AM for the blue coalition in-game.</p>
<h2>Set Voice</h2>
<p>Use a specifc voice with the <a href="##(MSRS).SetVoice">MSRS.SetVoice</a> function, e.g, <code>:SetVoice("Microsoft Hedda Desktop")</code>.
<p>Use a specific voice with the <a href="##(MSRS).SetVoice">MSRS.SetVoice</a> function, e.g, <code>:SetVoice("Microsoft Hedda Desktop")</code>.
Note that this must be installed on your windows system.
If enabling SetGoogle(), you can use voices provided by Google
Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices</p>
Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices
For voices there are enumerators in this class to help you out on voice names:</p>
<pre><code> MSRS.Voices.Microsoft -- e.g. MSRS.Voices.Microsoft.Hedda - the Microsoft enumerator contains all voices known to work with SRS
MSRS.Voices.Google -- e.g. MSRS.Voices.Google.Standard.en_AU_Standard_A or MSRS.Voices.Google.Wavenet.de_DE_Wavenet_C - The Google enumerator contains voices for EN, DE, IT, FR and ES.
</code></pre>
<h2>Set Coordinate</h2>
@@ -1776,6 +1779,18 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices</
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from MSRS</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).AddFrequencies">MSRS:AddFrequencies(Frequencies)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add frequencies.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).AddModulations">MSRS:AddModulations(Modulations)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add modulations.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).ClassName">MSRS.ClassName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
@@ -3578,6 +3593,94 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS).AddFrequencies" ><strong>MSRS:AddFrequencies(Frequencies)</strong></a></h2>
</div>
<p>Add frequencies.</p>
<div id= "#Functions##AddFrequencies" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Frequencies</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Frequencies in MHz. Can also be given as a #number if only one frequency should be used.</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>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS).AddModulations" ><strong>MSRS:AddModulations(Modulations)</strong></a></h2>
</div>
<p>Add modulations.</p>
<div id= "#Functions##AddModulations" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Modulations</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Modulations. Can also be given as a #number if only one modulation should be used.</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>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS).GetCoalition" ><strong>MSRS:GetCoalition()</strong></a></h2>
</div>