Flash messages to player
+Flash messages to player
+Flash messages to player
+Flash messages to player
+The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +No loading happened, so we need to pickup something else.
+ @@ -4827,6 +4830,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +No loading happened, so we need to pickup something else.
+ @@ -5439,6 +5445,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +No loading happened, so we need to pickup something else.
+ @@ -6939,6 +6948,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +No loading happened, so we need to pickup something else.
+ diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 033406c59..fb816bf4c 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2754,9 +2754,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Set destination airbase for next :Route() command.
- @@ -2790,9 +2787,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a depoly mission.
- @@ -2818,9 +2812,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a pickup mission.
- @@ -4547,9 +4538,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Set destination airbase for next :Route() command.
- @@ -4583,9 +4571,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a depoly mission.
- @@ -4611,9 +4596,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a pickup mission.
- @@ -5182,9 +5164,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Set destination airbase for next :Route() command.
- @@ -5218,9 +5197,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a depoly mission.
- @@ -5246,9 +5222,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a pickup mission.
- @@ -6705,9 +6678,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Set destination airbase for next :Route() command.
- @@ -6741,9 +6711,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a depoly mission.
- @@ -6769,9 +6736,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -Aircraft is on a pickup mission.
- diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index dcf9819bc..1088c9eae 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -2911,22 +2911,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defaumeter
+kph
+meter
+kph
+meter
+kph
+meter
+kph
+Set cargo object.
+ + + +Set cargo object.
+ + + +BASE:E( {PlayerUnit:GetName(), A2GSystem } )
+BASE:E( {PlayerUnit:GetName(), A2GSystem } )
+The AI is on by default when spawning a group.
-The internal counter of the amount of spawning the has happened since SpawnStart.
-The AI is on by default when spawning a group.
-The internal counter of the amount of spawning the has happened since SpawnStart.
-Spawns a new static using a given template.
+Gets the major axis of the oval.
+Gets the major axis of the oval.
ZONE_OVAL.New(vec2, major_axis, minor_axis, angle, self, name)
Creates a new ZONE_OVAL from a center point, major axis, minor axis, and angle.
Remove drawing from F10 map
+Gets the major axis of the oval.
+Gets the major axis of the oval.
Creates a new ZONE_OVAL from a center point, major axis, minor axis, and angle.
@@ -15799,6 +15816,19 @@ When moose is loading dynamically (for moose class development), tracing is switZONE_OVAL
+ #string + name +
+Name of the zone.
+ +@@ -15851,26 +15881,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
- self -
-- name -
-Kickspeed
-Kickspeed
-Function to get the HQ object for further use
+The #DETECTION_AREAS object for AWACS
+ + + +switch alarm state RED
+The #DETECTION_AREAS object for AWACS
+switch alarm state RED
+Contains the counter how many units are currently alive.
+ +Contains the counter how many units are currently alive.
+ +Create the CSV file.
-Create the CSV file.
-Path to SRS directory.
+Path to SRS directory (only necessary if SRS exe backend is used).
Path to Google JSON-Key.
+Path to Google JSON-Key (SRS exe backend) or Google API key (DCS-gRPC backend).
Also decrease flag for section members of flight.
+Set stack flag.
Make player section lead if he was not before.
-Band modulation.
+ + + +table of CSAR unit names
-table of CSAR unit names
-table of CSAR unit names
-holds #CTLD_ENGINEERING objects
+Beacons
-tables
+Folderpath.
+noob catch
+time to repairor build a unit/group
holds #CTLD_ENGINEERING objects
+Beacons
-tables
+Folderpath.
+noob catch
+time to repairor build a unit/group
holds #CTLD_ENGINEERING objects
+Beacons
-tables
+Folderpath.
+noob catch
+time to repairor build a unit/group
Can transport crate.
+Flag for direct loading.
-Flag for direct loading.
-Main Features:
This script needs SRS version >= 1.9.6.
+The text-to-speech conversion of SRS is done via an external exe file. When this file is called, a windows cmd window is briefly opended. That puts DCS out of focus, which is annoying,
+expecially in VR but unavoidable (if you have a solution, please feel free to share!).
NOTE that this is not an issue if the mission is running on a server. +Also NOTE that using DCS-gRPC as backend will avoid the pop-up window.
-- Create a SOUNDTEXT object.
local text=SOUNDTEXT:New("All Enemies destroyed")
--- MOOSE SRS
+-- MOOSE SRS
local msrs=MSRS:New("D:\\DCS\\_SRS\\", 305, radio.modulation.AM)
-- Text-to speech with default voice after 2 seconds.
@@ -1704,34 +1719,24 @@ msrs:PlaySoundText(text, 2)
Use a specific "culture" with the MSRS.SetCulture function, e.g. :SetCulture("en-US") or :SetCulture("de-DE").
-Set Google
-
-Use Google's text-to-speech engine with the MSRS.SetGoogle function, e.g. ':SetGoogle()'.
-By enabling this it also allows you to utilize SSML in your text for added flexibility.
-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
-
-
-Pro-Tipp - use the command line with power shell to call DCS-SR-ExternalAudio.exe - it will tell you what is missing.
-and also the Google Console error, in case you have missed a step in setting up your Google TTS.
-E.g. .\DCS-SR-ExternalAudio.exe -t "Text Message" -f 255 -m AM -c 2 -s 2 -z -G "Path_To_You_Google.Json"
-Plays a message on 255AM for the blue coalition in-game.
-
Set Voice
Use a specific voice with the MSRS.SetVoice function, e.g, :SetVoice("Microsoft Hedda Desktop").
-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
-For voices there are enumerators in this class to help you out on voice names:
+Note that this must be installed on your windows system.
- 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.
+Note that you can set voices for each provider via the MSRS.SetVoiceProvider function. Also shortcuts are available, i.e.
+MSRS.SetVoiceWindows, MSRS.SetVoiceGoogle, MSRS.SetVoiceAzure and MSRS.SetVoiceAmazon.
+
+For voices there are enumerators in this class to help you out on voice names:
+
+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.
Set Coordinate
-Use MSRS.SetCoordinate to define the origin from where the transmission is broadcasted.
+Use MSRS.SetCoordinate to define the origin from where the transmission is broadcasted.
+Note that this is only a factor if SRS server has line-of-sight and/or distance limit enabled.
Set SRS Port
@@ -1745,14 +1750,72 @@ For voices there are enumerators in this class to help you out on voice names:See MSRS.LoadConfigFile for details on how to set this up.
-Set DCS-gRPC as an alternative to 'DCS-SR-ExternalAudio.exe' for TTS
+TTS Providers
+
+The default provider for generating speech from text is the native Windows TTS service. Note that you need to install the voices you want to use.
+
+Pro-Tip - use the command line with power shell to call DCS-SR-ExternalAudio.exe - it will tell you what is missing,
+and also the Google Console error, in case you have missed a step in setting up your Google TTS.
+For example, .\DCS-SR-ExternalAudio.exe -t "Text Message" -f 255 -m AM -c 2 -s 2 -z -G "Path_To_You_Google.Json"
+plays a message on 255 MHz AM for the blue coalition in-game.
+
+Google
+
+In order to use Google Cloud for TTS you need to use MSRS.SetProvider and MSRS.SetProviderOptionsGoogle functions:
+
+msrs:SetProvider(MSRS.Provider.GOOGLE)
+msrs:SetProviderOptionsGoogle(CredentialsFile, AccessKey)
+
+
+The parameter CredentialsFile is used with the default 'DCS-SR-ExternalAudio.exe' backend and must be the full path to the credentials JSON file.
+The AccessKey parameter is used with the DCS-gRPC backend (see below).
+
+You can set the voice to use with Google via MSRS.SetVoiceGoogle.
+
+When using Google it also allows you to utilize SSML in your text for more flexibility.
+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
+
+Amazon Web Service [Only DCS-gRPC backend]
+
+In order to use Amazon Web Service (ASW) for TTS you need to use MSRS.SetProvider and MSRS.SetProviderOptionsAmazon functions:
+
+msrs:SetProvider(MSRS.Provider.AMAZON)
+msrs:SetProviderOptionsAmazon(AccessKey, SecretKey, Region)
+
+
+The parameters AccessKey and SecretKey are your ASW access and secret keys, respectively. The parameter Region is your ASW region.
+
+You can set the voice to use with ASW via MSRS.SetVoiceAmazon.
+
+Microsoft Azure [Only DCS-gRPC backend]
+
+In order to use Microsoft Azure for TTS you need to use MSRS.SetProvider and MSRS.SetProviderOptionsAzure functions:
+
+msrs:SetProvider(MSRS.Provider.AZURE)
+msrs:SetProviderOptionsAmazon(AccessKey, Region)
+
+
+The parameter AccessKey is your Azure access key. The parameter Region is your Azure region.
+
+You can set the voice to use with Azure via MSRS.SetVoiceAzure.
+
+Backend
+
+The default interface to SRS is via calling the 'DCS-SR-ExternalAudio.exe'. As noted above, this has the unavoidable drawback that a pop-up briefly appears
+and DCS might be put out of focus.
+
+DCS-gRPC as an alternative to 'DCS-SR-ExternalAudio.exe' for TTS
+
+Another interface to SRS is DCS-gRPC. This does not call an exe file and therefore avoids the annoying pop-up window.
+In addition to Windows and Google cloud, it also offers Microsoft Azure and Amazon Web Service as providers for TTS.
Use MSRS.SetDefaultBackendGRPC to enable DCS-gRPC as an alternate backend for transmitting text-to-speech over SRS.
This can be useful if 'DCS-SR-ExternalAudio.exe' cannot be used in the environment, or to use Azure or AWS clouds for TTS. Note that DCS-gRPC does not (yet?) support
all of the features and options available with 'DCS-SR-ExternalAudio.exe'. Of note, only text-to-speech is supported and it it cannot be used to transmit audio files.
-DCS-gRPC must be installed and configured per the DCS-gRPC documentation and already running via either the 'autostart' mechanism
-or a Lua call to 'GRPC.load()' prior to use of the alternate DCS-gRPC backend. If a cloud TTS provider is being used, the API key must be set via the 'Config\dcs-grpc.lua'
+
DCS-gRPC must be installed and configured per the DCS-gRPC documentation and already running via either the 'autostart' mechanism
+or a Lua call to 'GRPC.load()' prior to use of the alternate DCS-gRPC backend. If a cloud TTS provider is being used, the API key must be set via the 'Config\dcs-grpc.lua'
configuration file prior DCS-gRPC being started. DCS-gRPC can be used both with DCS dedicated server and regular DCS installations.
To use the default local Windows TTS with DCS-gRPC, Windows 2019 Server (or newer) or Windows 10/11 are required. Voices for non-local languages and dialects may need to
@@ -1760,7 +1823,7 @@ be explicitly installed.
To set the MSRS class to use the DCS-gRPC backend for all future instances, call the function MSRS.SetDefaultBackendGRPC().
-Note - When using other classes that use MSRS with the alternate DCS-gRPC backend, pass them strings instead of nil values for non-applicable fields with filesystem paths,
+
Note - When using other classes that use MSRS with the alternate DCS-gRPC backend, pass them strings instead of nil values for non-applicable fields with filesystem paths,
such as the SRS path or Google credential path. This will help maximize compatibility with other classes that were written for the default backend.
Basic Play Text-To-Speech example using alternate DCS-gRPC backend (DCS-gRPC not previously started):
@@ -1770,8 +1833,8 @@ GRPC.load()
-- Select the alternate DCS-gRPC backend for new MSRS instances
MSRS.SetDefaultBackendGRPC()
-- Create a SOUNDTEXT object.
-local text=SOUNDTEXT:New("All Enemies destroyed")
--- MOOSE SRS
+local text=SOUNDTEXT:New("All Enemies destroyed")
+-- MOOSE SRS
local msrs=MSRS:New('', 305.0)
-- Text-to speech with default voice after 30 seconds.
msrs:PlaySoundText(text, 30)
@@ -1828,12 +1891,6 @@ atis:Start()
Fields and Methods inherited from MSRS
Description
-
-
-
-
-
@@ -1847,9 +1904,9 @@ atis:Start()
-
-Table containing functions and variables to enable an alternate backend to transmit to SRS.
+
@@ -1861,25 +1918,25 @@ atis:Start()
-Name of the standard config file
+Name of the standard config file.
-Path to the standard config file
+Path to the standard config file.
-
+If true if config file was loaded.
-
-
+Get currently set backend.
@@ -1889,7 +1946,7 @@ atis:Start()
-
Get frequencies.
@@ -1901,7 +1958,7 @@ atis:Start()
-
Get modulations.
@@ -1916,6 +1973,24 @@ atis:Start()
Get port.
+
+
+
+
+Get provider.
+
+
+
+
+Get provider options.
+
+
+
+
+Get voice.
@@ -1943,7 +2018,7 @@ atis:Start()
- MSRS:New(PathToSRS, Frequency, Modulation, Volume, AltBackend)
Create a new MSRS object.
@@ -1979,9 +2054,27 @@ atis:Start()
-
-Restores default SRS backend (DCS-SR-ExternalAudio.exe) to be used by all new MSRS class instances to transmit over SRS.
+
+
+
+
+
+Set backend to communicate with SRS.
+
+
+
+
+Set DCS-gRPC as backend to communicate with SRS.
+
+
+
+
+Set DCS-SR-ExternalAudio.exe as backend to communicate with SRS.
@@ -2003,21 +2096,15 @@ atis:Start()
-
-Sets an alternate SRS backend to be used by MSRS to transmit over SRS for all new MSRS class instances.
+Set the default backend.
-
-Sets DCS-gRPC as the default SRS backend for all new MSRS class instances.
-
-
-
-
-Set to use a specific voice.
+Set DCS-gRPC to be the default backend.
@@ -2035,13 +2122,13 @@ atis:Start()
-Use google text-to-speech credentials.
+[Deprecated] Use google text-to-speech credentials.
-gRPC Backend: Use google text-to-speech set the API key.
+[Deprecated] Use google text-to-speech set the API key (only for DCS-gRPC).
@@ -2066,24 +2153,96 @@ atis:Start()
Set port.
+
+
+
+
+Set provider used to generate text-to-speech.
+
+
+
+ MSRS:SetProviderOptions(Provider, CredentialsFile, AccessKey, SecretKey, Region)
+Set provider options and credentials.
+
+
+
+
+Set provider options and credentials for Amazon Web Service (ASW).
+
+
+
+
+Set provider options and credentials for Microsoft Azure.
+
+
+
+
+Set provider options and credentials for Google Cloud.
+
+
+
+
+Use Amazon Web Service (ASW) to provide text-to-speech.
+
+
+
+
+Use Microsoft Azure to provide text-to-speech.
-Use Google text-to-speech as default.
+Use Google to provide text-to-speech.
-Use Microsoft text-to-speech as default.
+Use Microsoft to provide text-to-speech.
Set to use a specific voice.
+
+
+
+
+Set to use a specific voice if Amazon Web Service is use as provider (only DCS-gRPC backend).
+
+
+
+
+Set to use a specific voice if Microsoft Azure is use as provider (only DCS-gRPC backend).
+
+
+
+
+Set to use a specific voice if Google is use as provider.
+
+
+
+
+Set to use a specific voice for a given provider.
+
+
+
+
+Set to use a specific voice if Microsoft Windows' native TTS is use as provider.
@@ -2096,6 +2255,18 @@ atis:Start()
+
+
+
+ MSRS._CreateProviderOptions(Provider, CredentialsFile, AccessKey, SecretKey, Region)
+Create MSRS.ProviderOptions.
+
+
+
+ MSRS:_DCSgRPCtts(Text, Frequencies, Gender, Culture, Voice, Volume, Label, Coordinate)
+Make DCS-gRPC API call to transmit text-to-speech over SRS.
@@ -2117,9 +2288,9 @@ atis:Start()
-
-Adds or replaces functions and variables in the current MSRS class instance to enable an alternate backends for transmitting to SRS.
+Backend used as interface to SRS (MSRS.Backend.SRSEXE or MSRS.Backend.GRPC).
@@ -2138,12 +2309,6 @@ atis:Start()
Culture. Default "en-GB".
-
-
-
-
-
@@ -2156,12 +2321,6 @@ atis:Start()
Gender. Default "female".
-
-
-
-
-Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".
@@ -2185,7 +2344,13 @@ atis:Start()
-Path to the SRS exe. This includes the final slash "/".
+Path to the SRS exe.
+
+
+
+
+Provider options. Each element is a data structure of type MSRS.ProvierOptions.
@@ -2197,25 +2362,7 @@ atis:Start()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Default provider TTS backend, e.g. "Google" or "Microsoft", default is Microsoft
+Provider of TTS (win, gcloud, azure, amazon).
@@ -2227,7 +2374,7 @@ atis:Start()
-Specific voce.
+Specific voice. Only used if no explicit provider voice specified.
@@ -2770,6 +2917,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The main event handling function...
+
+
+
+
| Fields and Methods inherited from MSRS.Backend | +Description | +
|---|---|
| + |
+ Use DCS-gRPC. + |
+
| + |
+ Use |
| Fields and Methods inherited from MSRS.Provider | +Description | +
|---|---|
| + |
+ Amazon Web Service ( |
+
| + |
+ Microsoft Azure ( |
+
| + |
+ Google ( |
+
| + |
+ Microsoft windows ( |
Google credentials JSON file (full path).
+Default voice (not used).
Access key (DCS-gRPC with Google, ASW, AZURE as provider).
+Provider.
Region.
Secret key (DCS-gRPC with ASW as provider)
Voice used.
Time interval in seconds for checking the radio queue.
+Time interval in seconds for checking the radio queue.
Volume
-| Fields and Methods inherited from MSRS_BACKEND_DCSGRPC | -Description | -
|---|---|
| - |
- A table of functions that will add or replace the default MSRS class functions. - |
-
| - |
- A table of variables that will add or replace the default MSRS class variables. - |
-
| - |
- Version number of this alternate backend. |
Table containing functions and variables to enable an alternate backend to transmit to SRS.
-Name of the standard config file
+Name of the standard config file.
Path to the standard config file
+Path to the standard config file.
Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.
+Backend used as interface to SRS (MSRS.Backend.SRSEXE or MSRS.Backend.GRPC).
+Culture. Default "en-GB".
-Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".
- -Path to the SRS exe. This includes the final slash "/".
+Path to the SRS exe.
+ +Provider options. Each element is a data structure of type MSRS.ProvierOptions.
Default provider TTS backend, e.g. "Google" or "Microsoft", default is Microsoft
+Provider of TTS (win, gcloud, azure, amazon).
Specific voce.
+Specific voice. Only used if no explicit provider voice specified.
Get currently set backend.
+ +MSRS
+#string:
+Backend.
+ +Get frequencies.
@@ -4196,20 +4372,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defauMSRS
- #table - Frequencies -
-in MHz.
+#table:
+Frequencies in MHz.
-Get modulations.
@@ -4259,18 +4432,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defauMSRS
- #table - Modulations -
-#table:
+Modulations.
+ +Get provider.
+ +Get provider options.
+ +MSRS
++ #string + Provider +
+Provider. Default is as set via MSRS.SetProvider.
+ +Provider options.
+ +Get voice.
+ +MSRS
++ #string + Provider +
+Provider. Default is the currently set provider (self.provider).
#string:
+Voice.
+ +Create a new MSRS object.
+ +Required argument is the frequency and modulation.
+Other parameters are read from the Moose_MSRS.lua config file. If you do not have that file set up you must set up and use the DCS-SR-ExternalAudio.exe (not DCS-gRPC) as backend, you need to still
+set the path to the exe file via MSRS.SetPath.
#string - PathToSRS + Path
Path to the directory, where SRS is located.
+Path to SRS directory. Default C:\\Program Files\\DCS-SimpleRadio-Standalone.
- #number - Volume + #string + Backend
Volume - 1.0 is max, 0.0 is silence
- -- #table - AltBackend -
-Optional table containing tables 'Functions' and 'Vars' which add/replace functions and variables for the MSRS instance to allow alternate backends for transmitting to SRS.
+Backend used: MSRS.Backend.SRSEXE (default) or MSRS.Backend.GRPC.
Restores default SRS backend (DCS-SR-ExternalAudio.exe) to be used by all new MSRS class instances to transmit over SRS.
+Set backend to communicate with SRS.
-There are two options:
+ +MSRS.Backend.SRSEXE: This is the default and uses the DCS-SR-ExternalAudio.exe.MSRS.Backend.GRPC: Via DCS-gRPC.MSRS
++ #string + Backend +
+Backend used. Default is MSRS.Backend.SRSEXE.
self
+ +Set DCS-gRPC as backend to communicate with SRS.
+ +#boolean:
+Returns 'true' on success.
+self
+ +Set DCS-SR-ExternalAudio.exe as backend to communicate with SRS.
MSRS
++ Backend +
+self
Set the coordinate from which the transmissions will be broadcasted.
+ +Note that this is only a factor if SRS has line-of-sight or distance enabled.
+Culture, e.g. "en-GB" (default).
+Culture, e.g. "en-GB".
Sets an alternate SRS backend to be used by MSRS to transmit over SRS for all new MSRS class instances.
+Set the default backend.
- #table Backend
A table containing a table Functions with new/replacement class functions and Vars with new/replacement variables.
#boolean:
-Returns 'true' on success.
- -Sets DCS-gRPC as the default SRS backend for all new MSRS class instances.
+Set DCS-gRPC to be the default backend.
MSRS
#boolean:
-Returns 'true' on success.
- -Set to use a specific voice.
- - -Will override gender and culture settings.
- -MSRS
-- #string - Voice -
-Voice.
- -self
- -Use google text-to-speech credentials.
+[Deprecated] Use google text-to-speech credentials.
Also sets Google as default TTS provider.
@@ -5441,7 +5759,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defaugRPC Backend: Use google text-to-speech set the API key.
+[Deprecated] Use google text-to-speech set the API key (only for DCS-gRPC).
Set path to SRS install directory.
-More precisely, path to where the DCS-
+More precisely, path to where the DCS-SR-ExternalAudio.exe is located.
Path to the directory, where the sound file is located. This does not contain a final backslash or slash.
+Path to the directory, where the sound file is located. Default is C:\\Program Files\\DCS-SimpleRadio-Standalone.
Set provider used to generate text-to-speech.
+ + +These options are available:
+ +MSRS.Provider.WINDOWS: Microsoft Windows (default)MSRS.Provider.GOOGLE: Google CloudMSRS.Provider.AZURE: Microsoft Azure (only with DCS-gRPC backend)MSRS.Provier.AMAZON: Amazone Web Service (only with DCS-gRPC backend)Note that all providers except Microsoft Windows need as additonal information the credentials of your account.
+ + +MSRS
++ #string + Provider +
+self
+ +Set provider options and credentials.
+ +MSRS
++ #string + Provider +
+Provider.
+ ++ #string + CredentialsFile +
+Full path to your credentials file. For Google this is the path to a JSON file.
+ ++ #string + AccessKey +
+Your API access key.
+ ++ #string + SecretKey +
+Your secret key.
+ ++ #string + Region +
+Region to use.
+ +Provider optionas table.
+ +Set provider options and credentials for Amazon Web Service (ASW).
+ + +Only supported in combination with DCS-gRPC as backend.
+ + +Set provider options and credentials for Microsoft Azure.
+ + +Only supported in combination with DCS-gRPC as backend.
+ + +Set provider options and credentials for Google Cloud.
+ +MSRS
++ #string + CredentialsFile +
+Full path to your credentials file. For Google this is the path to a JSON file. This is used if DCS-SR-ExternalAudio.exe is used as backend.
+ #string + AccessKey +
+Your API access key. This is necessary if DCS-gRPC is used as backend.
+ +self
+ +Use Amazon Web Service (ASW) to provide text-to-speech.
+ + +Only supported if used in combination with DCS-gRPC as backend.
+ +Use Microsoft Azure to provide text-to-speech.
+ + +Only supported if used in combination with DCS-gRPC as backend.
+ +Use Google text-to-speech as default.
+Use Google to provide text-to-speech.
Use Microsoft text-to-speech as default.
+Use Microsoft to provide text-to-speech.
Set to use a specific voice.
-Will override gender and culture settings.
+Note that this will override any gender and culture settings as a voice already has a certain gender/culture.
Set to use a specific voice if Amazon Web Service is use as provider (only DCS-gRPC backend).
+ + +Note that this will override any gender and culture settings.
+ + +Set to use a specific voice if Microsoft Azure is use as provider (only DCS-gRPC backend).
+ + +Note that this will override any gender and culture settings.
+ +MSRS
++ #string + Voice +
+Azure Voice. Default "en-US-AriaNeural".
self
+ +Set to use a specific voice if Google is use as provider.
+ + +Note that this will override any gender and culture settings.
+ +MSRS
++ #string + Voice +
+Voice. Default MSRS.Voices.Google.Standard.en_GB_Standard_A.
self
+ +Set to use a specific voice for a given provider.
+ + +Note that this will override any gender and culture settings.
+ +MSRS
++ #string + Voice +
+Voice.
+ ++ #string + Provider +
+Provider. Default is as set by MSRS.SetProvider, which itself defaults to MSRS.Provider.WINDOWS if not set.
self
+ +Set to use a specific voice if Microsoft Windows' native TTS is use as provider.
+ + +Note that this will override any gender and culture settings.
+ +MSRS
++ #string + Voice +
+Voice. Default "Microsoft Hazel Desktop".
self
+ +Create MSRS.ProviderOptions.
+ +MSRS
++ #string + Provider +
+Provider.
+ ++ #string + CredentialsFile +
+Full path to your credentials file. For Google this is the path to a JSON file.
+ ++ #string + AccessKey +
+Your API access key.
+ ++ #string + SecretKey +
+Your secret key.
+ ++ #string + Region +
+Region to use.
+ +Provider optionas table.
+ +Make DCS-gRPC API call to transmit text-to-speech over SRS.
+ +MSRS
++ #string + Text +
+Text of message to transmit (can also be SSML).
+ ++ #table + Frequencies +
+Radio frequencies to transmit on. Can also accept a number in MHz.
+ ++ #string + Gender +
+Gender.
+ ++ #string + Culture +
+Culture.
+ ++ #string + Voice +
+Voice.
+ ++ #number + Volume +
+Volume.
+ ++ #string + Label +
+Label.
+ ++ Core.Point#COORDINATE + Coordinate +
+Coordinate.
+ +self
+ +Latitude.
+Latitude (or 0 if no input coordinate was given).
Longitude.
+Longitude (or 0 if no input coordinate was given).
Altitude.
+Altitude (or 0 if no input coordinate was given).
Adds or replaces functions and variables in the current MSRS class instance to enable an alternate backends for transmitting to SRS.
- -MSRS
-- #table - A -
-table containing a table Functions with new/replacement class functions and Vars with new/replacement variables.
- Backend -
-self
- -Table containing functions and variables to enable an alternate backend to transmit to SRS.
-Name of the standard config file
+Name of the standard config file.
@@ -6194,7 +7333,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.ConfigFilePath -Path to the standard config file
+Path to the standard config file.
@@ -6205,18 +7344,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean MSRS.ConfigLoaded - - - - - -Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.
+Backend used as interface to SRS (MSRS.Backend.SRSEXE or MSRS.Backend.GRPC).
+Culture. Default "en-GB".
- - - -Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".
- -Path to the SRS exe. This includes the final slash "/".
+Path to the SRS exe.
+ +Provider options. Each element is a data structure of type MSRS.ProvierOptions.
Default provider TTS backend, e.g. "Google" or "Microsoft", default is Microsoft
+Provider of TTS (win, gcloud, azure, amazon).
Specific voce.
+Specific voice. Only used if no explicit provider voice specified.
Backend options to communicate with SRS.
+ +Use DCS-gRPC.
+ +Use DCS-SR-ExternalAudio.exe.
GRPC options
+GRPC options.
Provider options: voice, credentials
+Text-to-speech providers.
+ + +These are compatible with the DCS-gRPC conventions.
+Amazon Web Service (asw). Only possible with DCS-gRPC backend.
Microsoft Azure (azure). Only possible with DCS-gRPC backend.
Google (gcloud).
Microsoft windows (win).
Provider options.
+ +Google credentials JSON file (full path).
+ +Default voice (not used).
Access key (DCS-gRPC with Google, ASW, AZURE as provider).
+Provider.
Region.
Secret key (DCS-gRPC with ASW as provider)
Voice used.
Time interval in seconds for checking the radio queue.
+Time interval in seconds for checking the radio queue.
@@ -10164,7 +11397,7 @@ This can be used to submit multiple TTS messages and the class takes care that tThe transmission data table.
+The transmission data table.
Time interval in seconds for checking the radio queue.
+Time interval in seconds for checking the radio queue.
@@ -14309,60 +15542,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -Alternate backend for MSRS to enable text-to-speech via DCS-gRPC.
- - -A table containing functions and variables for MSRS to use DCS-gRPC DCS-gRPC 0.7.0 or newer as a backend to transmit over SRS.
-This is not a standalone class. Instead, variables and functions under the Vars and Functions tables get added to or replace MSRS variables/functions when activated.
A table of functions that will add or replace the default MSRS class functions.
- -A table of variables that will add or replace the default MSRS class variables.
- -Version number of this alternate backend.
- -Stack by pointer.
-Stack by pointer.
-Coordinate of the mark.
-Coordinate of the mark.
-Coordinate of the mark.
-