diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2866ead --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +v2.0.1 (2022-09-05) +- ModelExpiredException +- SpeechRecongnitionSettings to contain silence segmentation setting. CloudDecoder support for boost vocabulary. + +v2.0.0 (2022-08-31) +- Introduced AudioProcessorSettings and SpeechRecoginitionSettings in MicToSpeechly +- Improved support for On-device decoder on Oculus, Android, OS X (available separately from Speechly): Model bundle support, libSpeechly VAD support + +v1.0.0 +- First release \ No newline at end of file diff --git a/README.md b/README.md index d9bda7b..7f3e8d7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Speechly Client for Unity and .NET Standard 2.0 API +# Speechly Client Library for Unity and C# [Speechly](https://www.speechly.com/?utm_source=github&utm_medium=react-client&utm_campaign=text) is an API for building voice features into games, XR, applications and web sites. This client library streams audio from a Unity or .NET app to Speechly cloud API and provides a C# API for receiving real-time speech-to-text transcription and natural language understanding results. @@ -12,23 +12,19 @@ Download [speechly-client.unitypackage](https://github.com/speechly/speechly-uni ## Requirements -- A C# development environment conforming to .NET Standard 2.0 API +- A C# development environment with .NET Standard 2.0 API: - Unity 2018.1 or later (tested with 2019.4.36f1 and 2021.2.12f1) - Microsoft .NET Core 3 or later (tested with .NET 6.0.200) -## Contents of this repository - -- [speechly-client-net-standard-2.0/](speechly-client-net-standard-2.0/) contains the Speechly client library code and a sample .NET console app. -- [speechly-unity/Assets/Speechly/](speechly-unity/Assets/Speechly/) folder contains the same basic .NET Speechly client code plus Unity-specific `MicToSpeechly.cs` microphone code and Unity sample projects: - - [speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/](speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/) - - [speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/](speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/) - - [speechly-unity/Assets/SpeechlyExamples/VoiceCommands/](speechly-unity/Assets/SpeechlyExamples/VoiceCommands/) - ## Getting Started with Unity -Import `Speechly/` folder from [speechly-client.unitypackage](https://github.com/speechly/speechly-unity-dotnet/raw/main/speechly-client.unitypackage) that contains code to use Speechly cloud API. +### Installation -> If you want to skip straight to trying out a working sample scene, see [more code examples](#more-code-examples) below. +- Download [speechly-client.unitypackage](https://github.com/speechly/speechly-unity-dotnet/raw/main/speechly-client.unitypackage) +- Select Assets > Import Package > Custom Package... and select the downloaded file. +- Import `Speechly/` folder from the package to your Unity project +- Drop `MicToSpeechly` prefab to your scene hierarchy +- Select it and enter a valid token in the `App Id` field ### Unity example @@ -73,9 +69,9 @@ public class AudioFileToSpeechly : MonoBehaviour await SpeechlyClient.Initialize(decoder); // Send test audio. Callback(s) will fire and log the results. - await client.StartContext(); + await client.Start(); client.ProcessAudioFile("Assets/Speechly/00_chinese_restaurant.raw"); - await client.StopContext(); + await client.Stop(); } void Update() @@ -86,7 +82,13 @@ public class AudioFileToSpeechly : MonoBehaviour } ``` -## More code examples +## Contents of this repository + +- [speechly-client-net-standard-2.0/](speechly-client-net-standard-2.0/) contains the Speechly client library code and a sample .NET console app. +- [speechly-unity/Assets/Speechly/](speechly-unity/Assets/Speechly/) folder contains the same basic .NET Speechly client code plus Unity-specific `MicToSpeechly.cs` microphone code and Unity sample projects: + - [speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/](speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/) + - [speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/](speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/) + - [speechly-unity/Assets/SpeechlyExamples/VoiceCommands/](speechly-unity/Assets/SpeechlyExamples/VoiceCommands/) ### MicToSpeechly @@ -107,9 +109,12 @@ To enable microphone input on OS X, set `Player Settings > Settings for PC, Mac To diagnose problems with device builds, you can do the following: - First try running MicToSpeechlyScene.unity in the editor without errors. -- Change to Android player, set MicToSpeechlyScene.unity as the main scene and do a `build and run` to deploy the build to on a device. -- On terminal, do `adb logcat -s Unity:D` to follow Unity-related logs from the device. -- Run the app on device. Keep `Hold to talk` button pressed and say "ONE, TWO, THREE". Then release the button. +- Change to Android player, set MicToSpeechlyScene.unity as the main scene and do a `build and run` to deploy and start the build to on a device. +- On the terminal start following Unity-related log lines: +``` +adb logcat -s Unity:D +``` +- Use the app on device. Ensure it's listening (e.g. keep `Hold to talk` button pressed) and say "ONE, TWO, THREE". Then release the button. - You should see "ONE, TWO, THREE" displayed in the top-left corner of the screen. If not, see the terminal for errors. ### Android troubleshooting diff --git a/api/.manifest b/api/.manifest index 676a825..8f47142 100644 --- a/api/.manifest +++ b/api/.manifest @@ -2,20 +2,6 @@ "Speechly.SLUClient": "Speechly.SLUClient.yml", "Speechly.SLUClient.CloudDecoder": "Speechly.SLUClient.CloudDecoder.yml", "Speechly.SLUClient.CloudDecoder.#ctor(System.String,System.String,System.String,System.String,System.Boolean)": "Speechly.SLUClient.CloudDecoder.yml", - "Speechly.SLUClient.EnergyTresholdVAD": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.Enabled": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.Energy": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32)": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADActivation": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADControlListening": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADFrames": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADRelease": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise": "Speechly.SLUClient.EnergyTresholdVAD.yml", - "Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis": "Speechly.SLUClient.EnergyTresholdVAD.yml", "Speechly.SLUClient.IDecoder": "Speechly.SLUClient.IDecoder.yml", "Speechly.SLUClient.Segment": "Speechly.SLUClient.Segment.yml", "Speechly.SLUClient.Segment.#ctor(System.String,System.Int32)": "Speechly.SLUClient.Segment.yml", @@ -28,42 +14,63 @@ "Speechly.SLUClient.Segment.ToString(Speechly.Types.BeautifyIntent,Speechly.Types.BeautifyEntity,System.String)": "Speechly.SLUClient.Segment.yml", "Speechly.SLUClient.Segment.words": "Speechly.SLUClient.Segment.yml", "Speechly.SLUClient.SpeechlyClient": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean)": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean)": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable{System.Boolean})": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder)": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.Debug": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean)": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.IsActive": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.IsAudioStreaming": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.IsReady": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnEntity": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnIntent": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnSegmentChange": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.OnStartContext": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.OnStart": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnStartStream": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.OnStopContext": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.OnStop": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnStopStream": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnTentativeEntity": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnTentativeIntent": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnTentativeTranscript": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.OnTranscript": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.Output": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream)": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean)": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32)": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.ProcessAudioFile(System.String)": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.SamplesSent": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.Shutdown": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.StartContext(System.String)": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.Start(System.String)": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.StartStream(System.String,System.Boolean)": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.StopContext": "Speechly.SLUClient.SpeechlyClient.yml", + "Speechly.SLUClient.SpeechlyClient.Stop": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.StopStream(System.Boolean)": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.StreamSamplePos": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.SLUClient.SpeechlyClient.Update": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.UtteranceSerial": "Speechly.SLUClient.SpeechlyClient.yml", - "Speechly.SLUClient.SpeechlyClient.Vad": "Speechly.SLUClient.SpeechlyClient.yml", "Speechly.Tools": "Speechly.Tools.yml", + "Speechly.Tools.AudioProcessor": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean)": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.OnSendAudio": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.OnVadStateChange": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.Options": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.Output": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean)": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.Reset(System.Int32)": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.SendAudioDelegate": "Speechly.Tools.AudioProcessor.SendAudioDelegate.yml", + "Speechly.Tools.AudioProcessor.Start": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.Stop": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.Vad": "Speechly.Tools.AudioProcessor.yml", + "Speechly.Tools.AudioProcessor.VadChangeDelegate": "Speechly.Tools.AudioProcessor.VadChangeDelegate.yml", "Speechly.Tools.AudioTools": "Speechly.Tools.AudioTools.yml", "Speechly.Tools.AudioTools.ConvertInt16ToFloat(System.Byte[]@,System.Single[]@,System.Int32,System.Int32,System.Int32)": "Speechly.Tools.AudioTools.yml", + "Speechly.Tools.AudioTools.DbToEnergy(System.Single)": "Speechly.Tools.AudioTools.yml", "Speechly.Tools.AudioTools.Downsample(System.Single[]@,System.Single[]@,System.Int32,System.Int32,System.Int32,System.Int32)": "Speechly.Tools.AudioTools.yml", + "Speechly.Tools.AudioTools.EnergyToDb(System.Single)": "Speechly.Tools.AudioTools.yml", "Speechly.Tools.AudioTools.GetAudioPeak(System.Single[]@,System.Int32,System.Int32)": "Speechly.Tools.AudioTools.yml", "Speechly.Tools.AudioTools.GetEnergy(System.Single[]@,System.Int32,System.Int32)": "Speechly.Tools.AudioTools.yml", + "Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5": "Speechly.Tools.AudioTools.yml", + "Speechly.Tools.EnergyThresholdVAD": "Speechly.Tools.EnergyThresholdVAD.yml", + "Speechly.Tools.EnergyThresholdVAD.#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo)": "Speechly.Tools.EnergyThresholdVAD.yml", + "Speechly.Tools.EnergyThresholdVAD.Options": "Speechly.Tools.EnergyThresholdVAD.yml", + "Speechly.Tools.EnergyThresholdVAD.Output": "Speechly.Tools.EnergyThresholdVAD.yml", + "Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32)": "Speechly.Tools.EnergyThresholdVAD.yml", + "Speechly.Tools.EnergyThresholdVAD.ResetVAD": "Speechly.Tools.EnergyThresholdVAD.yml", "Speechly.Tools.JSON": "Speechly.Tools.JSON.yml", "Speechly.Tools.JSON.Parse``1(System.String,``0)": "Speechly.Tools.JSON.yml", "Speechly.Tools.JSON.ParseFromStream``1(Stream,``0)": "Speechly.Tools.JSON.yml", @@ -91,8 +98,28 @@ "Speechly.Tools.WsClient.SendBytes(ArraySegment{System.Byte})": "Speechly.Tools.WsClient.yml", "Speechly.Tools.WsClient.SendText(System.String)": "Speechly.Tools.WsClient.yml", "Speechly.Types": "Speechly.Types.yml", + "Speechly.Types.AudioInfo": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioInfo.IsSignalDetected": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioInfo.NoiseLevelDb": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioInfo.SamplesSent": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioInfo.SignalDb": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioInfo.StreamSamplePos": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioInfo.UtteranceSerial": "Speechly.Types.AudioInfo.yml", + "Speechly.Types.AudioProcessorOptions": "Speechly.Types.AudioProcessorOptions.yml", + "Speechly.Types.AudioProcessorOptions.FrameMillis": "Speechly.Types.AudioProcessorOptions.yml", + "Speechly.Types.AudioProcessorOptions.HistoryFrames": "Speechly.Types.AudioProcessorOptions.yml", + "Speechly.Types.AudioProcessorOptions.InputSampleRate": "Speechly.Types.AudioProcessorOptions.yml", + "Speechly.Types.AudioProcessorOptions.InternalSampleRate": "Speechly.Types.AudioProcessorOptions.yml", + "Speechly.Types.AudioProcessorOptions.VADControlsListening": "Speechly.Types.AudioProcessorOptions.yml", + "Speechly.Types.AudioProcessorOptions.VADSettings": "Speechly.Types.AudioProcessorOptions.yml", "Speechly.Types.BeautifyEntity": "Speechly.Types.BeautifyEntity.yml", "Speechly.Types.BeautifyIntent": "Speechly.Types.BeautifyIntent.yml", + "Speechly.Types.ContextOptions": "Speechly.Types.ContextOptions.yml", + "Speechly.Types.ContextOptions.BoostVocabulary": "Speechly.Types.ContextOptions.yml", + "Speechly.Types.ContextOptions.ShallowFusionSettings": "Speechly.Types.ContextOptions.ShallowFusionSettings.yml", + "Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary": "Speechly.Types.ContextOptions.ShallowFusionSettings.yml", + "Speechly.Types.ContextOptions.ShallowFusionSettings.Weight": "Speechly.Types.ContextOptions.ShallowFusionSettings.yml", + "Speechly.Types.ContextOptions.SilenceSegmentationMillis": "Speechly.Types.ContextOptions.yml", "Speechly.Types.Entity": "Speechly.Types.Entity.yml", "Speechly.Types.Entity.endPosition": "Speechly.Types.Entity.yml", "Speechly.Types.Entity.isFinal": "Speechly.Types.Entity.yml", @@ -104,6 +131,10 @@ "Speechly.Types.Intent.intent": "Speechly.Types.Intent.yml", "Speechly.Types.Intent.isFinal": "Speechly.Types.Intent.yml", "Speechly.Types.IntentDelegate": "Speechly.Types.IntentDelegate.yml", + "Speechly.Types.ModelExpiredException": "Speechly.Types.ModelExpiredException.yml", + "Speechly.Types.ModelExpiredException.#ctor": "Speechly.Types.ModelExpiredException.yml", + "Speechly.Types.ModelExpiredException.#ctor(System.String)": "Speechly.Types.ModelExpiredException.yml", + "Speechly.Types.ModelExpiredException.#ctor(System.String,Exception)": "Speechly.Types.ModelExpiredException.yml", "Speechly.Types.MsgCommon": "Speechly.Types.MsgCommon.yml", "Speechly.Types.MsgCommon.audio_context": "Speechly.Types.MsgCommon.yml", "Speechly.Types.MsgCommon.segment_id": "Speechly.Types.MsgCommon.yml", @@ -126,13 +157,30 @@ "Speechly.Types.MsgTranscript": "Speechly.Types.MsgTranscript.yml", "Speechly.Types.MsgTranscript.data": "Speechly.Types.MsgTranscript.yml", "Speechly.Types.SegmentChangeDelegate": "Speechly.Types.SegmentChangeDelegate.yml", - "Speechly.Types.StartContextDelegate": "Speechly.Types.StartContextDelegate.yml", + "Speechly.Types.StartDelegate": "Speechly.Types.StartDelegate.yml", + "Speechly.Types.StartMessage": "Speechly.Types.StartMessage.yml", + "Speechly.Types.StartMessage.appId": "Speechly.Types.StartMessage.yml", + "Speechly.Types.StartMessage.eventType": "Speechly.Types.StartMessage.yml", + "Speechly.Types.StartMessage.options": "Speechly.Types.StartMessage.yml", + "Speechly.Types.StartMessage.Options": "Speechly.Types.StartMessage.Options.yml", + "Speechly.Types.StartMessage.Options.silence_triggered_segmentation": "Speechly.Types.StartMessage.Options.yml", + "Speechly.Types.StartMessage.Options.vocabulary": "Speechly.Types.StartMessage.Options.yml", + "Speechly.Types.StartMessage.Options.vocabulary_bias": "Speechly.Types.StartMessage.Options.yml", "Speechly.Types.StartStreamDelegate": "Speechly.Types.StartStreamDelegate.yml", - "Speechly.Types.StopContextDelegate": "Speechly.Types.StopContextDelegate.yml", + "Speechly.Types.StopDelegate": "Speechly.Types.StopDelegate.yml", "Speechly.Types.StopStreamDelegate": "Speechly.Types.StopStreamDelegate.yml", "Speechly.Types.TentativeEntityDelegate": "Speechly.Types.TentativeEntityDelegate.yml", "Speechly.Types.TentativeTranscriptDelegate": "Speechly.Types.TentativeTranscriptDelegate.yml", "Speechly.Types.TranscriptDelegate": "Speechly.Types.TranscriptDelegate.yml", + "Speechly.Types.VADOptions": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.Enabled": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.NoiseGateDb": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.NoiseLearnHalftimeMillis": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.SignalActivation": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.SignalRelease": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.SignalSearchFrames": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.SignalSustainMillis": "Speechly.Types.VADOptions.yml", + "Speechly.Types.VADOptions.SignalToNoiseDb": "Speechly.Types.VADOptions.yml", "Speechly.Types.Word": "Speechly.Types.Word.yml", "Speechly.Types.Word.endTimestamp": "Speechly.Types.Word.yml", "Speechly.Types.Word.index": "Speechly.Types.Word.yml", diff --git a/api/Speechly.SLUClient.CloudDecoder.yml b/api/Speechly.SLUClient.CloudDecoder.yml index 738e45a..788827a 100644 --- a/api/Speechly.SLUClient.CloudDecoder.yml +++ b/api/Speechly.SLUClient.CloudDecoder.yml @@ -16,7 +16,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: CloudDecoder path: speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs @@ -24,7 +24,7 @@ items: assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\nProvides speech processing with Speechly's cloud SLU service.\n\nInternally handles authentication using https and audio streaming via secure websocket.\nAudio is streamed when listening is started with SpeechlyClient.StartContext().\nStreaming stops upon call to SpeechlyClient.StopContext().\n" + summary: "\nProvides speech processing with Speechly's cloud SLU service.\n\nInternally handles authentication using https and audio streaming via secure websocket.\nAudio is streamed when listening is started with SpeechlyClient.Start().\nStreaming stops upon call to SpeechlyClient.Stop().\n" example: [] syntax: content: 'public class CloudDecoder : IDecoder' @@ -54,11 +54,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: .ctor path: speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs - startLine: 39 + startLine: 40 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient diff --git a/api/Speechly.SLUClient.EnergyTresholdVAD.yml b/api/Speechly.SLUClient.EnergyTresholdVAD.yml deleted file mode 100644 index a32d82c..0000000 --- a/api/Speechly.SLUClient.EnergyTresholdVAD.yml +++ /dev/null @@ -1,544 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: Speechly.SLUClient.EnergyTresholdVAD - commentId: T:Speechly.SLUClient.EnergyTresholdVAD - id: EnergyTresholdVAD - parent: Speechly.SLUClient - children: - - Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - - Speechly.SLUClient.EnergyTresholdVAD.Enabled - - Speechly.SLUClient.EnergyTresholdVAD.Energy - - Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - - Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) - - Speechly.SLUClient.EnergyTresholdVAD.VADActivation - - Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - - Speechly.SLUClient.EnergyTresholdVAD.VADFrames - - Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - - Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - - Speechly.SLUClient.EnergyTresholdVAD.VADRelease - - Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - - Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - langs: - - csharp - - vb - name: EnergyTresholdVAD - nameWithType: EnergyTresholdVAD - fullName: Speechly.SLUClient.EnergyTresholdVAD - type: Class - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: EnergyTresholdVAD - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 17 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - summary: "\nAdaptive energy threshold voice activity detection (VAD) implementation.\nIt can be used to enable hands-free operation of the SLU decoder.\n\nWhen enough loud frames have been detected, VAD activates and calls StartContext automatically. When enough silent frames have been detected, the VAD deactivates after the sustain time and StopContext is called automatically. The background noise energy gradually adapts when VAD is not active.\n\nUse its public field to configure minimum energy level, signal-to-noise ratio, minimum activation time and an activation/deactivation treshold (ratio of loud to silent frames).\n" - example: [] - syntax: - content: 'public class EnergyTresholdVAD : object' - content.vb: >- - Public Class EnergyTresholdVAD - Inherits Object - inheritance: - - System.Object - modifiers.csharp: - - public - - class - modifiers.vb: - - Public - - Class -- uid: Speechly.SLUClient.EnergyTresholdVAD.Enabled - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.Enabled - id: Enabled - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: Enabled - nameWithType: EnergyTresholdVAD.Enabled - fullName: Speechly.SLUClient.EnergyTresholdVAD.Enabled - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: Enabled - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 19 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public bool Enabled - return: - type: System.Boolean - content.vb: Public Enabled As Boolean - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - id: VADMinimumEnergy - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADMinimumEnergy - nameWithType: EnergyTresholdVAD.VADMinimumEnergy - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADMinimumEnergy - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 25 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public float VADMinimumEnergy - return: - type: System.Single - content.vb: Public VADMinimumEnergy As Single - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - id: VADSignalToNoise - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADSignalToNoise - nameWithType: EnergyTresholdVAD.VADSignalToNoise - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADSignalToNoise - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 31 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public float VADSignalToNoise - return: - type: System.Single - content.vb: Public VADSignalToNoise As Single - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADFrames - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADFrames - id: VADFrames - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADFrames - nameWithType: EnergyTresholdVAD.VADFrames - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADFrames - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADFrames - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 37 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public int VADFrames - return: - type: System.Int32 - content.vb: Public VADFrames As Integer - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADActivation - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADActivation - id: VADActivation - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADActivation - nameWithType: EnergyTresholdVAD.VADActivation - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADActivation - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADActivation - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 43 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public float VADActivation - return: - type: System.Single - content.vb: Public VADActivation As Single - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADRelease - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADRelease - id: VADRelease - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADRelease - nameWithType: EnergyTresholdVAD.VADRelease - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADRelease - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADRelease - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 49 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public float VADRelease - return: - type: System.Single - content.vb: Public VADRelease As Single - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - id: VADSustainMillis - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADSustainMillis - nameWithType: EnergyTresholdVAD.VADSustainMillis - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADSustainMillis - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 55 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public int VADSustainMillis - return: - type: System.Int32 - content.vb: Public VADSustainMillis As Integer - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - id: VADNoiseHalftimeMillis - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADNoiseHalftimeMillis - nameWithType: EnergyTresholdVAD.VADNoiseHalftimeMillis - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADNoiseHalftimeMillis - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 61 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public int VADNoiseHalftimeMillis - return: - type: System.Int32 - content.vb: Public VADNoiseHalftimeMillis As Integer - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - id: VADControlListening - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: VADControlListening - nameWithType: EnergyTresholdVAD.VADControlListening - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - type: Field - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: VADControlListening - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 66 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public bool VADControlListening - return: - type: System.Boolean - content.vb: Public VADControlListening As Boolean - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: Speechly.SLUClient.EnergyTresholdVAD.Energy - commentId: P:Speechly.SLUClient.EnergyTresholdVAD.Energy - id: Energy - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: Energy - nameWithType: EnergyTresholdVAD.Energy - fullName: Speechly.SLUClient.EnergyTresholdVAD.Energy - type: Property - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: Energy - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 68 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public float Energy { get; } - parameters: [] - return: - type: System.Single - content.vb: Public ReadOnly Property Energy As Single - overload: Speechly.SLUClient.EnergyTresholdVAD.Energy* - modifiers.csharp: - - public - - get - modifiers.vb: - - Public - - ReadOnly -- uid: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - commentId: P:Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - id: BaselineEnergy - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: BaselineEnergy - nameWithType: EnergyTresholdVAD.BaselineEnergy - fullName: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - type: Property - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: BaselineEnergy - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 69 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public float BaselineEnergy { get; } - parameters: [] - return: - type: System.Single - content.vb: Public ReadOnly Property BaselineEnergy As Single - overload: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy* - modifiers.csharp: - - public - - get - modifiers.vb: - - Public - - ReadOnly -- uid: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - commentId: P:Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - id: IsSignalDetected - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: IsSignalDetected - nameWithType: EnergyTresholdVAD.IsSignalDetected - fullName: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - type: Property - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: IsSignalDetected - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 70 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public bool IsSignalDetected { get; } - parameters: [] - return: - type: System.Boolean - content.vb: Public ReadOnly Property IsSignalDetected As Boolean - overload: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected* - modifiers.csharp: - - public - - get - modifiers.vb: - - Public - - ReadOnly -- uid: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) - commentId: M:Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) - id: ProcessFrame(System.Single[],System.Int32,System.Int32) - parent: Speechly.SLUClient.EnergyTresholdVAD - langs: - - csharp - - vb - name: ProcessFrame(Single[], Int32, Int32) - nameWithType: EnergyTresholdVAD.ProcessFrame(Single[], Int32, Int32) - fullName: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[], System.Int32, System.Int32) - type: Method - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: ProcessFrame - path: speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs - startLine: 75 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public void ProcessFrame(float[] floats, int start = 0, int length = null) - parameters: - - id: floats - type: System.Single[] - - id: start - type: System.Int32 - - id: length - type: System.Int32 - content.vb: Public Sub ProcessFrame(floats As Single(), start As Integer = 0, length As Integer = Nothing) - overload: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame* - nameWithType.vb: EnergyTresholdVAD.ProcessFrame(Single(), Int32, Int32) - modifiers.csharp: - - public - modifiers.vb: - - Public - fullName.vb: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single(), System.Int32, System.Int32) - name.vb: ProcessFrame(Single(), Int32, Int32) -references: -- uid: Speechly.SLUClient - commentId: N:Speechly.SLUClient - name: Speechly.SLUClient - nameWithType: Speechly.SLUClient - fullName: Speechly.SLUClient -- uid: System.Boolean - isExternal: true - name: Boolean - nameWithType: Boolean - fullName: System.Boolean -- uid: System.Single - isExternal: true - name: Single - nameWithType: Single - fullName: System.Single -- uid: System.Int32 - isExternal: true - name: Int32 - nameWithType: Int32 - fullName: System.Int32 -- uid: Speechly.SLUClient.EnergyTresholdVAD.Energy* - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.Energy - name: Energy - nameWithType: EnergyTresholdVAD.Energy - fullName: Speechly.SLUClient.EnergyTresholdVAD.Energy -- uid: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy* - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - name: BaselineEnergy - nameWithType: EnergyTresholdVAD.BaselineEnergy - fullName: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy -- uid: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected* - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - name: IsSignalDetected - nameWithType: EnergyTresholdVAD.IsSignalDetected - fullName: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected -- uid: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame* - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame - name: ProcessFrame - nameWithType: EnergyTresholdVAD.ProcessFrame - fullName: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame -- uid: System.Single[] - isExternal: true - name: Single[] - nameWithType: Single[] - fullName: System.Single[] - nameWithType.vb: Single() - fullName.vb: System.Single() - name.vb: Single() - spec.csharp: - - uid: System.Single - name: Single - nameWithType: Single - fullName: System.Single - isExternal: true - - name: '[]' - nameWithType: '[]' - fullName: '[]' - spec.vb: - - uid: System.Single - name: Single - nameWithType: Single - fullName: System.Single - isExternal: true - - name: () - nameWithType: () - fullName: () diff --git a/api/Speechly.SLUClient.IDecoder.yml b/api/Speechly.SLUClient.IDecoder.yml index 0332be1..d27328a 100644 --- a/api/Speechly.SLUClient.IDecoder.yml +++ b/api/Speechly.SLUClient.IDecoder.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/IDecoder.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: IDecoder path: speechly-client-net-standard-2.0/Speechly/SLUClient/IDecoder.cs - startLine: 6 + startLine: 7 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient diff --git a/api/Speechly.SLUClient.Segment.yml b/api/Speechly.SLUClient.Segment.yml index d65baf1..6a6b574 100644 --- a/api/Speechly.SLUClient.Segment.yml +++ b/api/Speechly.SLUClient.Segment.yml @@ -24,7 +24,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Segment path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -61,7 +61,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: id path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -92,7 +92,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: contextId path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -123,7 +123,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: isFinal path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -154,7 +154,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: words path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -185,7 +185,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: entities path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -216,7 +216,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: intent path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -247,7 +247,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: .ctor path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -282,7 +282,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ToString path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs @@ -316,7 +316,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ToString path: speechly-client-net-standard-2.0/Speechly/SLUClient/Segment.cs diff --git a/api/Speechly.SLUClient.SpeechlyClient.yml b/api/Speechly.SLUClient.SpeechlyClient.yml index 9b6a81b..feb90b4 100644 --- a/api/Speechly.SLUClient.SpeechlyClient.yml +++ b/api/Speechly.SLUClient.SpeechlyClient.yml @@ -5,36 +5,35 @@ items: id: SpeechlyClient parent: Speechly.SLUClient children: - - Speechly.SLUClient.SpeechlyClient.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean) + - Speechly.SLUClient.SpeechlyClient.#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean) + - Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable{System.Boolean}) - Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier - - Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) + - Speechly.SLUClient.SpeechlyClient.Debug + - Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) - Speechly.SLUClient.SpeechlyClient.IsActive - Speechly.SLUClient.SpeechlyClient.IsAudioStreaming - Speechly.SLUClient.SpeechlyClient.IsReady - Speechly.SLUClient.SpeechlyClient.OnEntity - Speechly.SLUClient.SpeechlyClient.OnIntent - Speechly.SLUClient.SpeechlyClient.OnSegmentChange - - Speechly.SLUClient.SpeechlyClient.OnStartContext + - Speechly.SLUClient.SpeechlyClient.OnStart - Speechly.SLUClient.SpeechlyClient.OnStartStream - - Speechly.SLUClient.SpeechlyClient.OnStopContext + - Speechly.SLUClient.SpeechlyClient.OnStop - Speechly.SLUClient.SpeechlyClient.OnStopStream - Speechly.SLUClient.SpeechlyClient.OnTentativeEntity - Speechly.SLUClient.SpeechlyClient.OnTentativeIntent - Speechly.SLUClient.SpeechlyClient.OnTentativeTranscript - Speechly.SLUClient.SpeechlyClient.OnTranscript + - Speechly.SLUClient.SpeechlyClient.Output - Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream) - - Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + - Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) - Speechly.SLUClient.SpeechlyClient.ProcessAudioFile(System.String) - - Speechly.SLUClient.SpeechlyClient.SamplesSent - Speechly.SLUClient.SpeechlyClient.Shutdown - - Speechly.SLUClient.SpeechlyClient.StartContext(System.String) + - Speechly.SLUClient.SpeechlyClient.Start(System.String) - Speechly.SLUClient.SpeechlyClient.StartStream(System.String,System.Boolean) - - Speechly.SLUClient.SpeechlyClient.StopContext + - Speechly.SLUClient.SpeechlyClient.Stop - Speechly.SLUClient.SpeechlyClient.StopStream(System.Boolean) - - Speechly.SLUClient.SpeechlyClient.StreamSamplePos - Speechly.SLUClient.SpeechlyClient.Update - - Speechly.SLUClient.SpeechlyClient.UtteranceSerial - - Speechly.SLUClient.SpeechlyClient.Vad langs: - csharp - vb @@ -45,7 +44,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: SpeechlyClient path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -53,7 +52,7 @@ items: assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\nCreate a new Speechly Spoken Language Understading (SLU) Client to process speech and provide the results of automatic speech recogition (ASR) and natural langugage understanding (NLU) using delegates.\n\n#### Usage\n\n- Create a new SpeechlyClient instance.\n- Create an SLU decoder () and pass it to `SpeechlyClient`'s .\n- Attach delegates like to listen to and handle the SLU results.\n- Feed audio to process with .\n- (delegates are firing up as speech is processed)\n- When you don't need SLU services any more call to free resources.\n\nYou can feed audio continuously, but control when to start and stop process speech with and or\nlet voice activity detection (VAD) handle that automatically by passing to SpeechlyClient constructor.\n" + summary: "\nCreate a new Speechly Spoken Language Understading (SLU) Client to process speech and provide the results of automatic speech recogition (ASR) and natural langugage understanding (NLU) using delegates.\n\n#### Usage\n\n- Create a new SpeechlyClient instance.\n- Create an SLU decoder () and pass it to `SpeechlyClient`'s .\n- Attach delegates like to listen to and handle the SLU results.\n- Feed audio to process with .\n- (delegates are firing up as speech is processed)\n- When you don't need SLU services any more call to free resources.\n\nYou can feed audio continuously, but control when to start and stop process speech with and or\nlet voice activity detection (VAD) handle that automatically by passing to SpeechlyClient constructor.\n" example: [] syntax: content: 'public class SpeechlyClient : object' @@ -82,7 +81,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnSegmentChange path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -90,7 +89,7 @@ items: assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\nRead the combined results of automatic speech recoginition (ASR) and natural language detection (NLU).\n\nYou can control when to start and stop process speech either manually with and or\nautomatically by providing a voice activity detection (VAD) field to .\n" + summary: "\nRead the combined results of automatic speech recoginition (ASR) and natural language detection (NLU).\n\nYou can control when to start and stop process speech either manually with and or\nautomatically by providing a voice activity detection (VAD) field to .\n" example: [] syntax: content: public SegmentChangeDelegate OnSegmentChange @@ -115,7 +114,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnTentativeTranscript path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -146,7 +145,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnTranscript path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -177,7 +176,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnTentativeEntity path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -208,7 +207,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnEntity path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -239,7 +238,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnTentativeIntent path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -270,7 +269,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnIntent path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -301,7 +300,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnStartStream path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -332,7 +331,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnStopStream path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -349,68 +348,103 @@ items: - public modifiers.vb: - Public -- uid: Speechly.SLUClient.SpeechlyClient.OnStartContext - commentId: F:Speechly.SLUClient.SpeechlyClient.OnStartContext - id: OnStartContext +- uid: Speechly.SLUClient.SpeechlyClient.OnStart + commentId: F:Speechly.SLUClient.SpeechlyClient.OnStart + id: OnStart parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: OnStartContext - nameWithType: SpeechlyClient.OnStartContext - fullName: Speechly.SLUClient.SpeechlyClient.OnStartContext + name: OnStart + nameWithType: SpeechlyClient.OnStart + fullName: Speechly.SLUClient.SpeechlyClient.OnStart type: Field source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: OnStartContext + id: OnStart path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs startLine: 44 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient syntax: - content: public StartContextDelegate OnStartContext + content: public StartDelegate OnStart return: - type: Speechly.Types.StartContextDelegate - content.vb: Public OnStartContext As StartContextDelegate + type: Speechly.Types.StartDelegate + content.vb: Public OnStart As StartDelegate modifiers.csharp: - public modifiers.vb: - Public -- uid: Speechly.SLUClient.SpeechlyClient.OnStopContext - commentId: F:Speechly.SLUClient.SpeechlyClient.OnStopContext - id: OnStopContext +- uid: Speechly.SLUClient.SpeechlyClient.OnStop + commentId: F:Speechly.SLUClient.SpeechlyClient.OnStop + id: OnStop parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: OnStopContext - nameWithType: SpeechlyClient.OnStopContext - fullName: Speechly.SLUClient.SpeechlyClient.OnStopContext + name: OnStop + nameWithType: SpeechlyClient.OnStop + fullName: Speechly.SLUClient.SpeechlyClient.OnStop type: Field source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: OnStopContext + id: OnStop path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs startLine: 45 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient syntax: - content: public StopContextDelegate OnStopContext + content: public StopDelegate OnStop return: - type: Speechly.Types.StopContextDelegate - content.vb: Public OnStopContext As StopContextDelegate + type: Speechly.Types.StopDelegate + content.vb: Public OnStop As StopDelegate modifiers.csharp: - public modifiers.vb: - Public +- uid: Speechly.SLUClient.SpeechlyClient.Output + commentId: P:Speechly.SLUClient.SpeechlyClient.Output + id: Output + parent: Speechly.SLUClient.SpeechlyClient + langs: + - csharp + - vb + name: Output + nameWithType: SpeechlyClient.Output + fullName: Speechly.SLUClient.SpeechlyClient.Output + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Output + path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs + startLine: 47 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.SLUClient + syntax: + content: public AudioInfo Output { get; } + parameters: [] + return: + type: Speechly.Types.AudioInfo + content.vb: Public ReadOnly Property Output As AudioInfo + overload: Speechly.SLUClient.SpeechlyClient.Output* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly - uid: Speechly.SLUClient.SpeechlyClient.IsAudioStreaming commentId: P:Speechly.SLUClient.SpeechlyClient.IsAudioStreaming id: IsAudioStreaming @@ -425,11 +459,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: IsAudioStreaming path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 48 + startLine: 51 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -460,11 +494,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: IsReady path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 51 + startLine: 54 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -496,11 +530,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: IsActive path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 58 + startLine: 61 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -518,76 +552,6 @@ items: modifiers.vb: - Public - ReadOnly -- uid: Speechly.SLUClient.SpeechlyClient.SamplesSent - commentId: P:Speechly.SLUClient.SpeechlyClient.SamplesSent - id: SamplesSent - parent: Speechly.SLUClient.SpeechlyClient - langs: - - csharp - - vb - name: SamplesSent - nameWithType: SpeechlyClient.SamplesSent - fullName: Speechly.SLUClient.SpeechlyClient.SamplesSent - type: Property - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: SamplesSent - path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 60 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public int SamplesSent { get; } - parameters: [] - return: - type: System.Int32 - content.vb: Public ReadOnly Property SamplesSent As Integer - overload: Speechly.SLUClient.SpeechlyClient.SamplesSent* - modifiers.csharp: - - public - - get - modifiers.vb: - - Public - - ReadOnly -- uid: Speechly.SLUClient.SpeechlyClient.Vad - commentId: P:Speechly.SLUClient.SpeechlyClient.Vad - id: Vad - parent: Speechly.SLUClient.SpeechlyClient - langs: - - csharp - - vb - name: Vad - nameWithType: SpeechlyClient.Vad - fullName: Speechly.SLUClient.SpeechlyClient.Vad - type: Property - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: Vad - path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 61 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - syntax: - content: public EnergyTresholdVAD Vad { get; } - parameters: [] - return: - type: Speechly.SLUClient.EnergyTresholdVAD - content.vb: Public ReadOnly Property Vad As EnergyTresholdVAD - overload: Speechly.SLUClient.SpeechlyClient.Vad* - modifiers.csharp: - - public - - get - modifiers.vb: - - Public - - ReadOnly - uid: Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier commentId: P:Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier id: AudioInputStreamIdentifier @@ -602,7 +566,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: AudioInputStreamIdentifier path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -624,23 +588,23 @@ items: modifiers.vb: - Public - ReadOnly -- uid: Speechly.SLUClient.SpeechlyClient.UtteranceSerial - commentId: P:Speechly.SLUClient.SpeechlyClient.UtteranceSerial - id: UtteranceSerial +- uid: Speechly.SLUClient.SpeechlyClient.Debug + commentId: F:Speechly.SLUClient.SpeechlyClient.Debug + id: Debug parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: UtteranceSerial - nameWithType: SpeechlyClient.UtteranceSerial - fullName: Speechly.SLUClient.SpeechlyClient.UtteranceSerial - type: Property + name: Debug + nameWithType: SpeechlyClient.Debug + fullName: Speechly.SLUClient.SpeechlyClient.Debug + type: Field source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: UtteranceSerial + id: Debug path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs startLine: 67 assemblies: @@ -648,142 +612,98 @@ items: namespace: Speechly.SLUClient example: [] syntax: - content: public int UtteranceSerial { get; } - parameters: [] + content: public bool Debug return: - type: System.Int32 - content.vb: Public ReadOnly Property UtteranceSerial As Integer - overload: Speechly.SLUClient.SpeechlyClient.UtteranceSerial* - modifiers.csharp: - - public - - get - modifiers.vb: - - Public - - ReadOnly -- uid: Speechly.SLUClient.SpeechlyClient.StreamSamplePos - commentId: P:Speechly.SLUClient.SpeechlyClient.StreamSamplePos - id: StreamSamplePos - parent: Speechly.SLUClient.SpeechlyClient - langs: - - csharp - - vb - name: StreamSamplePos - nameWithType: SpeechlyClient.StreamSamplePos - fullName: Speechly.SLUClient.SpeechlyClient.StreamSamplePos - type: Property - source: - remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad - repo: git@github.com:speechly/speechly-unity-dotnet.git - id: StreamSamplePos - path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 70 - assemblies: - - speechly-unity-net-standard-2.0 - namespace: Speechly.SLUClient - example: [] - syntax: - content: public int StreamSamplePos { get; } - parameters: [] - return: - type: System.Int32 - content.vb: Public ReadOnly Property StreamSamplePos As Integer - overload: Speechly.SLUClient.SpeechlyClient.StreamSamplePos* + type: System.Boolean + content.vb: Public Debug As Boolean modifiers.csharp: - public - - get modifiers.vb: - Public - - ReadOnly -- uid: Speechly.SLUClient.SpeechlyClient.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean) - commentId: M:Speechly.SLUClient.SpeechlyClient.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean) - id: '#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean)' +- uid: Speechly.SLUClient.SpeechlyClient.#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean) + commentId: M:Speechly.SLUClient.SpeechlyClient.#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean) + id: '#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean)' parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: SpeechlyClient(Int32, Int32, Int32, Boolean, String, EnergyTresholdVAD, Boolean) - nameWithType: SpeechlyClient.SpeechlyClient(Int32, Int32, Int32, Boolean, String, EnergyTresholdVAD, Boolean) - fullName: Speechly.SLUClient.SpeechlyClient.SpeechlyClient(System.Int32, System.Int32, System.Int32, System.Boolean, System.String, Speechly.SLUClient.EnergyTresholdVAD, System.Boolean) + name: SpeechlyClient(Boolean, String, AudioInfo, Boolean) + nameWithType: SpeechlyClient.SpeechlyClient(Boolean, String, AudioInfo, Boolean) + fullName: Speechly.SLUClient.SpeechlyClient.SpeechlyClient(System.Boolean, System.String, Speechly.Types.AudioInfo, System.Boolean) type: Constructor source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: .ctor path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 107 + startLine: 93 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient summary: "\nCreate a new SpeechlyClient to process audio and fire delegates to provide SLU results.\n" example: [] syntax: - content: public SpeechlyClient(int frameMillis = 30, int historyFrames = 5, int inputSampleRate = 16000, bool manualUpdate = false, string saveToFolder = null, EnergyTresholdVAD vad = null, bool debug = false) + content: public SpeechlyClient(bool manualUpdate = false, string saveToFolder = null, AudioInfo output = null, bool debug = false) parameters: - - id: frameMillis - type: System.Int32 - description: 'Size of one audio frame (default: `30` ms). Total history duration will be historyFrames*frameSamples. History is sent upon StartContext to capture the start of utterance which especially important with VAD, which activates with a constant delay.' - - id: historyFrames - type: System.Int32 - description: 'Count of the audio history frames (default: `5`). Total history duration will be historyFrames * frameSamples.' - - id: inputSampleRate - type: System.Int32 - description: 'Define the sample rate of incoming audio (default: `16000`)' - id: manualUpdate type: System.Boolean description: 'Setting `manualUpdate = true` postpones SpeechlyClient's delegates (OnSegmentChange, OnTranscript...) until you manually run . This enables you to call Unity API in SpeechlyClient's delegates, as Unity API should only be used in the main Unity thread. (Default: false)' - id: saveToFolder type: System.String description: 'Defines a local folder to save utterance files as 16 bit, 16000 hZ mono raw. Null disables saving. (default: `null`)' - - id: vad - type: Speechly.SLUClient.EnergyTresholdVAD - description: ' instance to control automatic listening on/off. Null disables VAD. (default: `null`)' + - id: output + type: Speechly.Types.AudioInfo - id: debug type: System.Boolean description: 'Enable debug prints thru delegate. (default: `false`)' - content.vb: Public Sub New(frameMillis As Integer = 30, historyFrames As Integer = 5, inputSampleRate As Integer = 16000, manualUpdate As Boolean = False, saveToFolder As String = Nothing, vad As EnergyTresholdVAD = Nothing, debug As Boolean = False) + content.vb: Public Sub New(manualUpdate As Boolean = False, saveToFolder As String = Nothing, output As AudioInfo = Nothing, debug As Boolean = False) overload: Speechly.SLUClient.SpeechlyClient.#ctor* modifiers.csharp: - public modifiers.vb: - Public -- uid: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) - commentId: M:Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) - id: Initialize(Speechly.SLUClient.IDecoder) +- uid: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) + commentId: M:Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) + id: Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: Initialize(IDecoder) - nameWithType: SpeechlyClient.Initialize(IDecoder) - fullName: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) + name: Initialize(IDecoder, AudioProcessorOptions, ContextOptions, Boolean) + nameWithType: SpeechlyClient.Initialize(IDecoder, AudioProcessorOptions, ContextOptions, Boolean) + fullName: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder, Speechly.Types.AudioProcessorOptions, Speechly.Types.ContextOptions, System.Boolean) type: Method source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Initialize path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 142 + startLine: 123 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient summary: "\nSLU decoder instance to use like .\n\nThe SLU decoder provides the automatic speech recognition (ASR) and\nnatural language understanding (NLU) capabilities via SLU delegates (OnSegmentChange, OnTranscript...).\n" example: [] syntax: - content: public async Task Initialize(IDecoder decoder) + content: public async Task Initialize(IDecoder decoder, AudioProcessorOptions audioProcessorOptions = null, ContextOptions contextOptions = null, bool preferLibSpeechlyAudioProcessor = false) parameters: - id: decoder type: Speechly.SLUClient.IDecoder description: SLU decoder implementing IDecoder interface like . + - id: audioProcessorOptions + type: Speechly.Types.AudioProcessorOptions + - id: contextOptions + type: Speechly.Types.ContextOptions + - id: preferLibSpeechlyAudioProcessor + type: System.Boolean return: type: Task description: Task that completes when the decoder is ready. - content.vb: Public Function Initialize(decoder As IDecoder) As Task + content.vb: Public Function Initialize(decoder As IDecoder, audioProcessorOptions As AudioProcessorOptions = Nothing, contextOptions As ContextOptions = Nothing, preferLibSpeechlyAudioProcessor As Boolean = False) As Task overload: Speechly.SLUClient.SpeechlyClient.Initialize* modifiers.csharp: - public @@ -804,15 +724,15 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: StartStream path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 163 + startLine: 175 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\n`StartStream` should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and StartContext ensure it's been called.\n`OnStreamStart` delegate is triggered upon a call to StartStream.\n" + summary: "\n`StartStream` should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and Start ensure it's been called.\n`OnStreamStart` delegate is triggered upon a call to StartStream.\n" example: [] syntax: content: public void StartStream(string streamIdentifier, bool auto = false) @@ -841,11 +761,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: StopStream path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 182 + startLine: 197 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -862,32 +782,71 @@ items: - public modifiers.vb: - Public -- uid: Speechly.SLUClient.SpeechlyClient.StartContext(System.String) - commentId: M:Speechly.SLUClient.SpeechlyClient.StartContext(System.String) - id: StartContext(System.String) +- uid: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable{System.Boolean}) + commentId: M:Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable{System.Boolean}) + id: AdjustAudioProcessor(System.Nullable{System.Boolean}) + parent: Speechly.SLUClient.SpeechlyClient + langs: + - csharp + - vb + name: AdjustAudioProcessor(Nullable) + nameWithType: SpeechlyClient.AdjustAudioProcessor(Nullable) + fullName: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable) + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: AdjustAudioProcessor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs + startLine: 216 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.SLUClient + summary: "\nControl AudioProcessor parameters.\n" + example: [] + syntax: + content: public void AdjustAudioProcessor(bool? vadControlsListening = null) + parameters: + - id: vadControlsListening + type: System.Nullable{System.Boolean} + description: '`true` enables VAD to control listening. `false` disables VAD feature and stops listening immediately. `null` for no change.' + content.vb: Public Sub AdjustAudioProcessor(vadControlsListening As Boolean? = Nothing) + overload: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor* + nameWithType.vb: SpeechlyClient.AdjustAudioProcessor(Nullable(Of Boolean)) + modifiers.csharp: + - public + modifiers.vb: + - Public + fullName.vb: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable(Of System.Boolean)) + name.vb: AdjustAudioProcessor(Nullable(Of Boolean)) +- uid: Speechly.SLUClient.SpeechlyClient.Start(System.String) + commentId: M:Speechly.SLUClient.SpeechlyClient.Start(System.String) + id: Start(System.String) parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: StartContext(String) - nameWithType: SpeechlyClient.StartContext(String) - fullName: Speechly.SLUClient.SpeechlyClient.StartContext(System.String) + name: Start(String) + nameWithType: SpeechlyClient.Start(String) + fullName: Speechly.SLUClient.SpeechlyClient.Start(System.String) type: Method source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: StartContext + id: Start path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 208 + startLine: 241 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\nStart listening for user speech and feeding it to the SLU decoder.\n`OnContextStart` is triggered upon a call to StartContext. It's also triggered by automatic VAD activation.\n\nYou don't need to await this call if you don't need the utterance id.\n" + summary: "\nStart listening for user speech and feeding it to the SLU decoder.\n`OnContextStart` is triggered upon a call to Start. It's also triggered by automatic VAD activation.\n\nYou don't need to await this call if you don't need the utterance id.\n" example: [] syntax: - content: public Task StartContext(string appId = null) + content: public Task Start(string appId = null) parameters: - id: appId type: System.String @@ -895,8 +854,8 @@ items: return: type: Task{System.String} description: An unique utterance id. - content.vb: Public Function StartContext(appId As String = Nothing) As Task(Of String) - overload: Speechly.SLUClient.SpeechlyClient.StartContext* + content.vb: Public Function Start(appId As String = Nothing) As Task(Of String) + overload: Speechly.SLUClient.SpeechlyClient.Start* modifiers.csharp: - public modifiers.vb: @@ -915,11 +874,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ProcessAudioFile path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 243 + startLine: 280 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -934,32 +893,32 @@ items: - public modifiers.vb: - Public -- uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) - commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) - id: ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) +- uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) + commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) + id: ProcessAudio(System.Single[],System.Int32,System.Int32) parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: ProcessAudio(Single[], Int32, Int32, Boolean) - nameWithType: SpeechlyClient.ProcessAudio(Single[], Int32, Int32, Boolean) - fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[], System.Int32, System.Int32, System.Boolean) + name: ProcessAudio(Single[], Int32, Int32) + nameWithType: SpeechlyClient.ProcessAudio(Single[], Int32, Int32) + fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[], System.Int32, System.Int32) type: Method source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ProcessAudio path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 273 + startLine: 309 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\nProcess speech audio samples from a microphone or other audio source.\n\nIt's recommended to constantly feed new audio as long as you want to use Speechly's SLU services.\n\nYou can control when to start and stop process speech either manually with and or\nautomatically by providing a voice activity detection (VAD) field to .\n\nThe audio is handled as follows:\n- Downsample to 16kHz if needed\n- Add to history ringbuffer\n- Calculate energy (VAD)\n- Automatic Start/StopContext (VAD)\n- Send utterance audio to a file\n- Send utterance audio to Speechly SLU decoder\n" + summary: "\nProcess speech audio samples from a microphone or other audio source.\n\nIt's recommended to constantly feed new audio as long as you want to use Speechly's SLU services.\n\nYou can control when to start and stop process speech either manually with and or\nautomatically by providing a voice activity detection (VAD) field to .\n\nThe audio is handled as follows:\n- Downsample to 16kHz if needed\n- Add to history ringbuffer\n- Calculate energy (VAD)\n- Automatic Start/Stop (VAD)\n- Send utterance audio to a file\n- Send utterance audio to Speechly SLU decoder\n" example: [] syntax: - content: public void ProcessAudio(float[] floats, int start = 0, int length = null, bool forceSubFrameProcess = false) + content: public void ProcessAudio(float[] floats, int start = 0, int length = null) parameters: - id: floats type: System.Single[] @@ -970,18 +929,15 @@ items: - id: length type: System.Int32 description: 'Length of audio to process in samples or `-1` to process the whole array (default: `-1`).' - - id: forceSubFrameProcess - type: System.Boolean - description: ' internally uses this to force processing of last subframe at end of audio stream (default: `false`).' - content.vb: Public Sub ProcessAudio(floats As Single(), start As Integer = 0, length As Integer = Nothing, forceSubFrameProcess As Boolean = False) + content.vb: Public Sub ProcessAudio(floats As Single(), start As Integer = 0, length As Integer = Nothing) overload: Speechly.SLUClient.SpeechlyClient.ProcessAudio* - nameWithType.vb: SpeechlyClient.ProcessAudio(Single(), Int32, Int32, Boolean) + nameWithType.vb: SpeechlyClient.ProcessAudio(Single(), Int32, Int32) modifiers.csharp: - public modifiers.vb: - Public - fullName.vb: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single(), System.Int32, System.Int32, System.Boolean) - name.vb: ProcessAudio(Single(), Int32, Int32, Boolean) + fullName.vb: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single(), System.Int32, System.Int32) + name.vb: ProcessAudio(Single(), Int32, Int32) - uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream) commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream) id: ProcessAudio(Stream) @@ -996,11 +952,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ProcessAudio path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 334 + startLine: 323 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -1015,37 +971,37 @@ items: - public modifiers.vb: - Public -- uid: Speechly.SLUClient.SpeechlyClient.StopContext - commentId: M:Speechly.SLUClient.SpeechlyClient.StopContext - id: StopContext +- uid: Speechly.SLUClient.SpeechlyClient.Stop + commentId: M:Speechly.SLUClient.SpeechlyClient.Stop + id: Stop parent: Speechly.SLUClient.SpeechlyClient langs: - csharp - vb - name: StopContext() - nameWithType: SpeechlyClient.StopContext() - fullName: Speechly.SLUClient.SpeechlyClient.StopContext() + name: Stop() + nameWithType: SpeechlyClient.Stop() + fullName: Speechly.SLUClient.SpeechlyClient.Stop() type: Method source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: StopContext + id: Stop path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 412 + startLine: 376 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient - summary: "\nStop listening for user speech.\n`OnContextStop` is triggered upon a call to StopContext. It's also triggered by automatic VAD deactivation.\n\nYou don't need to await this call if you don't need the utterance id.\n" + summary: "\nStop listening for user speech.\n`OnContextStop` is triggered upon a call to Stop. It's also triggered by automatic VAD deactivation.\n\nYou don't need to await this call if you don't need the utterance id.\n" example: [] syntax: - content: public Task StopContext() + content: public Task Stop() return: type: Task{System.String} description: An unique utterance id. - content.vb: Public Function StopContext As Task(Of String) - overload: Speechly.SLUClient.SpeechlyClient.StopContext* + content.vb: Public Function Stop As Task(Of String) + overload: Speechly.SLUClient.SpeechlyClient.Stop* modifiers.csharp: - public modifiers.vb: @@ -1064,11 +1020,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Update path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 442 + startLine: 407 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -1096,11 +1052,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Shutdown path: speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs - startLine: 539 + startLine: 511 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.SLUClient @@ -1124,35 +1080,40 @@ references: name: CloudDecoder nameWithType: CloudDecoder fullName: Speechly.SLUClient.CloudDecoder -- uid: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) - commentId: M:Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) +- uid: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) + commentId: M:Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) isExternal: true - uid: Speechly.SLUClient.SpeechlyClient.OnSegmentChange commentId: F:Speechly.SLUClient.SpeechlyClient.OnSegmentChange isExternal: true -- uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) - commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) +- uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) + commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) isExternal: true - uid: Speechly.SLUClient.SpeechlyClient.Shutdown commentId: M:Speechly.SLUClient.SpeechlyClient.Shutdown isExternal: true -- uid: Speechly.SLUClient.SpeechlyClient.StartContext(System.String) - commentId: M:Speechly.SLUClient.SpeechlyClient.StartContext(System.String) +- uid: Speechly.SLUClient.SpeechlyClient.Start(System.String) + commentId: M:Speechly.SLUClient.SpeechlyClient.Start(System.String) isExternal: true -- uid: Speechly.SLUClient.SpeechlyClient.StopContext - commentId: M:Speechly.SLUClient.SpeechlyClient.StopContext +- uid: Speechly.SLUClient.SpeechlyClient.Stop + commentId: M:Speechly.SLUClient.SpeechlyClient.Stop isExternal: true -- uid: Speechly.SLUClient.EnergyTresholdVAD - commentId: T:Speechly.SLUClient.EnergyTresholdVAD - parent: Speechly.SLUClient - name: EnergyTresholdVAD - nameWithType: EnergyTresholdVAD - fullName: Speechly.SLUClient.EnergyTresholdVAD +- uid: Speechly.Tools.EnergyThresholdVAD + commentId: T:Speechly.Tools.EnergyThresholdVAD + parent: Speechly.Tools + name: EnergyThresholdVAD + nameWithType: EnergyThresholdVAD + fullName: Speechly.Tools.EnergyThresholdVAD - uid: Speechly.SLUClient commentId: N:Speechly.SLUClient name: Speechly.SLUClient nameWithType: Speechly.SLUClient fullName: Speechly.SLUClient +- uid: Speechly.Tools + commentId: N:Speechly.Tools + name: Speechly.Tools + nameWithType: Speechly.Tools + fullName: Speechly.Tools - uid: Speechly.SLUClient.SpeechlyClient commentId: T:Speechly.SLUClient.SpeechlyClient name: SpeechlyClient @@ -1211,18 +1172,29 @@ references: name: StopStreamDelegate nameWithType: StopStreamDelegate fullName: Speechly.Types.StopStreamDelegate -- uid: Speechly.Types.StartContextDelegate - commentId: T:Speechly.Types.StartContextDelegate +- uid: Speechly.Types.StartDelegate + commentId: T:Speechly.Types.StartDelegate parent: Speechly.Types - name: StartContextDelegate - nameWithType: StartContextDelegate - fullName: Speechly.Types.StartContextDelegate -- uid: Speechly.Types.StopContextDelegate - commentId: T:Speechly.Types.StopContextDelegate + name: StartDelegate + nameWithType: StartDelegate + fullName: Speechly.Types.StartDelegate +- uid: Speechly.Types.StopDelegate + commentId: T:Speechly.Types.StopDelegate parent: Speechly.Types - name: StopContextDelegate - nameWithType: StopContextDelegate - fullName: Speechly.Types.StopContextDelegate + name: StopDelegate + nameWithType: StopDelegate + fullName: Speechly.Types.StopDelegate +- uid: Speechly.SLUClient.SpeechlyClient.Output* + commentId: Overload:Speechly.SLUClient.SpeechlyClient.Output + name: Output + nameWithType: SpeechlyClient.Output + fullName: Speechly.SLUClient.SpeechlyClient.Output +- uid: Speechly.Types.AudioInfo + commentId: T:Speechly.Types.AudioInfo + parent: Speechly.Types + name: AudioInfo + nameWithType: AudioInfo + fullName: Speechly.Types.AudioInfo - uid: Speechly.SLUClient.SpeechlyClient.IsAudioStreaming* commentId: Overload:Speechly.SLUClient.SpeechlyClient.IsAudioStreaming name: IsAudioStreaming @@ -1243,21 +1215,6 @@ references: name: IsActive nameWithType: SpeechlyClient.IsActive fullName: Speechly.SLUClient.SpeechlyClient.IsActive -- uid: Speechly.SLUClient.SpeechlyClient.SamplesSent* - commentId: Overload:Speechly.SLUClient.SpeechlyClient.SamplesSent - name: SamplesSent - nameWithType: SpeechlyClient.SamplesSent - fullName: Speechly.SLUClient.SpeechlyClient.SamplesSent -- uid: System.Int32 - isExternal: true - name: Int32 - nameWithType: Int32 - fullName: System.Int32 -- uid: Speechly.SLUClient.SpeechlyClient.Vad* - commentId: Overload:Speechly.SLUClient.SpeechlyClient.Vad - name: Vad - nameWithType: SpeechlyClient.Vad - fullName: Speechly.SLUClient.SpeechlyClient.Vad - uid: Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier* commentId: Overload:Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier name: AudioInputStreamIdentifier @@ -1268,16 +1225,6 @@ references: name: String nameWithType: String fullName: System.String -- uid: Speechly.SLUClient.SpeechlyClient.UtteranceSerial* - commentId: Overload:Speechly.SLUClient.SpeechlyClient.UtteranceSerial - name: UtteranceSerial - nameWithType: SpeechlyClient.UtteranceSerial - fullName: Speechly.SLUClient.SpeechlyClient.UtteranceSerial -- uid: Speechly.SLUClient.SpeechlyClient.StreamSamplePos* - commentId: Overload:Speechly.SLUClient.SpeechlyClient.StreamSamplePos - name: StreamSamplePos - nameWithType: SpeechlyClient.StreamSamplePos - fullName: Speechly.SLUClient.SpeechlyClient.StreamSamplePos - uid: Speechly.SLUClient.SpeechlyClient.Update commentId: M:Speechly.SLUClient.SpeechlyClient.Update isExternal: true @@ -1300,6 +1247,18 @@ references: name: IDecoder nameWithType: IDecoder fullName: Speechly.SLUClient.IDecoder +- uid: Speechly.Types.AudioProcessorOptions + commentId: T:Speechly.Types.AudioProcessorOptions + parent: Speechly.Types + name: AudioProcessorOptions + nameWithType: AudioProcessorOptions + fullName: Speechly.Types.AudioProcessorOptions +- uid: Speechly.Types.ContextOptions + commentId: T:Speechly.Types.ContextOptions + parent: Speechly.Types + name: ContextOptions + nameWithType: ContextOptions + fullName: Speechly.Types.ContextOptions - uid: Task isExternal: true name: Task @@ -1315,11 +1274,98 @@ references: name: StopStream nameWithType: SpeechlyClient.StopStream fullName: Speechly.SLUClient.SpeechlyClient.StopStream -- uid: Speechly.SLUClient.SpeechlyClient.StartContext* - commentId: Overload:Speechly.SLUClient.SpeechlyClient.StartContext - name: StartContext - nameWithType: SpeechlyClient.StartContext - fullName: Speechly.SLUClient.SpeechlyClient.StartContext +- uid: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor* + commentId: Overload:Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor + name: AdjustAudioProcessor + nameWithType: SpeechlyClient.AdjustAudioProcessor + fullName: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor +- uid: System.Nullable{System.Boolean} + commentId: '!:System.Nullable{System.Boolean}' + definition: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + nameWithType.vb: Nullable(Of Boolean) + fullName.vb: System.Nullable(Of System.Boolean) + name.vb: Nullable(Of Boolean) + spec.csharp: + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: < + nameWithType: < + fullName: < + - uid: System.Boolean + name: Boolean + nameWithType: Boolean + fullName: System.Boolean + isExternal: true + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - uid: System.Boolean + name: Boolean + nameWithType: Boolean + fullName: System.Boolean + isExternal: true + - name: ) + nameWithType: ) + fullName: ) +- uid: System.Nullable`1 + commentId: '!:System.Nullable`1' + isExternal: true + name: Nullable<> + nameWithType: Nullable<> + fullName: System.Nullable<> + nameWithType.vb: Nullable(Of ) + fullName.vb: System.Nullable(Of ) + name.vb: Nullable(Of ) + spec.csharp: + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: < + nameWithType: < + fullName: < + - name: '' + nameWithType: '' + fullName: '' + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: '' + nameWithType: '' + fullName: '' + - name: ) + nameWithType: ) + fullName: ) +- uid: Speechly.SLUClient.SpeechlyClient.Start* + commentId: Overload:Speechly.SLUClient.SpeechlyClient.Start + name: Start + nameWithType: SpeechlyClient.Start + fullName: Speechly.SLUClient.SpeechlyClient.Start - uid: Task{System.String} commentId: '!:Task{System.String}' definition: Task`1 @@ -1406,9 +1452,6 @@ references: name: ProcessAudioFile nameWithType: SpeechlyClient.ProcessAudioFile fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudioFile -- uid: Speechly.SLUClient.SpeechlyClient.StopStream(System.Boolean) - commentId: M:Speechly.SLUClient.SpeechlyClient.StopStream(System.Boolean) - isExternal: true - uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio* commentId: Overload:Speechly.SLUClient.SpeechlyClient.ProcessAudio name: ProcessAudio @@ -1440,16 +1483,21 @@ references: - name: () nameWithType: () fullName: () +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 - uid: Stream isExternal: true name: Stream nameWithType: Stream fullName: Stream -- uid: Speechly.SLUClient.SpeechlyClient.StopContext* - commentId: Overload:Speechly.SLUClient.SpeechlyClient.StopContext - name: StopContext - nameWithType: SpeechlyClient.StopContext - fullName: Speechly.SLUClient.SpeechlyClient.StopContext +- uid: Speechly.SLUClient.SpeechlyClient.Stop* + commentId: Overload:Speechly.SLUClient.SpeechlyClient.Stop + name: Stop + nameWithType: SpeechlyClient.Stop + fullName: Speechly.SLUClient.SpeechlyClient.Stop - uid: Speechly.SLUClient.SpeechlyClient.Update* commentId: Overload:Speechly.SLUClient.SpeechlyClient.Update name: Update diff --git a/api/Speechly.SLUClient.yml b/api/Speechly.SLUClient.yml index 5a1366c..bf1ba5f 100644 --- a/api/Speechly.SLUClient.yml +++ b/api/Speechly.SLUClient.yml @@ -5,7 +5,6 @@ items: id: Speechly.SLUClient children: - Speechly.SLUClient.CloudDecoder - - Speechly.SLUClient.EnergyTresholdVAD - Speechly.SLUClient.IDecoder - Speechly.SLUClient.Segment - Speechly.SLUClient.SpeechlyClient @@ -24,12 +23,6 @@ references: name: CloudDecoder nameWithType: CloudDecoder fullName: Speechly.SLUClient.CloudDecoder -- uid: Speechly.SLUClient.EnergyTresholdVAD - commentId: T:Speechly.SLUClient.EnergyTresholdVAD - parent: Speechly.SLUClient - name: EnergyTresholdVAD - nameWithType: EnergyTresholdVAD - fullName: Speechly.SLUClient.EnergyTresholdVAD - uid: Speechly.SLUClient.IDecoder commentId: T:Speechly.SLUClient.IDecoder parent: Speechly.SLUClient diff --git a/api/Speechly.Tools.AudioProcessor.SendAudioDelegate.yml b/api/Speechly.Tools.AudioProcessor.SendAudioDelegate.yml new file mode 100644 index 0000000..68119b0 --- /dev/null +++ b/api/Speechly.Tools.AudioProcessor.SendAudioDelegate.yml @@ -0,0 +1,78 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Tools.AudioProcessor.SendAudioDelegate + commentId: T:Speechly.Tools.AudioProcessor.SendAudioDelegate + id: AudioProcessor.SendAudioDelegate + parent: Speechly.Tools + children: [] + langs: + - csharp + - vb + name: AudioProcessor.SendAudioDelegate + nameWithType: AudioProcessor.SendAudioDelegate + fullName: Speechly.Tools.AudioProcessor.SendAudioDelegate + type: Delegate + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SendAudioDelegate + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 11 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public delegate void SendAudioDelegate(float[] floats, int start = 0, int length = null); + parameters: + - id: floats + type: System.Single[] + - id: start + type: System.Int32 + - id: length + type: System.Int32 + content.vb: Public Delegate Sub SendAudioDelegate(floats As Single(), start As Integer = 0, length As Integer = Nothing) + modifiers.csharp: + - public + - delegate + modifiers.vb: + - Public + - Delegate +references: +- uid: Speechly.Tools + commentId: N:Speechly.Tools + name: Speechly.Tools + nameWithType: Speechly.Tools + fullName: Speechly.Tools +- uid: System.Single[] + isExternal: true + name: Single[] + nameWithType: Single[] + fullName: System.Single[] + nameWithType.vb: Single() + fullName.vb: System.Single() + name.vb: Single() + spec.csharp: + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: '[]' + nameWithType: '[]' + fullName: '[]' + spec.vb: + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: () + nameWithType: () + fullName: () +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 diff --git a/api/Speechly.Tools.AudioProcessor.VadChangeDelegate.yml b/api/Speechly.Tools.AudioProcessor.VadChangeDelegate.yml new file mode 100644 index 0000000..6ca6458 --- /dev/null +++ b/api/Speechly.Tools.AudioProcessor.VadChangeDelegate.yml @@ -0,0 +1,48 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Tools.AudioProcessor.VadChangeDelegate + commentId: T:Speechly.Tools.AudioProcessor.VadChangeDelegate + id: AudioProcessor.VadChangeDelegate + parent: Speechly.Tools + children: [] + langs: + - csharp + - vb + name: AudioProcessor.VadChangeDelegate + nameWithType: AudioProcessor.VadChangeDelegate + fullName: Speechly.Tools.AudioProcessor.VadChangeDelegate + type: Delegate + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: VadChangeDelegate + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 12 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public delegate void VadChangeDelegate(bool isSignalDetected); + parameters: + - id: isSignalDetected + type: System.Boolean + content.vb: Public Delegate Sub VadChangeDelegate(isSignalDetected As Boolean) + modifiers.csharp: + - public + - delegate + modifiers.vb: + - Public + - Delegate +references: +- uid: Speechly.Tools + commentId: N:Speechly.Tools + name: Speechly.Tools + nameWithType: Speechly.Tools + fullName: Speechly.Tools +- uid: System.Boolean + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean diff --git a/api/Speechly.Tools.AudioProcessor.yml b/api/Speechly.Tools.AudioProcessor.yml new file mode 100644 index 0000000..227c05f --- /dev/null +++ b/api/Speechly.Tools.AudioProcessor.yml @@ -0,0 +1,516 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Tools.AudioProcessor + commentId: T:Speechly.Tools.AudioProcessor + id: AudioProcessor + parent: Speechly.Tools + children: + - Speechly.Tools.AudioProcessor.#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean) + - Speechly.Tools.AudioProcessor.OnSendAudio + - Speechly.Tools.AudioProcessor.OnVadStateChange + - Speechly.Tools.AudioProcessor.Options + - Speechly.Tools.AudioProcessor.Output + - Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + - Speechly.Tools.AudioProcessor.Reset(System.Int32) + - Speechly.Tools.AudioProcessor.Start + - Speechly.Tools.AudioProcessor.Stop + - Speechly.Tools.AudioProcessor.Vad + langs: + - csharp + - vb + name: AudioProcessor + nameWithType: AudioProcessor + fullName: Speechly.Tools.AudioProcessor + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: AudioProcessor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 8 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: 'public class AudioProcessor : object' + content.vb: >- + Public Class AudioProcessor + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Tools.AudioProcessor.OnSendAudio + commentId: F:Speechly.Tools.AudioProcessor.OnSendAudio + id: OnSendAudio + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: OnSendAudio + nameWithType: AudioProcessor.OnSendAudio + fullName: Speechly.Tools.AudioProcessor.OnSendAudio + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: OnSendAudio + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 14 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public AudioProcessor.SendAudioDelegate OnSendAudio + return: + type: Speechly.Tools.AudioProcessor.SendAudioDelegate + content.vb: Public OnSendAudio As AudioProcessor.SendAudioDelegate + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.AudioProcessor.OnVadStateChange + commentId: F:Speechly.Tools.AudioProcessor.OnVadStateChange + id: OnVadStateChange + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: OnVadStateChange + nameWithType: AudioProcessor.OnVadStateChange + fullName: Speechly.Tools.AudioProcessor.OnVadStateChange + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: OnVadStateChange + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 15 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public AudioProcessor.VadChangeDelegate OnVadStateChange + return: + type: Speechly.Tools.AudioProcessor.VadChangeDelegate + content.vb: Public OnVadStateChange As AudioProcessor.VadChangeDelegate + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.AudioProcessor.Vad + commentId: P:Speechly.Tools.AudioProcessor.Vad + id: Vad + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: Vad + nameWithType: AudioProcessor.Vad + fullName: Speechly.Tools.AudioProcessor.Vad + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Vad + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 16 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public EnergyThresholdVAD Vad { get; } + parameters: [] + return: + type: Speechly.Tools.EnergyThresholdVAD + content.vb: Public ReadOnly Property Vad As EnergyThresholdVAD + overload: Speechly.Tools.AudioProcessor.Vad* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Tools.AudioProcessor.Options + commentId: P:Speechly.Tools.AudioProcessor.Options + id: Options + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: Options + nameWithType: AudioProcessor.Options + fullName: Speechly.Tools.AudioProcessor.Options + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Options + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 17 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public AudioProcessorOptions Options { get; } + parameters: [] + return: + type: Speechly.Types.AudioProcessorOptions + content.vb: Public ReadOnly Property Options As AudioProcessorOptions + overload: Speechly.Tools.AudioProcessor.Options* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Tools.AudioProcessor.Output + commentId: P:Speechly.Tools.AudioProcessor.Output + id: Output + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: Output + nameWithType: AudioProcessor.Output + fullName: Speechly.Tools.AudioProcessor.Output + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Output + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 18 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public AudioInfo Output { get; } + parameters: [] + return: + type: Speechly.Types.AudioInfo + content.vb: Public ReadOnly Property Output As AudioInfo + overload: Speechly.Tools.AudioProcessor.Output* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Tools.AudioProcessor.#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean) + commentId: M:Speechly.Tools.AudioProcessor.#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean) + id: '#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean)' + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: AudioProcessor(AudioProcessorOptions, AudioInfo, Boolean) + nameWithType: AudioProcessor.AudioProcessor(AudioProcessorOptions, AudioInfo, Boolean) + fullName: Speechly.Tools.AudioProcessor.AudioProcessor(Speechly.Types.AudioProcessorOptions, Speechly.Types.AudioInfo, System.Boolean) + type: Constructor + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: .ctor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 29 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public AudioProcessor(AudioProcessorOptions options, AudioInfo output, bool debug = false) + parameters: + - id: options + type: Speechly.Types.AudioProcessorOptions + - id: output + type: Speechly.Types.AudioInfo + - id: debug + type: System.Boolean + content.vb: Public Sub New(options As AudioProcessorOptions, output As AudioInfo, debug As Boolean = False) + overload: Speechly.Tools.AudioProcessor.#ctor* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.AudioProcessor.Start + commentId: M:Speechly.Tools.AudioProcessor.Start + id: Start + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: Start() + nameWithType: AudioProcessor.Start() + fullName: Speechly.Tools.AudioProcessor.Start() + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Start + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 44 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public void Start() + content.vb: Public Sub Start + overload: Speechly.Tools.AudioProcessor.Start* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.AudioProcessor.Stop + commentId: M:Speechly.Tools.AudioProcessor.Stop + id: Stop + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: Stop() + nameWithType: AudioProcessor.Stop() + fullName: Speechly.Tools.AudioProcessor.Stop() + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Stop + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 50 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public void Stop() + content.vb: Public Sub Stop + overload: Speechly.Tools.AudioProcessor.Stop* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.AudioProcessor.Reset(System.Int32) + commentId: M:Speechly.Tools.AudioProcessor.Reset(System.Int32) + id: Reset(System.Int32) + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: Reset(Int32) + nameWithType: AudioProcessor.Reset(Int32) + fullName: Speechly.Tools.AudioProcessor.Reset(System.Int32) + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Reset + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 56 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public void Reset(int inputSampleRate = 0) + parameters: + - id: inputSampleRate + type: System.Int32 + content.vb: Public Sub Reset(inputSampleRate As Integer = 0) + overload: Speechly.Tools.AudioProcessor.Reset* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + commentId: M:Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + id: ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + parent: Speechly.Tools.AudioProcessor + langs: + - csharp + - vb + name: ProcessAudio(Single[], Int32, Int32, Boolean) + nameWithType: AudioProcessor.ProcessAudio(Single[], Int32, Int32, Boolean) + fullName: Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[], System.Int32, System.Int32, System.Boolean) + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: ProcessAudio + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs + startLine: 93 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + summary: "\nProcess speech audio samples from a microphone or other audio source.\n\nIt's recommended to constantly feed new audio as long as you want to use Speechly's SLU services.\n\nYou can control when to start and stop process speech either manually with and or\nautomatically by providing a voice activity detection (VAD) field to .\n\nThe audio is handled as follows:\n- Downsample to 16kHz if needed\n- Add to history ringbuffer\n- Calculate energy (VAD)\n- Automatic Start/Stop (VAD)\n- Send utterance audio to a file\n- Send utterance audio to Speechly SLU decoder\n" + example: [] + syntax: + content: public void ProcessAudio(float[] floats, int start = 0, int length = null, bool forceSubFrameProcess = false) + parameters: + - id: floats + type: System.Single[] + description: Array of float containing samples to feed to the audio pipeline. Each sample needs to be in range -1f..1f. + - id: start + type: System.Int32 + description: 'Start index of audio to process in samples (default: `0`).' + - id: length + type: System.Int32 + description: 'Length of audio to process in samples or `-1` to process the whole array (default: `-1`).' + - id: forceSubFrameProcess + type: System.Boolean + description: 'Forces processing of last subframe at end of audio stream (default: `false`).' + content.vb: Public Sub ProcessAudio(floats As Single(), start As Integer = 0, length As Integer = Nothing, forceSubFrameProcess As Boolean = False) + overload: Speechly.Tools.AudioProcessor.ProcessAudio* + nameWithType.vb: AudioProcessor.ProcessAudio(Single(), Int32, Int32, Boolean) + modifiers.csharp: + - public + modifiers.vb: + - Public + fullName.vb: Speechly.Tools.AudioProcessor.ProcessAudio(System.Single(), System.Int32, System.Int32, System.Boolean) + name.vb: ProcessAudio(Single(), Int32, Int32, Boolean) +references: +- uid: Speechly.Tools + commentId: N:Speechly.Tools + name: Speechly.Tools + nameWithType: Speechly.Tools + fullName: Speechly.Tools +- uid: Speechly.Tools.AudioProcessor.SendAudioDelegate + commentId: T:Speechly.Tools.AudioProcessor.SendAudioDelegate + parent: Speechly.Tools + name: AudioProcessor.SendAudioDelegate + nameWithType: AudioProcessor.SendAudioDelegate + fullName: Speechly.Tools.AudioProcessor.SendAudioDelegate +- uid: Speechly.Tools.AudioProcessor.VadChangeDelegate + commentId: T:Speechly.Tools.AudioProcessor.VadChangeDelegate + parent: Speechly.Tools + name: AudioProcessor.VadChangeDelegate + nameWithType: AudioProcessor.VadChangeDelegate + fullName: Speechly.Tools.AudioProcessor.VadChangeDelegate +- uid: Speechly.Tools.AudioProcessor.Vad* + commentId: Overload:Speechly.Tools.AudioProcessor.Vad + name: Vad + nameWithType: AudioProcessor.Vad + fullName: Speechly.Tools.AudioProcessor.Vad +- uid: Speechly.Tools.EnergyThresholdVAD + commentId: T:Speechly.Tools.EnergyThresholdVAD + parent: Speechly.Tools + name: EnergyThresholdVAD + nameWithType: EnergyThresholdVAD + fullName: Speechly.Tools.EnergyThresholdVAD +- uid: Speechly.Tools.AudioProcessor.Options* + commentId: Overload:Speechly.Tools.AudioProcessor.Options + name: Options + nameWithType: AudioProcessor.Options + fullName: Speechly.Tools.AudioProcessor.Options +- uid: Speechly.Types.AudioProcessorOptions + commentId: T:Speechly.Types.AudioProcessorOptions + parent: Speechly.Types + name: AudioProcessorOptions + nameWithType: AudioProcessorOptions + fullName: Speechly.Types.AudioProcessorOptions +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: Speechly.Tools.AudioProcessor.Output* + commentId: Overload:Speechly.Tools.AudioProcessor.Output + name: Output + nameWithType: AudioProcessor.Output + fullName: Speechly.Tools.AudioProcessor.Output +- uid: Speechly.Types.AudioInfo + commentId: T:Speechly.Types.AudioInfo + parent: Speechly.Types + name: AudioInfo + nameWithType: AudioInfo + fullName: Speechly.Types.AudioInfo +- uid: Speechly.Tools.AudioProcessor.#ctor* + commentId: Overload:Speechly.Tools.AudioProcessor.#ctor + name: AudioProcessor + nameWithType: AudioProcessor.AudioProcessor + fullName: Speechly.Tools.AudioProcessor.AudioProcessor +- uid: System.Boolean + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: Speechly.Tools.AudioProcessor.Start* + commentId: Overload:Speechly.Tools.AudioProcessor.Start + name: Start + nameWithType: AudioProcessor.Start + fullName: Speechly.Tools.AudioProcessor.Start +- uid: Speechly.Tools.AudioProcessor.Stop* + commentId: Overload:Speechly.Tools.AudioProcessor.Stop + name: Stop + nameWithType: AudioProcessor.Stop + fullName: Speechly.Tools.AudioProcessor.Stop +- uid: Speechly.Tools.AudioProcessor.Reset* + commentId: Overload:Speechly.Tools.AudioProcessor.Reset + name: Reset + nameWithType: AudioProcessor.Reset + fullName: Speechly.Tools.AudioProcessor.Reset +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Speechly.Tools.AudioProcessor.Start + commentId: M:Speechly.Tools.AudioProcessor.Start + isExternal: true +- uid: Speechly.Tools.AudioProcessor.Stop + commentId: M:Speechly.Tools.AudioProcessor.Stop + isExternal: true +- uid: Speechly.Tools.AudioProcessor.ProcessAudio* + commentId: Overload:Speechly.Tools.AudioProcessor.ProcessAudio + name: ProcessAudio + nameWithType: AudioProcessor.ProcessAudio + fullName: Speechly.Tools.AudioProcessor.ProcessAudio +- uid: System.Single[] + isExternal: true + name: Single[] + nameWithType: Single[] + fullName: System.Single[] + nameWithType.vb: Single() + fullName.vb: System.Single() + name.vb: Single() + spec.csharp: + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: '[]' + nameWithType: '[]' + fullName: '[]' + spec.vb: + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: () + nameWithType: () + fullName: () diff --git a/api/Speechly.Tools.AudioTools.yml b/api/Speechly.Tools.AudioTools.yml index d8d5492..a8d4e63 100644 --- a/api/Speechly.Tools.AudioTools.yml +++ b/api/Speechly.Tools.AudioTools.yml @@ -6,9 +6,12 @@ items: parent: Speechly.Tools children: - Speechly.Tools.AudioTools.ConvertInt16ToFloat(System.Byte[]@,System.Single[]@,System.Int32,System.Int32,System.Int32) + - Speechly.Tools.AudioTools.DbToEnergy(System.Single) - Speechly.Tools.AudioTools.Downsample(System.Single[]@,System.Single[]@,System.Int32,System.Int32,System.Int32,System.Int32) + - Speechly.Tools.AudioTools.EnergyToDb(System.Single) - Speechly.Tools.AudioTools.GetAudioPeak(System.Single[]@,System.Int32,System.Int32) - Speechly.Tools.AudioTools.GetEnergy(System.Single[]@,System.Int32,System.Int32) + - Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 langs: - csharp - vb @@ -18,11 +21,11 @@ items: type: Class source: remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs - branch: feature/dotnet-vad + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: AudioTools - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs startLine: 3 assemblies: - speechly-unity-net-standard-2.0 @@ -53,11 +56,11 @@ items: type: Method source: remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs - branch: feature/dotnet-vad + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Downsample - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs startLine: 5 assemblies: - speechly-unity-net-standard-2.0 @@ -101,11 +104,11 @@ items: type: Method source: remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs - branch: feature/dotnet-vad + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: GetEnergy - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs startLine: 49 assemblies: - speechly-unity-net-standard-2.0 @@ -145,11 +148,11 @@ items: type: Method source: remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs - branch: feature/dotnet-vad + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: GetAudioPeak - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs startLine: 60 assemblies: - speechly-unity-net-standard-2.0 @@ -189,11 +192,11 @@ items: type: Method source: remote: - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs - branch: feature/dotnet-vad + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ConvertInt16ToFloat - path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs startLine: 73 assemblies: - speechly-unity-net-standard-2.0 @@ -224,6 +227,115 @@ items: - Shared fullName.vb: Speechly.Tools.AudioTools.ConvertInt16ToFloat(ByRef System.Byte(), ByRef System.Single(), System.Int32, System.Int32, System.Int32) name.vb: ConvertInt16ToFloat(ByRef Byte(), ByRef Single(), Int32, Int32, Int32) +- uid: Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 + commentId: F:Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 + id: LOG_2_PLUS_LOG_5 + parent: Speechly.Tools.AudioTools + langs: + - csharp + - vb + name: LOG_2_PLUS_LOG_5 + nameWithType: AudioTools.LOG_2_PLUS_LOG_5 + fullName: Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: LOG_2_PLUS_LOG_5 + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + startLine: 86 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public static readonly double LOG_2_PLUS_LOG_5 + return: + type: System.Double + content.vb: Public Shared ReadOnly LOG_2_PLUS_LOG_5 As Double + modifiers.csharp: + - public + - static + - readonly + modifiers.vb: + - Public + - Shared + - ReadOnly +- uid: Speechly.Tools.AudioTools.EnergyToDb(System.Single) + commentId: M:Speechly.Tools.AudioTools.EnergyToDb(System.Single) + id: EnergyToDb(System.Single) + parent: Speechly.Tools.AudioTools + langs: + - csharp + - vb + name: EnergyToDb(Single) + nameWithType: AudioTools.EnergyToDb(Single) + fullName: Speechly.Tools.AudioTools.EnergyToDb(System.Single) + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: EnergyToDb + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + startLine: 88 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public static float EnergyToDb(float energy) + parameters: + - id: energy + type: System.Single + return: + type: System.Single + content.vb: Public Shared Function EnergyToDb(energy As Single) As Single + overload: Speechly.Tools.AudioTools.EnergyToDb* + modifiers.csharp: + - public + - static + modifiers.vb: + - Public + - Shared +- uid: Speechly.Tools.AudioTools.DbToEnergy(System.Single) + commentId: M:Speechly.Tools.AudioTools.DbToEnergy(System.Single) + id: DbToEnergy(System.Single) + parent: Speechly.Tools.AudioTools + langs: + - csharp + - vb + name: DbToEnergy(Single) + nameWithType: AudioTools.DbToEnergy(Single) + fullName: Speechly.Tools.AudioTools.DbToEnergy(System.Single) + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: DbToEnergy + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs + startLine: 92 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public static float DbToEnergy(float db) + parameters: + - id: db + type: System.Single + return: + type: System.Single + content.vb: Public Shared Function DbToEnergy(db As Single) As Single + overload: Speechly.Tools.AudioTools.DbToEnergy* + modifiers.csharp: + - public + - static + modifiers.vb: + - Public + - Shared references: - uid: Speechly.Tools commentId: N:Speechly.Tools @@ -312,3 +424,19 @@ references: - name: () nameWithType: () fullName: () +- uid: System.Double + commentId: '!:System.Double' + isExternal: true + name: Double + nameWithType: Double + fullName: System.Double +- uid: Speechly.Tools.AudioTools.EnergyToDb* + commentId: Overload:Speechly.Tools.AudioTools.EnergyToDb + name: EnergyToDb + nameWithType: AudioTools.EnergyToDb + fullName: Speechly.Tools.AudioTools.EnergyToDb +- uid: Speechly.Tools.AudioTools.DbToEnergy* + commentId: Overload:Speechly.Tools.AudioTools.DbToEnergy + name: DbToEnergy + nameWithType: AudioTools.DbToEnergy + fullName: Speechly.Tools.AudioTools.DbToEnergy diff --git a/api/Speechly.Tools.EnergyThresholdVAD.yml b/api/Speechly.Tools.EnergyThresholdVAD.yml new file mode 100644 index 0000000..9763f6e --- /dev/null +++ b/api/Speechly.Tools.EnergyThresholdVAD.yml @@ -0,0 +1,299 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Tools.EnergyThresholdVAD + commentId: T:Speechly.Tools.EnergyThresholdVAD + id: EnergyThresholdVAD + parent: Speechly.Tools + children: + - Speechly.Tools.EnergyThresholdVAD.#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo) + - Speechly.Tools.EnergyThresholdVAD.Options + - Speechly.Tools.EnergyThresholdVAD.Output + - Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) + - Speechly.Tools.EnergyThresholdVAD.ResetVAD + langs: + - csharp + - vb + name: EnergyThresholdVAD + nameWithType: EnergyThresholdVAD + fullName: Speechly.Tools.EnergyThresholdVAD + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: EnergyThresholdVAD + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + startLine: 18 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + summary: "\nAdaptive energy threshold voice activity detection (VAD) implementation.\nIt can be used to enable hands-free operation of the SLU decoder.\n\nWhen enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time.\nUse its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time.\nThe background noise level gradually adapts when no signal is detected.\n\nIsSignalDetected can be used to drive SpeechlyClient's Start and Stop automatically by setting ControlListening true.\n" + example: [] + syntax: + content: 'public class EnergyThresholdVAD : object' + content.vb: >- + Public Class EnergyThresholdVAD + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Tools.EnergyThresholdVAD.Options + commentId: P:Speechly.Tools.EnergyThresholdVAD.Options + id: Options + parent: Speechly.Tools.EnergyThresholdVAD + langs: + - csharp + - vb + name: Options + nameWithType: EnergyThresholdVAD.Options + fullName: Speechly.Tools.EnergyThresholdVAD.Options + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Options + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + startLine: 21 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public VADOptions Options { get; } + parameters: [] + return: + type: Speechly.Types.VADOptions + content.vb: Public ReadOnly Property Options As VADOptions + overload: Speechly.Tools.EnergyThresholdVAD.Options* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Tools.EnergyThresholdVAD.Output + commentId: P:Speechly.Tools.EnergyThresholdVAD.Output + id: Output + parent: Speechly.Tools.EnergyThresholdVAD + langs: + - csharp + - vb + name: Output + nameWithType: EnergyThresholdVAD.Output + fullName: Speechly.Tools.EnergyThresholdVAD.Output + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Output + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + startLine: 22 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public AudioInfo Output { get; } + parameters: [] + return: + type: Speechly.Types.AudioInfo + content.vb: Public ReadOnly Property Output As AudioInfo + overload: Speechly.Tools.EnergyThresholdVAD.Output* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Tools.EnergyThresholdVAD.#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo) + commentId: M:Speechly.Tools.EnergyThresholdVAD.#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo) + id: '#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo)' + parent: Speechly.Tools.EnergyThresholdVAD + langs: + - csharp + - vb + name: EnergyThresholdVAD(VADOptions, AudioInfo) + nameWithType: EnergyThresholdVAD.EnergyThresholdVAD(VADOptions, AudioInfo) + fullName: Speechly.Tools.EnergyThresholdVAD.EnergyThresholdVAD(Speechly.Types.VADOptions, Speechly.Types.AudioInfo) + type: Constructor + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: .ctor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + startLine: 30 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public EnergyThresholdVAD(VADOptions options, AudioInfo output) + parameters: + - id: options + type: Speechly.Types.VADOptions + - id: output + type: Speechly.Types.AudioInfo + content.vb: Public Sub New(options As VADOptions, output As AudioInfo) + overload: Speechly.Tools.EnergyThresholdVAD.#ctor* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) + commentId: M:Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) + id: ProcessFrame(System.Single[],System.Int32,System.Int32) + parent: Speechly.Tools.EnergyThresholdVAD + langs: + - csharp + - vb + name: ProcessFrame(Single[], Int32, Int32) + nameWithType: EnergyThresholdVAD.ProcessFrame(Single[], Int32, Int32) + fullName: Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[], System.Int32, System.Int32) + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: ProcessFrame + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + startLine: 35 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public void ProcessFrame(float[] floats, int start = 0, int length = null) + parameters: + - id: floats + type: System.Single[] + - id: start + type: System.Int32 + - id: length + type: System.Int32 + content.vb: Public Sub ProcessFrame(floats As Single(), start As Integer = 0, length As Integer = Nothing) + overload: Speechly.Tools.EnergyThresholdVAD.ProcessFrame* + nameWithType.vb: EnergyThresholdVAD.ProcessFrame(Single(), Int32, Int32) + modifiers.csharp: + - public + modifiers.vb: + - Public + fullName.vb: Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single(), System.Int32, System.Int32) + name.vb: ProcessFrame(Single(), Int32, Int32) +- uid: Speechly.Tools.EnergyThresholdVAD.ResetVAD + commentId: M:Speechly.Tools.EnergyThresholdVAD.ResetVAD + id: ResetVAD + parent: Speechly.Tools.EnergyThresholdVAD + langs: + - csharp + - vb + name: ResetVAD() + nameWithType: EnergyThresholdVAD.ResetVAD() + fullName: Speechly.Tools.EnergyThresholdVAD.ResetVAD() + type: Method + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: ResetVAD + path: speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs + startLine: 104 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Tools + syntax: + content: public void ResetVAD() + content.vb: Public Sub ResetVAD + overload: Speechly.Tools.EnergyThresholdVAD.ResetVAD* + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Tools + commentId: N:Speechly.Tools + name: Speechly.Tools + nameWithType: Speechly.Tools + fullName: Speechly.Tools +- uid: Speechly.Tools.EnergyThresholdVAD.Options* + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.Options + name: Options + nameWithType: EnergyThresholdVAD.Options + fullName: Speechly.Tools.EnergyThresholdVAD.Options +- uid: Speechly.Types.VADOptions + commentId: T:Speechly.Types.VADOptions + parent: Speechly.Types + name: VADOptions + nameWithType: VADOptions + fullName: Speechly.Types.VADOptions +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: Speechly.Tools.EnergyThresholdVAD.Output* + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.Output + name: Output + nameWithType: EnergyThresholdVAD.Output + fullName: Speechly.Tools.EnergyThresholdVAD.Output +- uid: Speechly.Types.AudioInfo + commentId: T:Speechly.Types.AudioInfo + parent: Speechly.Types + name: AudioInfo + nameWithType: AudioInfo + fullName: Speechly.Types.AudioInfo +- uid: Speechly.Tools.EnergyThresholdVAD.#ctor* + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.#ctor + name: EnergyThresholdVAD + nameWithType: EnergyThresholdVAD.EnergyThresholdVAD + fullName: Speechly.Tools.EnergyThresholdVAD.EnergyThresholdVAD +- uid: Speechly.Tools.EnergyThresholdVAD.ProcessFrame* + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.ProcessFrame + name: ProcessFrame + nameWithType: EnergyThresholdVAD.ProcessFrame + fullName: Speechly.Tools.EnergyThresholdVAD.ProcessFrame +- uid: System.Single[] + isExternal: true + name: Single[] + nameWithType: Single[] + fullName: System.Single[] + nameWithType.vb: Single() + fullName.vb: System.Single() + name.vb: Single() + spec.csharp: + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: '[]' + nameWithType: '[]' + fullName: '[]' + spec.vb: + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: () + nameWithType: () + fullName: () +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Speechly.Tools.EnergyThresholdVAD.ResetVAD* + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.ResetVAD + name: ResetVAD + nameWithType: EnergyThresholdVAD.ResetVAD + fullName: Speechly.Tools.EnergyThresholdVAD.ResetVAD diff --git a/api/Speechly.Tools.JSON.yml b/api/Speechly.Tools.JSON.yml index 3454c8d..8f83f2d 100644 --- a/api/Speechly.Tools.JSON.yml +++ b/api/Speechly.Tools.JSON.yml @@ -19,7 +19,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: JSON path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs @@ -54,7 +54,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: StringifyToStream path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs @@ -96,7 +96,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Stringify path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs @@ -138,7 +138,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ParseFromStream path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs @@ -184,7 +184,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Parse path: speechly-client-net-standard-2.0/Speechly/SLUClient/JSON.cs diff --git a/api/Speechly.Tools.Logger.LoggerDelegate.yml b/api/Speechly.Tools.Logger.LoggerDelegate.yml index 1555701..c64a4fe 100644 --- a/api/Speechly.Tools.Logger.LoggerDelegate.yml +++ b/api/Speechly.Tools.Logger.LoggerDelegate.yml @@ -15,7 +15,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: LoggerDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs diff --git a/api/Speechly.Tools.Logger.yml b/api/Speechly.Tools.Logger.yml index 83ebecf..28cc808 100644 --- a/api/Speechly.Tools.Logger.yml +++ b/api/Speechly.Tools.Logger.yml @@ -17,7 +17,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Logger path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs @@ -52,7 +52,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Log path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs @@ -85,7 +85,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: LogError path: speechly-client-net-standard-2.0/Speechly/SLUClient/Logger.cs diff --git a/api/Speechly.Tools.Platform.yml b/api/Speechly.Tools.Platform.yml index 423de1b..aa8f7f4 100644 --- a/api/Speechly.Tools.Platform.yml +++ b/api/Speechly.Tools.Platform.yml @@ -22,7 +22,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Platform path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs @@ -57,7 +57,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ConfigPath path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs @@ -90,7 +90,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: GetDeviceId path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs @@ -127,7 +127,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Fetch path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs @@ -164,11 +164,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: GetPersistentStoragePath path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - startLine: 54 + startLine: 62 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Tools @@ -198,11 +198,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: GuidFromString path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - startLine: 65 + startLine: 73 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Tools @@ -235,11 +235,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: RestoreOrCreateConfig path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - startLine: 77 + startLine: 85 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Tools @@ -279,11 +279,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: SaveConfig path: speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs - startLine: 88 + startLine: 96 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Tools diff --git a/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.yml b/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.yml index a997d2d..bd42438 100644 --- a/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.yml +++ b/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.yml @@ -15,7 +15,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ResponseReceivedDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs diff --git a/api/Speechly.Tools.WsClient.yml b/api/Speechly.Tools.WsClient.yml index 12d20c2..c2c9024 100644 --- a/api/Speechly.Tools.WsClient.yml +++ b/api/Speechly.Tools.WsClient.yml @@ -22,7 +22,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: WsClient path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -57,7 +57,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: OnResponseReceived path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -88,7 +88,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ReceiveBufferSize path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -123,7 +123,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: ConnectAsync path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -161,7 +161,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: DisconnectAsync path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -194,7 +194,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: SendText path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -227,7 +227,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: SendBytes path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs @@ -263,7 +263,7 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Dispose path: speechly-client-net-standard-2.0/Speechly/SLUClient/WSClient.cs diff --git a/api/Speechly.Tools.yml b/api/Speechly.Tools.yml index 0f0e4b4..f64d31d 100644 --- a/api/Speechly.Tools.yml +++ b/api/Speechly.Tools.yml @@ -4,7 +4,11 @@ items: commentId: N:Speechly.Tools id: Speechly.Tools children: + - Speechly.Tools.AudioProcessor + - Speechly.Tools.AudioProcessor.SendAudioDelegate + - Speechly.Tools.AudioProcessor.VadChangeDelegate - Speechly.Tools.AudioTools + - Speechly.Tools.EnergyThresholdVAD - Speechly.Tools.JSON - Speechly.Tools.Logger - Speechly.Tools.Logger.LoggerDelegate @@ -21,11 +25,34 @@ items: assemblies: - speechly-unity-net-standard-2.0 references: +- uid: Speechly.Tools.AudioProcessor + commentId: T:Speechly.Tools.AudioProcessor + name: AudioProcessor + nameWithType: AudioProcessor + fullName: Speechly.Tools.AudioProcessor +- uid: Speechly.Tools.AudioProcessor.SendAudioDelegate + commentId: T:Speechly.Tools.AudioProcessor.SendAudioDelegate + parent: Speechly.Tools + name: AudioProcessor.SendAudioDelegate + nameWithType: AudioProcessor.SendAudioDelegate + fullName: Speechly.Tools.AudioProcessor.SendAudioDelegate +- uid: Speechly.Tools.AudioProcessor.VadChangeDelegate + commentId: T:Speechly.Tools.AudioProcessor.VadChangeDelegate + parent: Speechly.Tools + name: AudioProcessor.VadChangeDelegate + nameWithType: AudioProcessor.VadChangeDelegate + fullName: Speechly.Tools.AudioProcessor.VadChangeDelegate - uid: Speechly.Tools.AudioTools commentId: T:Speechly.Tools.AudioTools name: AudioTools nameWithType: AudioTools fullName: Speechly.Tools.AudioTools +- uid: Speechly.Tools.EnergyThresholdVAD + commentId: T:Speechly.Tools.EnergyThresholdVAD + parent: Speechly.Tools + name: EnergyThresholdVAD + nameWithType: EnergyThresholdVAD + fullName: Speechly.Tools.EnergyThresholdVAD - uid: Speechly.Tools.JSON commentId: T:Speechly.Tools.JSON name: JSON diff --git a/api/Speechly.Types.AudioInfo.yml b/api/Speechly.Types.AudioInfo.yml new file mode 100644 index 0000000..7202714 --- /dev/null +++ b/api/Speechly.Types.AudioInfo.yml @@ -0,0 +1,292 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.AudioInfo + commentId: T:Speechly.Types.AudioInfo + id: AudioInfo + parent: Speechly.Types + children: + - Speechly.Types.AudioInfo.IsSignalDetected + - Speechly.Types.AudioInfo.NoiseLevelDb + - Speechly.Types.AudioInfo.SamplesSent + - Speechly.Types.AudioInfo.SignalDb + - Speechly.Types.AudioInfo.StreamSamplePos + - Speechly.Types.AudioInfo.UtteranceSerial + langs: + - csharp + - vb + name: AudioInfo + nameWithType: AudioInfo + fullName: Speechly.Types.AudioInfo + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: AudioInfo + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 37 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + summary: "\nStatistics calculated by the Audio Processor. Note that this information is not currently available when using libSpeechly AudioProcessor.\n" + example: [] + syntax: + content: 'public class AudioInfo : object' + content.vb: >- + Public Class AudioInfo + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.AudioInfo.IsSignalDetected + commentId: F:Speechly.Types.AudioInfo.IsSignalDetected + id: IsSignalDetected + parent: Speechly.Types.AudioInfo + langs: + - csharp + - vb + name: IsSignalDetected + nameWithType: AudioInfo.IsSignalDetected + fullName: Speechly.Types.AudioInfo.IsSignalDetected + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: IsSignalDetected + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 42 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public bool IsSignalDetected + return: + type: System.Boolean + description: "\nTrue if VAD has detected a loud signal.\n" + content.vb: Public IsSignalDetected As Boolean + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioInfo.SignalDb + commentId: F:Speechly.Types.AudioInfo.SignalDb + id: SignalDb + parent: Speechly.Types.AudioInfo + langs: + - csharp + - vb + name: SignalDb + nameWithType: AudioInfo.SignalDb + fullName: Speechly.Types.AudioInfo.SignalDb + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SignalDb + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 50 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float SignalDb + return: + type: System.Single + description: "\nSignal level in dB above noise level.\n" + content.vb: Public SignalDb As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioInfo.NoiseLevelDb + commentId: F:Speechly.Types.AudioInfo.NoiseLevelDb + id: NoiseLevelDb + parent: Speechly.Types.AudioInfo + langs: + - csharp + - vb + name: NoiseLevelDb + nameWithType: AudioInfo.NoiseLevelDb + fullName: Speechly.Types.AudioInfo.NoiseLevelDb + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: NoiseLevelDb + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 58 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float NoiseLevelDb + return: + type: System.Single + description: "\nCurrent noise level in dB.\n" + content.vb: Public NoiseLevelDb As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioInfo.StreamSamplePos + commentId: P:Speechly.Types.AudioInfo.StreamSamplePos + id: StreamSamplePos + parent: Speechly.Types.AudioInfo + langs: + - csharp + - vb + name: StreamSamplePos + nameWithType: AudioInfo.StreamSamplePos + fullName: Speechly.Types.AudioInfo.StreamSamplePos + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: StreamSamplePos + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 63 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int StreamSamplePos { get; } + parameters: [] + return: + type: System.Int32 + description: "\nCurrent count of continuously processed samples (thru ProcessAudio) since StartStream\n" + content.vb: Public ReadOnly Property StreamSamplePos As Integer + overload: Speechly.Types.AudioInfo.StreamSamplePos* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Types.AudioInfo.SamplesSent + commentId: P:Speechly.Types.AudioInfo.SamplesSent + id: SamplesSent + parent: Speechly.Types.AudioInfo + langs: + - csharp + - vb + name: SamplesSent + nameWithType: AudioInfo.SamplesSent + fullName: Speechly.Types.AudioInfo.SamplesSent + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SamplesSent + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 68 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int SamplesSent { get; } + parameters: [] + return: + type: System.Int32 + description: "\nCurrent count of processed samples since Start\n" + content.vb: Public ReadOnly Property SamplesSent As Integer + overload: Speechly.Types.AudioInfo.SamplesSent* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +- uid: Speechly.Types.AudioInfo.UtteranceSerial + commentId: P:Speechly.Types.AudioInfo.UtteranceSerial + id: UtteranceSerial + parent: Speechly.Types.AudioInfo + langs: + - csharp + - vb + name: UtteranceSerial + nameWithType: AudioInfo.UtteranceSerial + fullName: Speechly.Types.AudioInfo.UtteranceSerial + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: UtteranceSerial + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 73 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int UtteranceSerial { get; } + parameters: [] + return: + type: System.Int32 + description: "\n0-based local index of utterance within the stream. -1 if no utterances have been processed.\n" + content.vb: Public ReadOnly Property UtteranceSerial As Integer + overload: Speechly.Types.AudioInfo.UtteranceSerial* + modifiers.csharp: + - public + - get + modifiers.vb: + - Public + - ReadOnly +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: System.Boolean + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: System.Single + isExternal: true + name: Single + nameWithType: Single + fullName: System.Single +- uid: Speechly.Types.AudioInfo.StreamSamplePos* + commentId: Overload:Speechly.Types.AudioInfo.StreamSamplePos + name: StreamSamplePos + nameWithType: AudioInfo.StreamSamplePos + fullName: Speechly.Types.AudioInfo.StreamSamplePos +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Speechly.Types.AudioInfo.SamplesSent* + commentId: Overload:Speechly.Types.AudioInfo.SamplesSent + name: SamplesSent + nameWithType: AudioInfo.SamplesSent + fullName: Speechly.Types.AudioInfo.SamplesSent +- uid: Speechly.Types.AudioInfo.UtteranceSerial* + commentId: Overload:Speechly.Types.AudioInfo.UtteranceSerial + name: UtteranceSerial + nameWithType: AudioInfo.UtteranceSerial + fullName: Speechly.Types.AudioInfo.UtteranceSerial diff --git a/api/Speechly.Types.AudioProcessorOptions.yml b/api/Speechly.Types.AudioProcessorOptions.yml new file mode 100644 index 0000000..f498c9e --- /dev/null +++ b/api/Speechly.Types.AudioProcessorOptions.yml @@ -0,0 +1,264 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.AudioProcessorOptions + commentId: T:Speechly.Types.AudioProcessorOptions + id: AudioProcessorOptions + parent: Speechly.Types + children: + - Speechly.Types.AudioProcessorOptions.FrameMillis + - Speechly.Types.AudioProcessorOptions.HistoryFrames + - Speechly.Types.AudioProcessorOptions.InputSampleRate + - Speechly.Types.AudioProcessorOptions.InternalSampleRate + - Speechly.Types.AudioProcessorOptions.VADControlsListening + - Speechly.Types.AudioProcessorOptions.VADSettings + langs: + - csharp + - vb + name: AudioProcessorOptions + nameWithType: AudioProcessorOptions + fullName: Speechly.Types.AudioProcessorOptions + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: AudioProcessorOptions + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 79 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + summary: "\nOptions for Audio Processor and Voice Activity Detection (VAD)\n" + example: [] + syntax: + content: 'public class AudioProcessorOptions : object' + content.vb: >- + Public Class AudioProcessorOptions + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.AudioProcessorOptions.InputSampleRate + commentId: F:Speechly.Types.AudioProcessorOptions.InputSampleRate + id: InputSampleRate + parent: Speechly.Types.AudioProcessorOptions + langs: + - csharp + - vb + name: InputSampleRate + nameWithType: AudioProcessorOptions.InputSampleRate + fullName: Speechly.Types.AudioProcessorOptions.InputSampleRate + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: InputSampleRate + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 84 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int InputSampleRate + return: + type: System.Int32 + description: "\nInput sample rate in Hz.\n" + content.vb: Public InputSampleRate As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioProcessorOptions.InternalSampleRate + commentId: F:Speechly.Types.AudioProcessorOptions.InternalSampleRate + id: InternalSampleRate + parent: Speechly.Types.AudioProcessorOptions + langs: + - csharp + - vb + name: InternalSampleRate + nameWithType: AudioProcessorOptions.InternalSampleRate + fullName: Speechly.Types.AudioProcessorOptions.InternalSampleRate + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: InternalSampleRate + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 89 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int InternalSampleRate + return: + type: System.Int32 + description: "\nInternal Speechly sample rate in Hz. Currently only 16000 Hz is supported.\n" + content.vb: Public InternalSampleRate As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioProcessorOptions.FrameMillis + commentId: F:Speechly.Types.AudioProcessorOptions.FrameMillis + id: FrameMillis + parent: Speechly.Types.AudioProcessorOptions + langs: + - csharp + - vb + name: FrameMillis + nameWithType: AudioProcessorOptions.FrameMillis + fullName: Speechly.Types.AudioProcessorOptions.FrameMillis + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: FrameMillis + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 94 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int FrameMillis + return: + type: System.Int32 + description: "\nInternal frame length. Affects audio caching and VAD energy analysis.\n" + content.vb: Public FrameMillis As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioProcessorOptions.HistoryFrames + commentId: F:Speechly.Types.AudioProcessorOptions.HistoryFrames + id: HistoryFrames + parent: Speechly.Types.AudioProcessorOptions + langs: + - csharp + - vb + name: HistoryFrames + nameWithType: AudioProcessorOptions.HistoryFrames + fullName: Speechly.Types.AudioProcessorOptions.HistoryFrames + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: HistoryFrames + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 103 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int HistoryFrames + return: + type: System.Int32 + description: "\nTotal number of history frames to keep in memory. Will be sent upon a starting a new utterance.\n" + content.vb: Public HistoryFrames As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioProcessorOptions.VADControlsListening + commentId: F:Speechly.Types.AudioProcessorOptions.VADControlsListening + id: VADControlsListening + parent: Speechly.Types.AudioProcessorOptions + langs: + - csharp + - vb + name: VADControlsListening + nameWithType: AudioProcessorOptions.VADControlsListening + fullName: Speechly.Types.AudioProcessorOptions.VADControlsListening + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: VADControlsListening + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 111 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public bool VADControlsListening + return: + type: System.Boolean + description: "\nAllows VAD's IsSignalDetected to control SpeechlyClient's Start/Stop.\n" + content.vb: Public VADControlsListening As Boolean + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.AudioProcessorOptions.VADSettings + commentId: F:Speechly.Types.AudioProcessorOptions.VADSettings + id: VADSettings + parent: Speechly.Types.AudioProcessorOptions + langs: + - csharp + - vb + name: VADSettings + nameWithType: AudioProcessorOptions.VADSettings + fullName: Speechly.Types.AudioProcessorOptions.VADSettings + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: VADSettings + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 116 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public VADOptions VADSettings + return: + type: Speechly.Types.VADOptions + content.vb: Public VADSettings As VADOptions + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: System.Boolean + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: Speechly.Types.VADOptions + commentId: T:Speechly.Types.VADOptions + parent: Speechly.Types + name: VADOptions + nameWithType: VADOptions + fullName: Speechly.Types.VADOptions diff --git a/api/Speechly.Types.BeautifyEntity.yml b/api/Speechly.Types.BeautifyEntity.yml index 669f4c5..a921e4e 100644 --- a/api/Speechly.Types.BeautifyEntity.yml +++ b/api/Speechly.Types.BeautifyEntity.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: BeautifyEntity path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 19 + startLine: 24 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.BeautifyIntent.yml b/api/Speechly.Types.BeautifyIntent.yml index f4656b8..42cd0e1 100644 --- a/api/Speechly.Types.BeautifyIntent.yml +++ b/api/Speechly.Types.BeautifyIntent.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: BeautifyIntent path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 18 + startLine: 23 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.ContextOptions.ShallowFusionSettings.yml b/api/Speechly.Types.ContextOptions.ShallowFusionSettings.yml new file mode 100644 index 0000000..062510f --- /dev/null +++ b/api/Speechly.Types.ContextOptions.ShallowFusionSettings.yml @@ -0,0 +1,124 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings + commentId: T:Speechly.Types.ContextOptions.ShallowFusionSettings + id: ContextOptions.ShallowFusionSettings + parent: Speechly.Types + children: + - Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + - Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + langs: + - csharp + - vb + name: ContextOptions.ShallowFusionSettings + nameWithType: ContextOptions.ShallowFusionSettings + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: ShallowFusionSettings + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 201 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + summary: "\nIncrease or decrease the probability of recognizing the provided words\n" + example: [] + syntax: + content: 'public class ShallowFusionSettings : object' + content.vb: >- + Public Class ShallowFusionSettings + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + commentId: F:Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + id: Vocabulary + parent: Speechly.Types.ContextOptions.ShallowFusionSettings + langs: + - csharp + - vb + name: Vocabulary + nameWithType: ContextOptions.ShallowFusionSettings.Vocabulary + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Vocabulary + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 210 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public string Vocabulary + return: + type: System.String + description: "\nNewline-delimited words that specify the vocabulary for score biasing.\n" + content.vb: Public Vocabulary As String + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + commentId: F:Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + id: Weight + parent: Speechly.Types.ContextOptions.ShallowFusionSettings + langs: + - csharp + - vb + name: Weight + nameWithType: ContextOptions.ShallowFusionSettings.Weight + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Weight + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 219 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float Weight + return: + type: System.Single + description: "\nBiasing weight. Positive values increase the probability of recognition, negative values decrease it.\n" + content.vb: Public Weight As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: System.String + isExternal: true + name: String + nameWithType: String + fullName: System.String +- uid: System.Single + isExternal: true + name: Single + nameWithType: Single + fullName: System.Single diff --git a/api/Speechly.Types.ContextOptions.yml b/api/Speechly.Types.ContextOptions.yml new file mode 100644 index 0000000..a98360b --- /dev/null +++ b/api/Speechly.Types.ContextOptions.yml @@ -0,0 +1,121 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.ContextOptions + commentId: T:Speechly.Types.ContextOptions + id: ContextOptions + parent: Speechly.Types + children: + - Speechly.Types.ContextOptions.BoostVocabulary + - Speechly.Types.ContextOptions.SilenceSegmentationMillis + langs: + - csharp + - vb + name: ContextOptions + nameWithType: ContextOptions + fullName: Speechly.Types.ContextOptions + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: ContextOptions + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 196 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + summary: "\nOptions for speech recognition\n" + example: [] + syntax: + content: 'public class ContextOptions : object' + content.vb: >- + Public Class ContextOptions + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.ContextOptions.SilenceSegmentationMillis + commentId: F:Speechly.Types.ContextOptions.SilenceSegmentationMillis + id: SilenceSegmentationMillis + parent: Speechly.Types.ContextOptions + langs: + - csharp + - vb + name: SilenceSegmentationMillis + nameWithType: ContextOptions.SilenceSegmentationMillis + fullName: Speechly.Types.ContextOptions.SilenceSegmentationMillis + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SilenceSegmentationMillis + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 227 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public int SilenceSegmentationMillis + return: + type: System.Int32 + content.vb: Public SilenceSegmentationMillis As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.ContextOptions.BoostVocabulary + commentId: F:Speechly.Types.ContextOptions.BoostVocabulary + id: BoostVocabulary + parent: Speechly.Types.ContextOptions + langs: + - csharp + - vb + name: BoostVocabulary + nameWithType: ContextOptions.BoostVocabulary + fullName: Speechly.Types.ContextOptions.BoostVocabulary + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: BoostVocabulary + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 232 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public ContextOptions.ShallowFusionSettings BoostVocabulary + return: + type: Speechly.Types.ContextOptions.ShallowFusionSettings + content.vb: Public BoostVocabulary As ContextOptions.ShallowFusionSettings + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings + commentId: T:Speechly.Types.ContextOptions.ShallowFusionSettings + parent: Speechly.Types + name: ContextOptions.ShallowFusionSettings + nameWithType: ContextOptions.ShallowFusionSettings + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings diff --git a/api/Speechly.Types.Entity.yml b/api/Speechly.Types.Entity.yml index 53d9233..c17348b 100644 --- a/api/Speechly.Types.Entity.yml +++ b/api/Speechly.Types.Entity.yml @@ -20,11 +20,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Entity path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 34 + startLine: 267 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -55,11 +55,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: type path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 37 + startLine: 270 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -86,11 +86,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: value path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 39 + startLine: 272 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -117,11 +117,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: startPosition path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 41 + startLine: 274 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -148,11 +148,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: endPosition path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 43 + startLine: 276 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -179,11 +179,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: isFinal path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 44 + startLine: 277 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.EntityDelegate.yml b/api/Speechly.Types.EntityDelegate.yml index b3043f8..56c7ee5 100644 --- a/api/Speechly.Types.EntityDelegate.yml +++ b/api/Speechly.Types.EntityDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: EntityDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 11 + startLine: 16 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.Intent.yml b/api/Speechly.Types.Intent.yml index 25d57a2..9f76303 100644 --- a/api/Speechly.Types.Intent.yml +++ b/api/Speechly.Types.Intent.yml @@ -17,11 +17,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Intent path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 47 + startLine: 280 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -52,11 +52,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: intent path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 48 + startLine: 281 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -83,11 +83,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: isFinal path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 49 + startLine: 282 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.IntentDelegate.yml b/api/Speechly.Types.IntentDelegate.yml index 289c210..fd086b6 100644 --- a/api/Speechly.Types.IntentDelegate.yml +++ b/api/Speechly.Types.IntentDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: IntentDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 12 + startLine: 17 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.ModelExpiredException.yml b/api/Speechly.Types.ModelExpiredException.yml new file mode 100644 index 0000000..73f0561 --- /dev/null +++ b/api/Speechly.Types.ModelExpiredException.yml @@ -0,0 +1,161 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.ModelExpiredException + commentId: T:Speechly.Types.ModelExpiredException + id: ModelExpiredException + parent: Speechly.Types + children: + - Speechly.Types.ModelExpiredException.#ctor + - Speechly.Types.ModelExpiredException.#ctor(System.String) + - Speechly.Types.ModelExpiredException.#ctor(System.String,Exception) + langs: + - csharp + - vb + name: ModelExpiredException + nameWithType: ModelExpiredException + fullName: Speechly.Types.ModelExpiredException + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: ModelExpiredException + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 27 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: 'public class ModelExpiredException : Exception' + content.vb: >- + Public Class ModelExpiredException + Inherits Exception + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.ModelExpiredException.#ctor + commentId: M:Speechly.Types.ModelExpiredException.#ctor + id: '#ctor' + parent: Speechly.Types.ModelExpiredException + langs: + - csharp + - vb + name: ModelExpiredException() + nameWithType: ModelExpiredException.ModelExpiredException() + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException() + type: Constructor + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: .ctor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 29 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public ModelExpiredException() + content.vb: Public Sub New + overload: Speechly.Types.ModelExpiredException.#ctor* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.ModelExpiredException.#ctor(System.String) + commentId: M:Speechly.Types.ModelExpiredException.#ctor(System.String) + id: '#ctor(System.String)' + parent: Speechly.Types.ModelExpiredException + langs: + - csharp + - vb + name: ModelExpiredException(String) + nameWithType: ModelExpiredException.ModelExpiredException(String) + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException(System.String) + type: Constructor + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: .ctor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 30 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public ModelExpiredException(string message) + parameters: + - id: message + type: System.String + content.vb: Public Sub New(message As String) + overload: Speechly.Types.ModelExpiredException.#ctor* + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.ModelExpiredException.#ctor(System.String,Exception) + commentId: M:Speechly.Types.ModelExpiredException.#ctor(System.String,Exception) + id: '#ctor(System.String,Exception)' + parent: Speechly.Types.ModelExpiredException + langs: + - csharp + - vb + name: ModelExpiredException(String, Exception) + nameWithType: ModelExpiredException.ModelExpiredException(String, Exception) + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException(System.String, Exception) + type: Constructor + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: .ctor + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 31 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public ModelExpiredException(string message, Exception inner) + parameters: + - id: message + type: System.String + - id: inner + type: Exception + content.vb: Public Sub New(message As String, inner As Exception) + overload: Speechly.Types.ModelExpiredException.#ctor* + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: Speechly.Types.ModelExpiredException.#ctor* + commentId: Overload:Speechly.Types.ModelExpiredException.#ctor + name: ModelExpiredException + nameWithType: ModelExpiredException.ModelExpiredException + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException +- uid: System.String + isExternal: true + name: String + nameWithType: String + fullName: System.String +- uid: Exception + commentId: '!:Exception' + isExternal: true + name: Exception + nameWithType: Exception + fullName: Exception diff --git a/api/Speechly.Types.MsgCommon.yml b/api/Speechly.Types.MsgCommon.yml index 7f2a20e..583270c 100644 --- a/api/Speechly.Types.MsgCommon.yml +++ b/api/Speechly.Types.MsgCommon.yml @@ -18,11 +18,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: MsgCommon path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 85 + startLine: 318 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -53,11 +53,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: type path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 86 + startLine: 319 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -88,11 +88,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: audio_context path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 87 + startLine: 320 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -123,11 +123,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: segment_id path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 88 + startLine: 321 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgEntity.yml b/api/Speechly.Types.MsgEntity.yml index febf525..13bae48 100644 --- a/api/Speechly.Types.MsgEntity.yml +++ b/api/Speechly.Types.MsgEntity.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: MsgEntity path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 56 + startLine: 289 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 57 + startLine: 290 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgIntent.Data.yml b/api/Speechly.Types.MsgIntent.Data.yml index 7ecce8d..3e44b11 100644 --- a/api/Speechly.Types.MsgIntent.Data.yml +++ b/api/Speechly.Types.MsgIntent.Data.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 77 + startLine: 310 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: intent path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 78 + startLine: 311 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgIntent.yml b/api/Speechly.Types.MsgIntent.yml index a226176..cabc6e0 100644 --- a/api/Speechly.Types.MsgIntent.yml +++ b/api/Speechly.Types.MsgIntent.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: MsgIntent path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 76 + startLine: 309 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 81 + startLine: 314 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgTentativeEntity.Data.yml b/api/Speechly.Types.MsgTentativeEntity.Data.yml index 161bd7a..b80b764 100644 --- a/api/Speechly.Types.MsgTentativeEntity.Data.yml +++ b/api/Speechly.Types.MsgTentativeEntity.Data.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 69 + startLine: 302 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: entities path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 70 + startLine: 303 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgTentativeEntity.yml b/api/Speechly.Types.MsgTentativeEntity.yml index 53afa6a..bb1ad46 100644 --- a/api/Speechly.Types.MsgTentativeEntity.yml +++ b/api/Speechly.Types.MsgTentativeEntity.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: MsgTentativeEntity path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 68 + startLine: 301 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 73 + startLine: 306 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgTentativeTranscript.Data.yml b/api/Speechly.Types.MsgTentativeTranscript.Data.yml index 5d9944a..0980d35 100644 --- a/api/Speechly.Types.MsgTentativeTranscript.Data.yml +++ b/api/Speechly.Types.MsgTentativeTranscript.Data.yml @@ -17,11 +17,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 61 + startLine: 294 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -52,11 +52,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: transcript path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 62 + startLine: 295 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -83,11 +83,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: words path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 63 + startLine: 296 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgTentativeTranscript.yml b/api/Speechly.Types.MsgTentativeTranscript.yml index 578fef9..e17f7ce 100644 --- a/api/Speechly.Types.MsgTentativeTranscript.yml +++ b/api/Speechly.Types.MsgTentativeTranscript.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: MsgTentativeTranscript path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 60 + startLine: 293 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 65 + startLine: 298 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.MsgTranscript.yml b/api/Speechly.Types.MsgTranscript.yml index f49aa03..36f7930 100644 --- a/api/Speechly.Types.MsgTranscript.yml +++ b/api/Speechly.Types.MsgTranscript.yml @@ -16,11 +16,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: MsgTranscript path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 52 + startLine: 285 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -51,11 +51,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: data path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 53 + startLine: 286 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.SegmentChangeDelegate.yml b/api/Speechly.Types.SegmentChangeDelegate.yml index 663fa3c..4465f0c 100644 --- a/api/Speechly.Types.SegmentChangeDelegate.yml +++ b/api/Speechly.Types.SegmentChangeDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: SegmentChangeDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 7 + startLine: 12 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.StopContextDelegate.yml b/api/Speechly.Types.StartDelegate.yml similarity index 61% rename from api/Speechly.Types.StopContextDelegate.yml rename to api/Speechly.Types.StartDelegate.yml index 35d524a..67059aa 100644 --- a/api/Speechly.Types.StopContextDelegate.yml +++ b/api/Speechly.Types.StartDelegate.yml @@ -1,31 +1,31 @@ ### YamlMime:ManagedReference items: -- uid: Speechly.Types.StopContextDelegate - commentId: T:Speechly.Types.StopContextDelegate - id: StopContextDelegate +- uid: Speechly.Types.StartDelegate + commentId: T:Speechly.Types.StartDelegate + id: StartDelegate parent: Speechly.Types children: [] langs: - csharp - vb - name: StopContextDelegate - nameWithType: StopContextDelegate - fullName: Speechly.Types.StopContextDelegate + name: StartDelegate + nameWithType: StartDelegate + fullName: Speechly.Types.StartDelegate type: Delegate source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: StopContextDelegate + id: StartDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 16 + startLine: 20 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types syntax: - content: public delegate void StopContextDelegate(); - content.vb: Public Delegate Sub StopContextDelegate + content: public delegate void StartDelegate(); + content.vb: Public Delegate Sub StartDelegate modifiers.csharp: - public - delegate diff --git a/api/Speechly.Types.StartMessage.Options.yml b/api/Speechly.Types.StartMessage.Options.yml new file mode 100644 index 0000000..8f4739c --- /dev/null +++ b/api/Speechly.Types.StartMessage.Options.yml @@ -0,0 +1,166 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.StartMessage.Options + commentId: T:Speechly.Types.StartMessage.Options + id: StartMessage.Options + parent: Speechly.Types + children: + - Speechly.Types.StartMessage.Options.silence_triggered_segmentation + - Speechly.Types.StartMessage.Options.vocabulary + - Speechly.Types.StartMessage.Options.vocabulary_bias + langs: + - csharp + - vb + name: StartMessage.Options + nameWithType: StartMessage.Options + fullName: Speechly.Types.StartMessage.Options + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Options + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 237 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: 'public class Options : object' + content.vb: >- + Public Class Options + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.StartMessage.Options.vocabulary + commentId: F:Speechly.Types.StartMessage.Options.vocabulary + id: vocabulary + parent: Speechly.Types.StartMessage.Options + langs: + - csharp + - vb + name: vocabulary + nameWithType: StartMessage.Options.vocabulary + fullName: Speechly.Types.StartMessage.Options.vocabulary + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: vocabulary + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 240 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public string[] vocabulary + return: + type: System.String[] + content.vb: Public vocabulary As String() + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.StartMessage.Options.vocabulary_bias + commentId: F:Speechly.Types.StartMessage.Options.vocabulary_bias + id: vocabulary_bias + parent: Speechly.Types.StartMessage.Options + langs: + - csharp + - vb + name: vocabulary_bias + nameWithType: StartMessage.Options.vocabulary_bias + fullName: Speechly.Types.StartMessage.Options.vocabulary_bias + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: vocabulary_bias + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 242 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public string[] vocabulary_bias + return: + type: System.String[] + content.vb: Public vocabulary_bias As String() + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.StartMessage.Options.silence_triggered_segmentation + commentId: F:Speechly.Types.StartMessage.Options.silence_triggered_segmentation + id: silence_triggered_segmentation + parent: Speechly.Types.StartMessage.Options + langs: + - csharp + - vb + name: silence_triggered_segmentation + nameWithType: StartMessage.Options.silence_triggered_segmentation + fullName: Speechly.Types.StartMessage.Options.silence_triggered_segmentation + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: silence_triggered_segmentation + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 244 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public string[] silence_triggered_segmentation + return: + type: System.String[] + content.vb: Public silence_triggered_segmentation As String() + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: System.String[] + isExternal: true + name: String[] + nameWithType: String[] + fullName: System.String[] + nameWithType.vb: String() + fullName.vb: System.String() + name.vb: String() + spec.csharp: + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: '[]' + nameWithType: '[]' + fullName: '[]' + spec.vb: + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: () + nameWithType: () + fullName: () diff --git a/api/Speechly.Types.StartMessage.yml b/api/Speechly.Types.StartMessage.yml new file mode 100644 index 0000000..be7eada --- /dev/null +++ b/api/Speechly.Types.StartMessage.yml @@ -0,0 +1,151 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.StartMessage + commentId: T:Speechly.Types.StartMessage + id: StartMessage + parent: Speechly.Types + children: + - Speechly.Types.StartMessage.appId + - Speechly.Types.StartMessage.eventType + - Speechly.Types.StartMessage.options + langs: + - csharp + - vb + name: StartMessage + nameWithType: StartMessage + fullName: Speechly.Types.StartMessage + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: StartMessage + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 235 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: 'public class StartMessage : object' + content.vb: >- + Public Class StartMessage + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.StartMessage.eventType + commentId: F:Speechly.Types.StartMessage.eventType + id: eventType + parent: Speechly.Types.StartMessage + langs: + - csharp + - vb + name: eventType + nameWithType: StartMessage.eventType + fullName: Speechly.Types.StartMessage.eventType + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: eventType + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 247 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public string eventType + return: + type: System.String + content.vb: Public eventType As String + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.StartMessage.appId + commentId: F:Speechly.Types.StartMessage.appId + id: appId + parent: Speechly.Types.StartMessage + langs: + - csharp + - vb + name: appId + nameWithType: StartMessage.appId + fullName: Speechly.Types.StartMessage.appId + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: appId + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 249 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public string appId + return: + type: System.String + content.vb: Public appId As String + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.StartMessage.options + commentId: F:Speechly.Types.StartMessage.options + id: options + parent: Speechly.Types.StartMessage + langs: + - csharp + - vb + name: options + nameWithType: StartMessage.options + fullName: Speechly.Types.StartMessage.options + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: options + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 251 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public StartMessage.Options options + return: + type: Speechly.Types.StartMessage.Options + content.vb: Public options As StartMessage.Options + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: System.String + isExternal: true + name: String + nameWithType: String + fullName: System.String +- uid: Speechly.Types.StartMessage.Options + commentId: T:Speechly.Types.StartMessage.Options + parent: Speechly.Types + name: StartMessage.Options + nameWithType: StartMessage.Options + fullName: Speechly.Types.StartMessage.Options diff --git a/api/Speechly.Types.StartStreamDelegate.yml b/api/Speechly.Types.StartStreamDelegate.yml index c54c74a..42dfbb3 100644 --- a/api/Speechly.Types.StartStreamDelegate.yml +++ b/api/Speechly.Types.StartStreamDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: StartStreamDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 13 + startLine: 18 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.StartContextDelegate.yml b/api/Speechly.Types.StopDelegate.yml similarity index 60% rename from api/Speechly.Types.StartContextDelegate.yml rename to api/Speechly.Types.StopDelegate.yml index 3e5f15d..3e5d2eb 100644 --- a/api/Speechly.Types.StartContextDelegate.yml +++ b/api/Speechly.Types.StopDelegate.yml @@ -1,31 +1,31 @@ ### YamlMime:ManagedReference items: -- uid: Speechly.Types.StartContextDelegate - commentId: T:Speechly.Types.StartContextDelegate - id: StartContextDelegate +- uid: Speechly.Types.StopDelegate + commentId: T:Speechly.Types.StopDelegate + id: StopDelegate parent: Speechly.Types children: [] langs: - csharp - vb - name: StartContextDelegate - nameWithType: StartContextDelegate - fullName: Speechly.Types.StartContextDelegate + name: StopDelegate + nameWithType: StopDelegate + fullName: Speechly.Types.StopDelegate type: Delegate source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git - id: StartContextDelegate + id: StopDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 15 + startLine: 21 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types syntax: - content: public delegate void StartContextDelegate(); - content.vb: Public Delegate Sub StartContextDelegate + content: public delegate void StopDelegate(); + content.vb: Public Delegate Sub StopDelegate modifiers.csharp: - public - delegate diff --git a/api/Speechly.Types.StopStreamDelegate.yml b/api/Speechly.Types.StopStreamDelegate.yml index 6458159..3f80b98 100644 --- a/api/Speechly.Types.StopStreamDelegate.yml +++ b/api/Speechly.Types.StopStreamDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: StopStreamDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 14 + startLine: 19 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.TentativeEntityDelegate.yml b/api/Speechly.Types.TentativeEntityDelegate.yml index eb0e447..6e883e0 100644 --- a/api/Speechly.Types.TentativeEntityDelegate.yml +++ b/api/Speechly.Types.TentativeEntityDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: TentativeEntityDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 10 + startLine: 15 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.TentativeTranscriptDelegate.yml b/api/Speechly.Types.TentativeTranscriptDelegate.yml index 5006244..119f2f7 100644 --- a/api/Speechly.Types.TentativeTranscriptDelegate.yml +++ b/api/Speechly.Types.TentativeTranscriptDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: TentativeTranscriptDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 8 + startLine: 13 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.TranscriptDelegate.yml b/api/Speechly.Types.TranscriptDelegate.yml index e56d004..77078d1 100644 --- a/api/Speechly.Types.TranscriptDelegate.yml +++ b/api/Speechly.Types.TranscriptDelegate.yml @@ -15,11 +15,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: TranscriptDelegate path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 9 + startLine: 14 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.VADOptions.yml b/api/Speechly.Types.VADOptions.yml new file mode 100644 index 0000000..4bfb2a2 --- /dev/null +++ b/api/Speechly.Types.VADOptions.yml @@ -0,0 +1,340 @@ +### YamlMime:ManagedReference +items: +- uid: Speechly.Types.VADOptions + commentId: T:Speechly.Types.VADOptions + id: VADOptions + parent: Speechly.Types + children: + - Speechly.Types.VADOptions.Enabled + - Speechly.Types.VADOptions.NoiseGateDb + - Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + - Speechly.Types.VADOptions.SignalActivation + - Speechly.Types.VADOptions.SignalRelease + - Speechly.Types.VADOptions.SignalSearchFrames + - Speechly.Types.VADOptions.SignalSustainMillis + - Speechly.Types.VADOptions.SignalToNoiseDb + langs: + - csharp + - vb + name: VADOptions + nameWithType: VADOptions + fullName: Speechly.Types.VADOptions + type: Class + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: VADOptions + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 122 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + summary: "\nOptions for Voice Activity Detection (VAD)\n" + example: [] + syntax: + content: 'public class VADOptions : object' + content.vb: >- + Public Class VADOptions + Inherits Object + inheritance: + - System.Object + modifiers.csharp: + - public + - class + modifiers.vb: + - Public + - Class +- uid: Speechly.Types.VADOptions.Enabled + commentId: P:Speechly.Types.VADOptions.Enabled + id: Enabled + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: Enabled + nameWithType: VADOptions.Enabled + fullName: Speechly.Types.VADOptions.Enabled + type: Property + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: Enabled + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 127 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public bool Enabled { get; set; } + parameters: [] + return: + type: System.Boolean + description: "\nEnable energy-level calculations\n" + content.vb: Public Property Enabled As Boolean + overload: Speechly.Types.VADOptions.Enabled* + modifiers.csharp: + - public + - get + - set + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.SignalToNoiseDb + commentId: F:Speechly.Types.VADOptions.SignalToNoiseDb + id: SignalToNoiseDb + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: SignalToNoiseDb + nameWithType: VADOptions.SignalToNoiseDb + fullName: Speechly.Types.VADOptions.SignalToNoiseDb + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SignalToNoiseDb + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 136 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float SignalToNoiseDb + return: + type: System.Single + description: "\nSignal-to-noise energy ratio needed for frame to be 'loud'\n" + content.vb: Public SignalToNoiseDb As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.NoiseGateDb + commentId: F:Speechly.Types.VADOptions.NoiseGateDb + id: NoiseGateDb + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: NoiseGateDb + nameWithType: VADOptions.NoiseGateDb + fullName: Speechly.Types.VADOptions.NoiseGateDb + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: NoiseGateDb + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 145 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float NoiseGateDb + return: + type: System.Single + description: "\nEnergy threshold - below this won't trigger activation\n" + content.vb: Public NoiseGateDb As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + commentId: F:Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + id: NoiseLearnHalftimeMillis + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: NoiseLearnHalftimeMillis + nameWithType: VADOptions.NoiseLearnHalftimeMillis + fullName: Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: NoiseLearnHalftimeMillis + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 154 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int NoiseLearnHalftimeMillis + return: + type: System.Int32 + description: "\nRate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy.\n" + content.vb: Public NoiseLearnHalftimeMillis As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.SignalSearchFrames + commentId: F:Speechly.Types.VADOptions.SignalSearchFrames + id: SignalSearchFrames + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: SignalSearchFrames + nameWithType: VADOptions.SignalSearchFrames + fullName: Speechly.Types.VADOptions.SignalSearchFrames + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SignalSearchFrames + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 163 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + syntax: + content: public int SignalSearchFrames + return: + type: System.Int32 + content.vb: Public SignalSearchFrames As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.SignalActivation + commentId: F:Speechly.Types.VADOptions.SignalActivation + id: SignalActivation + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: SignalActivation + nameWithType: VADOptions.SignalActivation + fullName: Speechly.Types.VADOptions.SignalActivation + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SignalActivation + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 172 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float SignalActivation + return: + type: System.Single + description: "\nMinimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected'\n" + content.vb: Public SignalActivation As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.SignalRelease + commentId: F:Speechly.Types.VADOptions.SignalRelease + id: SignalRelease + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: SignalRelease + nameWithType: VADOptions.SignalRelease + fullName: Speechly.Types.VADOptions.SignalRelease + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SignalRelease + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 181 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public float SignalRelease + return: + type: System.Single + description: "\nMaximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over.\n" + content.vb: Public SignalRelease As Single + modifiers.csharp: + - public + modifiers.vb: + - Public +- uid: Speechly.Types.VADOptions.SignalSustainMillis + commentId: F:Speechly.Types.VADOptions.SignalSustainMillis + id: SignalSustainMillis + parent: Speechly.Types.VADOptions + langs: + - csharp + - vb + name: SignalSustainMillis + nameWithType: VADOptions.SignalSustainMillis + fullName: Speechly.Types.VADOptions.SignalSustainMillis + type: Field + source: + remote: + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + branch: feature/new-library-2022-08 + repo: git@github.com:speechly/speechly-unity-dotnet.git + id: SignalSustainMillis + path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs + startLine: 190 + assemblies: + - speechly-unity-net-standard-2.0 + namespace: Speechly.Types + example: [] + syntax: + content: public int SignalSustainMillis + return: + type: System.Int32 + description: "\nDuration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true.\n" + content.vb: Public SignalSustainMillis As Integer + modifiers.csharp: + - public + modifiers.vb: + - Public +references: +- uid: Speechly.Types + commentId: N:Speechly.Types + name: Speechly.Types + nameWithType: Speechly.Types + fullName: Speechly.Types +- uid: Speechly.Types.VADOptions.Enabled* + commentId: Overload:Speechly.Types.VADOptions.Enabled + name: Enabled + nameWithType: VADOptions.Enabled + fullName: Speechly.Types.VADOptions.Enabled +- uid: System.Boolean + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: System.Single + isExternal: true + name: Single + nameWithType: Single + fullName: System.Single +- uid: System.Int32 + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 diff --git a/api/Speechly.Types.Word.yml b/api/Speechly.Types.Word.yml index 2181a10..d3b3462 100644 --- a/api/Speechly.Types.Word.yml +++ b/api/Speechly.Types.Word.yml @@ -20,11 +20,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: Word path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 21 + startLine: 254 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -55,11 +55,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: word path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 24 + startLine: 257 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -86,11 +86,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: index path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 26 + startLine: 259 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -117,11 +117,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: startTimestamp path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 28 + startLine: 261 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -148,11 +148,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: endTimestamp path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 30 + startLine: 263 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types @@ -179,11 +179,11 @@ items: source: remote: path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - branch: feature/dotnet-vad + branch: feature/new-library-2022-08 repo: git@github.com:speechly/speechly-unity-dotnet.git id: isFinal path: speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs - startLine: 31 + startLine: 264 assemblies: - speechly-unity-net-standard-2.0 namespace: Speechly.Types diff --git a/api/Speechly.Types.yml b/api/Speechly.Types.yml index 3022e3c..50ef4ac 100644 --- a/api/Speechly.Types.yml +++ b/api/Speechly.Types.yml @@ -4,12 +4,17 @@ items: commentId: N:Speechly.Types id: Speechly.Types children: + - Speechly.Types.AudioInfo + - Speechly.Types.AudioProcessorOptions - Speechly.Types.BeautifyEntity - Speechly.Types.BeautifyIntent + - Speechly.Types.ContextOptions + - Speechly.Types.ContextOptions.ShallowFusionSettings - Speechly.Types.Entity - Speechly.Types.EntityDelegate - Speechly.Types.Intent - Speechly.Types.IntentDelegate + - Speechly.Types.ModelExpiredException - Speechly.Types.MsgCommon - Speechly.Types.MsgEntity - Speechly.Types.MsgIntent @@ -20,13 +25,16 @@ items: - Speechly.Types.MsgTentativeTranscript.Data - Speechly.Types.MsgTranscript - Speechly.Types.SegmentChangeDelegate - - Speechly.Types.StartContextDelegate + - Speechly.Types.StartDelegate + - Speechly.Types.StartMessage + - Speechly.Types.StartMessage.Options - Speechly.Types.StartStreamDelegate - - Speechly.Types.StopContextDelegate + - Speechly.Types.StopDelegate - Speechly.Types.StopStreamDelegate - Speechly.Types.TentativeEntityDelegate - Speechly.Types.TentativeTranscriptDelegate - Speechly.Types.TranscriptDelegate + - Speechly.Types.VADOptions - Speechly.Types.Word langs: - csharp @@ -86,18 +94,18 @@ references: name: StopStreamDelegate nameWithType: StopStreamDelegate fullName: Speechly.Types.StopStreamDelegate -- uid: Speechly.Types.StartContextDelegate - commentId: T:Speechly.Types.StartContextDelegate - parent: Speechly.Types - name: StartContextDelegate - nameWithType: StartContextDelegate - fullName: Speechly.Types.StartContextDelegate -- uid: Speechly.Types.StopContextDelegate - commentId: T:Speechly.Types.StopContextDelegate - parent: Speechly.Types - name: StopContextDelegate - nameWithType: StopContextDelegate - fullName: Speechly.Types.StopContextDelegate +- uid: Speechly.Types.StartDelegate + commentId: T:Speechly.Types.StartDelegate + parent: Speechly.Types + name: StartDelegate + nameWithType: StartDelegate + fullName: Speechly.Types.StartDelegate +- uid: Speechly.Types.StopDelegate + commentId: T:Speechly.Types.StopDelegate + parent: Speechly.Types + name: StopDelegate + nameWithType: StopDelegate + fullName: Speechly.Types.StopDelegate - uid: Speechly.Types.BeautifyIntent commentId: T:Speechly.Types.BeautifyIntent parent: Speechly.Types @@ -110,6 +118,52 @@ references: name: BeautifyEntity nameWithType: BeautifyEntity fullName: Speechly.Types.BeautifyEntity +- uid: Speechly.Types.ModelExpiredException + commentId: T:Speechly.Types.ModelExpiredException + name: ModelExpiredException + nameWithType: ModelExpiredException + fullName: Speechly.Types.ModelExpiredException +- uid: Speechly.Types.AudioInfo + commentId: T:Speechly.Types.AudioInfo + parent: Speechly.Types + name: AudioInfo + nameWithType: AudioInfo + fullName: Speechly.Types.AudioInfo +- uid: Speechly.Types.AudioProcessorOptions + commentId: T:Speechly.Types.AudioProcessorOptions + parent: Speechly.Types + name: AudioProcessorOptions + nameWithType: AudioProcessorOptions + fullName: Speechly.Types.AudioProcessorOptions +- uid: Speechly.Types.VADOptions + commentId: T:Speechly.Types.VADOptions + parent: Speechly.Types + name: VADOptions + nameWithType: VADOptions + fullName: Speechly.Types.VADOptions +- uid: Speechly.Types.ContextOptions + commentId: T:Speechly.Types.ContextOptions + parent: Speechly.Types + name: ContextOptions + nameWithType: ContextOptions + fullName: Speechly.Types.ContextOptions +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings + commentId: T:Speechly.Types.ContextOptions.ShallowFusionSettings + parent: Speechly.Types + name: ContextOptions.ShallowFusionSettings + nameWithType: ContextOptions.ShallowFusionSettings + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings +- uid: Speechly.Types.StartMessage + commentId: T:Speechly.Types.StartMessage + name: StartMessage + nameWithType: StartMessage + fullName: Speechly.Types.StartMessage +- uid: Speechly.Types.StartMessage.Options + commentId: T:Speechly.Types.StartMessage.Options + parent: Speechly.Types + name: StartMessage.Options + nameWithType: StartMessage.Options + fullName: Speechly.Types.StartMessage.Options - uid: Speechly.Types.Word commentId: T:Speechly.Types.Word parent: Speechly.Types diff --git a/api/toc.yml b/api/toc.yml index 88c549c..c7d1151 100644 --- a/api/toc.yml +++ b/api/toc.yml @@ -4,8 +4,6 @@ items: - uid: Speechly.SLUClient.CloudDecoder name: CloudDecoder - - uid: Speechly.SLUClient.EnergyTresholdVAD - name: EnergyTresholdVAD - uid: Speechly.SLUClient.IDecoder name: IDecoder - uid: Speechly.SLUClient.Segment @@ -15,8 +13,16 @@ - uid: Speechly.Tools name: Speechly.Tools items: + - uid: Speechly.Tools.AudioProcessor + name: AudioProcessor + - uid: Speechly.Tools.AudioProcessor.SendAudioDelegate + name: AudioProcessor.SendAudioDelegate + - uid: Speechly.Tools.AudioProcessor.VadChangeDelegate + name: AudioProcessor.VadChangeDelegate - uid: Speechly.Tools.AudioTools name: AudioTools + - uid: Speechly.Tools.EnergyThresholdVAD + name: EnergyThresholdVAD - uid: Speechly.Tools.JSON name: JSON - uid: Speechly.Tools.Logger @@ -32,10 +38,18 @@ - uid: Speechly.Types name: Speechly.Types items: + - uid: Speechly.Types.AudioInfo + name: AudioInfo + - uid: Speechly.Types.AudioProcessorOptions + name: AudioProcessorOptions - uid: Speechly.Types.BeautifyEntity name: BeautifyEntity - uid: Speechly.Types.BeautifyIntent name: BeautifyIntent + - uid: Speechly.Types.ContextOptions + name: ContextOptions + - uid: Speechly.Types.ContextOptions.ShallowFusionSettings + name: ContextOptions.ShallowFusionSettings - uid: Speechly.Types.Entity name: Entity - uid: Speechly.Types.EntityDelegate @@ -44,6 +58,8 @@ name: Intent - uid: Speechly.Types.IntentDelegate name: IntentDelegate + - uid: Speechly.Types.ModelExpiredException + name: ModelExpiredException - uid: Speechly.Types.MsgCommon name: MsgCommon - uid: Speechly.Types.MsgEntity @@ -64,12 +80,16 @@ name: MsgTranscript - uid: Speechly.Types.SegmentChangeDelegate name: SegmentChangeDelegate - - uid: Speechly.Types.StartContextDelegate - name: StartContextDelegate + - uid: Speechly.Types.StartDelegate + name: StartDelegate + - uid: Speechly.Types.StartMessage + name: StartMessage + - uid: Speechly.Types.StartMessage.Options + name: StartMessage.Options - uid: Speechly.Types.StartStreamDelegate name: StartStreamDelegate - - uid: Speechly.Types.StopContextDelegate - name: StopContextDelegate + - uid: Speechly.Types.StopDelegate + name: StopDelegate - uid: Speechly.Types.StopStreamDelegate name: StopStreamDelegate - uid: Speechly.Types.TentativeEntityDelegate @@ -78,5 +98,7 @@ name: TentativeTranscriptDelegate - uid: Speechly.Types.TranscriptDelegate name: TranscriptDelegate + - uid: Speechly.Types.VADOptions + name: VADOptions - uid: Speechly.Types.Word name: Word diff --git a/docs/README.html b/docs/README.html index b09ea94..8f5b132 100644 --- a/docs/README.html +++ b/docs/README.html @@ -5,10 +5,10 @@ - Speechly Client for Unity and .NET Standard 2.0 API + Speechly Client Library for Unity and C# - - + + @@ -60,35 +60,28 @@
-

Speechly Client for Unity and .NET Standard 2.0 API

+

Speechly Client Library for Unity and C#

Speechly is an API for building voice features into games, XR, applications and web sites. This client library streams audio from a Unity or .NET app to Speechly cloud API and provides a C# API for receiving real-time speech-to-text transcription and natural language understanding results.

Download speechly-client.unitypackage to get the latest Speechly Unity client library and example scenes bundled up for Unity.

Requirements

    -
  • A C# development environment conforming to .NET Standard 2.0 API +
  • A C# development environment with .NET Standard 2.0 API:
    • Unity 2018.1 or later (tested with 2019.4.36f1 and 2021.2.12f1)
    • Microsoft .NET Core 3 or later (tested with .NET 6.0.200)
-

Contents of this repository

- -

Getting Started with Unity

-

Import Speechly/ folder from speechly-client.unitypackage that contains code to use Speechly cloud API.

-
-

If you want to skip straight to trying out a working sample scene, see more code examples below.

-

Unity example

The following code example streams a pre-recorded raw audio file (16 bit mono, 16000 samples/sec) to Speechly via the websocket API and logs speech and language recognition results to console.

Constructing SpeechlyClient requires an appId (or projectId) from Speechly Dashboard that determines which intents and keywords (entities) should be returned in addition to basic speech-to-text (ASR).

@@ -127,9 +120,9 @@

Unity example

await SpeechlyClient.Initialize(decoder); // Send test audio. Callback(s) will fire and log the results. - await client.StartContext(); + await client.Start(); client.ProcessAudioFile("Assets/Speechly/00_chinese_restaurant.raw"); - await client.StopContext(); + await client.Stop(); } void Update() @@ -139,7 +132,17 @@

Unity example

} } -

More code examples

+

Contents of this repository

+

MicToSpeechly

Import SpeechlyExamples/MicToSpeechly/ and Speechly/ folders from speechly-client.unitypackage to run a Unity sample scene that streams data from microphone to Speechly using MicToSpeechly.cs script running on a GameObject. App-specific logic is in UseSpeechly.cs which registers a callback and shows speech-to-text results in the UI.

VoiceCommands

@@ -155,9 +158,13 @@

Device testing

To diagnose problems with device builds, you can do the following:

  • First try running MicToSpeechlyScene.unity in the editor without errors.
    • -
  • Change to Android player, set MicToSpeechlyScene.unity as the main scene and do a build and run to deploy the build to on a device.
    • -
  • On terminal, do adb logcat -s Unity:D to follow Unity-related logs from the device.
    • -
  • Run the app on device. Keep Hold to talk button pressed and say "ONE, TWO, THREE". Then release the button.
    • +
  • Change to Android player, set MicToSpeechlyScene.unity as the main scene and do a build and run to deploy and start the build to on a device.
    • +
  • On the terminal start following Unity-related log lines:
    • +
+
adb logcat -s Unity:D
+
+
    +
  • Use the app on device. Ensure it's listening (e.g. keep Hold to talk button pressed) and say "ONE, TWO, THREE". Then release the button.
  • You should see "ONE, TWO, THREE" displayed in the top-left corner of the screen. If not, see the terminal for errors.

Android troubleshooting

@@ -191,7 +198,7 @@

Command line usage with dotnet

diff --git a/docs/api/Speechly.SLUClient.AppTokenRequest.html b/docs/api/Speechly.SLUClient.AppTokenRequest.html deleted file mode 100644 index 330366a..0000000 --- a/docs/api/Speechly.SLUClient.AppTokenRequest.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - Class AppTokenRequest - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class AppTokenRequest -

-
-
-
-
Inheritance
-
System.Object
-
AppTokenRequest
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class AppTokenRequest : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

appId

-
-
-
Declaration
-
- 
public string appId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - -

deviceId

-
-
-
Declaration
-
- 
public string deviceId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.AudioTools.html b/docs/api/Speechly.SLUClient.AudioTools.html deleted file mode 100644 index 5183dbc..0000000 --- a/docs/api/Speechly.SLUClient.AudioTools.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - - Class AudioTools - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class AudioTools -

-
-
-
-
Inheritance
-
System.Object
-
AudioTools
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class AudioTools : object
-
-

Methods -

- - | - Improve this Doc - - - View Source - - -

ConvertInt16ToFloat(in Byte[], ref Single[], Int32, Int32, Int32)

-
-
-
Declaration
-
- 
public static int ConvertInt16ToFloat(in byte[] src, ref float[] dest, int srcStartSample = 0, int lengthSamples = null, int dstIndex = 0)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Byte[]src
System.Single[]dest
System.Int32srcStartSample
System.Int32lengthSamples
System.Int32dstIndex
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.Int32
- - | - Improve this Doc - - - View Source - - -

Downsample(in Single[], ref Single[], Int32, Int32, Int32, Int32)

-
-
-
Declaration
-
- 
public static void Downsample(in float[] src, ref float[] dest, int sourceIndex = 0, int sourceLength = null, int destIndex = 0, int destLength = null)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Single[]src
System.Single[]dest
System.Int32sourceIndex
System.Int32sourceLength
System.Int32destIndex
System.Int32destLength
- - | - Improve this Doc - - - View Source - - -

GetAudioPeak(in Single[], Int32, Int32)

-
-
-
Declaration
-
- 
public static float GetAudioPeak(in float[] samples, int start = 0, int length = null)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Single[]samples
System.Int32start
System.Int32length
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - - -

GetEnergy(in Single[], Int32, Int32)

-
-
-
Declaration
-
- 
public static float GetEnergy(in float[] samples, int start = 0, int length = null)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Single[]samples
System.Int32start
System.Int32length
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.Single
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.CloudDecoder.html b/docs/api/Speechly.SLUClient.CloudDecoder.html index d498c65..027d9c8 100644 --- a/docs/api/Speechly.SLUClient.CloudDecoder.html +++ b/docs/api/Speechly.SLUClient.CloudDecoder.html @@ -10,7 +10,7 @@ - + @@ -75,8 +75,8 @@

Provides speech processing with Speechly's cloud SLU service.

Internally handles authentication using https and audio streaming via secure websocket. -Audio is streamed when listening is started with SpeechlyClient.StartContext(). -Streaming stops upon call to SpeechlyClient.StopContext().

+Audio is streamed when listening is started with SpeechlyClient.Start(). +Streaming stops upon call to SpeechlyClient.Stop().

@@ -95,10 +95,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

CloudDecoder(String, String, String, String, Boolean)

@@ -159,10 +159,10 @@
Parameters
diff --git a/docs/api/Speechly.SLUClient.ConfigTool.html b/docs/api/Speechly.SLUClient.ConfigTool.html deleted file mode 100644 index 6f640a5..0000000 --- a/docs/api/Speechly.SLUClient.ConfigTool.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - - Class ConfigTool - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class ConfigTool -

-
-
-
-
Inheritance
-
System.Object
-
ConfigTool
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class ConfigTool : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

ConfigPath

-
-
-
Declaration
-
- 
public static string ConfigPath
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - -

deviceId

-
-
-
Declaration
-
- 
public string deviceId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-

Methods -

- - | - Improve this Doc - - - View Source - - -

RestoreOrCreate<T>(String)

-
-
-
Declaration
-
- 
public static T RestoreOrCreate<T>(string ConfigFileName)
-    where T : class, new()
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.StringConfigFileName
-
Returns
- - - - - - - - - - - - - -
TypeDescription
T
-
Type Parameters
- - - - - - - - - - - - - -
NameDescription
T
- - | - Improve this Doc - - - View Source - - -

Save<T>(T, String)

-
-
-
Declaration
-
- 
public static void Save<T>(T configData, string ConfigFileName)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
TconfigData
System.StringConfigFileName
-
Type Parameters
- - - - - - - - - - - - - -
NameDescription
T
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.EnergyTresholdVAD.html b/docs/api/Speechly.SLUClient.EnergyTresholdVAD.html deleted file mode 100644 index e3b4867..0000000 --- a/docs/api/Speechly.SLUClient.EnergyTresholdVAD.html +++ /dev/null @@ -1,534 +0,0 @@ - - - - - - - - Class EnergyTresholdVAD - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class EnergyTresholdVAD -

-

Adaptive energy threshold voice activity detection (VAD) implementation. -It can be used to enable hands-free operation of the SLU decoder.

-

When enough loud frames have been detected, VAD activates and calls StartContext automatically. When enough silent frames have been detected, the VAD deactivates after the sustain time and StopContext is called automatically. The background noise energy gradually adapts when VAD is not active.

-

Use its public field to configure minimum energy level, signal-to-noise ratio, minimum activation time and an activation/deactivation treshold (ratio of loud to silent frames).

-
-
-
-
Inheritance
-
System.Object
-
EnergyTresholdVAD
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class EnergyTresholdVAD : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

Enabled

-
-
-
Declaration
-
- 
public bool Enabled
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Boolean
- - | - Improve this Doc - - - View Source - -

VADActivation

-
-
-
Declaration
-
- 
public float VADActivation
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - -

VADControlListening

-
-
-
Declaration
-
- 
public bool VADControlListening
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Boolean
- - | - Improve this Doc - - - View Source - -

VADFrames

-
-
-
Declaration
-
- 
public int VADFrames
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
- - | - Improve this Doc - - - View Source - -

VADMinimumEnergy

-
-
-
Declaration
-
- 
public float VADMinimumEnergy
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - -

VADNoiseHalftimeMillis

-
-
-
Declaration
-
- 
public int VADNoiseHalftimeMillis
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
- - | - Improve this Doc - - - View Source - -

VADRelease

-
-
-
Declaration
-
- 
public float VADRelease
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - -

VADSignalToNoise

-
-
-
Declaration
-
- 
public float VADSignalToNoise
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - -

VADSustainMillis

-
-
-
Declaration
-
- 
public int VADSustainMillis
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
-

Properties -

- - | - Improve this Doc - - - View Source - - -

BaselineEnergy

-
-
-
Declaration
-
- 
public float BaselineEnergy { get; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - - -

Energy

-
-
-
Declaration
-
- 
public float Energy { get; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Single
- - | - Improve this Doc - - - View Source - - -

IsSignalDetected

-
-
-
Declaration
-
- 
public bool IsSignalDetected { get; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Boolean
-

Methods -

- - | - Improve this Doc - - - View Source - - -

ProcessFrame(Single[], Int32, Int32)

-
-
-
Declaration
-
- 
public void ProcessFrame(float[] floats, int start = 0, int length = null)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Single[]floats
System.Int32start
System.Int32length
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.IDecoder.html b/docs/api/Speechly.SLUClient.IDecoder.html index aa5b808..529ab26 100644 --- a/docs/api/Speechly.SLUClient.IDecoder.html +++ b/docs/api/Speechly.SLUClient.IDecoder.html @@ -10,7 +10,7 @@ - + @@ -95,10 +95,10 @@
Syntax
diff --git a/docs/api/Speechly.SLUClient.IntentFormatter.html b/docs/api/Speechly.SLUClient.IntentFormatter.html deleted file mode 100644 index cb38091..0000000 --- a/docs/api/Speechly.SLUClient.IntentFormatter.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - - Delegate IntentFormatter - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate IntentFormatter -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate string IntentFormatter(string intent);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.Stringintent
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.JSON.html b/docs/api/Speechly.SLUClient.JSON.html deleted file mode 100644 index a771978..0000000 --- a/docs/api/Speechly.SLUClient.JSON.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - Class JSON - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class JSON -

-
-
-
-
Inheritance
-
System.Object
-
JSON
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class JSON : object
-
-

Methods -

- - | - Improve this Doc - - - View Source - - -

Parse<T>(String, T)

-
-
-
Declaration
-
- 
public static T Parse<T>(string json, T obj)
-    where T : class
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Stringjson
Tobj
-
Returns
- - - - - - - - - - - - - -
TypeDescription
T
-
Type Parameters
- - - - - - - - - - - - - -
NameDescription
T
- - | - Improve this Doc - - - View Source - - -

ParseFromStream<T>(Stream, T)

-
-
-
Declaration
-
- 
public static T ParseFromStream<T>(Stream stream, T obj)
-    where T : class
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
Streamstream
Tobj
-
Returns
- - - - - - - - - - - - - -
TypeDescription
T
-
Type Parameters
- - - - - - - - - - - - - -
NameDescription
T
- - | - Improve this Doc - - - View Source - - -

Stringify<T>(T)

-
-
-
Declaration
-
- 
public static string Stringify<T>(T obj)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
Tobj
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.String
-
Type Parameters
- - - - - - - - - - - - - -
NameDescription
T
- - | - Improve this Doc - - - View Source - - -

StringifyToStream<T>(T)

-
-
-
Declaration
-
- 
public static MemoryStream StringifyToStream<T>(T obj)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
Tobj
-
Returns
- - - - - - - - - - - - - -
TypeDescription
MemoryStream
-
Type Parameters
- - - - - - - - - - - - - -
NameDescription
T
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.Logger.LoggerDelegate.html b/docs/api/Speechly.SLUClient.Logger.LoggerDelegate.html deleted file mode 100644 index 340368a..0000000 --- a/docs/api/Speechly.SLUClient.Logger.LoggerDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate Logger.LoggerDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate Logger.LoggerDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void LoggerDelegate(string s);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.Strings
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgEntity.html b/docs/api/Speechly.SLUClient.MsgEntity.html deleted file mode 100644 index 11bb32a..0000000 --- a/docs/api/Speechly.SLUClient.MsgEntity.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgEntity - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgEntity -

-
-
-
-
Inheritance
-
System.Object
-
MsgEntity
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class MsgEntity : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

data

-
-
-
Declaration
-
- 
public Entity data
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
Entity
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgIntent.Data.html b/docs/api/Speechly.SLUClient.MsgIntent.Data.html deleted file mode 100644 index 1dc33ae..0000000 --- a/docs/api/Speechly.SLUClient.MsgIntent.Data.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgIntent.Data - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgIntent.Data -

-
-
-
-
Inheritance
-
System.Object
-
MsgIntent.Data
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class Data : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

intent

-
-
-
Declaration
-
- 
public string intent
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgIntent.html b/docs/api/Speechly.SLUClient.MsgIntent.html deleted file mode 100644 index fc46233..0000000 --- a/docs/api/Speechly.SLUClient.MsgIntent.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgIntent - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgIntent -

-
-
-
-
Inheritance
-
System.Object
-
MsgIntent
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class MsgIntent : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

data

-
-
-
Declaration
-
- 
public MsgIntent.Data data
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
MsgIntent.Data
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgTentativeEntity.Data.html b/docs/api/Speechly.SLUClient.MsgTentativeEntity.Data.html deleted file mode 100644 index 8792efb..0000000 --- a/docs/api/Speechly.SLUClient.MsgTentativeEntity.Data.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgTentativeEntity.Data - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgTentativeEntity.Data -

-
-
-
-
Inheritance
-
System.Object
-
MsgTentativeEntity.Data
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class Data : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

entities

-
-
-
Declaration
-
- 
public Entity[] entities
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
Entity[]
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgTentativeEntity.html b/docs/api/Speechly.SLUClient.MsgTentativeEntity.html deleted file mode 100644 index eb5a4b3..0000000 --- a/docs/api/Speechly.SLUClient.MsgTentativeEntity.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgTentativeEntity - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgTentativeEntity -

-
-
-
-
Inheritance
-
System.Object
-
MsgTentativeEntity
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class MsgTentativeEntity : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

data

-
-
-
Declaration
-
- 
public MsgTentativeEntity.Data data
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
MsgTentativeEntity.Data
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgTentativeTranscript.Data.html b/docs/api/Speechly.SLUClient.MsgTentativeTranscript.Data.html deleted file mode 100644 index 1741e60..0000000 --- a/docs/api/Speechly.SLUClient.MsgTentativeTranscript.Data.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - Class MsgTentativeTranscript.Data - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgTentativeTranscript.Data -

-
-
-
-
Inheritance
-
System.Object
-
MsgTentativeTranscript.Data
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class Data : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

transcript

-
-
-
Declaration
-
- 
public string transcript
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - -

words

-
-
-
Declaration
-
- 
public Word[] words
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
Word[]
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgTentativeTranscript.html b/docs/api/Speechly.SLUClient.MsgTentativeTranscript.html deleted file mode 100644 index c20212f..0000000 --- a/docs/api/Speechly.SLUClient.MsgTentativeTranscript.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgTentativeTranscript - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgTentativeTranscript -

-
-
-
-
Inheritance
-
System.Object
-
MsgTentativeTranscript
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class MsgTentativeTranscript : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

data

-
-
-
Declaration
-
- 
public MsgTentativeTranscript.Data data
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
MsgTentativeTranscript.Data
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.MsgTranscript.html b/docs/api/Speechly.SLUClient.MsgTranscript.html deleted file mode 100644 index d6a9176..0000000 --- a/docs/api/Speechly.SLUClient.MsgTranscript.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class MsgTranscript - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class MsgTranscript -

-
-
-
-
Inheritance
-
System.Object
-
MsgTranscript
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class MsgTranscript : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

data

-
-
-
Declaration
-
- 
public Word data
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
Word
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.Platform.html b/docs/api/Speechly.SLUClient.Platform.html deleted file mode 100644 index 00f2368..0000000 --- a/docs/api/Speechly.SLUClient.Platform.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - Class Platform - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class Platform -

-
-
-
-
Inheritance
-
System.Object
-
Platform
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class Platform : object
-
-

Methods -

- - | - Improve this Doc - - - View Source - - -

Fetch(String)

-
-
-
Declaration
-
- 
public static Task<byte[]> Fetch(string url)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.Stringurl
-
Returns
- - - - - - - - - - - - - -
TypeDescription
Task<System.Byte[]>
- - | - Improve this Doc - - - View Source - - -

GetDeviceId(String)

-
-
-
Declaration
-
- 
public static string GetDeviceId(string seed = null)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.Stringseed
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - - -

GetPersistentStoragePath()

-
-
-
Declaration
-
- 
public static string GetPersistentStoragePath()
-
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - - -

GuidFromString(String)

-
-
-
Declaration
-
- 
public static string GuidFromString(string s)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.Strings
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.Preferences.html b/docs/api/Speechly.SLUClient.Preferences.html deleted file mode 100644 index 2c36698..0000000 --- a/docs/api/Speechly.SLUClient.Preferences.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - Class Preferences - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class Preferences -

-
-
-
-
Inheritance
-
System.Object
-
Preferences
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class Preferences : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

deviceId

-
-
-
Declaration
-
- 
public string deviceId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - -

FileName

-
-
-
Declaration
-
- 
public static string FileName
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.ProjectTokenRequest.html b/docs/api/Speechly.SLUClient.ProjectTokenRequest.html deleted file mode 100644 index 9695c61..0000000 --- a/docs/api/Speechly.SLUClient.ProjectTokenRequest.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - Class ProjectTokenRequest - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class ProjectTokenRequest -

-
-
-
-
Inheritance
-
System.Object
-
ProjectTokenRequest
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class ProjectTokenRequest : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

deviceId

-
-
-
Declaration
-
- 
public string deviceId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
- - | - Improve this Doc - - - View Source - -

projectId

-
-
-
Declaration
-
- 
public string projectId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.ResponseReceivedDelegate.html b/docs/api/Speechly.SLUClient.ResponseReceivedDelegate.html deleted file mode 100644 index 0c0475a..0000000 --- a/docs/api/Speechly.SLUClient.ResponseReceivedDelegate.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - Delegate ResponseReceivedDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate ResponseReceivedDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void ResponseReceivedDelegate(MsgCommon msgCommon, string msgString);
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
MsgCommonmsgCommon
System.StringmsgString
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.Segment.html b/docs/api/Speechly.SLUClient.Segment.html index 1f8eaee..ba0257f 100644 --- a/docs/api/Speechly.SLUClient.Segment.html +++ b/docs/api/Speechly.SLUClient.Segment.html @@ -10,7 +10,7 @@ - + @@ -92,10 +92,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

Segment(String, Int32)

@@ -131,10 +131,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

contextId

@@ -160,10 +160,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

entities

@@ -189,10 +189,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

id

@@ -218,10 +218,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

intent

@@ -247,10 +247,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

isFinal

@@ -276,10 +276,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

words

@@ -307,10 +307,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

ToString()

@@ -337,10 +337,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

ToString(BeautifyIntent, BeautifyEntity, String)

@@ -400,10 +400,10 @@
Returns
diff --git a/docs/api/Speechly.SLUClient.SegmentMessage.html b/docs/api/Speechly.SLUClient.SegmentMessage.html deleted file mode 100644 index e0b02dc..0000000 --- a/docs/api/Speechly.SLUClient.SegmentMessage.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - - - Struct SegmentMessage - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Struct SegmentMessage -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public struct SegmentMessage
-
-

Constructors -

- - | - Improve this Doc - - - View Source - - -

SegmentMessage(MsgCommon, String)

-
-
-
Declaration
-
- 
public SegmentMessage(MsgCommon msgCommon, string msgString)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
MsgCommonmsgCommon
System.StringmsgString
-

Fields -

- - | - Improve this Doc - - - View Source - -

msgCommon

-
-
-
Declaration
-
- 
public MsgCommon msgCommon
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
MsgCommon
- - | - Improve this Doc - - - View Source - -

msgString

-
-
-
Declaration
-
- 
public string msgString
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.IntentDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.IntentDelegate.html deleted file mode 100644 index 394a6f5..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.IntentDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.IntentDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.IntentDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void IntentDelegate(MsgIntent msg);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
MsgIntentmsg
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.SegmentChangeDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.SegmentChangeDelegate.html deleted file mode 100644 index 9ca3586..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.SegmentChangeDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.SegmentChangeDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.SegmentChangeDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void SegmentChangeDelegate(Segment segment);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
Segmentsegment
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.StartContextDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.StartContextDelegate.html deleted file mode 100644 index 38f70fe..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.StartContextDelegate.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.StartContextDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.StartContextDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void StartContextDelegate();
-
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.StartStreamDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.StartStreamDelegate.html deleted file mode 100644 index 7f27908..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.StartStreamDelegate.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.StartStreamDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.StartStreamDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void StartStreamDelegate();
-
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.StopContextDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.StopContextDelegate.html deleted file mode 100644 index d4ec574..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.StopContextDelegate.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.StopContextDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.StopContextDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void StopContextDelegate();
-
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.StopStreamDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.StopStreamDelegate.html deleted file mode 100644 index 4ac5701..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.StopStreamDelegate.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.StopStreamDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.StopStreamDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void StopStreamDelegate();
-
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.TentativeEntityDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.TentativeEntityDelegate.html deleted file mode 100644 index 579fe9e..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.TentativeEntityDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.TentativeEntityDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.TentativeEntityDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void TentativeEntityDelegate(MsgTentativeEntity msg);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
MsgTentativeEntitymsg
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.TentativeTranscriptDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.TentativeTranscriptDelegate.html deleted file mode 100644 index 22428f0..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.TentativeTranscriptDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.TentativeTranscriptDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.TentativeTranscriptDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void TentativeTranscriptDelegate(MsgTentativeTranscript msg);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
MsgTentativeTranscriptmsg
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.TranscriptDelegate.html b/docs/api/Speechly.SLUClient.SpeechlyClient.TranscriptDelegate.html deleted file mode 100644 index becf28d..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.TranscriptDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate SpeechlyClient.TranscriptDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate SpeechlyClient.TranscriptDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void TranscriptDelegate(MsgTranscript msg);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
MsgTranscriptmsg
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.html b/docs/api/Speechly.SLUClient.SpeechlyClient.html index a2cbd6c..ddd1c52 100644 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.html +++ b/docs/api/Speechly.SLUClient.SpeechlyClient.html @@ -10,7 +10,7 @@ - + @@ -77,14 +77,14 @@

Usage

-

You can feed audio continuously, but control when to start and stop process speech with StartContext(String) and StopContext() or -let voice activity detection (VAD) handle that automatically by passing EnergyTresholdVAD to SpeechlyClient constructor.

+

You can feed audio continuously, but control when to start and stop process speech with Start(String) and Stop() or +let voice activity detection (VAD) handle that automatically by passing EnergyThresholdVAD to SpeechlyClient constructor.

@@ -102,19 +102,19 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source -

SpeechlyClient(Int32, Int32, Int32, Boolean, String, EnergyTresholdVAD, Boolean)

+

SpeechlyClient(Boolean, String, AudioInfo, Boolean)

Create a new SpeechlyClient to process audio and fire delegates to provide SLU results.

Declaration
- 
public SpeechlyClient(int frameMillis = 30, int historyFrames = 5, int inputSampleRate = 16000, bool manualUpdate = false, string saveToFolder = null, EnergyTresholdVAD vad = null, bool debug = false)
+ 
public SpeechlyClient(bool manualUpdate = false, string saveToFolder = null, AudioInfo output = null, bool debug = false)
Parameters
@@ -126,24 +126,6 @@
Parameters
- - - - - - - - - - - - - - - @@ -157,10 +139,9 @@
Parameters
- - - + + + @@ -174,10 +155,39 @@

Fields

| - Improve this Doc + Improve this Doc + + + View Source + +

Debug

+
+
+
Declaration
+
+ 
public bool Debug
+
+
Field Value
+
System.Int32frameMillis

Size of one audio frame (default: 30 ms). Total history duration will be historyFrames*frameSamples. History is sent upon StartContext to capture the start of utterance which especially important with VAD, which activates with a constant delay.

-
System.Int32historyFrames

Count of the audio history frames (default: 5). Total history duration will be historyFrames * frameSamples.

-
System.Int32inputSampleRate

Define the sample rate of incoming audio (default: 16000)

-
System.Boolean manualUpdate
EnergyTresholdVADvad

EnergyTresholdVAD instance to control automatic listening on/off. Null disables VAD. (default: null)

-		AudioInfooutput
System.Boolean
+ + + + + + + + + + + + +
TypeDescription
System.Boolean
+ + | + Improve this Doc - View Source + View Source

OnEntity

@@ -203,10 +213,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnIntent

@@ -232,14 +242,14 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnSegmentChange

Read the combined results of automatic speech recoginition (ASR) and natural language detection (NLU).

-

You can control when to start and stop process speech either manually with StartContext(String) and StopContext() or +

You can control when to start and stop process speech either manually with Start(String) and Stop() or automatically by providing a voice activity detection (VAD) field to SpeechlyClient.

@@ -264,17 +274,17 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source -

OnStartContext

+

OnStart

Declaration
- 
public StartContextDelegate OnStartContext
+ 
public StartDelegate OnStart
Field Value
@@ -286,17 +296,17 @@
Field Value
- +
StartContextDelegateStartDelegate
| - Improve this Doc + Improve this Doc - View Source + View Source

OnStartStream

@@ -322,17 +332,17 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source -

OnStopContext

+

OnStop

Declaration
- 
public StopContextDelegate OnStopContext
+ 
public StopDelegate OnStop
Field Value
@@ -344,17 +354,17 @@
Field Value
- +
StopContextDelegateStopDelegate
| - Improve this Doc + Improve this Doc - View Source + View Source

OnStopStream

@@ -380,10 +390,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnTentativeEntity

@@ -409,10 +419,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnTentativeIntent

@@ -438,10 +448,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnTentativeTranscript

@@ -467,10 +477,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnTranscript

@@ -498,10 +508,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

AudioInputStreamIdentifier

@@ -528,10 +538,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsActive

@@ -558,10 +568,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsAudioStreaming

@@ -588,10 +598,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsReady

@@ -618,18 +628,18 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source - -

SamplesSent

+ +

Output

Declaration
- 
public int SamplesSent { get; }
+ 
public AudioInfo Output { get; }
Property Value
@@ -641,112 +651,56 @@
Property Value
- - - - -
System.Int32
- - | - Improve this Doc - - - View Source - - -

StreamSamplePos

-
-
-
Declaration
-
- 
public int StreamSamplePos { get; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
- - | - Improve this Doc - - - View Source - - -

UtteranceSerial

-
-
-
Declaration
-
- 
public int UtteranceSerial { get; }
-
-
Property Value
- - - - - - - - - - +
TypeDescription
System.Int32AudioInfo
+

Methods +

| - Improve this Doc + Improve this Doc - View Source + View Source - -

Vad

-
+ +

AdjustAudioProcessor(Nullable<Boolean>)

+

Control AudioProcessor parameters.

+
Declaration
- 
public EnergyTresholdVAD Vad { get; }
+ 
public void AdjustAudioProcessor(bool? vadControlsListening = null)
-
Property Value
+
Parameters
+ - - + + +
TypeName Description
EnergyTresholdVADSystem.Nullable<System.Boolean>vadControlsListening

true enables VAD to control listening. false disables VAD feature and stops listening immediately. null for no change.

+
-

Methods -

| - Improve this Doc + Improve this Doc - View Source + View Source -

Initialize(IDecoder)

+

Initialize(IDecoder, AudioProcessorOptions, ContextOptions, Boolean)

SLU decoder instance to use like CloudDecoder.

The SLU decoder provides the automatic speech recognition (ASR) and natural language understanding (NLU) capabilities via SLU delegates (OnSegmentChange, OnTranscript...).

@@ -754,7 +708,7 @@

Declaration
- 
public async Task Initialize(IDecoder decoder)
+ 
public async Task Initialize(IDecoder decoder, AudioProcessorOptions audioProcessorOptions = null, ContextOptions contextOptions = null, bool preferLibSpeechlyAudioProcessor = false)
Parameters
@@ -772,6 +726,21 @@
Parameters
+ + + + + + + + + + + + + + +

SLU decoder implementing IDecoder interface like CloudDecoder.
AudioProcessorOptionsaudioProcessorOptions
ContextOptionscontextOptions
System.BooleanpreferLibSpeechlyAudioProcessor
Returns
@@ -792,10 +761,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

ProcessAudio(Stream)

@@ -824,23 +793,23 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source -

ProcessAudio(Single[], Int32, Int32, Boolean)

+

ProcessAudio(Single[], Int32, Int32)

Process speech audio samples from a microphone or other audio source.

It's recommended to constantly feed new audio as long as you want to use Speechly's SLU services.

-

You can control when to start and stop process speech either manually with StartContext(String) and StopContext() or +

You can control when to start and stop process speech either manually with Start(String) and Stop() or automatically by providing a voice activity detection (VAD) field to SpeechlyClient.

The audio is handled as follows:

  • Downsample to 16kHz if needed
  • Add to history ringbuffer
  • Calculate energy (VAD)
    • -
  • Automatic Start/StopContext (VAD)
    • +
  • Automatic Start/Stop (VAD)
  • Send utterance audio to a file
  • Send utterance audio to Speechly SLU decoder
@@ -848,7 +817,7 @@

Declaration
- 
public void ProcessAudio(float[] floats, int start = 0, int length = null, bool forceSubFrameProcess = false)
+ 
public void ProcessAudio(float[] floats, int start = 0, int length = null)
Parameters
@@ -876,22 +845,16 @@
Parameters
- - - - -
System.Int32 length

Length of audio to process in samples or -1 to process the whole array (default: -1).

-
System.BooleanforceSubFrameProcess

StopStream(Boolean) internally uses this to force processing of last subframe at end of audio stream (default: false).
| - Improve this Doc + Improve this Doc - View Source + View Source

ProcessAudioFile(String)

@@ -920,10 +883,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Shutdown()

@@ -952,21 +915,21 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source - -

StartContext(String)

+ +

Start(String)

Start listening for user speech and feeding it to the SLU decoder. -OnContextStart is triggered upon a call to StartContext. It's also triggered by automatic VAD activation.

+OnContextStart is triggered upon a call to Start. It's also triggered by automatic VAD activation.

You don't need to await this call if you don't need the utterance id.

Declaration
- 
public Task<string> StartContext(string appId = null)
+ 
public Task<string> Start(string appId = null)
Parameters
@@ -1004,14 +967,14 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

StartStream(String, Boolean)

-

StartStream should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and StartContext ensure it's been called. +

StartStream should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and Start ensure it's been called. OnStreamStart delegate is triggered upon a call to StartStream.

@@ -1043,21 +1006,21 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source - -

StopContext()

+ +

Stop()

Stop listening for user speech. -OnContextStop is triggered upon a call to StopContext. It's also triggered by automatic VAD deactivation.

+OnContextStop is triggered upon a call to Stop. It's also triggered by automatic VAD deactivation.

You don't need to await this call if you don't need the utterance id.

Declaration
- 
public Task<string> StopContext()
+ 
public Task<string> Stop()
Returns
@@ -1077,10 +1040,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

StopStream(Boolean)

@@ -1111,10 +1074,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Update()

@@ -1133,10 +1096,10 @@
Declaration
diff --git a/docs/api/Speechly.SLUClient.SpeechlyClientTest.html b/docs/api/Speechly.SLUClient.SpeechlyClientTest.html deleted file mode 100644 index 0b64353..0000000 --- a/docs/api/Speechly.SLUClient.SpeechlyClientTest.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - - - Class SpeechlyClientTest - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class SpeechlyClientTest -

-
-
-
-
Inheritance
-
System.Object
-
SpeechlyClientTest
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class SpeechlyClientTest : object
-
-

Methods -

- - | - Improve this Doc - - - View Source - - -

SplitWithVAD(String, String, String)

-
-
-
Declaration
-
- 
public static void SplitWithVAD(string fileName, string saveToFolder = null, string logUtteranceFolder = null)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.StringfileName
System.StringsaveToFolder
System.StringlogUtteranceFolder
- - | - Improve this Doc - - - View Source - - -

TestCloudProcessing(String)

-
-
-
Declaration
-
- 
public static async Task TestCloudProcessing(string fileName)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.StringfileName
-
Returns
- - - - - - - - - - - - - -
TypeDescription
Task
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.TokenResponse.html b/docs/api/Speechly.SLUClient.TokenResponse.html deleted file mode 100644 index fd26c4f..0000000 --- a/docs/api/Speechly.SLUClient.TokenResponse.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Class TokenResponse - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class TokenResponse -

-
-
-
-
Inheritance
-
System.Object
-
TokenResponse
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class TokenResponse : object
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

access_token

-
-
-
Declaration
-
- 
public string access_token
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.String
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.WsClient.ResponseReceivedDelegate.html b/docs/api/Speechly.SLUClient.WsClient.ResponseReceivedDelegate.html deleted file mode 100644 index 9633df1..0000000 --- a/docs/api/Speechly.SLUClient.WsClient.ResponseReceivedDelegate.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - Delegate WsClient.ResponseReceivedDelegate - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Delegate WsClient.ResponseReceivedDelegate -

-
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public delegate void ResponseReceivedDelegate(MemoryStream inputStream);
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
MemoryStreaminputStream
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.WsClient.html b/docs/api/Speechly.SLUClient.WsClient.html deleted file mode 100644 index 4f8110e..0000000 --- a/docs/api/Speechly.SLUClient.WsClient.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - Class WsClient - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
- -
- -
-
-
-
-
-
-
- - -

Class WsClient -

-
-
-
-
Inheritance
-
System.Object
-
WsClient
-
-
Namespace: Speechly.SLUClient
-
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
-
- 
public class WsClient : IDisposable
-
-

Fields -

- - | - Improve this Doc - - - View Source - -

OnResponseReceived

-
-
-
Declaration
-
- 
public WsClient.ResponseReceivedDelegate OnResponseReceived
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
WsClient.ResponseReceivedDelegate
-

Properties -

- - | - Improve this Doc - - - View Source - - -

ReceiveBufferSize

-
-
-
Declaration
-
- 
public int ReceiveBufferSize { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
-

Methods -

- - | - Improve this Doc - - - View Source - - -

ConnectAsync(String, String)

-
-
-
Declaration
-
- 
public async Task ConnectAsync(string url, string authToken)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Stringurl
System.StringauthToken
-
Returns
- - - - - - - - - - - - - -
TypeDescription
Task
- - | - Improve this Doc - - - View Source - - -

DisconnectAsync()

-
-
-
Declaration
-
- 
public async Task DisconnectAsync()
-
-
Returns
- - - - - - - - - - - - - -
TypeDescription
Task
- - | - Improve this Doc - - - View Source - - -

Dispose()

-
-
-
Declaration
-
- 
public void Dispose()
-
- - | - Improve this Doc - - - View Source - - -

SendBytes(ArraySegment<Byte>)

-
-
-
Declaration
-
- 
public void SendBytes(ArraySegment<byte> byteArraySegment)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
ArraySegment<System.Byte>byteArraySegment
- - | - Improve this Doc - - - View Source - - -

SendText(String)

-
-
-
Declaration
-
- 
public void SendText(string text)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
System.Stringtext
-
-
- - -
-
- - -
- - - - - - diff --git a/docs/api/Speechly.SLUClient.html b/docs/api/Speechly.SLUClient.html index f836f12..4e8f58d 100644 --- a/docs/api/Speechly.SLUClient.html +++ b/docs/api/Speechly.SLUClient.html @@ -10,7 +10,7 @@ - + @@ -80,14 +80,8 @@

Classes

CloudDecoder

Provides speech processing with Speechly's cloud SLU service.

Internally handles authentication using https and audio streaming via secure websocket. -Audio is streamed when listening is started with SpeechlyClient.StartContext(). -Streaming stops upon call to SpeechlyClient.StopContext().

-
-

EnergyTresholdVAD

-

Adaptive energy threshold voice activity detection (VAD) implementation. -It can be used to enable hands-free operation of the SLU decoder.

-

When enough loud frames have been detected, VAD activates and calls StartContext automatically. When enough silent frames have been detected, the VAD deactivates after the sustain time and StopContext is called automatically. The background noise energy gradually adapts when VAD is not active.

-

Use its public field to configure minimum energy level, signal-to-noise ratio, minimum activation time and an activation/deactivation treshold (ratio of loud to silent frames).

+Audio is streamed when listening is started with SpeechlyClient.Start(). +Streaming stops upon call to SpeechlyClient.Stop().

IDecoder

@@ -100,14 +94,14 @@

SpeechlyClient

Usage

 -

You can feed audio continuously, but control when to start and stop process speech with StartContext(String) and StopContext() or -let voice activity detection (VAD) handle that automatically by passing EnergyTresholdVAD to SpeechlyClient constructor.

+

You can feed audio continuously, but control when to start and stop process speech with Start(String) and Stop() or +let voice activity detection (VAD) handle that automatically by passing EnergyThresholdVAD to SpeechlyClient constructor.

diff --git a/docs/api/Speechly.SLUClient.EntityFormatter.html b/docs/api/Speechly.Tools.AudioProcessor.SendAudioDelegate.html similarity index 71% rename from docs/api/Speechly.SLUClient.EntityFormatter.html rename to docs/api/Speechly.Tools.AudioProcessor.SendAudioDelegate.html index 02f4f67..92f2119 100644 --- a/docs/api/Speechly.SLUClient.EntityFormatter.html +++ b/docs/api/Speechly.Tools.AudioProcessor.SendAudioDelegate.html @@ -5,12 +5,12 @@ - Delegate EntityFormatter + <title>Delegate AudioProcessor.SendAudioDelegate - - + @@ -68,18 +68,18 @@
-
+
-

Delegate EntityFormatter +

Delegate AudioProcessor.SendAudioDelegate

-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Tools
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public delegate string EntityFormatter(string words, string entityType);
+ 
public delegate void SendAudioDelegate(float[] floats, int start = 0, int length = null);
Parameters
@@ -92,28 +92,18 @@
Parameters
- - + + - - + + - -
System.StringwordsSystem.Single[]floats
System.StringentityTypeSystem.Int32start
-
Returns
- - - - - - - - - + + @@ -126,10 +116,10 @@
Returns
diff --git a/docs/api/Speechly.SLUClient.SpeechlyClient.EntityDelegate.html b/docs/api/Speechly.Tools.AudioProcessor.VadChangeDelegate.html similarity index 74% rename from docs/api/Speechly.SLUClient.SpeechlyClient.EntityDelegate.html rename to docs/api/Speechly.Tools.AudioProcessor.VadChangeDelegate.html index 4b4c83d..11b9b0f 100644 --- a/docs/api/Speechly.SLUClient.SpeechlyClient.EntityDelegate.html +++ b/docs/api/Speechly.Tools.AudioProcessor.VadChangeDelegate.html @@ -5,12 +5,12 @@ - Delegate SpeechlyClient.EntityDelegate + <title>Delegate AudioProcessor.VadChangeDelegate - - + @@ -68,18 +68,18 @@
-
+
-

Delegate SpeechlyClient.EntityDelegate +

Delegate AudioProcessor.VadChangeDelegate

-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Tools
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public delegate void EntityDelegate(MsgEntity msg);
+ 
public delegate void VadChangeDelegate(bool isSignalDetected);
Parameters
TypeDescription
System.StringSystem.Int32length
@@ -92,8 +92,8 @@
Parameters
- - + + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Tools.AudioProcessor.html b/docs/api/Speechly.Tools.AudioProcessor.html new file mode 100644 index 0000000..b67fd65 --- /dev/null +++ b/docs/api/Speechly.Tools.AudioProcessor.html @@ -0,0 +1,455 @@ + + + + + + + + Class AudioProcessor + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class AudioProcessor +

+
+
+
+
Inheritance
+
System.Object
+
AudioProcessor
+
+
Namespace: Speechly.Tools
+
Assembly: speechly-unity-net-standard-2.0.dll
+
Syntax
+
+ 
public class AudioProcessor : object
+
+

Constructors +

+ + | + Improve this Doc + + + View Source + + +

AudioProcessor(AudioProcessorOptions, AudioInfo, Boolean)

+
+
+
Declaration
+
+ 
public AudioProcessor(AudioProcessorOptions options, AudioInfo output, bool debug = false)
+
+
Parameters
+
MsgEntitymsgSystem.BooleanisSignalDetected
+ + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
AudioProcessorOptionsoptions
AudioInfooutput
System.Booleandebug
+

Fields +

+ + | + Improve this Doc + + + View Source + +

OnSendAudio

+
+
+
Declaration
+
+ 
public AudioProcessor.SendAudioDelegate OnSendAudio
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
AudioProcessor.SendAudioDelegate
+ + | + Improve this Doc + + + View Source + +

OnVadStateChange

+
+
+
Declaration
+
+ 
public AudioProcessor.VadChangeDelegate OnVadStateChange
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
AudioProcessor.VadChangeDelegate
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

Options

+
+
+
Declaration
+
+ 
public AudioProcessorOptions Options { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
AudioProcessorOptions
+ + | + Improve this Doc + + + View Source + + +

Output

+
+
+
Declaration
+
+ 
public AudioInfo Output { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
AudioInfo
+ + | + Improve this Doc + + + View Source + + +

Vad

+
+
+
Declaration
+
+ 
public EnergyThresholdVAD Vad { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
EnergyThresholdVAD
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

ProcessAudio(Single[], Int32, Int32, Boolean)

+

Process speech audio samples from a microphone or other audio source.

+

It's recommended to constantly feed new audio as long as you want to use Speechly's SLU services.

+

You can control when to start and stop process speech either manually with Start() and Stop() or +automatically by providing a voice activity detection (VAD) field to .

+

The audio is handled as follows:

+
    +
  • Downsample to 16kHz if needed
    • +
  • Add to history ringbuffer
    • +
  • Calculate energy (VAD)
    • +
  • Automatic Start/Stop (VAD)
    • +
  • Send utterance audio to a file
    • +
  • Send utterance audio to Speechly SLU decoder
    • +
+
+
+
Declaration
+
+ 
public void ProcessAudio(float[] floats, int start = 0, int length = null, bool forceSubFrameProcess = false)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Single[]floats

Array of float containing samples to feed to the audio pipeline. Each sample needs to be in range -1f..1f.

+
System.Int32start

Start index of audio to process in samples (default: 0).

+
System.Int32length

Length of audio to process in samples or -1 to process the whole array (default: -1).

+
System.BooleanforceSubFrameProcess

Forces processing of last subframe at end of audio stream (default: false).

+
+ + | + Improve this Doc + + + View Source + + +

Reset(Int32)

+
+
+
Declaration
+
+ 
public void Reset(int inputSampleRate = 0)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Int32inputSampleRate
+ + | + Improve this Doc + + + View Source + + +

Start()

+
+
+
Declaration
+
+ 
public void Start()
+
+ + | + Improve this Doc + + + View Source + + +

Stop()

+
+
+
Declaration
+
+ 
public void Stop()
+
+
+
+ + +
+ + + + + + + + + + diff --git a/docs/api/Speechly.Tools.AudioTools.html b/docs/api/Speechly.Tools.AudioTools.html index 914c41f..487b8d2 100644 --- a/docs/api/Speechly.Tools.AudioTools.html +++ b/docs/api/Speechly.Tools.AudioTools.html @@ -10,7 +10,7 @@ - + @@ -86,14 +86,45 @@
Syntax
public class AudioTools : object
+

Fields +

+ + | + Improve this Doc + + + View Source + +

LOG_2_PLUS_LOG_5

+
+
+
Declaration
+
+ 
public static readonly double LOG_2_PLUS_LOG_5
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Double

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

ConvertInt16ToFloat(in Byte[], ref Single[], Int32, Int32, Int32)

@@ -157,10 +188,57 @@
Returns
| - Improve this Doc + Improve this Doc + + + View Source + + +

DbToEnergy(Single)

+
+
+
Declaration
+
+ 
public static float DbToEnergy(float db)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Singledb
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Single
+ + | + Improve this Doc - View Source + View Source

Downsample(in Single[], ref Single[], Int32, Int32, Int32, Int32)

@@ -214,10 +292,57 @@
Parameters
| - Improve this Doc + Improve this Doc + + + View Source + + +

EnergyToDb(Single)

+
+
+
Declaration
+
+ 
public static float EnergyToDb(float energy)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Singleenergy
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Single
+ + | + Improve this Doc - View Source + View Source

GetAudioPeak(in Single[], Int32, Int32)

@@ -271,10 +396,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetEnergy(in Single[], Int32, Int32)

@@ -334,10 +459,10 @@
Returns
diff --git a/docs/api/Speechly.Tools.EnergyThresholdVAD.html b/docs/api/Speechly.Tools.EnergyThresholdVAD.html new file mode 100644 index 0000000..f3c73de --- /dev/null +++ b/docs/api/Speechly.Tools.EnergyThresholdVAD.html @@ -0,0 +1,297 @@ + + + + + + + + Class EnergyThresholdVAD + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class EnergyThresholdVAD +

+

Adaptive energy threshold voice activity detection (VAD) implementation. +It can be used to enable hands-free operation of the SLU decoder.

+

When enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time. +Use its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time. +The background noise level gradually adapts when no signal is detected.

+

IsSignalDetected can be used to drive SpeechlyClient's Start and Stop automatically by setting ControlListening true.

+
+
+
+
Inheritance
+
System.Object
+
EnergyThresholdVAD
+
+
Namespace: Speechly.Tools
+
Assembly: speechly-unity-net-standard-2.0.dll
+
Syntax
+
+ 
public class EnergyThresholdVAD : object
+
+

Constructors +

+ + | + Improve this Doc + + + View Source + + +

EnergyThresholdVAD(VADOptions, AudioInfo)

+
+
+
Declaration
+
+ 
public EnergyThresholdVAD(VADOptions options, AudioInfo output)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
VADOptionsoptions
AudioInfooutput
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

Options

+
+
+
Declaration
+
+ 
public VADOptions Options { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
VADOptions
+ + | + Improve this Doc + + + View Source + + +

Output

+
+
+
Declaration
+
+ 
public AudioInfo Output { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
AudioInfo
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

ProcessFrame(Single[], Int32, Int32)

+
+
+
Declaration
+
+ 
public void ProcessFrame(float[] floats, int start = 0, int length = null)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Single[]floats
System.Int32start
System.Int32length
+ + | + Improve this Doc + + + View Source + + +

ResetVAD()

+
+
+
Declaration
+
+ 
public void ResetVAD()
+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Speechly.Tools.JSON.html b/docs/api/Speechly.Tools.JSON.html index 8342458..4597ff5 100644 --- a/docs/api/Speechly.Tools.JSON.html +++ b/docs/api/Speechly.Tools.JSON.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Parse<T>(String, T)

@@ -158,10 +158,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ParseFromStream<T>(Stream, T)

@@ -226,10 +226,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Stringify<T>(T)

@@ -288,10 +288,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

StringifyToStream<T>(T)

@@ -356,10 +356,10 @@
Type Parameters
diff --git a/docs/api/Speechly.Tools.Logger.LoggerDelegate.html b/docs/api/Speechly.Tools.Logger.LoggerDelegate.html index 5ce1646..4766311 100644 --- a/docs/api/Speechly.Tools.Logger.LoggerDelegate.html +++ b/docs/api/Speechly.Tools.Logger.LoggerDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Tools.Logger.html b/docs/api/Speechly.Tools.Logger.html index 00b61e5..028c067 100644 --- a/docs/api/Speechly.Tools.Logger.html +++ b/docs/api/Speechly.Tools.Logger.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

Log

@@ -119,10 +119,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

LogError

@@ -154,10 +154,10 @@
Field Value
diff --git a/docs/api/Speechly.Tools.Platform.html b/docs/api/Speechly.Tools.Platform.html index 80f9bd3..802a97c 100644 --- a/docs/api/Speechly.Tools.Platform.html +++ b/docs/api/Speechly.Tools.Platform.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

ConfigPath

@@ -121,10 +121,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Fetch(String)

@@ -168,10 +168,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetDeviceId(String)

@@ -215,10 +215,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetPersistentStoragePath()

@@ -245,10 +245,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GuidFromString(String)

@@ -292,10 +292,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

RestoreOrCreateConfig<T>(String)

@@ -355,10 +355,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveConfig<T>(T, String)

@@ -413,10 +413,10 @@
Type Parameters
diff --git a/docs/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.html b/docs/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.html index 571ab9c..deb9639 100644 --- a/docs/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.html +++ b/docs/api/Speechly.Tools.WsClient.ResponseReceivedDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Tools.WsClient.html b/docs/api/Speechly.Tools.WsClient.html index e30612a..6a59247 100644 --- a/docs/api/Speechly.Tools.WsClient.html +++ b/docs/api/Speechly.Tools.WsClient.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

OnResponseReceived

@@ -121,10 +121,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ReceiveBufferSize

@@ -153,10 +153,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

ConnectAsync(String, String)

@@ -205,10 +205,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

DisconnectAsync()

@@ -235,10 +235,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Dispose()

@@ -250,10 +250,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

SendBytes(ArraySegment<Byte>)

@@ -282,10 +282,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SendText(String)

@@ -320,10 +320,10 @@
Parameters
diff --git a/docs/api/Speechly.Tools.html b/docs/api/Speechly.Tools.html index 377e589..d004a29 100644 --- a/docs/api/Speechly.Tools.html +++ b/docs/api/Speechly.Tools.html @@ -10,7 +10,7 @@ - + @@ -77,8 +77,18 @@

Namespace S

Classes

+

AudioProcessor

+

AudioTools

+

EnergyThresholdVAD

+

Adaptive energy threshold voice activity detection (VAD) implementation. +It can be used to enable hands-free operation of the SLU decoder.

+

When enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time. +Use its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time. +The background noise level gradually adapts when no signal is detected.

+

IsSignalDetected can be used to drive SpeechlyClient's Start and Stop automatically by setting ControlListening true.

+

JSON

Logger

@@ -89,6 +99,10 @@

WsClient

Delegates

+

AudioProcessor.SendAudioDelegate

+
+

AudioProcessor.VadChangeDelegate

+

Logger.LoggerDelegate

WsClient.ResponseReceivedDelegate

diff --git a/docs/api/Speechly.SLUClient.Entity.html b/docs/api/Speechly.Types.AudioInfo.html similarity index 51% rename from docs/api/Speechly.SLUClient.Entity.html rename to docs/api/Speechly.Types.AudioInfo.html index a98a3cd..2b9ed55 100644 --- a/docs/api/Speechly.SLUClient.Entity.html +++ b/docs/api/Speechly.Types.AudioInfo.html @@ -5,12 +5,12 @@ - Class Entity + <title>Class AudioInfo - - + @@ -68,39 +68,40 @@
-
+
-

Class Entity +

Class AudioInfo

-
+

Statistics calculated by the Audio Processor. Note that this information is not currently available when using libSpeechly AudioProcessor.

+
Inheritance
System.Object
-
Entity
+
AudioInfo
-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public class Entity : object
+ 
public class AudioInfo : object

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source -

endPosition

+

IsSignalDetected

Declaration
- 
public int endPosition
+ 
public bool IsSignalDetected
Field Value
@@ -112,24 +113,25 @@
Field Value
- - + +
System.Int32System.Boolean

True if VAD has detected a loud signal.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

isFinal

+

NoiseLevelDb

Declaration
- 
public bool isFinal
+ 
public float NoiseLevelDb
Field Value
@@ -141,26 +143,60 @@
Field Value
- - + +
System.BooleanSystem.Single

Current noise level in dB.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

startPosition

+

SignalDb

Declaration
- 
public int startPosition
+ 
public float SignalDb
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Single

Signal level in dB above noise level.

+
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

SamplesSent

+
+
+
Declaration
+
+ 
public int SamplesSent { get; }
+
+
Property Value
@@ -171,25 +207,27 @@
Field Value
- +
System.Int32

Current count of processed samples since Start

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

type

+ +

StreamSamplePos

Declaration
- 
public string type
+ 
public int StreamSamplePos { get; }
-
Field Value
+
Property Value
@@ -199,26 +237,28 @@
Field Value
- - + +
System.StringSystem.Int32

Current count of continuously processed samples (thru ProcessAudio) since StartStream

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

value

+ +

UtteranceSerial

Declaration
- 
public string value
+ 
public int UtteranceSerial { get; }
-
Field Value
+
Property Value
@@ -228,8 +268,9 @@
Field Value
- - + +
System.StringSystem.Int32

0-based local index of utterance within the stream. -1 if no utterances have been processed.

+
@@ -241,10 +282,10 @@
Field Value
diff --git a/docs/api/Speechly.SLUClient.Word.html b/docs/api/Speechly.Types.AudioProcessorOptions.html similarity index 52% rename from docs/api/Speechly.SLUClient.Word.html rename to docs/api/Speechly.Types.AudioProcessorOptions.html index 3bbf445..235c35a 100644 --- a/docs/api/Speechly.SLUClient.Word.html +++ b/docs/api/Speechly.Types.AudioProcessorOptions.html @@ -5,12 +5,12 @@ - Class Word + <title>Class AudioProcessorOptions - - + @@ -68,39 +68,40 @@
-
+
-

Class Word +

Class AudioProcessorOptions

-
+

Options for Audio Processor and Voice Activity Detection (VAD)

+
Inheritance
System.Object
-
Word
+
AudioProcessorOptions
-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public class Word : object
+ 
public class AudioProcessorOptions : object

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source -

endTimestamp

+

FrameMillis

Declaration
- 
public int endTimestamp
+ 
public int FrameMillis
Field Value
@@ -113,23 +114,24 @@
Field Value
- +
System.Int32

Internal frame length. Affects audio caching and VAD energy analysis.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

index

+

HistoryFrames

Declaration
- 
public int index
+ 
public int HistoryFrames
Field Value
@@ -142,23 +144,24 @@
Field Value
- +
System.Int32

Total number of history frames to keep in memory. Will be sent upon a starting a new utterance.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

isFinal

+

InputSampleRate

Declaration
- 
public bool isFinal
+ 
public int InputSampleRate
Field Value
@@ -170,24 +173,25 @@
Field Value
- - + +
System.BooleanSystem.Int32

Input sample rate in Hz.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

startTimestamp

+

InternalSampleRate

Declaration
- 
public int startTimestamp
+ 
public int InternalSampleRate
Field Value
@@ -200,23 +204,54 @@
Field Value
- + + + +
System.Int32

Internal Speechly sample rate in Hz. Currently only 16000 Hz is supported.

+
+ + | + Improve this Doc + + + View Source + +

VADControlsListening

+
+
+
Declaration
+
+ 
public bool VADControlsListening
+
+
Field Value
+ + + + + + + + + + +
TypeDescription
System.Boolean

Allows VAD's IsSignalDetected to control SpeechlyClient's Start/Stop.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

word

+

VADSettings

Declaration
- 
public string word
+ 
public VADOptions VADSettings
Field Value
@@ -228,7 +263,7 @@
Field Value
- + @@ -241,10 +276,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.BeautifyEntity.html b/docs/api/Speechly.Types.BeautifyEntity.html index ab90a6b..457cb87 100644 --- a/docs/api/Speechly.Types.BeautifyEntity.html +++ b/docs/api/Speechly.Types.BeautifyEntity.html @@ -10,7 +10,7 @@ - + @@ -126,10 +126,10 @@
Returns
diff --git a/docs/api/Speechly.Types.BeautifyIntent.html b/docs/api/Speechly.Types.BeautifyIntent.html index ba47686..ab15a62 100644 --- a/docs/api/Speechly.Types.BeautifyIntent.html +++ b/docs/api/Speechly.Types.BeautifyIntent.html @@ -10,7 +10,7 @@ - + @@ -121,10 +121,10 @@
Returns
diff --git a/docs/api/Speechly.SLUClient.Intent.html b/docs/api/Speechly.Types.ContextOptions.ShallowFusionSettings.html similarity index 63% rename from docs/api/Speechly.SLUClient.Intent.html rename to docs/api/Speechly.Types.ContextOptions.ShallowFusionSettings.html index 66db428..e5e7252 100644 --- a/docs/api/Speechly.SLUClient.Intent.html +++ b/docs/api/Speechly.Types.ContextOptions.ShallowFusionSettings.html @@ -5,12 +5,12 @@ - Class Intent + <title>Class ContextOptions.ShallowFusionSettings - - + @@ -68,39 +68,40 @@
-
+
-

Class Intent +

Class ContextOptions.ShallowFusionSettings

-
+

Increase or decrease the probability of recognizing the provided words

+
Inheritance
System.Object
-
Intent
+
ContextOptions.ShallowFusionSettings
-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public class Intent : object
+ 
public class ShallowFusionSettings : object

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source -

intent

+

Vocabulary

Declaration
- 
public string intent
+ 
public string Vocabulary
Field Value
System.StringVADOptions
@@ -113,23 +114,24 @@
Field Value
- +
System.String

Newline-delimited words that specify the vocabulary for score biasing.

+
| - Improve this Doc + Improve this Doc - View Source + View Source -

isFinal

+

Weight

Declaration
- 
public bool isFinal
+ 
public float Weight
Field Value
@@ -141,8 +143,9 @@
Field Value
- - + +
System.BooleanSystem.Single

Biasing weight. Positive values increase the probability of recognition, negative values decrease it.

+
@@ -154,10 +157,10 @@
Field Value
diff --git a/docs/api/Speechly.SLUClient.Logger.html b/docs/api/Speechly.Types.ContextOptions.html similarity index 65% rename from docs/api/Speechly.SLUClient.Logger.html rename to docs/api/Speechly.Types.ContextOptions.html index d1dd589..7f21a64 100644 --- a/docs/api/Speechly.SLUClient.Logger.html +++ b/docs/api/Speechly.Types.ContextOptions.html @@ -5,12 +5,12 @@ - Class Logger + <title>Class ContextOptions - - + @@ -68,39 +68,40 @@
-
+
-

Class Logger +

Class ContextOptions

-
+

Options for speech recognition

+
Inheritance
System.Object
-
Logger
+
ContextOptions
-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public class Logger : object
+ 
public class ContextOptions : object

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source -

Log

+

BoostVocabulary

Declaration
- 
public static Logger.LoggerDelegate Log
+ 
public ContextOptions.ShallowFusionSettings BoostVocabulary
Field Value
@@ -112,24 +113,24 @@
Field Value
- +
Logger.LoggerDelegateContextOptions.ShallowFusionSettings
| - Improve this Doc + Improve this Doc - View Source + View Source -

LogError

+

SilenceSegmentationMillis

Declaration
- 
public static Logger.LoggerDelegate LogError
+ 
public int SilenceSegmentationMillis
Field Value
@@ -141,7 +142,7 @@
Field Value
- + @@ -154,10 +155,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.Entity.html b/docs/api/Speechly.Types.Entity.html index 80d7f10..99ecafc 100644 --- a/docs/api/Speechly.Types.Entity.html +++ b/docs/api/Speechly.Types.Entity.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

endPosition

@@ -119,10 +119,10 @@
Field Value
Logger.LoggerDelegateSystem.Int32
| - Improve this Doc + Improve this Doc - View Source + View Source

isFinal

@@ -148,10 +148,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

startPosition

@@ -177,10 +177,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

type

@@ -206,10 +206,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

value

@@ -241,10 +241,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.EntityDelegate.html b/docs/api/Speechly.Types.EntityDelegate.html index d79262e..320df07 100644 --- a/docs/api/Speechly.Types.EntityDelegate.html +++ b/docs/api/Speechly.Types.EntityDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Types.Intent.html b/docs/api/Speechly.Types.Intent.html index be416a1..147282b 100644 --- a/docs/api/Speechly.Types.Intent.html +++ b/docs/api/Speechly.Types.Intent.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

intent

@@ -119,10 +119,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

isFinal

@@ -154,10 +154,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.IntentDelegate.html b/docs/api/Speechly.Types.IntentDelegate.html index 2a93a0d..8b3ed9e 100644 --- a/docs/api/Speechly.Types.IntentDelegate.html +++ b/docs/api/Speechly.Types.IntentDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.SLUClient.MsgCommon.html b/docs/api/Speechly.Types.ModelExpiredException.html similarity index 58% rename from docs/api/Speechly.SLUClient.MsgCommon.html rename to docs/api/Speechly.Types.ModelExpiredException.html index c52c4c7..f5f1cf9 100644 --- a/docs/api/Speechly.SLUClient.MsgCommon.html +++ b/docs/api/Speechly.Types.ModelExpiredException.html @@ -5,12 +5,12 @@ - Class MsgCommon + <title>Class ModelExpiredException - - + @@ -68,124 +68,110 @@
-
+
-

Class MsgCommon +

Class ModelExpiredException

Inheritance
System.Object
-
MsgCommon
+
ModelExpiredException
-
-
Implements
- -
-
Namespace: Speechly.SLUClient
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public class MsgCommon : object, IMsgCommonProps
+ 
public class ModelExpiredException : Exception
-

Properties +

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source - -

audio_context

+ +

ModelExpiredException()

Declaration
- 
public string audio_context { get; set; }
+ 
public ModelExpiredException()
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.String
| - Improve this Doc + Improve this Doc - View Source + View Source - -

segment_id

+ +

ModelExpiredException(String)

Declaration
- 
public int segment_id { get; set; }
+ 
public ModelExpiredException(string message)
-
Property Value
+
Parameters
+ - + +
TypeName Description
System.Int32System.Stringmessage
| - Improve this Doc + Improve this Doc - View Source + View Source - -

type

+ +

ModelExpiredException(String, Exception)

Declaration
- 
public string type { get; set; }
+ 
public ModelExpiredException(string message, Exception inner)
-
Property Value
+
Parameters
+ + + + + + +
TypeName Description
System.Stringmessage
Exceptioninner
-

Implements

-
@@ -194,10 +180,10 @@

Implements

diff --git a/docs/api/Speechly.Types.MsgCommon.html b/docs/api/Speechly.Types.MsgCommon.html index cf76d46..3a7841e 100644 --- a/docs/api/Speechly.Types.MsgCommon.html +++ b/docs/api/Speechly.Types.MsgCommon.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

audio_context

@@ -120,10 +120,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

segment_id

@@ -150,10 +150,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

type

@@ -186,10 +186,10 @@
Property Value
diff --git a/docs/api/Speechly.Types.MsgEntity.html b/docs/api/Speechly.Types.MsgEntity.html index 9a2078a..dca8911 100644 --- a/docs/api/Speechly.Types.MsgEntity.html +++ b/docs/api/Speechly.Types.MsgEntity.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

data

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgIntent.Data.html b/docs/api/Speechly.Types.MsgIntent.Data.html index b90425b..ded4948 100644 --- a/docs/api/Speechly.Types.MsgIntent.Data.html +++ b/docs/api/Speechly.Types.MsgIntent.Data.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

intent

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgIntent.html b/docs/api/Speechly.Types.MsgIntent.html index 3f778f7..c5e3e85 100644 --- a/docs/api/Speechly.Types.MsgIntent.html +++ b/docs/api/Speechly.Types.MsgIntent.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

data

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgTentativeEntity.Data.html b/docs/api/Speechly.Types.MsgTentativeEntity.Data.html index b4c0ade..382292b 100644 --- a/docs/api/Speechly.Types.MsgTentativeEntity.Data.html +++ b/docs/api/Speechly.Types.MsgTentativeEntity.Data.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

entities

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgTentativeEntity.html b/docs/api/Speechly.Types.MsgTentativeEntity.html index 4bab2a8..4e00428 100644 --- a/docs/api/Speechly.Types.MsgTentativeEntity.html +++ b/docs/api/Speechly.Types.MsgTentativeEntity.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

data

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgTentativeTranscript.Data.html b/docs/api/Speechly.Types.MsgTentativeTranscript.Data.html index e89c3d6..e459982 100644 --- a/docs/api/Speechly.Types.MsgTentativeTranscript.Data.html +++ b/docs/api/Speechly.Types.MsgTentativeTranscript.Data.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

transcript

@@ -119,10 +119,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

words

@@ -154,10 +154,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgTentativeTranscript.html b/docs/api/Speechly.Types.MsgTentativeTranscript.html index 69cb7c8..c75e4a1 100644 --- a/docs/api/Speechly.Types.MsgTentativeTranscript.html +++ b/docs/api/Speechly.Types.MsgTentativeTranscript.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

data

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.MsgTranscript.html b/docs/api/Speechly.Types.MsgTranscript.html index 0e3898f..7c13775 100644 --- a/docs/api/Speechly.Types.MsgTranscript.html +++ b/docs/api/Speechly.Types.MsgTranscript.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

data

@@ -125,10 +125,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.SegmentChangeDelegate.html b/docs/api/Speechly.Types.SegmentChangeDelegate.html index 67ec3e9..224d309 100644 --- a/docs/api/Speechly.Types.SegmentChangeDelegate.html +++ b/docs/api/Speechly.Types.SegmentChangeDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Types.StartContextDelegate.html b/docs/api/Speechly.Types.StartDelegate.html similarity index 79% rename from docs/api/Speechly.Types.StartContextDelegate.html rename to docs/api/Speechly.Types.StartDelegate.html index e652853..79b5fb0 100644 --- a/docs/api/Speechly.Types.StartContextDelegate.html +++ b/docs/api/Speechly.Types.StartDelegate.html @@ -5,12 +5,12 @@ - Delegate StartContextDelegate + <title>Delegate StartDelegate - - + @@ -68,18 +68,18 @@
-
+
-

Delegate StartContextDelegate +

Delegate StartDelegate

Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public delegate void StartContextDelegate();
+ 
public delegate void StartDelegate();
@@ -89,10 +89,10 @@
Syntax
diff --git a/docs/api/Speechly.SLUClient.IMsgCommonProps.html b/docs/api/Speechly.Types.StartMessage.Options.html similarity index 60% rename from docs/api/Speechly.SLUClient.IMsgCommonProps.html rename to docs/api/Speechly.Types.StartMessage.Options.html index cdb7c9d..0c59864 100644 --- a/docs/api/Speechly.SLUClient.IMsgCommonProps.html +++ b/docs/api/Speechly.Types.StartMessage.Options.html @@ -5,12 +5,12 @@ - Interface IMsgCommonProps + <title>Class StartMessage.Options - - + @@ -68,37 +68,41 @@
-
+
-

Interface IMsgCommonProps +

Class StartMessage.Options

-
Namespace: Speechly.SLUClient
+
+
Inheritance
+
System.Object
+
StartMessage.Options
+
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public interface IMsgCommonProps
+ 
public class Options : object
-

Properties +

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source - -

audio_context

+

silence_triggered_segmentation

Declaration
- 
string audio_context { get; set; }
+ 
public string[] silence_triggered_segmentation
-
Property Value
+
Field Value
@@ -108,27 +112,26 @@
Property Value
- +
System.StringSystem.String[]
| - Improve this Doc + Improve this Doc - View Source + View Source - -

segment_id

+

vocabulary

Declaration
- 
int segment_id { get; set; }
+ 
public string[] vocabulary
-
Property Value
+
Field Value
@@ -138,27 +141,26 @@
Property Value
- +
System.Int32System.String[]
| - Improve this Doc + Improve this Doc - View Source + View Source - -

type

+

vocabulary_bias

Declaration
- 
string type { get; set; }
+ 
public string[] vocabulary_bias
-
Property Value
+
Field Value
@@ -168,7 +170,7 @@
Property Value
- + @@ -181,10 +183,10 @@
Property Value
diff --git a/docs/api/Speechly.Types.SegmentMessage.html b/docs/api/Speechly.Types.StartMessage.html similarity index 62% rename from docs/api/Speechly.Types.SegmentMessage.html rename to docs/api/Speechly.Types.StartMessage.html index cfd7122..9a1e91c 100644 --- a/docs/api/Speechly.Types.SegmentMessage.html +++ b/docs/api/Speechly.Types.StartMessage.html @@ -5,12 +5,12 @@ - Struct SegmentMessage + <title>Class StartMessage - - + @@ -68,73 +68,68 @@
-
+
-

Struct SegmentMessage +

Class StartMessage

+
+
Inheritance
+
System.Object
+
StartMessage
+
Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public struct SegmentMessage
+ 
public class StartMessage : object
-

Constructors +

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source - -

SegmentMessage(MsgCommon, String)

+

appId

Declaration
- 
public SegmentMessage(MsgCommon msgCommon, string msgString)
+ 
public string appId
-
Parameters
+
Field Value
System.StringSystem.String[]
- - - - - - -
TypeName Description
MsgCommonmsgCommon
System.StringmsgString
-

Fields -

| - Improve this Doc + Improve this Doc - View Source + View Source -

msgCommon

+

eventType

Declaration
- 
public MsgCommon msgCommon
+ 
public string eventType
Field Value
@@ -146,24 +141,24 @@
Field Value
- +
MsgCommonSystem.String
| - Improve this Doc + Improve this Doc - View Source + View Source -

msgString

+

options

Declaration
- 
public string msgString
+ 
public StartMessage.Options options
Field Value
@@ -175,7 +170,7 @@
Field Value
- + @@ -188,10 +183,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.StartStreamDelegate.html b/docs/api/Speechly.Types.StartStreamDelegate.html index 85f91c2..8bda5ce 100644 --- a/docs/api/Speechly.Types.StartStreamDelegate.html +++ b/docs/api/Speechly.Types.StartStreamDelegate.html @@ -10,7 +10,7 @@ - + @@ -89,10 +89,10 @@
Syntax
diff --git a/docs/api/Speechly.Types.StopContextDelegate.html b/docs/api/Speechly.Types.StopDelegate.html similarity index 79% rename from docs/api/Speechly.Types.StopContextDelegate.html rename to docs/api/Speechly.Types.StopDelegate.html index 387f2c2..48b4dd2 100644 --- a/docs/api/Speechly.Types.StopContextDelegate.html +++ b/docs/api/Speechly.Types.StopDelegate.html @@ -5,12 +5,12 @@ - Delegate StopContextDelegate + <title>Delegate StopDelegate - - + @@ -68,18 +68,18 @@
-
+
-

Delegate StopContextDelegate +

Delegate StopDelegate

Namespace: Speechly.Types
Assembly: speechly-unity-net-standard-2.0.dll
-
Syntax
+
Syntax
- 
public delegate void StopContextDelegate();
+ 
public delegate void StopDelegate();
@@ -89,10 +89,10 @@
Syntax
diff --git a/docs/api/Speechly.Types.StopStreamDelegate.html b/docs/api/Speechly.Types.StopStreamDelegate.html index b3418b8..8730efa 100644 --- a/docs/api/Speechly.Types.StopStreamDelegate.html +++ b/docs/api/Speechly.Types.StopStreamDelegate.html @@ -10,7 +10,7 @@ - + @@ -89,10 +89,10 @@
Syntax
diff --git a/docs/api/Speechly.Types.TentativeEntityDelegate.html b/docs/api/Speechly.Types.TentativeEntityDelegate.html index 229362f..7a448dd 100644 --- a/docs/api/Speechly.Types.TentativeEntityDelegate.html +++ b/docs/api/Speechly.Types.TentativeEntityDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Types.TentativeTranscriptDelegate.html b/docs/api/Speechly.Types.TentativeTranscriptDelegate.html index 82fde55..25c7231 100644 --- a/docs/api/Speechly.Types.TentativeTranscriptDelegate.html +++ b/docs/api/Speechly.Types.TentativeTranscriptDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Types.TranscriptDelegate.html b/docs/api/Speechly.Types.TranscriptDelegate.html index ecad1ee..458c8bb 100644 --- a/docs/api/Speechly.Types.TranscriptDelegate.html +++ b/docs/api/Speechly.Types.TranscriptDelegate.html @@ -10,7 +10,7 @@ - + @@ -106,10 +106,10 @@
Parameters
diff --git a/docs/api/Speechly.Types.VADOptions.html b/docs/api/Speechly.Types.VADOptions.html new file mode 100644 index 0000000..c0912ff --- /dev/null +++ b/docs/api/Speechly.Types.VADOptions.html @@ -0,0 +1,376 @@ + + + + + + + + Class VADOptions + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class VADOptions +

+

Options for Voice Activity Detection (VAD)

+
+
+
+
Inheritance
+
System.Object
+
VADOptions
+
+
Namespace: Speechly.Types
+
Assembly: speechly-unity-net-standard-2.0.dll
+
Syntax
+
+ 
public class VADOptions : object
+
+

Fields +

+ + | + Improve this Doc + + + View Source + +

NoiseGateDb

+
+
+
Declaration
+
+ 
public float NoiseGateDb
+
+
Field Value
+
System.StringStartMessage.Options
+ + + + + + + + + + + + +
TypeDescription
System.Single

Energy threshold - below this won't trigger activation

+
+ + | + Improve this Doc + + + View Source + +

NoiseLearnHalftimeMillis

+
+
+
Declaration
+
+ 
public int NoiseLearnHalftimeMillis
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32

Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy.

+
+ + | + Improve this Doc + + + View Source + +

SignalActivation

+
+
+
Declaration
+
+ 
public float SignalActivation
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Single

Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected'

+
+ + | + Improve this Doc + + + View Source + +

SignalRelease

+
+
+
Declaration
+
+ 
public float SignalRelease
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Single

Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over.

+
+ + | + Improve this Doc + + + View Source + +

SignalSearchFrames

+
+
+
Declaration
+
+ 
public int SignalSearchFrames
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+ + | + Improve this Doc + + + View Source + +

SignalSustainMillis

+
+
+
Declaration
+
+ 
public int SignalSustainMillis
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32

Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true.

+
+ + | + Improve this Doc + + + View Source + +

SignalToNoiseDb

+
+
+
Declaration
+
+ 
public float SignalToNoiseDb
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Single

Signal-to-noise energy ratio needed for frame to be 'loud'

+
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

Enabled

+
+
+
Declaration
+
+ 
public bool Enabled { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Enable energy-level calculations

+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Speechly.Types.Word.html b/docs/api/Speechly.Types.Word.html index 6c83608..42c99d8 100644 --- a/docs/api/Speechly.Types.Word.html +++ b/docs/api/Speechly.Types.Word.html @@ -10,7 +10,7 @@ - + @@ -90,10 +90,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

endTimestamp

@@ -119,10 +119,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

index

@@ -148,10 +148,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

isFinal

@@ -177,10 +177,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

startTimestamp

@@ -206,10 +206,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

word

@@ -241,10 +241,10 @@
Field Value
diff --git a/docs/api/Speechly.Types.html b/docs/api/Speechly.Types.html index afe67cd..6c755c5 100644 --- a/docs/api/Speechly.Types.html +++ b/docs/api/Speechly.Types.html @@ -10,7 +10,7 @@ - + @@ -77,10 +77,24 @@

Namespace S

Classes

+

AudioInfo

+

Statistics calculated by the Audio Processor. Note that this information is not currently available when using libSpeechly AudioProcessor.

+
+

AudioProcessorOptions

+

Options for Audio Processor and Voice Activity Detection (VAD)

+
+

ContextOptions

+

Options for speech recognition

+
+

ContextOptions.ShallowFusionSettings

+

Increase or decrease the probability of recognizing the provided words

+

Entity

Intent

+

ModelExpiredException

+

MsgCommon

MsgEntity

@@ -99,6 +113,13 @@

MsgTe

MsgTranscript

+

StartMessage

+
+

StartMessage.Options

+
+

VADOptions

+

Options for Voice Activity Detection (VAD)

+

Word

Delegates @@ -113,11 +134,11 @@

IntentDelegate

SegmentChangeDelegate

-

StartContextDelegate

+

StartDelegate

StartStreamDelegate

-

StopContextDelegate

+

StopDelegate

StopStreamDelegate

diff --git a/docs/api/toc.html b/docs/api/toc.html index e56c244..0f1756c 100644 --- a/docs/api/toc.html +++ b/docs/api/toc.html @@ -20,9 +20,6 @@
  • CloudDecoder
    • -
  • - EnergyTresholdVAD -
  • IDecoder
    • @@ -39,9 +36,21 @@ Speechly.Tools
      +
    • + AudioProcessor +
      • +
    • + AudioProcessor.SendAudioDelegate +
      • +
    • + AudioProcessor.VadChangeDelegate +
    • AudioTools
      • +
    • + EnergyThresholdVAD +
    • JSON
      • @@ -67,12 +76,24 @@ Speechly.Types
        +
      • + AudioInfo +
        • +
      • + AudioProcessorOptions +
      • BeautifyEntity
      • BeautifyIntent
        • +
      • + ContextOptions +
        • +
      • + ContextOptions.ShallowFusionSettings +
      • Entity
        • @@ -85,6 +106,9 @@
      • IntentDelegate
        • +
      • + ModelExpiredException +
      • MsgCommon
        • @@ -116,13 +140,19 @@ SegmentChangeDelegate
      • - StartContextDelegate + StartDelegate +
        • +
      • + StartMessage +
        • +
      • + StartMessage.Options
      • StartStreamDelegate
      • - StopContextDelegate + StopDelegate
      • StopStreamDelegate @@ -136,6 +166,9 @@
      • TranscriptDelegate
        • +
      • + VADOptions +
      • Word
        • diff --git a/docs/articles/intro.html b/docs/articles/intro.html deleted file mode 100644 index afcc556..0000000 --- a/docs/articles/intro.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - Hey ho! - - - - - - - - - - - - - - - -
        -
        - - - -
        - -
        -
        -
        -
        -
        -
        -

        Hey ho!

        - -
        -
        - - -
        -
        - - -
        - - - - - - diff --git a/docs/index.html b/docs/index.html index 7bd15df..a03e4a8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ Speechly Client for Unity and .NET Standard 2.0 API - + @@ -90,7 +90,7 @@

        Overview of SpeechlyClient au
        diff --git a/docs/manifest.json b/docs/manifest.json index c072d52..82e64bc 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -3,6 +3,18 @@ "source_base_path": "/Users/arzga/Documents/Speechly/git/speechly-unity-dotnet", "xrefmap": "xrefmap.yml", "files": [ + { + "type": "Conceptual", + "source_relative_path": "CHANGELOG.md", + "output": { + ".html": { + "relative_path": "CHANGELOG.html", + "hash": "6GpL3IMWg43tMZDMjI8IOYKJOhXxEAfEXMb0i7fdC3M=" + } + }, + "is_incremental": false, + "version": "" + }, { "log_codes": [ "InvalidFileLink" @@ -12,19 +24,19 @@ "output": { ".html": { "relative_path": "README.html", - "hash": "ltH9TVkEGTSyjw7O9LED4HW9confwJuITMpBhhcr+r8=" + "hash": "Ua7JEn5wRakUDGjL9ro35I64N+YnzR5m0x7x8vKxIr0=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { - "type": "ManagedReference", - "source_relative_path": "api/Speechly.SLUClient.CloudDecoder.yml", + "type": "Conceptual", + "source_relative_path": "REMOTEBRANCH.md", "output": { ".html": { - "relative_path": "api/Speechly.SLUClient.CloudDecoder.html", - "hash": "5UP4cF/uEMPTGkq1PtexxyZcJ8y5ODMklRjb9B3HHcY=" + "relative_path": "REMOTEBRANCH.html", + "hash": "Vj4VvVXOvfLMLdj3lNEYlEwaVxyjL1muTtyDUlgUF3Q=" } }, "is_incremental": true, @@ -32,14 +44,14 @@ }, { "type": "ManagedReference", - "source_relative_path": "api/Speechly.SLUClient.EnergyTresholdVAD.yml", + "source_relative_path": "api/Speechly.SLUClient.CloudDecoder.yml", "output": { ".html": { - "relative_path": "api/Speechly.SLUClient.EnergyTresholdVAD.html", - "hash": "i5GguilcANbHAkBNRYSrMbzBAD0ZvsttR8/bZExO/r8=" + "relative_path": "api/Speechly.SLUClient.CloudDecoder.html", + "hash": "BX23AkHwZxCzhiq9zhalbNmRpZqpXV1locgraqitH8o=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -48,10 +60,10 @@ "output": { ".html": { "relative_path": "api/Speechly.SLUClient.IDecoder.html", - "hash": "K0HJ1RDmhgURLKoIssRBwkFirscxdhMItqgk51xRYCM=" + "hash": "8DYUv9cKrLG3tRBQfSUf4N7RgYT8HzbMS0SC1H2rReU=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -60,10 +72,10 @@ "output": { ".html": { "relative_path": "api/Speechly.SLUClient.Segment.html", - "hash": "Ce8bP9m2V0ofWBOrYPKdfGUlwIMVTnFAMIpt4dl5oSc=" + "hash": "+O9JLHj4n5gj8pxUOdUgJu/dXj6zdRJM8o3Zzs5ZuNI=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -72,10 +84,10 @@ "output": { ".html": { "relative_path": "api/Speechly.SLUClient.SpeechlyClient.html", - "hash": "d2mywa4VPdugAfWJp9hZ8fecr+X3UOo0Vlg+y2lRnSM=" + "hash": "KtJGWBSL9ETLoCZP9v/7OGFSGkUUXurQHrhlLv5LhTY=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -84,10 +96,46 @@ "output": { ".html": { "relative_path": "api/Speechly.SLUClient.html", - "hash": "yyZKUatTKzs3HzFRSkvv5mg9uTWYm80AsMMvgDZRKaU=" + "hash": "o1KRXhNmjSD6k9UG+YX2O2cuGZwZiM9ElxlS7R1G9RU=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Tools.AudioProcessor.SendAudioDelegate.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Tools.AudioProcessor.SendAudioDelegate.html", + "hash": "PIL/LzFSW496e08f9kVfsDVGW9Sr2GVjxVUQtYBP6c4=" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Tools.AudioProcessor.VadChangeDelegate.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Tools.AudioProcessor.VadChangeDelegate.html", + "hash": "+W9/squ8pBsU/iCp9TkVE60IyjKVjBkKUdYjEWErpZw=" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Tools.AudioProcessor.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Tools.AudioProcessor.html", + "hash": "ADAd2z6Jo9PLOVU1460ExAFGwYXCIkq9/H8ltLW8cuo=" + } + }, + "is_incremental": false, "version": "" }, { @@ -96,10 +144,22 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.AudioTools.html", - "hash": "/EJRJvsm4tBucGu5W5Fzln+zR1nWCHjwfgvGOcvWI3c=" + "hash": "JFiriisxQ8YkMnqn+Yf6I0F5h7q3sxqvqw6zR3F+UrQ=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Tools.EnergyThresholdVAD.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Tools.EnergyThresholdVAD.html", + "hash": "oqXQbJNP/xaiI2s3Z0ZeuYaUw99QrftJB+HmTNRNmmY=" + } + }, + "is_incremental": false, "version": "" }, { @@ -108,10 +168,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.JSON.html", - "hash": "a8bxIDKP6eqgHEQhhWKdP4u7oQA2B5uLjmdGRjOS18U=" + "hash": "8Wdne3idFruLxRbRBSbDnNViZCgpV51BISCKISFLoiI=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -120,10 +180,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.Logger.LoggerDelegate.html", - "hash": "BtyKp3ou5sAHsYq9xb/uAWGCB5bvYjvkcq86gb1v2Tg=" + "hash": "kgy8oe5dzWTQOolg6mhU+mM9Jz5jq/t5IAUKEkrMOvc=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -132,10 +192,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.Logger.html", - "hash": "H9pgurLx68vJpjwjasP8eQ3aG/IDZ+PQLhLOUZh95t0=" + "hash": "QOObne6YWKGcVvFdoZFRbWw7LWdcBAmGqu70HG0vVLM=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -144,10 +204,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.Platform.html", - "hash": "3kvssSysqM0Wi6gPF9/FkTKcxhkb3OPOKKWMrmtT7DA=" + "hash": "TsnA7shzyzp+1AOHZcMZi91g2145JvZcDutcYV9peXs=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -156,10 +216,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.WsClient.ResponseReceivedDelegate.html", - "hash": "Y8EDXtHi+4qATAZdpyEqtOPX6ehDhZK8lorIZplK2Bs=" + "hash": "OoDxAIijLPJ809IpL2Otnaxbd13w0HzpeI3sepF/hrg=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -168,10 +228,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.WsClient.html", - "hash": "26h/zEA3UNyquG4zpyMivu2x+rWlfcjbOSKUU2Ty2HY=" + "hash": "ZrEhkpqkEga+7Bo4rpFK/yFddO4pM6E9tn6r9VGNkDo=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -180,10 +240,34 @@ "output": { ".html": { "relative_path": "api/Speechly.Tools.html", - "hash": "Qv17G7nn+uktVFupT8tHwJUaqfnW1Sj43lT88VrMZVA=" + "hash": "Gmd9NyxSFgbmEegYJZO+NnGF1wCWKl8ZKxvjmy0AkhY=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.AudioInfo.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.AudioInfo.html", + "hash": "BlZ6fmCU7MTlnmNdH40q5y0ASgloycKXrBMP02Utx/g=" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.AudioProcessorOptions.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.AudioProcessorOptions.html", + "hash": "6BE03l2xa9uiXjotPrrKUHxrIQq/gmAEYXCgzHkFcdY=" + } + }, + "is_incremental": false, "version": "" }, { @@ -192,10 +276,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.BeautifyEntity.html", - "hash": "boHUXuR5izH3zqSvG4Ec/ANTfDQcW3ylyRkaYYVHE4g=" + "hash": "85SryKLDH3Q/eAr0TrJHE7Uq5jBH0QKKyGbAZqZvA00=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -204,10 +288,34 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.BeautifyIntent.html", - "hash": "3n7diCGlAa+U0oqmBS/Jq/nHval4G2sNa069hU+jnrE=" + "hash": "RBpkiSwYspFpJA3pdz986KecMG1AU2OUzZg4s7tMaTU=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.ContextOptions.ShallowFusionSettings.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.ContextOptions.ShallowFusionSettings.html", + "hash": "r30wREeQk6nit7olzKJSArLyy8zlhfEn8HmhUyjkzaY=" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.ContextOptions.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.ContextOptions.html", + "hash": "mKgJj2HfkPZi6rlDgcSqyR25s8H05Wa7GMaLtsw5518=" + } + }, + "is_incremental": false, "version": "" }, { @@ -216,10 +324,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.Entity.html", - "hash": "1hcIssOWMuLIYFKLJdRcVMhhsAyDX2J5SwsErYsiIOU=" + "hash": "hkYqQZkwtsuG/eR+9MrSQoDWitSKaRGi5tuV2FItyeA=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -228,10 +336,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.EntityDelegate.html", - "hash": "SDplwNP4/Zuzcuq+g3ovtTs0Pag5IdOcPOZM9IM6jNs=" + "hash": "7xkPQQnHukFMspF189W6f0du7obARb+nYKk44ISbtgM=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -240,10 +348,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.Intent.html", - "hash": "YLQG7YxwKOz/1LphEYoQTxTBzUgwMovJ6eu+qhXuV20=" + "hash": "SAW4JfJxpFRVfzsOiRXu0rQgMf940GRlIhIicpKxodo=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -252,10 +360,22 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.IntentDelegate.html", - "hash": "xgWxuoX6N+WgeRyNr30lfQUFebpZabyOZBcQMWczSlQ=" + "hash": "kHkHvBeJjezshxORBSvl71L0tnE34BwxT2lASF6O2kI=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.ModelExpiredException.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.ModelExpiredException.html", + "hash": "EjnI4zCvU0RFujB3ZXEbc5S07+2M+14Q3N4ZbscuXIk=" + } + }, + "is_incremental": false, "version": "" }, { @@ -264,10 +384,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgCommon.html", - "hash": "8PNOqGCRhWuhheT9lHT1wBcqaH6RiBEZivTpn/ZFP9c=" + "hash": "uZnwpdpaRihd9KcdoLWDDrEqQdXPi7dK2jwF+I1tfbQ=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -276,10 +396,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgEntity.html", - "hash": "93VX3iM9CyG+SSKXodd/iSg3I9wraGs7/RxvyO730hM=" + "hash": "dIt01UtOI+fJoqJEo0WXxmxUAUFXz3mUlhXXqegNdxA=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -288,10 +408,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgIntent.Data.html", - "hash": "6HIhFrgPGOjFHR863Ewy3XeB9KIy2d5LMr+zdQeiyzM=" + "hash": "Hl9TPiRseSVOpEeF/SXBMoX0SHMgi1Pp/Y272foxlBM=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -300,10 +420,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgIntent.html", - "hash": "CQFmcs9frsZL50SjPaA8SiCdOQYWgPD5dO2BoOMdcB8=" + "hash": "O1U24D7Qn57GLbOhArYalmz0le5zUFAwDNAMsEL68t4=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -312,10 +432,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgTentativeEntity.Data.html", - "hash": "z5jVBvqMxWXjx2CCAlkKJkTXDJ2H53zZIh8812oLg8c=" + "hash": "w5oRVpPnzOhrNdxE/Iv/8R3Hia85mImwRrZLb+BnZQ4=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -324,10 +444,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgTentativeEntity.html", - "hash": "dmkMhl0iJMgCo5NdodvIBLZZbMdua9nK9N4aCDrXqxQ=" + "hash": "abzNMd1N7LGd1tg4N+KMc6B37cM2zGKH8DfkmTjxrgA=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -336,10 +456,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgTentativeTranscript.Data.html", - "hash": "VgG+T07/gxmSibYu0oGQD1ldcmzKPhXx1HA96vMPpus=" + "hash": "pPxJSjF1Wi/R9wRA/fequYTPNWNwa/B20zqF+gcbKMY=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -348,10 +468,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgTentativeTranscript.html", - "hash": "ECxZSEtIHhWiZEjJmrzTK/8qw9jlWb3pY0+4ZP+QyY8=" + "hash": "5bl4ON2dlU5ikHBzOiRexsv+DmU0xOlwHvGtchr38O0=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -360,10 +480,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.MsgTranscript.html", - "hash": "RGW6FTqesOjB8CRT9dDAAzpmhk8jHj8OIALtZ/+Mvbs=" + "hash": "KyeRdS8eMKx7TTEkRajq00MYu+tVZ2ep75Vw6kImMK8=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -372,22 +492,46 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.SegmentChangeDelegate.html", - "hash": "ZqYmAQAKLWODKvcXhQIVCujM90TF7gVYgwfTu+fyppo=" + "hash": "77auSVXgLX5rE3Ikd4NBHaLmRB4aGwnmEdGtZOabsiA=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { "type": "ManagedReference", - "source_relative_path": "api/Speechly.Types.StartContextDelegate.yml", + "source_relative_path": "api/Speechly.Types.StartDelegate.yml", "output": { ".html": { - "relative_path": "api/Speechly.Types.StartContextDelegate.html", - "hash": "yV91I1oiPOpknvwt4SA9kyv/Hl9hAQb8+VthW80TPds=" + "relative_path": "api/Speechly.Types.StartDelegate.html", + "hash": "OBspTMQUOwi11ERsczA37/ydgyYvIHsFOxlA53PVnEo=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.StartMessage.Options.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.StartMessage.Options.html", + "hash": "O25R9UPdQCUi7+dI4/NCpb4lspm+Hd7wA9J2UqnGO5M=" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.StartMessage.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.StartMessage.html", + "hash": "ew7HRYUDPkZQ6CDzEu4Hx4cXQI3CK1FE35oVDMvECtA=" + } + }, + "is_incremental": false, "version": "" }, { @@ -396,22 +540,22 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.StartStreamDelegate.html", - "hash": "QmrUTuf88rIoWhI6Hs/A0TY2y9U6dsUtC1Y5cxLsrfM=" + "hash": "ql32iwtxxfcXKMJF/ALoD1laEqsd8i9Bl19JdujD4bw=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { "type": "ManagedReference", - "source_relative_path": "api/Speechly.Types.StopContextDelegate.yml", + "source_relative_path": "api/Speechly.Types.StopDelegate.yml", "output": { ".html": { - "relative_path": "api/Speechly.Types.StopContextDelegate.html", - "hash": "Z4qrXE32qtdlM502nAvdXyuU6a/SKwhgAG2VGYQiAjE=" + "relative_path": "api/Speechly.Types.StopDelegate.html", + "hash": "65QIJhXOXWRPTlUpuv6oJNUdZvHN/3JhziiWF8GMCg0=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -420,10 +564,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.StopStreamDelegate.html", - "hash": "XxsnJVQkfL9aDk6TMBkDj2cylUQ91Tp00gNaARnMWrk=" + "hash": "u6SEJ7n4BfEzCxuVbXsEjYOuy+nVgNiTvU5+YKRSQmY=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -432,10 +576,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.TentativeEntityDelegate.html", - "hash": "YrjQXfRjcyqR6ekS47vXajT3Fu9Ssf64IrMkIZH8YeI=" + "hash": "P5nziTV8dGI33WLizjWXBVlfp5NlwK7vdyou1NHO0jM=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -444,10 +588,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.TentativeTranscriptDelegate.html", - "hash": "ZqChfwpPFhdI5KAVq+NZwulNw+Groxw9Uuk7EPMbp20=" + "hash": "flIXlCFr9f/3OHcyZ2bcpJuOoTkOA2P2hxLzPrS9SaM=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -456,10 +600,22 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.TranscriptDelegate.html", - "hash": "xgVqXY+XInJFMXiek+evkT0ZgTmI3ixup54AcjbLmV0=" + "hash": "DyRGrbrwCZibIpOpVa3CaYACn8vIT4jVH5Zuy7Wqu/8=" } }, - "is_incremental": true, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Speechly.Types.VADOptions.yml", + "output": { + ".html": { + "relative_path": "api/Speechly.Types.VADOptions.html", + "hash": "dLBv1D6WQjlgiBb3qo9YiPEpNUeexCt00hjucrNV2Sw=" + } + }, + "is_incremental": false, "version": "" }, { @@ -468,10 +624,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.Word.html", - "hash": "tIzyfDt0ybYKycVNMdqhfylqyKgyaCpdrQ1z0PA2x8E=" + "hash": "YOt9A/yMjA7iaWM1B1yCm02MM52klZxCHoas5NDr15Y=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -480,10 +636,10 @@ "output": { ".html": { "relative_path": "api/Speechly.Types.html", - "hash": "ZpO8kXhOyHyytwcdUFtiI2JdwFLdqZya1aPB43H9uq0=" + "hash": "0gEAAfqW0OPCFUVsmZeykteDrqWzDKOhBxulO0CngQA=" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -492,7 +648,7 @@ "output": { ".html": { "relative_path": "api/toc.html", - "hash": "KoYKF+4Kca9RVwcCCPYN7PLdcVxP+T3i9Ck8nhY8/wo=" + "hash": "N98g2NuS7Iy2HKJr0w5kBn6hlMNdlSaj/9ZKf+tqX/c=" } }, "is_incremental": false, @@ -507,7 +663,7 @@ "output": { ".html": { "relative_path": "index.html", - "hash": "DHNfre4PdbgpnWlxQLecK150P5bSws6WWFUZq6uKTd4=" + "hash": "EPaRLlby3+ZMXoE+Gu24FGmDDLU0bDl8/ifG520mO3U=" } }, "is_incremental": true, @@ -526,14 +682,14 @@ "ConceptualDocumentProcessor": { "can_incremental": true, "incrementalPhase": "build", - "total_file_count": 2, + "total_file_count": 4, "skipped_file_count": 2 }, "ManagedReferenceDocumentProcessor": { "can_incremental": true, "incrementalPhase": "build", - "total_file_count": 39, - "skipped_file_count": 39 + "total_file_count": 50, + "skipped_file_count": 16 }, "TocDocumentProcessor": { "can_incremental": false, diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 8c9a9c4..d91e2d5 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -26,121 +26,6 @@ references: isSpec: "True" fullName: Speechly.SLUClient.CloudDecoder.CloudDecoder nameWithType: CloudDecoder.CloudDecoder -- uid: Speechly.SLUClient.EnergyTresholdVAD - name: EnergyTresholdVAD - href: api/Speechly.SLUClient.EnergyTresholdVAD.html - commentId: T:Speechly.SLUClient.EnergyTresholdVAD - fullName: Speechly.SLUClient.EnergyTresholdVAD - nameWithType: EnergyTresholdVAD -- uid: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - name: BaselineEnergy - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_BaselineEnergy - commentId: P:Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - fullName: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - nameWithType: EnergyTresholdVAD.BaselineEnergy -- uid: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy* - name: BaselineEnergy - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_BaselineEnergy_ - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - isSpec: "True" - fullName: Speechly.SLUClient.EnergyTresholdVAD.BaselineEnergy - nameWithType: EnergyTresholdVAD.BaselineEnergy -- uid: Speechly.SLUClient.EnergyTresholdVAD.Enabled - name: Enabled - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_Enabled - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.Enabled - fullName: Speechly.SLUClient.EnergyTresholdVAD.Enabled - nameWithType: EnergyTresholdVAD.Enabled -- uid: Speechly.SLUClient.EnergyTresholdVAD.Energy - name: Energy - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_Energy - commentId: P:Speechly.SLUClient.EnergyTresholdVAD.Energy - fullName: Speechly.SLUClient.EnergyTresholdVAD.Energy - nameWithType: EnergyTresholdVAD.Energy -- uid: Speechly.SLUClient.EnergyTresholdVAD.Energy* - name: Energy - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_Energy_ - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.Energy - isSpec: "True" - fullName: Speechly.SLUClient.EnergyTresholdVAD.Energy - nameWithType: EnergyTresholdVAD.Energy -- uid: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - name: IsSignalDetected - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_IsSignalDetected - commentId: P:Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - fullName: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - nameWithType: EnergyTresholdVAD.IsSignalDetected -- uid: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected* - name: IsSignalDetected - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_IsSignalDetected_ - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - isSpec: "True" - fullName: Speechly.SLUClient.EnergyTresholdVAD.IsSignalDetected - nameWithType: EnergyTresholdVAD.IsSignalDetected -- uid: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) - name: ProcessFrame(Single[], Int32, Int32) - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_ProcessFrame_System_Single___System_Int32_System_Int32_ - commentId: M:Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) - name.vb: ProcessFrame(Single(), Int32, Int32) - fullName: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single[], System.Int32, System.Int32) - fullName.vb: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame(System.Single(), System.Int32, System.Int32) - nameWithType: EnergyTresholdVAD.ProcessFrame(Single[], Int32, Int32) - nameWithType.vb: EnergyTresholdVAD.ProcessFrame(Single(), Int32, Int32) -- uid: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame* - name: ProcessFrame - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_ProcessFrame_ - commentId: Overload:Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame - isSpec: "True" - fullName: Speechly.SLUClient.EnergyTresholdVAD.ProcessFrame - nameWithType: EnergyTresholdVAD.ProcessFrame -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADActivation - name: VADActivation - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADActivation - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADActivation - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADActivation - nameWithType: EnergyTresholdVAD.VADActivation -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - name: VADControlListening - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADControlListening - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADControlListening - nameWithType: EnergyTresholdVAD.VADControlListening -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADFrames - name: VADFrames - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADFrames - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADFrames - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADFrames - nameWithType: EnergyTresholdVAD.VADFrames -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - name: VADMinimumEnergy - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADMinimumEnergy - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADMinimumEnergy - nameWithType: EnergyTresholdVAD.VADMinimumEnergy -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - name: VADNoiseHalftimeMillis - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADNoiseHalftimeMillis - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADNoiseHalftimeMillis - nameWithType: EnergyTresholdVAD.VADNoiseHalftimeMillis -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADRelease - name: VADRelease - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADRelease - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADRelease - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADRelease - nameWithType: EnergyTresholdVAD.VADRelease -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - name: VADSignalToNoise - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADSignalToNoise - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADSignalToNoise - nameWithType: EnergyTresholdVAD.VADSignalToNoise -- uid: Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - name: VADSustainMillis - href: api/Speechly.SLUClient.EnergyTresholdVAD.html#Speechly_SLUClient_EnergyTresholdVAD_VADSustainMillis - commentId: F:Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - fullName: Speechly.SLUClient.EnergyTresholdVAD.VADSustainMillis - nameWithType: EnergyTresholdVAD.VADSustainMillis - uid: Speechly.SLUClient.IDecoder name: IDecoder href: api/Speechly.SLUClient.IDecoder.html @@ -227,12 +112,12 @@ references: commentId: T:Speechly.SLUClient.SpeechlyClient fullName: Speechly.SLUClient.SpeechlyClient nameWithType: SpeechlyClient -- uid: Speechly.SLUClient.SpeechlyClient.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean) - name: SpeechlyClient(Int32, Int32, Int32, Boolean, String, EnergyTresholdVAD, Boolean) - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient__ctor_System_Int32_System_Int32_System_Int32_System_Boolean_System_String_Speechly_SLUClient_EnergyTresholdVAD_System_Boolean_ - commentId: M:Speechly.SLUClient.SpeechlyClient.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean,System.String,Speechly.SLUClient.EnergyTresholdVAD,System.Boolean) - fullName: Speechly.SLUClient.SpeechlyClient.SpeechlyClient(System.Int32, System.Int32, System.Int32, System.Boolean, System.String, Speechly.SLUClient.EnergyTresholdVAD, System.Boolean) - nameWithType: SpeechlyClient.SpeechlyClient(Int32, Int32, Int32, Boolean, String, EnergyTresholdVAD, Boolean) +- uid: Speechly.SLUClient.SpeechlyClient.#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean) + name: SpeechlyClient(Boolean, String, AudioInfo, Boolean) + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient__ctor_System_Boolean_System_String_Speechly_Types_AudioInfo_System_Boolean_ + commentId: M:Speechly.SLUClient.SpeechlyClient.#ctor(System.Boolean,System.String,Speechly.Types.AudioInfo,System.Boolean) + fullName: Speechly.SLUClient.SpeechlyClient.SpeechlyClient(System.Boolean, System.String, Speechly.Types.AudioInfo, System.Boolean) + nameWithType: SpeechlyClient.SpeechlyClient(Boolean, String, AudioInfo, Boolean) - uid: Speechly.SLUClient.SpeechlyClient.#ctor* name: SpeechlyClient href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient__ctor_ @@ -240,6 +125,22 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.SpeechlyClient nameWithType: SpeechlyClient.SpeechlyClient +- uid: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable{System.Boolean}) + name: AdjustAudioProcessor(Nullable) + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_AdjustAudioProcessor_System_Nullable_System_Boolean__ + commentId: M:Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable{System.Boolean}) + name.vb: AdjustAudioProcessor(Nullable(Of Boolean)) + fullName: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable) + fullName.vb: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor(System.Nullable(Of System.Boolean)) + nameWithType: SpeechlyClient.AdjustAudioProcessor(Nullable) + nameWithType.vb: SpeechlyClient.AdjustAudioProcessor(Nullable(Of Boolean)) +- uid: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor* + name: AdjustAudioProcessor + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_AdjustAudioProcessor_ + commentId: Overload:Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor + isSpec: "True" + fullName: Speechly.SLUClient.SpeechlyClient.AdjustAudioProcessor + nameWithType: SpeechlyClient.AdjustAudioProcessor - uid: Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier name: AudioInputStreamIdentifier href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_AudioInputStreamIdentifier @@ -253,12 +154,18 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.AudioInputStreamIdentifier nameWithType: SpeechlyClient.AudioInputStreamIdentifier -- uid: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) - name: Initialize(IDecoder) - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Initialize_Speechly_SLUClient_IDecoder_ - commentId: M:Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) - fullName: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder) - nameWithType: SpeechlyClient.Initialize(IDecoder) +- uid: Speechly.SLUClient.SpeechlyClient.Debug + name: Debug + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Debug + commentId: F:Speechly.SLUClient.SpeechlyClient.Debug + fullName: Speechly.SLUClient.SpeechlyClient.Debug + nameWithType: SpeechlyClient.Debug +- uid: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) + name: Initialize(IDecoder, AudioProcessorOptions, ContextOptions, Boolean) + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Initialize_Speechly_SLUClient_IDecoder_Speechly_Types_AudioProcessorOptions_Speechly_Types_ContextOptions_System_Boolean_ + commentId: M:Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder,Speechly.Types.AudioProcessorOptions,Speechly.Types.ContextOptions,System.Boolean) + fullName: Speechly.SLUClient.SpeechlyClient.Initialize(Speechly.SLUClient.IDecoder, Speechly.Types.AudioProcessorOptions, Speechly.Types.ContextOptions, System.Boolean) + nameWithType: SpeechlyClient.Initialize(IDecoder, AudioProcessorOptions, ContextOptions, Boolean) - uid: Speechly.SLUClient.SpeechlyClient.Initialize* name: Initialize href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Initialize_ @@ -323,24 +230,24 @@ references: commentId: F:Speechly.SLUClient.SpeechlyClient.OnSegmentChange fullName: Speechly.SLUClient.SpeechlyClient.OnSegmentChange nameWithType: SpeechlyClient.OnSegmentChange -- uid: Speechly.SLUClient.SpeechlyClient.OnStartContext - name: OnStartContext - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_OnStartContext - commentId: F:Speechly.SLUClient.SpeechlyClient.OnStartContext - fullName: Speechly.SLUClient.SpeechlyClient.OnStartContext - nameWithType: SpeechlyClient.OnStartContext +- uid: Speechly.SLUClient.SpeechlyClient.OnStart + name: OnStart + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_OnStart + commentId: F:Speechly.SLUClient.SpeechlyClient.OnStart + fullName: Speechly.SLUClient.SpeechlyClient.OnStart + nameWithType: SpeechlyClient.OnStart - uid: Speechly.SLUClient.SpeechlyClient.OnStartStream name: OnStartStream href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_OnStartStream commentId: F:Speechly.SLUClient.SpeechlyClient.OnStartStream fullName: Speechly.SLUClient.SpeechlyClient.OnStartStream nameWithType: SpeechlyClient.OnStartStream -- uid: Speechly.SLUClient.SpeechlyClient.OnStopContext - name: OnStopContext - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_OnStopContext - commentId: F:Speechly.SLUClient.SpeechlyClient.OnStopContext - fullName: Speechly.SLUClient.SpeechlyClient.OnStopContext - nameWithType: SpeechlyClient.OnStopContext +- uid: Speechly.SLUClient.SpeechlyClient.OnStop + name: OnStop + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_OnStop + commentId: F:Speechly.SLUClient.SpeechlyClient.OnStop + fullName: Speechly.SLUClient.SpeechlyClient.OnStop + nameWithType: SpeechlyClient.OnStop - uid: Speechly.SLUClient.SpeechlyClient.OnStopStream name: OnStopStream href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_OnStopStream @@ -371,21 +278,34 @@ references: commentId: F:Speechly.SLUClient.SpeechlyClient.OnTranscript fullName: Speechly.SLUClient.SpeechlyClient.OnTranscript nameWithType: SpeechlyClient.OnTranscript +- uid: Speechly.SLUClient.SpeechlyClient.Output + name: Output + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Output + commentId: P:Speechly.SLUClient.SpeechlyClient.Output + fullName: Speechly.SLUClient.SpeechlyClient.Output + nameWithType: SpeechlyClient.Output +- uid: Speechly.SLUClient.SpeechlyClient.Output* + name: Output + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Output_ + commentId: Overload:Speechly.SLUClient.SpeechlyClient.Output + isSpec: "True" + fullName: Speechly.SLUClient.SpeechlyClient.Output + nameWithType: SpeechlyClient.Output - uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream) name: ProcessAudio(Stream) href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_ProcessAudio_Stream_ commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream) fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudio(Stream) nameWithType: SpeechlyClient.ProcessAudio(Stream) -- uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) - name: ProcessAudio(Single[], Int32, Int32, Boolean) - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_ProcessAudio_System_Single___System_Int32_System_Int32_System_Boolean_ - commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) - name.vb: ProcessAudio(Single(), Int32, Int32, Boolean) - fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[], System.Int32, System.Int32, System.Boolean) - fullName.vb: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single(), System.Int32, System.Int32, System.Boolean) - nameWithType: SpeechlyClient.ProcessAudio(Single[], Int32, Int32, Boolean) - nameWithType.vb: SpeechlyClient.ProcessAudio(Single(), Int32, Int32, Boolean) +- uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) + name: ProcessAudio(Single[], Int32, Int32) + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_ProcessAudio_System_Single___System_Int32_System_Int32_ + commentId: M:Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[],System.Int32,System.Int32) + name.vb: ProcessAudio(Single(), Int32, Int32) + fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single[], System.Int32, System.Int32) + fullName.vb: Speechly.SLUClient.SpeechlyClient.ProcessAudio(System.Single(), System.Int32, System.Int32) + nameWithType: SpeechlyClient.ProcessAudio(Single[], Int32, Int32) + nameWithType.vb: SpeechlyClient.ProcessAudio(Single(), Int32, Int32) - uid: Speechly.SLUClient.SpeechlyClient.ProcessAudio* name: ProcessAudio href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_ProcessAudio_ @@ -406,19 +326,6 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.ProcessAudioFile nameWithType: SpeechlyClient.ProcessAudioFile -- uid: Speechly.SLUClient.SpeechlyClient.SamplesSent - name: SamplesSent - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_SamplesSent - commentId: P:Speechly.SLUClient.SpeechlyClient.SamplesSent - fullName: Speechly.SLUClient.SpeechlyClient.SamplesSent - nameWithType: SpeechlyClient.SamplesSent -- uid: Speechly.SLUClient.SpeechlyClient.SamplesSent* - name: SamplesSent - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_SamplesSent_ - commentId: Overload:Speechly.SLUClient.SpeechlyClient.SamplesSent - isSpec: "True" - fullName: Speechly.SLUClient.SpeechlyClient.SamplesSent - nameWithType: SpeechlyClient.SamplesSent - uid: Speechly.SLUClient.SpeechlyClient.Shutdown name: Shutdown() href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Shutdown @@ -432,19 +339,19 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.Shutdown nameWithType: SpeechlyClient.Shutdown -- uid: Speechly.SLUClient.SpeechlyClient.StartContext(System.String) - name: StartContext(String) - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StartContext_System_String_ - commentId: M:Speechly.SLUClient.SpeechlyClient.StartContext(System.String) - fullName: Speechly.SLUClient.SpeechlyClient.StartContext(System.String) - nameWithType: SpeechlyClient.StartContext(String) -- uid: Speechly.SLUClient.SpeechlyClient.StartContext* - name: StartContext - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StartContext_ - commentId: Overload:Speechly.SLUClient.SpeechlyClient.StartContext +- uid: Speechly.SLUClient.SpeechlyClient.Start(System.String) + name: Start(String) + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Start_System_String_ + commentId: M:Speechly.SLUClient.SpeechlyClient.Start(System.String) + fullName: Speechly.SLUClient.SpeechlyClient.Start(System.String) + nameWithType: SpeechlyClient.Start(String) +- uid: Speechly.SLUClient.SpeechlyClient.Start* + name: Start + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Start_ + commentId: Overload:Speechly.SLUClient.SpeechlyClient.Start isSpec: "True" - fullName: Speechly.SLUClient.SpeechlyClient.StartContext - nameWithType: SpeechlyClient.StartContext + fullName: Speechly.SLUClient.SpeechlyClient.Start + nameWithType: SpeechlyClient.Start - uid: Speechly.SLUClient.SpeechlyClient.StartStream(System.String,System.Boolean) name: StartStream(String, Boolean) href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StartStream_System_String_System_Boolean_ @@ -458,19 +365,19 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.StartStream nameWithType: SpeechlyClient.StartStream -- uid: Speechly.SLUClient.SpeechlyClient.StopContext - name: StopContext() - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StopContext - commentId: M:Speechly.SLUClient.SpeechlyClient.StopContext - fullName: Speechly.SLUClient.SpeechlyClient.StopContext() - nameWithType: SpeechlyClient.StopContext() -- uid: Speechly.SLUClient.SpeechlyClient.StopContext* - name: StopContext - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StopContext_ - commentId: Overload:Speechly.SLUClient.SpeechlyClient.StopContext +- uid: Speechly.SLUClient.SpeechlyClient.Stop + name: Stop() + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Stop + commentId: M:Speechly.SLUClient.SpeechlyClient.Stop + fullName: Speechly.SLUClient.SpeechlyClient.Stop() + nameWithType: SpeechlyClient.Stop() +- uid: Speechly.SLUClient.SpeechlyClient.Stop* + name: Stop + href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Stop_ + commentId: Overload:Speechly.SLUClient.SpeechlyClient.Stop isSpec: "True" - fullName: Speechly.SLUClient.SpeechlyClient.StopContext - nameWithType: SpeechlyClient.StopContext + fullName: Speechly.SLUClient.SpeechlyClient.Stop + nameWithType: SpeechlyClient.Stop - uid: Speechly.SLUClient.SpeechlyClient.StopStream(System.Boolean) name: StopStream(Boolean) href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StopStream_System_Boolean_ @@ -484,19 +391,6 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.StopStream nameWithType: SpeechlyClient.StopStream -- uid: Speechly.SLUClient.SpeechlyClient.StreamSamplePos - name: StreamSamplePos - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StreamSamplePos - commentId: P:Speechly.SLUClient.SpeechlyClient.StreamSamplePos - fullName: Speechly.SLUClient.SpeechlyClient.StreamSamplePos - nameWithType: SpeechlyClient.StreamSamplePos -- uid: Speechly.SLUClient.SpeechlyClient.StreamSamplePos* - name: StreamSamplePos - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_StreamSamplePos_ - commentId: Overload:Speechly.SLUClient.SpeechlyClient.StreamSamplePos - isSpec: "True" - fullName: Speechly.SLUClient.SpeechlyClient.StreamSamplePos - nameWithType: SpeechlyClient.StreamSamplePos - uid: Speechly.SLUClient.SpeechlyClient.Update name: Update() href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Update @@ -510,38 +404,149 @@ references: isSpec: "True" fullName: Speechly.SLUClient.SpeechlyClient.Update nameWithType: SpeechlyClient.Update -- uid: Speechly.SLUClient.SpeechlyClient.UtteranceSerial - name: UtteranceSerial - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_UtteranceSerial - commentId: P:Speechly.SLUClient.SpeechlyClient.UtteranceSerial - fullName: Speechly.SLUClient.SpeechlyClient.UtteranceSerial - nameWithType: SpeechlyClient.UtteranceSerial -- uid: Speechly.SLUClient.SpeechlyClient.UtteranceSerial* - name: UtteranceSerial - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_UtteranceSerial_ - commentId: Overload:Speechly.SLUClient.SpeechlyClient.UtteranceSerial - isSpec: "True" - fullName: Speechly.SLUClient.SpeechlyClient.UtteranceSerial - nameWithType: SpeechlyClient.UtteranceSerial -- uid: Speechly.SLUClient.SpeechlyClient.Vad - name: Vad - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Vad - commentId: P:Speechly.SLUClient.SpeechlyClient.Vad - fullName: Speechly.SLUClient.SpeechlyClient.Vad - nameWithType: SpeechlyClient.Vad -- uid: Speechly.SLUClient.SpeechlyClient.Vad* - name: Vad - href: api/Speechly.SLUClient.SpeechlyClient.html#Speechly_SLUClient_SpeechlyClient_Vad_ - commentId: Overload:Speechly.SLUClient.SpeechlyClient.Vad - isSpec: "True" - fullName: Speechly.SLUClient.SpeechlyClient.Vad - nameWithType: SpeechlyClient.Vad - uid: Speechly.Tools name: Speechly.Tools href: api/Speechly.Tools.html commentId: N:Speechly.Tools fullName: Speechly.Tools nameWithType: Speechly.Tools +- uid: Speechly.Tools.AudioProcessor + name: AudioProcessor + href: api/Speechly.Tools.AudioProcessor.html + commentId: T:Speechly.Tools.AudioProcessor + fullName: Speechly.Tools.AudioProcessor + nameWithType: AudioProcessor +- uid: Speechly.Tools.AudioProcessor.#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean) + name: AudioProcessor(AudioProcessorOptions, AudioInfo, Boolean) + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor__ctor_Speechly_Types_AudioProcessorOptions_Speechly_Types_AudioInfo_System_Boolean_ + commentId: M:Speechly.Tools.AudioProcessor.#ctor(Speechly.Types.AudioProcessorOptions,Speechly.Types.AudioInfo,System.Boolean) + fullName: Speechly.Tools.AudioProcessor.AudioProcessor(Speechly.Types.AudioProcessorOptions, Speechly.Types.AudioInfo, System.Boolean) + nameWithType: AudioProcessor.AudioProcessor(AudioProcessorOptions, AudioInfo, Boolean) +- uid: Speechly.Tools.AudioProcessor.#ctor* + name: AudioProcessor + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor__ctor_ + commentId: Overload:Speechly.Tools.AudioProcessor.#ctor + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.AudioProcessor + nameWithType: AudioProcessor.AudioProcessor +- uid: Speechly.Tools.AudioProcessor.OnSendAudio + name: OnSendAudio + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_OnSendAudio + commentId: F:Speechly.Tools.AudioProcessor.OnSendAudio + fullName: Speechly.Tools.AudioProcessor.OnSendAudio + nameWithType: AudioProcessor.OnSendAudio +- uid: Speechly.Tools.AudioProcessor.OnVadStateChange + name: OnVadStateChange + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_OnVadStateChange + commentId: F:Speechly.Tools.AudioProcessor.OnVadStateChange + fullName: Speechly.Tools.AudioProcessor.OnVadStateChange + nameWithType: AudioProcessor.OnVadStateChange +- uid: Speechly.Tools.AudioProcessor.Options + name: Options + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Options + commentId: P:Speechly.Tools.AudioProcessor.Options + fullName: Speechly.Tools.AudioProcessor.Options + nameWithType: AudioProcessor.Options +- uid: Speechly.Tools.AudioProcessor.Options* + name: Options + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Options_ + commentId: Overload:Speechly.Tools.AudioProcessor.Options + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.Options + nameWithType: AudioProcessor.Options +- uid: Speechly.Tools.AudioProcessor.Output + name: Output + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Output + commentId: P:Speechly.Tools.AudioProcessor.Output + fullName: Speechly.Tools.AudioProcessor.Output + nameWithType: AudioProcessor.Output +- uid: Speechly.Tools.AudioProcessor.Output* + name: Output + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Output_ + commentId: Overload:Speechly.Tools.AudioProcessor.Output + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.Output + nameWithType: AudioProcessor.Output +- uid: Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + name: ProcessAudio(Single[], Int32, Int32, Boolean) + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_ProcessAudio_System_Single___System_Int32_System_Int32_System_Boolean_ + commentId: M:Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[],System.Int32,System.Int32,System.Boolean) + name.vb: ProcessAudio(Single(), Int32, Int32, Boolean) + fullName: Speechly.Tools.AudioProcessor.ProcessAudio(System.Single[], System.Int32, System.Int32, System.Boolean) + fullName.vb: Speechly.Tools.AudioProcessor.ProcessAudio(System.Single(), System.Int32, System.Int32, System.Boolean) + nameWithType: AudioProcessor.ProcessAudio(Single[], Int32, Int32, Boolean) + nameWithType.vb: AudioProcessor.ProcessAudio(Single(), Int32, Int32, Boolean) +- uid: Speechly.Tools.AudioProcessor.ProcessAudio* + name: ProcessAudio + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_ProcessAudio_ + commentId: Overload:Speechly.Tools.AudioProcessor.ProcessAudio + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.ProcessAudio + nameWithType: AudioProcessor.ProcessAudio +- uid: Speechly.Tools.AudioProcessor.Reset(System.Int32) + name: Reset(Int32) + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Reset_System_Int32_ + commentId: M:Speechly.Tools.AudioProcessor.Reset(System.Int32) + fullName: Speechly.Tools.AudioProcessor.Reset(System.Int32) + nameWithType: AudioProcessor.Reset(Int32) +- uid: Speechly.Tools.AudioProcessor.Reset* + name: Reset + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Reset_ + commentId: Overload:Speechly.Tools.AudioProcessor.Reset + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.Reset + nameWithType: AudioProcessor.Reset +- uid: Speechly.Tools.AudioProcessor.SendAudioDelegate + name: AudioProcessor.SendAudioDelegate + href: api/Speechly.Tools.AudioProcessor.SendAudioDelegate.html + commentId: T:Speechly.Tools.AudioProcessor.SendAudioDelegate + fullName: Speechly.Tools.AudioProcessor.SendAudioDelegate + nameWithType: AudioProcessor.SendAudioDelegate +- uid: Speechly.Tools.AudioProcessor.Start + name: Start() + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Start + commentId: M:Speechly.Tools.AudioProcessor.Start + fullName: Speechly.Tools.AudioProcessor.Start() + nameWithType: AudioProcessor.Start() +- uid: Speechly.Tools.AudioProcessor.Start* + name: Start + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Start_ + commentId: Overload:Speechly.Tools.AudioProcessor.Start + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.Start + nameWithType: AudioProcessor.Start +- uid: Speechly.Tools.AudioProcessor.Stop + name: Stop() + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Stop + commentId: M:Speechly.Tools.AudioProcessor.Stop + fullName: Speechly.Tools.AudioProcessor.Stop() + nameWithType: AudioProcessor.Stop() +- uid: Speechly.Tools.AudioProcessor.Stop* + name: Stop + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Stop_ + commentId: Overload:Speechly.Tools.AudioProcessor.Stop + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.Stop + nameWithType: AudioProcessor.Stop +- uid: Speechly.Tools.AudioProcessor.Vad + name: Vad + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Vad + commentId: P:Speechly.Tools.AudioProcessor.Vad + fullName: Speechly.Tools.AudioProcessor.Vad + nameWithType: AudioProcessor.Vad +- uid: Speechly.Tools.AudioProcessor.Vad* + name: Vad + href: api/Speechly.Tools.AudioProcessor.html#Speechly_Tools_AudioProcessor_Vad_ + commentId: Overload:Speechly.Tools.AudioProcessor.Vad + isSpec: "True" + fullName: Speechly.Tools.AudioProcessor.Vad + nameWithType: AudioProcessor.Vad +- uid: Speechly.Tools.AudioProcessor.VadChangeDelegate + name: AudioProcessor.VadChangeDelegate + href: api/Speechly.Tools.AudioProcessor.VadChangeDelegate.html + commentId: T:Speechly.Tools.AudioProcessor.VadChangeDelegate + fullName: Speechly.Tools.AudioProcessor.VadChangeDelegate + nameWithType: AudioProcessor.VadChangeDelegate - uid: Speechly.Tools.AudioTools name: AudioTools href: api/Speechly.Tools.AudioTools.html @@ -564,6 +569,19 @@ references: isSpec: "True" fullName: Speechly.Tools.AudioTools.ConvertInt16ToFloat nameWithType: AudioTools.ConvertInt16ToFloat +- uid: Speechly.Tools.AudioTools.DbToEnergy(System.Single) + name: DbToEnergy(Single) + href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_DbToEnergy_System_Single_ + commentId: M:Speechly.Tools.AudioTools.DbToEnergy(System.Single) + fullName: Speechly.Tools.AudioTools.DbToEnergy(System.Single) + nameWithType: AudioTools.DbToEnergy(Single) +- uid: Speechly.Tools.AudioTools.DbToEnergy* + name: DbToEnergy + href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_DbToEnergy_ + commentId: Overload:Speechly.Tools.AudioTools.DbToEnergy + isSpec: "True" + fullName: Speechly.Tools.AudioTools.DbToEnergy + nameWithType: AudioTools.DbToEnergy - uid: Speechly.Tools.AudioTools.Downsample(System.Single[]@,System.Single[]@,System.Int32,System.Int32,System.Int32,System.Int32) name: Downsample(in Single[], ref Single[], Int32, Int32, Int32, Int32) href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_Downsample_System_Single____System_Single____System_Int32_System_Int32_System_Int32_System_Int32_ @@ -580,6 +598,19 @@ references: isSpec: "True" fullName: Speechly.Tools.AudioTools.Downsample nameWithType: AudioTools.Downsample +- uid: Speechly.Tools.AudioTools.EnergyToDb(System.Single) + name: EnergyToDb(Single) + href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_EnergyToDb_System_Single_ + commentId: M:Speechly.Tools.AudioTools.EnergyToDb(System.Single) + fullName: Speechly.Tools.AudioTools.EnergyToDb(System.Single) + nameWithType: AudioTools.EnergyToDb(Single) +- uid: Speechly.Tools.AudioTools.EnergyToDb* + name: EnergyToDb + href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_EnergyToDb_ + commentId: Overload:Speechly.Tools.AudioTools.EnergyToDb + isSpec: "True" + fullName: Speechly.Tools.AudioTools.EnergyToDb + nameWithType: AudioTools.EnergyToDb - uid: Speechly.Tools.AudioTools.GetAudioPeak(System.Single[]@,System.Int32,System.Int32) name: GetAudioPeak(in Single[], Int32, Int32) href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_GetAudioPeak_System_Single____System_Int32_System_Int32_ @@ -612,6 +643,86 @@ references: isSpec: "True" fullName: Speechly.Tools.AudioTools.GetEnergy nameWithType: AudioTools.GetEnergy +- uid: Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 + name: LOG_2_PLUS_LOG_5 + href: api/Speechly.Tools.AudioTools.html#Speechly_Tools_AudioTools_LOG_2_PLUS_LOG_5 + commentId: F:Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 + fullName: Speechly.Tools.AudioTools.LOG_2_PLUS_LOG_5 + nameWithType: AudioTools.LOG_2_PLUS_LOG_5 +- uid: Speechly.Tools.EnergyThresholdVAD + name: EnergyThresholdVAD + href: api/Speechly.Tools.EnergyThresholdVAD.html + commentId: T:Speechly.Tools.EnergyThresholdVAD + fullName: Speechly.Tools.EnergyThresholdVAD + nameWithType: EnergyThresholdVAD +- uid: Speechly.Tools.EnergyThresholdVAD.#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo) + name: EnergyThresholdVAD(VADOptions, AudioInfo) + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD__ctor_Speechly_Types_VADOptions_Speechly_Types_AudioInfo_ + commentId: M:Speechly.Tools.EnergyThresholdVAD.#ctor(Speechly.Types.VADOptions,Speechly.Types.AudioInfo) + fullName: Speechly.Tools.EnergyThresholdVAD.EnergyThresholdVAD(Speechly.Types.VADOptions, Speechly.Types.AudioInfo) + nameWithType: EnergyThresholdVAD.EnergyThresholdVAD(VADOptions, AudioInfo) +- uid: Speechly.Tools.EnergyThresholdVAD.#ctor* + name: EnergyThresholdVAD + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD__ctor_ + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.#ctor + isSpec: "True" + fullName: Speechly.Tools.EnergyThresholdVAD.EnergyThresholdVAD + nameWithType: EnergyThresholdVAD.EnergyThresholdVAD +- uid: Speechly.Tools.EnergyThresholdVAD.Options + name: Options + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_Options + commentId: P:Speechly.Tools.EnergyThresholdVAD.Options + fullName: Speechly.Tools.EnergyThresholdVAD.Options + nameWithType: EnergyThresholdVAD.Options +- uid: Speechly.Tools.EnergyThresholdVAD.Options* + name: Options + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_Options_ + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.Options + isSpec: "True" + fullName: Speechly.Tools.EnergyThresholdVAD.Options + nameWithType: EnergyThresholdVAD.Options +- uid: Speechly.Tools.EnergyThresholdVAD.Output + name: Output + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_Output + commentId: P:Speechly.Tools.EnergyThresholdVAD.Output + fullName: Speechly.Tools.EnergyThresholdVAD.Output + nameWithType: EnergyThresholdVAD.Output +- uid: Speechly.Tools.EnergyThresholdVAD.Output* + name: Output + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_Output_ + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.Output + isSpec: "True" + fullName: Speechly.Tools.EnergyThresholdVAD.Output + nameWithType: EnergyThresholdVAD.Output +- uid: Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) + name: ProcessFrame(Single[], Int32, Int32) + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_ProcessFrame_System_Single___System_Int32_System_Int32_ + commentId: M:Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[],System.Int32,System.Int32) + name.vb: ProcessFrame(Single(), Int32, Int32) + fullName: Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single[], System.Int32, System.Int32) + fullName.vb: Speechly.Tools.EnergyThresholdVAD.ProcessFrame(System.Single(), System.Int32, System.Int32) + nameWithType: EnergyThresholdVAD.ProcessFrame(Single[], Int32, Int32) + nameWithType.vb: EnergyThresholdVAD.ProcessFrame(Single(), Int32, Int32) +- uid: Speechly.Tools.EnergyThresholdVAD.ProcessFrame* + name: ProcessFrame + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_ProcessFrame_ + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.ProcessFrame + isSpec: "True" + fullName: Speechly.Tools.EnergyThresholdVAD.ProcessFrame + nameWithType: EnergyThresholdVAD.ProcessFrame +- uid: Speechly.Tools.EnergyThresholdVAD.ResetVAD + name: ResetVAD() + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_ResetVAD + commentId: M:Speechly.Tools.EnergyThresholdVAD.ResetVAD + fullName: Speechly.Tools.EnergyThresholdVAD.ResetVAD() + nameWithType: EnergyThresholdVAD.ResetVAD() +- uid: Speechly.Tools.EnergyThresholdVAD.ResetVAD* + name: ResetVAD + href: api/Speechly.Tools.EnergyThresholdVAD.html#Speechly_Tools_EnergyThresholdVAD_ResetVAD_ + commentId: Overload:Speechly.Tools.EnergyThresholdVAD.ResetVAD + isSpec: "True" + fullName: Speechly.Tools.EnergyThresholdVAD.ResetVAD + nameWithType: EnergyThresholdVAD.ResetVAD - uid: Speechly.Tools.JSON name: JSON href: api/Speechly.Tools.JSON.html @@ -907,6 +1018,111 @@ references: commentId: N:Speechly.Types fullName: Speechly.Types nameWithType: Speechly.Types +- uid: Speechly.Types.AudioInfo + name: AudioInfo + href: api/Speechly.Types.AudioInfo.html + commentId: T:Speechly.Types.AudioInfo + fullName: Speechly.Types.AudioInfo + nameWithType: AudioInfo +- uid: Speechly.Types.AudioInfo.IsSignalDetected + name: IsSignalDetected + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_IsSignalDetected + commentId: F:Speechly.Types.AudioInfo.IsSignalDetected + fullName: Speechly.Types.AudioInfo.IsSignalDetected + nameWithType: AudioInfo.IsSignalDetected +- uid: Speechly.Types.AudioInfo.NoiseLevelDb + name: NoiseLevelDb + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_NoiseLevelDb + commentId: F:Speechly.Types.AudioInfo.NoiseLevelDb + fullName: Speechly.Types.AudioInfo.NoiseLevelDb + nameWithType: AudioInfo.NoiseLevelDb +- uid: Speechly.Types.AudioInfo.SamplesSent + name: SamplesSent + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_SamplesSent + commentId: P:Speechly.Types.AudioInfo.SamplesSent + fullName: Speechly.Types.AudioInfo.SamplesSent + nameWithType: AudioInfo.SamplesSent +- uid: Speechly.Types.AudioInfo.SamplesSent* + name: SamplesSent + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_SamplesSent_ + commentId: Overload:Speechly.Types.AudioInfo.SamplesSent + isSpec: "True" + fullName: Speechly.Types.AudioInfo.SamplesSent + nameWithType: AudioInfo.SamplesSent +- uid: Speechly.Types.AudioInfo.SignalDb + name: SignalDb + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_SignalDb + commentId: F:Speechly.Types.AudioInfo.SignalDb + fullName: Speechly.Types.AudioInfo.SignalDb + nameWithType: AudioInfo.SignalDb +- uid: Speechly.Types.AudioInfo.StreamSamplePos + name: StreamSamplePos + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_StreamSamplePos + commentId: P:Speechly.Types.AudioInfo.StreamSamplePos + fullName: Speechly.Types.AudioInfo.StreamSamplePos + nameWithType: AudioInfo.StreamSamplePos +- uid: Speechly.Types.AudioInfo.StreamSamplePos* + name: StreamSamplePos + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_StreamSamplePos_ + commentId: Overload:Speechly.Types.AudioInfo.StreamSamplePos + isSpec: "True" + fullName: Speechly.Types.AudioInfo.StreamSamplePos + nameWithType: AudioInfo.StreamSamplePos +- uid: Speechly.Types.AudioInfo.UtteranceSerial + name: UtteranceSerial + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_UtteranceSerial + commentId: P:Speechly.Types.AudioInfo.UtteranceSerial + fullName: Speechly.Types.AudioInfo.UtteranceSerial + nameWithType: AudioInfo.UtteranceSerial +- uid: Speechly.Types.AudioInfo.UtteranceSerial* + name: UtteranceSerial + href: api/Speechly.Types.AudioInfo.html#Speechly_Types_AudioInfo_UtteranceSerial_ + commentId: Overload:Speechly.Types.AudioInfo.UtteranceSerial + isSpec: "True" + fullName: Speechly.Types.AudioInfo.UtteranceSerial + nameWithType: AudioInfo.UtteranceSerial +- uid: Speechly.Types.AudioProcessorOptions + name: AudioProcessorOptions + href: api/Speechly.Types.AudioProcessorOptions.html + commentId: T:Speechly.Types.AudioProcessorOptions + fullName: Speechly.Types.AudioProcessorOptions + nameWithType: AudioProcessorOptions +- uid: Speechly.Types.AudioProcessorOptions.FrameMillis + name: FrameMillis + href: api/Speechly.Types.AudioProcessorOptions.html#Speechly_Types_AudioProcessorOptions_FrameMillis + commentId: F:Speechly.Types.AudioProcessorOptions.FrameMillis + fullName: Speechly.Types.AudioProcessorOptions.FrameMillis + nameWithType: AudioProcessorOptions.FrameMillis +- uid: Speechly.Types.AudioProcessorOptions.HistoryFrames + name: HistoryFrames + href: api/Speechly.Types.AudioProcessorOptions.html#Speechly_Types_AudioProcessorOptions_HistoryFrames + commentId: F:Speechly.Types.AudioProcessorOptions.HistoryFrames + fullName: Speechly.Types.AudioProcessorOptions.HistoryFrames + nameWithType: AudioProcessorOptions.HistoryFrames +- uid: Speechly.Types.AudioProcessorOptions.InputSampleRate + name: InputSampleRate + href: api/Speechly.Types.AudioProcessorOptions.html#Speechly_Types_AudioProcessorOptions_InputSampleRate + commentId: F:Speechly.Types.AudioProcessorOptions.InputSampleRate + fullName: Speechly.Types.AudioProcessorOptions.InputSampleRate + nameWithType: AudioProcessorOptions.InputSampleRate +- uid: Speechly.Types.AudioProcessorOptions.InternalSampleRate + name: InternalSampleRate + href: api/Speechly.Types.AudioProcessorOptions.html#Speechly_Types_AudioProcessorOptions_InternalSampleRate + commentId: F:Speechly.Types.AudioProcessorOptions.InternalSampleRate + fullName: Speechly.Types.AudioProcessorOptions.InternalSampleRate + nameWithType: AudioProcessorOptions.InternalSampleRate +- uid: Speechly.Types.AudioProcessorOptions.VADControlsListening + name: VADControlsListening + href: api/Speechly.Types.AudioProcessorOptions.html#Speechly_Types_AudioProcessorOptions_VADControlsListening + commentId: F:Speechly.Types.AudioProcessorOptions.VADControlsListening + fullName: Speechly.Types.AudioProcessorOptions.VADControlsListening + nameWithType: AudioProcessorOptions.VADControlsListening +- uid: Speechly.Types.AudioProcessorOptions.VADSettings + name: VADSettings + href: api/Speechly.Types.AudioProcessorOptions.html#Speechly_Types_AudioProcessorOptions_VADSettings + commentId: F:Speechly.Types.AudioProcessorOptions.VADSettings + fullName: Speechly.Types.AudioProcessorOptions.VADSettings + nameWithType: AudioProcessorOptions.VADSettings - uid: Speechly.Types.BeautifyEntity name: BeautifyEntity href: api/Speechly.Types.BeautifyEntity.html @@ -919,6 +1135,42 @@ references: commentId: T:Speechly.Types.BeautifyIntent fullName: Speechly.Types.BeautifyIntent nameWithType: BeautifyIntent +- uid: Speechly.Types.ContextOptions + name: ContextOptions + href: api/Speechly.Types.ContextOptions.html + commentId: T:Speechly.Types.ContextOptions + fullName: Speechly.Types.ContextOptions + nameWithType: ContextOptions +- uid: Speechly.Types.ContextOptions.BoostVocabulary + name: BoostVocabulary + href: api/Speechly.Types.ContextOptions.html#Speechly_Types_ContextOptions_BoostVocabulary + commentId: F:Speechly.Types.ContextOptions.BoostVocabulary + fullName: Speechly.Types.ContextOptions.BoostVocabulary + nameWithType: ContextOptions.BoostVocabulary +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings + name: ContextOptions.ShallowFusionSettings + href: api/Speechly.Types.ContextOptions.ShallowFusionSettings.html + commentId: T:Speechly.Types.ContextOptions.ShallowFusionSettings + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings + nameWithType: ContextOptions.ShallowFusionSettings +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + name: Vocabulary + href: api/Speechly.Types.ContextOptions.ShallowFusionSettings.html#Speechly_Types_ContextOptions_ShallowFusionSettings_Vocabulary + commentId: F:Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings.Vocabulary + nameWithType: ContextOptions.ShallowFusionSettings.Vocabulary +- uid: Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + name: Weight + href: api/Speechly.Types.ContextOptions.ShallowFusionSettings.html#Speechly_Types_ContextOptions_ShallowFusionSettings_Weight + commentId: F:Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + fullName: Speechly.Types.ContextOptions.ShallowFusionSettings.Weight + nameWithType: ContextOptions.ShallowFusionSettings.Weight +- uid: Speechly.Types.ContextOptions.SilenceSegmentationMillis + name: SilenceSegmentationMillis + href: api/Speechly.Types.ContextOptions.html#Speechly_Types_ContextOptions_SilenceSegmentationMillis + commentId: F:Speechly.Types.ContextOptions.SilenceSegmentationMillis + fullName: Speechly.Types.ContextOptions.SilenceSegmentationMillis + nameWithType: ContextOptions.SilenceSegmentationMillis - uid: Speechly.Types.Entity name: Entity href: api/Speechly.Types.Entity.html @@ -985,6 +1237,37 @@ references: commentId: T:Speechly.Types.IntentDelegate fullName: Speechly.Types.IntentDelegate nameWithType: IntentDelegate +- uid: Speechly.Types.ModelExpiredException + name: ModelExpiredException + href: api/Speechly.Types.ModelExpiredException.html + commentId: T:Speechly.Types.ModelExpiredException + fullName: Speechly.Types.ModelExpiredException + nameWithType: ModelExpiredException +- uid: Speechly.Types.ModelExpiredException.#ctor + name: ModelExpiredException() + href: api/Speechly.Types.ModelExpiredException.html#Speechly_Types_ModelExpiredException__ctor + commentId: M:Speechly.Types.ModelExpiredException.#ctor + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException() + nameWithType: ModelExpiredException.ModelExpiredException() +- uid: Speechly.Types.ModelExpiredException.#ctor(System.String) + name: ModelExpiredException(String) + href: api/Speechly.Types.ModelExpiredException.html#Speechly_Types_ModelExpiredException__ctor_System_String_ + commentId: M:Speechly.Types.ModelExpiredException.#ctor(System.String) + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException(System.String) + nameWithType: ModelExpiredException.ModelExpiredException(String) +- uid: Speechly.Types.ModelExpiredException.#ctor(System.String,Exception) + name: ModelExpiredException(String, Exception) + href: api/Speechly.Types.ModelExpiredException.html#Speechly_Types_ModelExpiredException__ctor_System_String_Exception_ + commentId: M:Speechly.Types.ModelExpiredException.#ctor(System.String,Exception) + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException(System.String, Exception) + nameWithType: ModelExpiredException.ModelExpiredException(String, Exception) +- uid: Speechly.Types.ModelExpiredException.#ctor* + name: ModelExpiredException + href: api/Speechly.Types.ModelExpiredException.html#Speechly_Types_ModelExpiredException__ctor_ + commentId: Overload:Speechly.Types.ModelExpiredException.#ctor + isSpec: "True" + fullName: Speechly.Types.ModelExpiredException.ModelExpiredException + nameWithType: ModelExpiredException.ModelExpiredException - uid: Speechly.Types.MsgCommon name: MsgCommon href: api/Speechly.Types.MsgCommon.html @@ -1138,24 +1421,72 @@ references: commentId: T:Speechly.Types.SegmentChangeDelegate fullName: Speechly.Types.SegmentChangeDelegate nameWithType: SegmentChangeDelegate -- uid: Speechly.Types.StartContextDelegate - name: StartContextDelegate - href: api/Speechly.Types.StartContextDelegate.html - commentId: T:Speechly.Types.StartContextDelegate - fullName: Speechly.Types.StartContextDelegate - nameWithType: StartContextDelegate +- uid: Speechly.Types.StartDelegate + name: StartDelegate + href: api/Speechly.Types.StartDelegate.html + commentId: T:Speechly.Types.StartDelegate + fullName: Speechly.Types.StartDelegate + nameWithType: StartDelegate +- uid: Speechly.Types.StartMessage + name: StartMessage + href: api/Speechly.Types.StartMessage.html + commentId: T:Speechly.Types.StartMessage + fullName: Speechly.Types.StartMessage + nameWithType: StartMessage +- uid: Speechly.Types.StartMessage.appId + name: appId + href: api/Speechly.Types.StartMessage.html#Speechly_Types_StartMessage_appId + commentId: F:Speechly.Types.StartMessage.appId + fullName: Speechly.Types.StartMessage.appId + nameWithType: StartMessage.appId +- uid: Speechly.Types.StartMessage.eventType + name: eventType + href: api/Speechly.Types.StartMessage.html#Speechly_Types_StartMessage_eventType + commentId: F:Speechly.Types.StartMessage.eventType + fullName: Speechly.Types.StartMessage.eventType + nameWithType: StartMessage.eventType +- uid: Speechly.Types.StartMessage.options + name: options + href: api/Speechly.Types.StartMessage.html#Speechly_Types_StartMessage_options + commentId: F:Speechly.Types.StartMessage.options + fullName: Speechly.Types.StartMessage.options + nameWithType: StartMessage.options +- uid: Speechly.Types.StartMessage.Options + name: StartMessage.Options + href: api/Speechly.Types.StartMessage.Options.html + commentId: T:Speechly.Types.StartMessage.Options + fullName: Speechly.Types.StartMessage.Options + nameWithType: StartMessage.Options +- uid: Speechly.Types.StartMessage.Options.silence_triggered_segmentation + name: silence_triggered_segmentation + href: api/Speechly.Types.StartMessage.Options.html#Speechly_Types_StartMessage_Options_silence_triggered_segmentation + commentId: F:Speechly.Types.StartMessage.Options.silence_triggered_segmentation + fullName: Speechly.Types.StartMessage.Options.silence_triggered_segmentation + nameWithType: StartMessage.Options.silence_triggered_segmentation +- uid: Speechly.Types.StartMessage.Options.vocabulary + name: vocabulary + href: api/Speechly.Types.StartMessage.Options.html#Speechly_Types_StartMessage_Options_vocabulary + commentId: F:Speechly.Types.StartMessage.Options.vocabulary + fullName: Speechly.Types.StartMessage.Options.vocabulary + nameWithType: StartMessage.Options.vocabulary +- uid: Speechly.Types.StartMessage.Options.vocabulary_bias + name: vocabulary_bias + href: api/Speechly.Types.StartMessage.Options.html#Speechly_Types_StartMessage_Options_vocabulary_bias + commentId: F:Speechly.Types.StartMessage.Options.vocabulary_bias + fullName: Speechly.Types.StartMessage.Options.vocabulary_bias + nameWithType: StartMessage.Options.vocabulary_bias - uid: Speechly.Types.StartStreamDelegate name: StartStreamDelegate href: api/Speechly.Types.StartStreamDelegate.html commentId: T:Speechly.Types.StartStreamDelegate fullName: Speechly.Types.StartStreamDelegate nameWithType: StartStreamDelegate -- uid: Speechly.Types.StopContextDelegate - name: StopContextDelegate - href: api/Speechly.Types.StopContextDelegate.html - commentId: T:Speechly.Types.StopContextDelegate - fullName: Speechly.Types.StopContextDelegate - nameWithType: StopContextDelegate +- uid: Speechly.Types.StopDelegate + name: StopDelegate + href: api/Speechly.Types.StopDelegate.html + commentId: T:Speechly.Types.StopDelegate + fullName: Speechly.Types.StopDelegate + nameWithType: StopDelegate - uid: Speechly.Types.StopStreamDelegate name: StopStreamDelegate href: api/Speechly.Types.StopStreamDelegate.html @@ -1180,6 +1511,67 @@ references: commentId: T:Speechly.Types.TranscriptDelegate fullName: Speechly.Types.TranscriptDelegate nameWithType: TranscriptDelegate +- uid: Speechly.Types.VADOptions + name: VADOptions + href: api/Speechly.Types.VADOptions.html + commentId: T:Speechly.Types.VADOptions + fullName: Speechly.Types.VADOptions + nameWithType: VADOptions +- uid: Speechly.Types.VADOptions.Enabled + name: Enabled + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_Enabled + commentId: P:Speechly.Types.VADOptions.Enabled + fullName: Speechly.Types.VADOptions.Enabled + nameWithType: VADOptions.Enabled +- uid: Speechly.Types.VADOptions.Enabled* + name: Enabled + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_Enabled_ + commentId: Overload:Speechly.Types.VADOptions.Enabled + isSpec: "True" + fullName: Speechly.Types.VADOptions.Enabled + nameWithType: VADOptions.Enabled +- uid: Speechly.Types.VADOptions.NoiseGateDb + name: NoiseGateDb + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_NoiseGateDb + commentId: F:Speechly.Types.VADOptions.NoiseGateDb + fullName: Speechly.Types.VADOptions.NoiseGateDb + nameWithType: VADOptions.NoiseGateDb +- uid: Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + name: NoiseLearnHalftimeMillis + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_NoiseLearnHalftimeMillis + commentId: F:Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + fullName: Speechly.Types.VADOptions.NoiseLearnHalftimeMillis + nameWithType: VADOptions.NoiseLearnHalftimeMillis +- uid: Speechly.Types.VADOptions.SignalActivation + name: SignalActivation + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_SignalActivation + commentId: F:Speechly.Types.VADOptions.SignalActivation + fullName: Speechly.Types.VADOptions.SignalActivation + nameWithType: VADOptions.SignalActivation +- uid: Speechly.Types.VADOptions.SignalRelease + name: SignalRelease + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_SignalRelease + commentId: F:Speechly.Types.VADOptions.SignalRelease + fullName: Speechly.Types.VADOptions.SignalRelease + nameWithType: VADOptions.SignalRelease +- uid: Speechly.Types.VADOptions.SignalSearchFrames + name: SignalSearchFrames + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_SignalSearchFrames + commentId: F:Speechly.Types.VADOptions.SignalSearchFrames + fullName: Speechly.Types.VADOptions.SignalSearchFrames + nameWithType: VADOptions.SignalSearchFrames +- uid: Speechly.Types.VADOptions.SignalSustainMillis + name: SignalSustainMillis + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_SignalSustainMillis + commentId: F:Speechly.Types.VADOptions.SignalSustainMillis + fullName: Speechly.Types.VADOptions.SignalSustainMillis + nameWithType: VADOptions.SignalSustainMillis +- uid: Speechly.Types.VADOptions.SignalToNoiseDb + name: SignalToNoiseDb + href: api/Speechly.Types.VADOptions.html#Speechly_Types_VADOptions_SignalToNoiseDb + commentId: F:Speechly.Types.VADOptions.SignalToNoiseDb + fullName: Speechly.Types.VADOptions.SignalToNoiseDb + nameWithType: VADOptions.SignalToNoiseDb - uid: Speechly.Types.Word name: Word href: api/Speechly.Types.Word.html diff --git a/speechly-client-net-standard-2.0/Program.cs b/speechly-client-net-standard-2.0/Program.cs index 93d3ded..9603f8f 100644 --- a/speechly-client-net-standard-2.0/Program.cs +++ b/speechly-client-net-standard-2.0/Program.cs @@ -31,7 +31,7 @@ static async Task Main(string[] args) } foreach( string fileName in files) { - SpeechlyClientTest.SplitWithVAD(fileName, outFolder, logPath); + await SpeechlyClientTest.SplitWithVAD(fileName, outFolder, logPath); } break; diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs new file mode 100644 index 0000000..f6b0218 --- /dev/null +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs @@ -0,0 +1,173 @@ +using System; +using Speechly.Types; + +#if UNITY_EDITOR +using UnityEngine; +#endif + +namespace Speechly.Tools { + [System.Serializable] + + public class AudioProcessor { + public delegate void SendAudioDelegate(float[] floats, int start = 0, int length = -1); + public delegate void VadChangeDelegate(bool isSignalDetected); + + public SendAudioDelegate OnSendAudio = (floats, start, length) => {}; + public VadChangeDelegate OnVadStateChange = (isSignalDetected) => {}; + public EnergyThresholdVAD Vad { get; private set; } = null; + public AudioProcessorOptions Options { get; private set; } + public AudioInfo Output {get; private set; } + + private bool isActive = false; + private int frameSamples; + private float[] sampleRingBuffer = null; + private int frameSamplePos; + private int currentFrameNumber = 0; + private int streamFramePos = 0; + private bool wasSignalDetected = false; + private bool Debug; + + public AudioProcessor( + AudioProcessorOptions options, + AudioInfo output, + bool debug = false + ) { + this.Options = options; + this.Output = output; + + this.Vad = new EnergyThresholdVAD(this.Options.VADSettings, this.Output); + this.Debug = debug; + + this.frameSamples = this.Options.InternalSampleRate * this.Options.FrameMillis / 1000; + this.sampleRingBuffer = new float[this.frameSamples * this.Options.HistoryFrames]; + } + + public void Start() { + isActive = true; + Output.SamplesSent = 0; + Output.UtteranceSerial++; + } + + public void Stop() { + Flush(); + isActive = false; + wasSignalDetected = false; + } + + public void Reset(int inputSampleRate = 0) { + isActive = false; + streamFramePos = 0; + Output.StreamSamplePos = 0; + frameSamplePos = 0; + currentFrameNumber = 0; + Output.UtteranceSerial = -1; + if (inputSampleRate > 0) this.Options.InputSampleRate = inputSampleRate; + Vad?.ResetVAD(); + } + + private void Flush() { + ProcessAudio(sampleRingBuffer, 0, frameSamplePos, true); + } + + +/// +/// Process speech audio samples from a microphone or other audio source. +/// +/// It's recommended to constantly feed new audio as long as you want to use Speechly's SLU services. +/// +/// You can control when to start and stop process speech either manually with and or +/// automatically by providing a voice activity detection (VAD) field to . +/// +/// The audio is handled as follows: +/// - Downsample to 16kHz if needed +/// - Add to history ringbuffer +/// - Calculate energy (VAD) +/// - Automatic Start/Stop (VAD) +/// - Send utterance audio to a file +/// - Send utterance audio to Speechly SLU decoder +/// +/// Array of float containing samples to feed to the audio pipeline. Each sample needs to be in range -1f..1f. +/// Start index of audio to process in samples (default: `0`). +/// Length of audio to process in samples or `-1` to process the whole array (default: `-1`). +/// Forces processing of last subframe at end of audio stream (default: `false`). + + public void ProcessAudio(float[] floats, int start = 0, int length = -1, bool forceSubFrameProcess = false) { + if (length < 0) length = floats.Length; + if (length == 0) return; + + int i = start; + int endIndex = start + length; + + while (i < endIndex) { + int frameBase = currentFrameNumber * frameSamples; + + if (Options.InputSampleRate == Options.InternalSampleRate) { + // Copy input samples to fill current ringbuffer frame + int samplesToFillFrame = Math.Min(endIndex - i, frameSamples - frameSamplePos); + int frameEndIndex = frameSamplePos + samplesToFillFrame; + while (frameSamplePos < frameEndIndex) { + sampleRingBuffer[frameBase + frameSamplePos++] = floats[i++]; + } + } else { + // Downsample input samples to fill current ringbuffer frame + float ratio = 1f * Options.InputSampleRate / Options.InternalSampleRate; + int inputSamplesToFillFrame = Math.Min(endIndex - i, (int)Math.Round(ratio * (frameSamples - frameSamplePos))); + int samplesToFillFrame = Math.Min((int)Math.Round((endIndex - i) / ratio), frameSamples - frameSamplePos); + AudioTools.Downsample(floats, ref sampleRingBuffer, i,inputSamplesToFillFrame, frameBase+frameSamplePos,samplesToFillFrame); + i += inputSamplesToFillFrame; + frameSamplePos += samplesToFillFrame; + } + + // Process frame + if (frameSamplePos == frameSamples || forceSubFrameProcess) { + frameSamplePos = 0; + int subFrameSamples = forceSubFrameProcess ? frameSamplePos : frameSamples; + + if (!forceSubFrameProcess) { + ProcessFrame(sampleRingBuffer, frameBase, subFrameSamples); + } + + if (isActive) { + + if (Output.SamplesSent == 0) { + // Start of the utterance - send history frames + int sendHistory = Math.Min(streamFramePos, Options.HistoryFrames - 1); + int historyFrameIndex = (currentFrameNumber + Options.HistoryFrames - sendHistory) % Options.HistoryFrames; + while (historyFrameIndex != currentFrameNumber) { + OnSendAudio(sampleRingBuffer, historyFrameIndex * frameSamples, frameSamples); + Output.SamplesSent += frameSamples; + historyFrameIndex = (historyFrameIndex + 1) % Options.HistoryFrames; + } + } + OnSendAudio(sampleRingBuffer, frameBase, subFrameSamples); + Output.SamplesSent += subFrameSamples; + } + + streamFramePos += 1; + Output.StreamSamplePos += subFrameSamples; + currentFrameNumber = (currentFrameNumber + 1) % Options.HistoryFrames; + } + } + } + + private void ProcessFrame(float[] floats, int start = 0, int length = -1) { + AnalyzeAudioFrame(in floats, start, length); + AutoControlListening(); + } + + private void AnalyzeAudioFrame(in float[] waveData, int s, int frameSamples) { + if (this.Vad != null && this.Vad.Options.Enabled) { + Vad.ProcessFrame(waveData, s, frameSamples); + } + } + + private void AutoControlListening() { + if (this.Vad != null && this.Vad.Options.Enabled && this.Options.VADControlsListening) { + if (Output.IsSignalDetected != this.wasSignalDetected) { + OnVadStateChange(Output.IsSignalDetected); + this.wasSignalDetected = Output.IsSignalDetected; + } + } + } + } +} diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs similarity index 100% rename from speechly-client-net-standard-2.0/Speechly/SLUClient/AudioTools.cs rename to speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/AudioTools.cs diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs new file mode 100644 index 0000000..ca673e9 --- /dev/null +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs @@ -0,0 +1,113 @@ +using System; +using Speechly.Types; + +#if UNITY_EDITOR +using UnityEngine; +#endif + +namespace Speechly.Tools { +/// +/// Adaptive energy threshold voice activity detection (VAD) implementation. +/// It can be used to enable hands-free operation of the SLU decoder. +/// +/// When enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time. +/// Use its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time. +/// The background noise level gradually adapts when no signal is detected. +/// +/// IsSignalDetected can be used to drive SpeechlyClient's Start and Stop automatically by setting ControlListening true. +/// + [System.Serializable] + + public class EnergyThresholdVAD { + public VADOptions Options {get; private set; } + public AudioInfo Output {get; private set; } + + private float energy = 0f; + private float baselineEnergy = -1f; + private int loudFrameBits = 0; + private float vadSustainMillisLeft = 0; + private int frameMillis = 30; + + public EnergyThresholdVAD(VADOptions options, AudioInfo output) { + this.Output = output; + this.Options = options; + } + + public void ProcessFrame(float[] floats, int start = 0, int length = -1) { + if (!Options.Enabled) { + ResetVAD(); + return; + } + + energy = AudioTools.GetEnergy(in floats, start, length); + + if (baselineEnergy < 0f) { + baselineEnergy = energy; + } + + bool isLoudFrame = energy > Math.Max(Math.Pow(10.0, Options.NoiseGateDb / 10.0), baselineEnergy * Math.Pow(10.0, Options.SignalToNoiseDb / 10.0)); + PushFrameHistory(isLoudFrame); + + Output.IsSignalDetected = DetermineNewSignalState(Output.IsSignalDetected); + + AdaptBackgroundNoise(); + + Output.SignalDb = AudioTools.EnergyToDb(energy / baselineEnergy); + Output.NoiseLevelDb = AudioTools.EnergyToDb(baselineEnergy); + } + + private bool DetermineNewSignalState(bool currentState) { + vadSustainMillisLeft = Math.Max(vadSustainMillisLeft - frameMillis, 0); + + int loudFrames = CountLoudFrames(Options.SignalSearchFrames); + + int activationFrames = (int)Math.Round(Options.SignalActivation * Options.SignalSearchFrames); + int releaseFrames = (int)Math.Round(Options.SignalRelease * Options.SignalSearchFrames); + + if (loudFrames >= activationFrames) { + // Renew sustain time + vadSustainMillisLeft = Options.SignalSustainMillis; + return true; + } + + if (loudFrames <= releaseFrames && vadSustainMillisLeft == 0) { + return false; + } + + return currentState; + } + + private void AdaptBackgroundNoise() { + // Gradually learn background noise level + if (!Output.IsSignalDetected) { + if (Options.NoiseLearnHalftimeMillis > 0f) { + var decay = (float)Math.Pow(2.0, -frameMillis / (double)Options.NoiseLearnHalftimeMillis); + baselineEnergy = (baselineEnergy * decay) + (energy * (1f - decay)); + } + } + } + + private void PushFrameHistory(bool isLoud) { + loudFrameBits = (isLoud ? 1 : 0) | (loudFrameBits << 1); + } + + private int CountLoudFrames(int numHistoryFrames) { + int numActiveFrames = 0; + int t = loudFrameBits; + while (numHistoryFrames > 0) { + if ((t & 1) == 1) numActiveFrames++; + t = t >> 1; + numHistoryFrames--; + } + return numActiveFrames; + } + + public void ResetVAD() { + Output.IsSignalDetected = false; + loudFrameBits = 0; + energy = 0f; + baselineEnergy = -1f; + } + } + +} \ No newline at end of file diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs index 2ab7ef3..040b9e3 100644 --- a/speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/CloudDecoder.cs @@ -11,8 +11,8 @@ namespace Speechly.SLUClient { /// Provides speech processing with Speechly's cloud SLU service. /// /// Internally handles authentication using https and audio streaming via secure websocket. -/// Audio is streamed when listening is started with SpeechlyClient.StartContext(). -/// Streaming stops upon call to SpeechlyClient.StopContext(). +/// Audio is streamed when listening is started with SpeechlyClient.Start(). +/// Streaming stops upon call to SpeechlyClient.Stop(). /// public class CloudDecoder: IDecoder { @@ -27,6 +27,7 @@ public class CloudDecoder: IDecoder { private WsClient wsClient = null; private ConcurrentQueue> startContextTCS = new ConcurrentQueue>(); private ConcurrentQueue> stopContextTCS = new ConcurrentQueue>(); + private StartMessage startMessage; /// /// Initialize speech processing with Speechly's cloud SLU service. @@ -65,7 +66,7 @@ public CloudDecoder( this.projectId = projectId; } - override internal async Task Initialize() { + override internal async Task Initialize(AudioProcessorOptions audioProcessorOptions, ContextOptions contextOptions) { if (debug) Logger.Log("Initializing and connecting Cloud SLU..."); var tokenFetcher = new LoginToken(); string token = await tokenFetcher.FetchToken(loginUrl, projectId, appId, deviceId); @@ -75,18 +76,25 @@ override internal async Task Initialize() { wsClient = new WsClient(); wsClient.OnResponseReceived = OnResponse; + // Prebuild the start message + startMessage = new StartMessage() {eventType = "start", appId = this.appId}; + startMessage.options = new StartMessage.Options(); + startMessage.options.silence_triggered_segmentation = new[] {Convert.ToString(contextOptions.SilenceSegmentationMillis)}; + if (contextOptions.BoostVocabulary != null && !string.IsNullOrEmpty(contextOptions.BoostVocabulary.Vocabulary)) { + startMessage.options.vocabulary = contextOptions.BoostVocabulary.Vocabulary.ToUpper().Split('\n'); + startMessage.options.vocabulary_bias = new[] {Convert.ToString(contextOptions.BoostVocabulary.Weight)}; + } + await wsClient.ConnectAsync(apiUrl, token); if (debug) Logger.Log("Cloud SLU ready"); } - override internal Task StartContext() { + override internal Task Start() { var tcs = new TaskCompletionSource(); startContextTCS.Enqueue(tcs); - if (appId != null) { - wsClient.SendText($"{{\"event\": \"start\", \"appId\": \"{appId}\"}}"); - } else { - wsClient.SendText($"{{\"event\": \"start\"}}"); - } + + wsClient.SendText(JSON.Stringify(startMessage)); + return tcs.Task; } @@ -133,7 +141,7 @@ override internal void SendAudio(float[] floats, int start = 0, int length = -1) wsClient.SendBytes(new ArraySegment(buf)); } - override internal Task StopContext() { + override internal Task Stop() { var tcs = new TaskCompletionSource(); stopContextTCS.Enqueue(tcs); wsClient.SendText($"{{\"event\": \"stop\"}}"); diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs deleted file mode 100644 index 8a1c620..0000000 --- a/speechly-client-net-standard-2.0/Speechly/SLUClient/EnergyTresholdVAD.cs +++ /dev/null @@ -1,174 +0,0 @@ -using System; -using Speechly.Tools; - -#if UNITY_EDITOR -using UnityEngine; -#endif - -namespace Speechly.SLUClient { -/// -/// Adaptive energy threshold voice activity detection (VAD) implementation. -/// It can be used to enable hands-free operation of the SLU decoder. -/// -/// When enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time. -/// Use its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time. -/// The background noise level gradually adapts when no signal is detected. -/// -/// IsSignalDetected can be used to drive SpeechlyClient's StartContext and StopContext automatically by setting ControlListening true. -/// - - [System.Serializable] - public class EnergyTresholdVAD { - #if UNITY_EDITOR - [Tooltip("Run energy analysis.")] - #endif - public bool Enabled = true; - - #if UNITY_EDITOR - [Range(0.0f, 10.0f)] - [Tooltip("Signal-to-noise energy ratio needed for frame to be 'loud'")] - #endif - public float SignalToNoiseDb = 3.0f; - - #if UNITY_EDITOR - [Range(-90.0f, 0.0f)] - [Tooltip("Energy threshold - below this won't trigger activation")] - #endif - public float NoiseGateDb = -24f; - - #if UNITY_EDITOR - [Range(0, 5000)] - [Tooltip("Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy.")] - #endif - public int NoiseLearnHalftimeMillis = 400; - - #if UNITY_EDITOR - [Range(1, 32)] - [Tooltip("Number of past frames analyzed for energy threshold VAD. Should be <= than HistoryFrames.")] - #endif - public int SignalSearchFrames = 5; - - #if UNITY_EDITOR - [Range(.0f, 1.0f)] - [Tooltip("Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected'")] - #endif - public float SignalActivation = 0.7f; - - #if UNITY_EDITOR - [Range(.0f, 1.0f)] - [Tooltip("Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over.")] - #endif - public float SignalRelease = 0.2f; - - #if UNITY_EDITOR - [Range(0, 8000)] - [Tooltip("Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true.")] - #endif - public int SignalSustainMillis = 3000; - - #if UNITY_EDITOR - [Header("Output")] - #endif - public bool IsSignalDetected; - - #if UNITY_EDITOR - [Range(0.0f, 10.0f)] - #endif - public float SignalDb; - - #if UNITY_EDITOR - [Range(-90.0f, 0.0f)] - #endif - public float NoiseLevelDb; - - #if UNITY_EDITOR - [Header("Signal detection controls listening")] - [Tooltip("Enable listening control if you want to use IsSignalDetected to control SpeechlyClient's StartContext/StopContext.")] - #endif - public bool ControlListening = true; - - - public float Energy {get; private set; } = 0f; - public float BaselineEnergy {get; private set; } = -1f; - private int loudFrameBits = 0; - private float vadSustainMillisLeft = 0; - private int FrameMillis = 30; - - public void ProcessFrame(float[] floats, int start = 0, int length = -1) { - if (!Enabled) { - ResetVAD(); - return; - } - - Energy = AudioTools.GetEnergy(in floats, start, length); - - if (BaselineEnergy < 0f) { - BaselineEnergy = Energy; - } - - bool isLoudFrame = Energy > Math.Max(Math.Pow(10.0, NoiseGateDb / 10.0), BaselineEnergy * Math.Pow(10.0, SignalToNoiseDb / 10.0)); - PushFrameHistory(isLoudFrame); - - IsSignalDetected = DetermineNewSignalState(IsSignalDetected); - - AdaptBackgroundNoise(); - - SignalDb = AudioTools.EnergyToDb(Energy / BaselineEnergy); - NoiseLevelDb = AudioTools.EnergyToDb(BaselineEnergy); - } - - private bool DetermineNewSignalState(bool currentState) { - vadSustainMillisLeft = Math.Max(vadSustainMillisLeft - FrameMillis, 0); - - int loudFrames = CountLoudFrames(SignalSearchFrames); - - int activationFrames = (int)Math.Round(SignalActivation * SignalSearchFrames); - int releaseFrames = (int)Math.Round(SignalRelease * SignalSearchFrames); - - if (loudFrames >= activationFrames) { - // Renew sustain time - vadSustainMillisLeft = SignalSustainMillis; - return true; - } - - if (loudFrames <= releaseFrames && vadSustainMillisLeft == 0) { - return false; - } - - return currentState; - } - - private void AdaptBackgroundNoise() { - // Gradually learn background noise level - if (!IsSignalDetected) { - if (NoiseLearnHalftimeMillis > 0f) { - var decay = (float)Math.Pow(2.0, -FrameMillis / (double)NoiseLearnHalftimeMillis); - BaselineEnergy = (BaselineEnergy * decay) + (Energy * (1f - decay)); - } - } - } - - private void PushFrameHistory(bool isLoud) { - loudFrameBits = (isLoud ? 1 : 0) | (loudFrameBits << 1); - } - - private int CountLoudFrames(int numHistoryFrames) { - int numActiveFrames = 0; - int t = loudFrameBits; - while (numHistoryFrames > 0) { - if ((t & 1) == 1) numActiveFrames++; - t = t >> 1; - numHistoryFrames--; - } - return numActiveFrames; - } - - private void ResetVAD() { - IsSignalDetected = false; - loudFrameBits = 0; - Energy = 0f; - BaselineEnergy = -1f; - } - } - -} \ No newline at end of file diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/IDecoder.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/IDecoder.cs index 4547473..5a74801 100644 --- a/speechly-client-net-standard-2.0/Speechly/SLUClient/IDecoder.cs +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/IDecoder.cs @@ -1,4 +1,5 @@ using Speechly.Types; +using Speechly.Tools; using System.Threading.Tasks; namespace Speechly.SLUClient { @@ -6,10 +7,10 @@ namespace Speechly.SLUClient { public abstract class IDecoder { internal abstract event ResponseReceivedDelegate OnMessage; - internal abstract Task Initialize(); - internal abstract Task StartContext(); + internal abstract Task Initialize(AudioProcessorOptions audioProcessorOptions, ContextOptions contextOptions); + internal abstract Task Start(); internal abstract void SendAudio(float[] floats, int start = 0, int length = -1); - internal abstract Task StopContext(); + internal abstract Task Stop(); internal abstract Task Shutdown(); } } \ No newline at end of file diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs index ddcb905..87079e2 100644 --- a/speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/Platform.cs @@ -37,10 +37,18 @@ public static Task Fetch(string url) { var req = UnityEngine.Networking.UnityWebRequest.Get(url); var reqOp = req.SendWebRequest(); var tsc = new TaskCompletionSource(); - reqOp.completed += asyncOp => tsc.TrySetResult(reqOp.webRequest.downloadHandler.data); - if (reqOp.isDone) { + void completeLoad() { + if (!String.IsNullOrEmpty(req.error)) { + throw new Exception($"Error while fetching from url {url}:\n{req.error}"); + } tsc.TrySetResult(reqOp.webRequest.downloadHandler.data); + }; + + if (reqOp.isDone) { + completeLoad(); + } else { + reqOp.completed += asyncOp => completeLoad(); } return tsc.Task; diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs index bab811f..d64b7af 100644 --- a/speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/SpeechlyClient.cs @@ -20,8 +20,8 @@ namespace Speechly.SLUClient { /// - (delegates are firing up as speech is processed) /// - When you don't need SLU services any more call to free resources. /// -/// You can feed audio continuously, but control when to start and stop process speech with and or -/// let voice activity detection (VAD) handle that automatically by passing to SpeechlyClient constructor. +/// You can feed audio continuously, but control when to start and stop process speech with and or +/// let voice activity detection (VAD) handle that automatically by passing to SpeechlyClient constructor. /// public class SpeechlyClient { @@ -29,7 +29,7 @@ public class SpeechlyClient { /// /// Read the combined results of automatic speech recoginition (ASR) and natural language detection (NLU). /// -/// You can control when to start and stop process speech either manually with and or +/// You can control when to start and stop process speech either manually with and or /// automatically by providing a voice activity detection (VAD) field to . /// @@ -42,96 +42,75 @@ public class SpeechlyClient { public IntentDelegate OnIntent = (msg) => {}; public StartStreamDelegate OnStartStream = () => {}; public StopStreamDelegate OnStopStream = () => {}; - public StartContextDelegate OnStartContext = () => {}; - public StopContextDelegate OnStopContext = () => {}; + public StartDelegate OnStart = () => {}; + public StopDelegate OnStop = () => {}; + + public AudioInfo Output { get; private set; } + private AudioProcessor AudioProcessor; // Returns true when StartStream has been called public bool IsAudioStreaming { get; private set; } = false; - /// Returns true when SLU Engine is ready for Start/StopContext calls + /// Returns true when SLU Engine is ready for Start/Stop calls public bool IsReady { get { return this.decoder != null; } } - /// Returns true when StartContext is called and expecting StopContext next + /// Returns true when Start is called and expecting Stop next public bool IsActive { get; private set; } = false; - public int SamplesSent { get; private set; } = 0; - public EnergyTresholdVAD Vad { get; private set; } = null; - /// Utterance identifier public string AudioInputStreamIdentifier { get; private set; } = "utterance"; - /// 0-based local index of utterance within the stream - public int UtteranceSerial { get; private set; } = -1; - - /// Current count of continuously processed samples (thru ProcessAudio) from start of stream - public int StreamSamplePos { get; private set; } = 0; - /// Enable debug prints public bool Debug = false; /// Message queue used when manualUpdate is true. Delegates are fired with a call to Update() that should be run in the desired thread (main) thread. private ConcurrentQueue messageQueue = new ConcurrentQueue(); private Dictionary> activeContexts = new Dictionary>(); + private AudioProcessorOptions audioProcessorOptions; + private ContextOptions contextOptions; private bool manualUpdate; private string saveToFolder = null; private FileStream outAudioStream; - private int inputSampleRate = 16000; - private int internalSampleRate = 16000; - private int frameMillis = 30; - - /// Total number of history frames to keep in memory. Will be sent upon a starting a new utterance. - private int historyFrames = 5; - - private int frameSamples; - - private int streamFramePos = 0; private bool streamAutoStarted; - private float[] sampleRingBuffer = null; - private int frameSamplePos; - private int currentFrameNumber = 0; + private IDecoder decoder; /// /// Create a new SpeechlyClient to process audio and fire delegates to provide SLU results. /// -/// instance to control automatic listening on/off. Null disables VAD. (default: `null`) +/// instance to control automatic listening on/off. Null disables VAD. (default: `null`) /// Count of the audio history frames (default: `5`). Total history duration will be historyFrames * frameSamples. -/// Size of one audio frame (default: `30` ms). Total history duration will be historyFrames*frameSamples. History is sent upon StartContext to capture the start of utterance which especially important with VAD, which activates with a constant delay. +/// Size of one audio frame (default: `30` ms). Total history duration will be historyFrames*frameSamples. History is sent upon Start to capture the start of utterance which especially important with VAD, which activates with a constant delay. /// Setting `manualUpdate = true` postpones SpeechlyClient's delegates (OnSegmentChange, OnTranscript...) until you manually run . This enables you to call Unity API in SpeechlyClient's delegates, as Unity API should only be used in the main Unity thread. (Default: false) /// Defines a local folder to save utterance files as 16 bit, 16000 hZ mono raw. Null disables saving. (default: `null`) /// Define the sample rate of incoming audio (default: `16000`) /// Enable debug prints thru delegate. (default: `false`) public SpeechlyClient( - int frameMillis = 30, - int historyFrames = 5, - int inputSampleRate = 16000, bool manualUpdate = false, string saveToFolder = null, // @TODO Future: Allow storing to memory stream as well for replay? - EnergyTresholdVAD vad = null, // @TODO Future: Allow different VAD implementation thru IVAD interface + AudioInfo output = null, bool debug = false ) { - this.frameMillis = Math.Max(frameMillis, 1); - this.historyFrames = Math.Max(historyFrames, 1); // Need at least 1 frame; the current one - this.inputSampleRate = inputSampleRate; this.manualUpdate = manualUpdate; this.saveToFolder = saveToFolder; - this.Vad = vad; this.Debug = debug; - frameSamples = internalSampleRate * frameMillis / 1000; + if (output == null) { + this.Output = new AudioInfo(); + } else { + this.Output = output; + } if (saveToFolder != null) { Directory.CreateDirectory(saveToFolder); } - - sampleRingBuffer = new float[frameSamples * historyFrames]; } /// @@ -142,39 +121,73 @@ public SpeechlyClient( /// /// SLU decoder implementing IDecoder interface like . /// Task that completes when the decoder is ready. - public async Task Initialize(IDecoder decoder) { - if (this.decoder == null) { + public async Task Initialize(IDecoder decoder, AudioProcessorOptions audioProcessorOptions = null, ContextOptions contextOptions = null, bool preferLibSpeechlyAudioProcessor = false) { + if (audioProcessorOptions == null) { + audioProcessorOptions = new AudioProcessorOptions(); + } + this.audioProcessorOptions = audioProcessorOptions; + + if (contextOptions == null) { + contextOptions = new ContextOptions(); + } + this.contextOptions = contextOptions; + + if (this.decoder == null && decoder != null) { try { if (this.manualUpdate) { decoder.OnMessage += QueueMessage; } else { decoder.OnMessage += OnMessage; } - await decoder.Initialize(); + await decoder.Initialize( + audioProcessorOptions, + contextOptions + ); this.decoder = decoder; } catch (Exception e) { Logger.LogError(e.ToString()); throw; } } + + if (!preferLibSpeechlyAudioProcessor) { + this.AudioProcessor = new AudioProcessor( + audioProcessorOptions, + this.Output, + this.Debug + ); + + this.AudioProcessor.OnSendAudio += SendAudio; + this.AudioProcessor.OnVadStateChange += (isSignalDetected) => { + if (isSignalDetected) { + _ = Start(); + } else { + _ = Stop(); + } + }; + } + } /// -/// `StartStream` should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and StartContext ensure it's been called. +/// `StartStream` should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and Start ensure it's been called. /// `OnStreamStart` delegate is triggered upon a call to StartStream. /// public void StartStream(string streamIdentifier, bool auto = false) { if (!IsAudioStreaming) { - IsAudioStreaming = true; streamAutoStarted = auto; - streamFramePos = 0; - StreamSamplePos = 0; - frameSamplePos = 0; - currentFrameNumber = 0; - UtteranceSerial = -1; - this.AudioInputStreamIdentifier = streamIdentifier; + + IsAudioStreaming = true; + AudioInputStreamIdentifier = streamIdentifier; + AudioProcessor?.Reset(); OnStartStream(); + + // Start receiving results if using libSpeechly AudioProcessor + if (AudioProcessor == null && audioProcessorOptions.VADControlsListening) { + _ = Start(); + } + } } @@ -186,12 +199,9 @@ public void StopStream(bool auto = false) { if (IsAudioStreaming) { if ((auto && streamAutoStarted) || !streamAutoStarted) { if (IsActive) { - _ = StopContext(); + _ = Stop(); } - // Process remaining frame samples - ProcessAudio(sampleRingBuffer, 0, frameSamplePos, true); - IsAudioStreaming = false; OnStopStream(); @@ -199,16 +209,37 @@ public void StopStream(bool auto = false) { } } +/// +/// Control AudioProcessor parameters. +/// +/// `true` enables VAD to control listening. `false` disables VAD feature and stops listening immediately. `null` for no change. + + public void AdjustAudioProcessor(bool? vadControlsListening = null) { + if (vadControlsListening != null) { + this.audioProcessorOptions.VADControlsListening = (bool)vadControlsListening; + // Start audio flow if using libSpeechly + if (AudioProcessor == null) { + if (this.audioProcessorOptions.VADControlsListening && !IsActive) { + _ = Start(); + } + } + // Ensure listening is stopped when VAD control is toggled off + if (!this.audioProcessorOptions.VADControlsListening && IsActive) { + _ = Stop(); + } + } + } + /// /// Start listening for user speech and feeding it to the SLU decoder. -/// `OnContextStart` is triggered upon a call to StartContext. It's also triggered by automatic VAD activation. +/// `OnContextStart` is triggered upon a call to Start. It's also triggered by automatic VAD activation. /// /// You don't need to await this call if you don't need the utterance id. /// /// Cloud decoder only: The Speechly app id to connect to, if not the default. If specified, you must use project id based login with cloud decoder. /// An unique utterance id. - public Task StartContext(string appId = null) { + public Task Start(string appId = null) { if (IsActive) { throw new Exception("Already listening."); } @@ -218,21 +249,25 @@ public Task StartContext(string appId = null) { } IsActive = true; - SamplesSent = 0; - UtteranceSerial++; - - string localBaseName = $"{AudioInputStreamIdentifier}_{UtteranceSerial.ToString().PadLeft(4, '0')}"; + string localBaseName; + + if (AudioProcessor != null) { + AudioProcessor.Start(); + localBaseName = $"{AudioInputStreamIdentifier}_{Output.UtteranceSerial.ToString().PadLeft(4, '0')}"; + } else { + localBaseName = $"{AudioInputStreamIdentifier}"; + } string contextId = localBaseName; if (saveToFolder != null) { outAudioStream = new FileStream(Path.Combine(saveToFolder, $"{localBaseName}.raw"), FileMode.OpenOrCreate, FileAccess.Write, FileShare.None); } - OnStartContext(); + OnStart(); if (this.decoder != null) { try { - return this.decoder.StartContext(); + return this.decoder.Start(); } catch (Exception e) { IsActive = false; Logger.LogError(e.ToString()); @@ -257,87 +292,39 @@ public void ProcessAudioFile(string fileName) { /// /// It's recommended to constantly feed new audio as long as you want to use Speechly's SLU services. /// -/// You can control when to start and stop process speech either manually with and or +/// You can control when to start and stop process speech either manually with and or /// automatically by providing a voice activity detection (VAD) field to . /// /// The audio is handled as follows: /// - Downsample to 16kHz if needed /// - Add to history ringbuffer /// - Calculate energy (VAD) -/// - Automatic Start/StopContext (VAD) +/// - Automatic Start/Stop (VAD) /// - Send utterance audio to a file /// - Send utterance audio to Speechly SLU decoder /// /// Array of float containing samples to feed to the audio pipeline. Each sample needs to be in range -1f..1f. /// Start index of audio to process in samples (default: `0`). /// Length of audio to process in samples or `-1` to process the whole array (default: `-1`). -/// internally uses this to force processing of last subframe at end of audio stream (default: `false`). - public void ProcessAudio(float[] floats, int start = 0, int length = -1, bool forceSubFrameProcess = false) { + public void ProcessAudio(float[] floats, int start = 0, int length = -1) { if (!IsAudioStreaming) { StartStream(AudioInputStreamIdentifier, auto: false); // Assume no auto-start/stop if ProcessAudio call encountered before startContext call } - if (length < 0) length = floats.Length; - if (length == 0) return; - - int i = start; - int endIndex = start + length; - - while (i < endIndex) { - int frameBase = currentFrameNumber * frameSamples; - - if (inputSampleRate == internalSampleRate) { - // Copy input samples to fill current ringbuffer frame - int samplesToFillFrame = Math.Min(endIndex - i, frameSamples - frameSamplePos); - int frameEndIndex = frameSamplePos + samplesToFillFrame; - while (frameSamplePos < frameEndIndex) { - sampleRingBuffer[frameBase + frameSamplePos++] = floats[i++]; - } - } else { - // Downsample input samples to fill current ringbuffer frame - float ratio = 1f * inputSampleRate / internalSampleRate; - int inputSamplesToFillFrame = Math.Min(endIndex - i, (int)Math.Round(ratio * (frameSamples - frameSamplePos))); - int samplesToFillFrame = Math.Min((int)Math.Round((endIndex - i) / ratio), frameSamples - frameSamplePos); - AudioTools.Downsample(floats, ref sampleRingBuffer, i,inputSamplesToFillFrame, frameBase+frameSamplePos,samplesToFillFrame); - i += inputSamplesToFillFrame; - frameSamplePos += samplesToFillFrame; - } - - // Process frame - if (frameSamplePos == frameSamples || forceSubFrameProcess) { - frameSamplePos = 0; - int subFrameSamples = forceSubFrameProcess ? frameSamplePos : frameSamples; - - if (!forceSubFrameProcess) { - ProcessFrame(sampleRingBuffer, frameBase, subFrameSamples); - } - - if (IsActive) { - - if (SamplesSent == 0) { - // Start of the utterance - send history frames - int sendHistory = Math.Min(streamFramePos, historyFrames - 1); - int historyFrameIndex = (currentFrameNumber + historyFrames - sendHistory) % historyFrames; - while (historyFrameIndex != currentFrameNumber) { - SendAudio(sampleRingBuffer, historyFrameIndex * frameSamples, frameSamples); - historyFrameIndex = (historyFrameIndex + 1) % historyFrames; - } - } - SendAudio(sampleRingBuffer, frameBase, subFrameSamples); - } - - streamFramePos += 1; - StreamSamplePos += subFrameSamples; - currentFrameNumber = (currentFrameNumber + 1) % historyFrames; + if (AudioProcessor != null) { + AudioProcessor.ProcessAudio(floats, start, length); + } else { + if (IsActive) { + SendAudio(floats, start, length); } } } public void ProcessAudio(Stream fileStream) { - // @TODO Use a pre-allocated buf - var bytes = new byte[frameSamples * 2]; - var floats = new float[frameSamples]; + const int CHUNK_SAMPLES = 16000; + var bytes = new byte[CHUNK_SAMPLES * 2]; + var floats = new float[CHUNK_SAMPLES]; while (true) { int bytesRead = fileStream.Read(bytes, 0, bytes.Length); @@ -352,32 +339,7 @@ public void ProcessAudio(Stream fileStream) { } } - private void ProcessFrame(float[] floats, int start = 0, int length = -1) { - AnalyzeAudioFrame(in floats, start, length); - AutoControlListening(); - } - - private void AnalyzeAudioFrame(in float[] waveData, int s, int frameSamples) { - if (this.Vad != null && this.Vad.Enabled) { - Vad.ProcessFrame(waveData, s, frameSamples); - } - } - - private void AutoControlListening() { - if (this.Vad != null && this.Vad.Enabled && this.Vad.ControlListening) { - if (!IsActive && Vad.IsSignalDetected) { - _ = StartContext(); - } - - if (IsActive && !Vad.IsSignalDetected) { - _ = StopContext(); - } - } - } - - private void SendAudio(float[] floats, int start = 0, int length = -1) { - SamplesSent += length; - + internal void SendAudio(float[] floats, int start = 0, int length = -1) { // Stream to file if (saveToFolder != null) { SaveToDisk(floats, start, length); @@ -406,30 +368,31 @@ private void SaveToDisk(float[] floats, int start = 0, int length = -1) { /// /// Stop listening for user speech. -/// `OnContextStop` is triggered upon a call to StopContext. It's also triggered by automatic VAD deactivation. +/// `OnContextStop` is triggered upon a call to Stop. It's also triggered by automatic VAD deactivation. /// /// You don't need to await this call if you don't need the utterance id. /// /// An unique utterance id. - public Task StopContext() { + public Task Stop() { if (!IsActive) { throw new Exception("Already stopped listening."); } + AudioProcessor?.Stop(); IsActive = false; - string localBaseName = $"{AudioInputStreamIdentifier}_{UtteranceSerial.ToString().PadLeft(4, '0')}"; + string localBaseName = $"{AudioInputStreamIdentifier}_{Output.UtteranceSerial.ToString().PadLeft(4, '0')}"; string contextId = localBaseName; if (saveToFolder != null) { outAudioStream.Close(); } - OnStopContext(); + OnStop(); if (this.decoder != null) { try { - return this.decoder.StopContext(); + return this.decoder.Stop(); } catch (Exception e) { Logger.LogError(e.ToString()); throw; diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs b/speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs index a2f74e3..049dac1 100644 --- a/speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs +++ b/speechly-client-net-standard-2.0/Speechly/SLUClient/Types.cs @@ -1,8 +1,13 @@ using System; using System.Runtime.Serialization; +using System.Collections.Generic; using System.Text; using System.IO; +#if UNITY_EDITOR +using UnityEngine; +#endif + namespace Speechly.Types { public delegate void SegmentChangeDelegate(Speechly.SLUClient.Segment segment); @@ -13,12 +18,240 @@ namespace Speechly.Types { public delegate void IntentDelegate(MsgIntent msg); public delegate void StartStreamDelegate(); public delegate void StopStreamDelegate(); - public delegate void StartContextDelegate(); - public delegate void StopContextDelegate(); + public delegate void StartDelegate(); + public delegate void StopDelegate(); public delegate string BeautifyIntent (string intent); public delegate string BeautifyEntity (string entityValue, string entityType); + + public class ModelExpiredException : Exception + { + public ModelExpiredException() {} + public ModelExpiredException(string message) : base(message) {} + public ModelExpiredException(string message, Exception inner) : base(message, inner) {} + } + + /// + /// Statistics calculated by the Audio Processor. Note that this information is not currently available when using libSpeechly AudioProcessor. + /// + [System.Serializable] + public class AudioInfo { + /// + /// True if VAD has detected a loud signal. + /// + public bool IsSignalDetected; + + /// + /// Signal level in dB above noise level. + /// + #if UNITY_EDITOR + [Range(0.0f, 10.0f)] + #endif + public float SignalDb; + + /// + /// Current noise level in dB. + /// + #if UNITY_EDITOR + [Range(-90.0f, 0.0f)] + #endif + public float NoiseLevelDb; + + /// + /// Current count of continuously processed samples (thru ProcessAudio) since StartStream + /// + public int StreamSamplePos { get; internal set; } = 0; + + /// + /// Current count of processed samples since Start + /// + public int SamplesSent { get; internal set; } = 0; + + /// + /// 0-based local index of utterance within the stream. -1 if no utterances have been processed. + /// + public int UtteranceSerial { get; internal set; } = -1; + } + + /// + /// Options for Audio Processor and Voice Activity Detection (VAD) + /// + [System.Serializable] + public class AudioProcessorOptions { + /// + /// Input sample rate in Hz. + /// + public int InputSampleRate = 16000; + + /// + /// Internal Speechly sample rate in Hz. Currently only 16000 Hz is supported. + /// + public int InternalSampleRate = 16000; + + /// + /// Internal frame length. Affects audio caching and VAD energy analysis. + /// + public int FrameMillis = 30; + + /// + /// Total number of history frames to keep in memory. Will be sent upon a starting a new utterance. + /// + #if UNITY_EDITOR + [Range(1, 32)] + [Tooltip("Number of frames to keep in memory. When listening is started, history frames are sent to capture the lead-in audio.")] + #endif + public int HistoryFrames = 8; + + /// + /// Allows VAD's IsSignalDetected to control SpeechlyClient's Start/Stop. + /// + #if UNITY_EDITOR + [Tooltip("Allows VAD's IsSignalDetected to control SpeechlyClient's Start/Stop.")] + #endif + public bool VADControlsListening = false; + + #if UNITY_EDITOR + [SerializeField] + #endif + public VADOptions VADSettings = new VADOptions(); + } + + /// + /// Options for Voice Activity Detection (VAD) + /// + [System.Serializable] + public class VADOptions { + /// + /// Enable energy-level calculations + /// + public bool Enabled { get; set; } = true; + + /// + /// Signal-to-noise energy ratio needed for frame to be 'loud' + /// + #if UNITY_EDITOR + [Range(0.0f, 10.0f)] + [Tooltip("Signal-to-noise energy ratio needed for frame to be 'loud'")] + #endif + public float SignalToNoiseDb = 3.0f; /// Signal-to-noise energy ratio needed for frame to be 'loud' + + /// + /// Energy threshold - below this won't trigger activation + /// + #if UNITY_EDITOR + [Range(-90.0f, 0.0f)] + [Tooltip("Energy threshold - below this won't trigger activation")] + #endif + public float NoiseGateDb = -24f; + + /// + /// Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy. + /// + #if UNITY_EDITOR + [Range(0, 5000)] + [Tooltip("Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy.")] + #endif + public int NoiseLearnHalftimeMillis = 400; + + /// + /// Number of past frames analyzed for energy threshold VAD. Should be <= than HistoryFrames. + /// + #if UNITY_EDITOR + [Range(1, 32)] + [Tooltip("Number of past frames analyzed for energy threshold VAD. Should be <= than HistoryFrames.")] + #endif + public int SignalSearchFrames = 5; + + /// + /// Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected' + /// + #if UNITY_EDITOR + [Range(.0f, 1.0f)] + [Tooltip("Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected'")] + #endif + public float SignalActivation = 0.7f; + + /// + /// Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over. + /// + #if UNITY_EDITOR + [Range(.0f, 1.0f)] + [Tooltip("Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over.")] + #endif + public float SignalRelease = 0.2f; + + /// + /// Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true. + /// + #if UNITY_EDITOR + [Range(0, 8000)] + [Tooltip("Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true.")] + #endif + public int SignalSustainMillis = 3000; + } + + /// + /// Options for speech recognition + /// + [System.Serializable] + public class ContextOptions { + /// + /// Increase or decrease the probability of recognizing the provided words + /// + [System.Serializable] + public class ShallowFusionSettings { + /// + /// Newline-delimited words that specify the vocabulary for score biasing. + /// + #if UNITY_EDITOR + [TextArea] + [Tooltip("Newline-delimited words that specify the vocabulary for score biasing.")] + #endif + public string Vocabulary; + + /// + /// Biasing weight. Positive values increase the probability of recognition, negative values decrease it. + /// + #if UNITY_EDITOR + [Range(-4.0f, 4.0f)] + [Tooltip("Biasing weight. Positive values increase the probability of recognition, negative values decrease it.")] + #endif + public float Weight; + } + + #if UNITY_EDITOR + [Range(0, 1200)] + [Tooltip("Duration of silence in milliseconds that creates a new segment. Set to 0 to disable speech segmentation.")] + [SerializeField] + #endif + public int SilenceSegmentationMillis = 720; + + #if UNITY_EDITOR + [SerializeField] + #endif + public ShallowFusionSettings BoostVocabulary; + } + + [DataContract] + public class StartMessage { + [DataContract] + public class Options { + [DataMember(Name = "vocabulary", EmitDefaultValue=false)] + public string[] vocabulary = null; + [DataMember(Name = "vocabulary_bias", EmitDefaultValue=false)] + public string[] vocabulary_bias = null; + [DataMember(Name = "silence_triggered_segmentation", EmitDefaultValue=false)] + public string[] silence_triggered_segmentation; + } + [DataMember(Name = "event")] + public string eventType; + [DataMember(Name = "appId", EmitDefaultValue=false)] + public string appId; + [DataMember(Name = "options", EmitDefaultValue=false)] + public Options options; + } + [DataContract] public class Word { [DataMember(Name = "word")] diff --git a/speechly-client-net-standard-2.0/Speechly/SLUClientTest/SpeechlyClientTest.cs b/speechly-client-net-standard-2.0/Speechly/SLUClientTest/SpeechlyClientTest.cs index 29ebf9d..bbf34cf 100644 --- a/speechly-client-net-standard-2.0/Speechly/SLUClientTest/SpeechlyClientTest.cs +++ b/speechly-client-net-standard-2.0/Speechly/SLUClientTest/SpeechlyClientTest.cs @@ -5,6 +5,7 @@ using System.Linq; using System.Diagnostics; using Speechly.Tools; +using Speechly.Types; namespace Speechly.SLUClient { internal class SpeechlyClientTest { @@ -49,10 +50,10 @@ public static async Task TestCloudProcessing(string fileName) { var connectTime = stopWatch.ElapsedMilliseconds; stopWatch.Restart(); - _ = client.StartContext(); + _ = client.Start(); client.ProcessAudioFile(fileName); - await client.StopContext(); + await client.Stop(); var sluTime = stopWatch.ElapsedMilliseconds; Logger.Log($"==== STATS ===="); @@ -60,10 +61,13 @@ public static async Task TestCloudProcessing(string fileName) { Logger.Log($"SLU time: {sluTime} ms"); } - public static void SplitWithVAD(string fileName, string saveToFolder = null, string logUtteranceFolder = null) { + public static async Task SplitWithVAD(string fileName, string saveToFolder = null, string logUtteranceFolder = null) { Stopwatch stopWatch = new Stopwatch(); - EnergyTresholdVAD vad = new EnergyTresholdVAD(); + EnergyThresholdVAD vad = new EnergyThresholdVAD( + new VADOptions(), + new AudioInfo() + ); StreamWriter logUtteranceStream = null; int utteranceStartSamplePos = 0; @@ -74,10 +78,11 @@ public static void SplitWithVAD(string fileName, string saveToFolder = null, str var client = new SpeechlyClient( saveToFolder: saveToFolder, - vad: vad, debug: true ); + await client.Initialize(decoder: null, audioProcessorOptions: new AudioProcessorOptions() { VADControlsListening = true } ); + client.OnStartStream = () => { Logger.Log("client.OnStartStream"); if (logUtteranceFolder != null) { @@ -91,21 +96,21 @@ public static void SplitWithVAD(string fileName, string saveToFolder = null, str logUtteranceStream = null; }; - client.OnStartContext = () => { - Logger.Log($"client.OnStartContext {client.StreamSamplePos}"); - utteranceStartSamplePos = client.StreamSamplePos; + client.OnStart = () => { + Logger.Log($"client.OnStart {client.Output.StreamSamplePos}"); + utteranceStartSamplePos = client.Output.StreamSamplePos; }; - client.OnStopContext = () => { - Logger.Log("client.OnStopContext"); - string serialString = client.UtteranceSerial.ToString().PadLeft(4, '0'); - logUtteranceStream.WriteLine($"{client.AudioInputStreamIdentifier}\t{serialString}\t{utteranceStartSamplePos}\t{client.SamplesSent}"); + client.OnStop = () => { + Logger.Log("client.OnStop"); + string serialString = client.Output.UtteranceSerial.ToString().PadLeft(4, '0'); + logUtteranceStream.WriteLine($"{client.AudioInputStreamIdentifier}\t{serialString}\t{utteranceStartSamplePos}\t{client.Output.SamplesSent}"); }; stopWatch.Restart(); - // _ = client.StartContext(); + // _ = client.Start(); client.ProcessAudioFile(fileName); - // await client.StopContext(); + // await client.Stop(); var processTime = stopWatch.ElapsedMilliseconds; Logger.Log($"==== STATS ===="); diff --git a/speechly-client-net-standard-2.0/speechly-unity-net-standard-2.0.csproj b/speechly-client-net-standard-2.0/speechly-unity-net-standard-2.0.csproj index 567b2b0..078a5fa 100644 --- a/speechly-client-net-standard-2.0/speechly-unity-net-standard-2.0.csproj +++ b/speechly-client-net-standard-2.0/speechly-unity-net-standard-2.0.csproj @@ -1,6 +1,7 @@ + 2.0.1 Exe net6.0 speechly_unity_net_standard_2._0 diff --git a/speechly-client.unitypackage b/speechly-client.unitypackage index c60ff97..4465283 100644 Binary files a/speechly-client.unitypackage and b/speechly-client.unitypackage differ diff --git a/speechly-unity/Assets/Speechly/MicToSpeechly.cs b/speechly-unity/Assets/Speechly/MicToSpeechly.cs index cd91810..f6998e8 100644 --- a/speechly-unity/Assets/Speechly/MicToSpeechly.cs +++ b/speechly-unity/Assets/Speechly/MicToSpeechly.cs @@ -4,12 +4,16 @@ using System; using System.Threading.Tasks; using Speechly.Tools; +using Speechly.Types; using Logger = Speechly.Tools.Logger; namespace Speechly.SLUClient { public partial class MicToSpeechly : MonoBehaviour { + /// Set to false if you're calling AdjustAudioProcessor manually + public const bool WATCH_VAD_SETTING = true; + public enum SpeechlyEnvironment { Production, Staging, @@ -27,26 +31,33 @@ public static MicToSpeechly Instance [Tooltip("Speechly App Id from https://api.speechly.com/dashboard")] public string AppId = ""; + [Tooltip("Capture device name or null for default.")] + public string CaptureDeviceName = null; - public int MicSampleRate = 16000; - [Tooltip("Milliseconds of history data to send upon StartContext to capture lead of the utterance.")] - public int FrameMillis = 30; - [Range(1, 32)] - [Tooltip("Number of frames to keep in memory. When listening is started, history frames are sent to capture the lead-in audio.")] - public int HistoryFrames = 8; - [Tooltip("Voice Activity Detection (VAD) using adaptive energy thresholding. Automatically controls listening based on audio 'loudness'.")] - public EnergyTresholdVAD EnergyLevels = new EnergyTresholdVAD{ Enabled = true, ControlListening = false }; + + [Tooltip("Model Bundle filename")] + public string ModelBundle = null; + public bool DebugPrint = false; + + [SerializeField] + public AudioProcessorOptions AudioProcessorSettings = new AudioProcessorOptions(); + + [SerializeField] + public ContextOptions SpeechRecognitionSettings = new ContextOptions(); + + [SerializeField] + public AudioInfo Output = new AudioInfo(); + public SpeechlyClient SpeechlyClient { get; private set; } private AudioClip clip; private float[] waveData; private int oldRingbufferPos; - private bool wasVADEnabled = false; + private bool wasVADEnabled; private Coroutine runSpeechlyCoroutine = null; IDecoder decoder = null; - partial void CreateOnDeviceDecoder(bool debug); - + partial void CreateOnDeviceDecoder(string deviceId, string modelBundleFile, bool debug); private void Awake() { @@ -60,11 +71,8 @@ private void Awake() Logger.LogError = Debug.LogError; SpeechlyClient = new SpeechlyClient( - vad: this.EnergyLevels, manualUpdate: true, - frameMillis: FrameMillis, - historyFrames: HistoryFrames, - inputSampleRate: MicSampleRate, + output: this.Output, debug: DebugPrint ); @@ -79,10 +87,10 @@ void OnEnable() { // Debug.Log($"minFreq {minFreq} maxFreq {maxFreq}"); int capturedAudioBufferMillis = 500; - int micBufferMillis = FrameMillis * HistoryFrames + capturedAudioBufferMillis; + int micBufferMillis = AudioProcessorSettings.FrameMillis * AudioProcessorSettings.HistoryFrames + capturedAudioBufferMillis; int micBufferSecs = (micBufferMillis / 1000) + 1; // Start audio capture - clip = Microphone.Start(CaptureDeviceName, true, micBufferSecs, MicSampleRate); + clip = Microphone.Start(CaptureDeviceName, true, micBufferSecs, AudioProcessorSettings.InputSampleRate); if (clip != null) { @@ -94,6 +102,7 @@ void OnEnable() { throw new Exception($"Could not open microphone {CaptureDeviceName}"); } + wasVADEnabled = this.AudioProcessorSettings.VADControlsListening; runSpeechlyCoroutine = StartCoroutine(RunSpeechly()); } @@ -106,7 +115,11 @@ async void OnDisable() { private IEnumerator RunSpeechly() { if (SpeechlyEnv == SpeechlyEnvironment.OnDevice) { - CreateOnDeviceDecoder(debug: DebugPrint); + CreateOnDeviceDecoder( + deviceId: Platform.GetDeviceId(SystemInfo.deviceUniqueIdentifier), + ModelBundle, + debug: DebugPrint + ); if (this.decoder == null) { throw new Exception("Speechly on-device spoken language understanding (SLU) is not available. Most likely your Unity project does not contain the SpeechlyOnDevice folder. Please contact Speechly to enable on-device support - you'll need extra files delivered under Speechly on-device licence."); } @@ -123,7 +136,7 @@ private IEnumerator RunSpeechly() // Wait for connect Task task; - task = SpeechlyClient.Initialize(decoder); + task = SpeechlyClient.Initialize(decoder, AudioProcessorSettings, SpeechRecognitionSettings, preferLibSpeechlyAudioProcessor: SpeechlyEnv == SpeechlyEnvironment.OnDevice); yield return new WaitUntil(() => task.IsCompleted); while (true) { @@ -132,20 +145,6 @@ private IEnumerator RunSpeechly() // Fire handlers in main Unity thread SpeechlyClient.Update(); - // Ensure VAD-initiated listening is stopped if VAD state is altered "on the fly" - if (EnergyLevels != null) { - if (EnergyLevels.Enabled && EnergyLevels.ControlListening) { - wasVADEnabled = true; - } else { - if (wasVADEnabled) { - wasVADEnabled = false; - if (SpeechlyClient.IsActive) { - StopContext(); - } - } - } - } - int captureRingbufferPos = Microphone.GetPosition(CaptureDeviceName); int samples; @@ -163,21 +162,17 @@ private IEnumerator RunSpeechly() SpeechlyClient.ProcessAudio(waveData, 0, samples); } + if (WATCH_VAD_SETTING) { + if (this.AudioProcessorSettings.VADControlsListening != wasVADEnabled) { + SpeechlyClient.AdjustAudioProcessor(vadControlsListening: this.AudioProcessorSettings.VADControlsListening); + wasVADEnabled = this.AudioProcessorSettings.VADControlsListening; + } + } + // Wait for a frame for new audio yield return null; } } - - // Drop-and-forget wrapper for async StartContext - public void StartContext() { - _ = SpeechlyClient.StartContext(); - } - - // Drop-and-forget wrapper for async StopContext - public void StopContext() { - _ = SpeechlyClient.StopContext(); - } - } } \ No newline at end of file diff --git a/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing.meta b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing.meta new file mode 100644 index 0000000..0331603 --- /dev/null +++ b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: ac39873869d0f4e2387813224272fbd4 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs new file mode 100644 index 0000000..f6b0218 --- /dev/null +++ b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs @@ -0,0 +1,173 @@ +using System; +using Speechly.Types; + +#if UNITY_EDITOR +using UnityEngine; +#endif + +namespace Speechly.Tools { + [System.Serializable] + + public class AudioProcessor { + public delegate void SendAudioDelegate(float[] floats, int start = 0, int length = -1); + public delegate void VadChangeDelegate(bool isSignalDetected); + + public SendAudioDelegate OnSendAudio = (floats, start, length) => {}; + public VadChangeDelegate OnVadStateChange = (isSignalDetected) => {}; + public EnergyThresholdVAD Vad { get; private set; } = null; + public AudioProcessorOptions Options { get; private set; } + public AudioInfo Output {get; private set; } + + private bool isActive = false; + private int frameSamples; + private float[] sampleRingBuffer = null; + private int frameSamplePos; + private int currentFrameNumber = 0; + private int streamFramePos = 0; + private bool wasSignalDetected = false; + private bool Debug; + + public AudioProcessor( + AudioProcessorOptions options, + AudioInfo output, + bool debug = false + ) { + this.Options = options; + this.Output = output; + + this.Vad = new EnergyThresholdVAD(this.Options.VADSettings, this.Output); + this.Debug = debug; + + this.frameSamples = this.Options.InternalSampleRate * this.Options.FrameMillis / 1000; + this.sampleRingBuffer = new float[this.frameSamples * this.Options.HistoryFrames]; + } + + public void Start() { + isActive = true; + Output.SamplesSent = 0; + Output.UtteranceSerial++; + } + + public void Stop() { + Flush(); + isActive = false; + wasSignalDetected = false; + } + + public void Reset(int inputSampleRate = 0) { + isActive = false; + streamFramePos = 0; + Output.StreamSamplePos = 0; + frameSamplePos = 0; + currentFrameNumber = 0; + Output.UtteranceSerial = -1; + if (inputSampleRate > 0) this.Options.InputSampleRate = inputSampleRate; + Vad?.ResetVAD(); + } + + private void Flush() { + ProcessAudio(sampleRingBuffer, 0, frameSamplePos, true); + } + + +/// +/// Process speech audio samples from a microphone or other audio source. +/// +/// It's recommended to constantly feed new audio as long as you want to use Speechly's SLU services. +/// +/// You can control when to start and stop process speech either manually with and or +/// automatically by providing a voice activity detection (VAD) field to . +/// +/// The audio is handled as follows: +/// - Downsample to 16kHz if needed +/// - Add to history ringbuffer +/// - Calculate energy (VAD) +/// - Automatic Start/Stop (VAD) +/// - Send utterance audio to a file +/// - Send utterance audio to Speechly SLU decoder +/// +/// Array of float containing samples to feed to the audio pipeline. Each sample needs to be in range -1f..1f. +/// Start index of audio to process in samples (default: `0`). +/// Length of audio to process in samples or `-1` to process the whole array (default: `-1`). +/// Forces processing of last subframe at end of audio stream (default: `false`). + + public void ProcessAudio(float[] floats, int start = 0, int length = -1, bool forceSubFrameProcess = false) { + if (length < 0) length = floats.Length; + if (length == 0) return; + + int i = start; + int endIndex = start + length; + + while (i < endIndex) { + int frameBase = currentFrameNumber * frameSamples; + + if (Options.InputSampleRate == Options.InternalSampleRate) { + // Copy input samples to fill current ringbuffer frame + int samplesToFillFrame = Math.Min(endIndex - i, frameSamples - frameSamplePos); + int frameEndIndex = frameSamplePos + samplesToFillFrame; + while (frameSamplePos < frameEndIndex) { + sampleRingBuffer[frameBase + frameSamplePos++] = floats[i++]; + } + } else { + // Downsample input samples to fill current ringbuffer frame + float ratio = 1f * Options.InputSampleRate / Options.InternalSampleRate; + int inputSamplesToFillFrame = Math.Min(endIndex - i, (int)Math.Round(ratio * (frameSamples - frameSamplePos))); + int samplesToFillFrame = Math.Min((int)Math.Round((endIndex - i) / ratio), frameSamples - frameSamplePos); + AudioTools.Downsample(floats, ref sampleRingBuffer, i,inputSamplesToFillFrame, frameBase+frameSamplePos,samplesToFillFrame); + i += inputSamplesToFillFrame; + frameSamplePos += samplesToFillFrame; + } + + // Process frame + if (frameSamplePos == frameSamples || forceSubFrameProcess) { + frameSamplePos = 0; + int subFrameSamples = forceSubFrameProcess ? frameSamplePos : frameSamples; + + if (!forceSubFrameProcess) { + ProcessFrame(sampleRingBuffer, frameBase, subFrameSamples); + } + + if (isActive) { + + if (Output.SamplesSent == 0) { + // Start of the utterance - send history frames + int sendHistory = Math.Min(streamFramePos, Options.HistoryFrames - 1); + int historyFrameIndex = (currentFrameNumber + Options.HistoryFrames - sendHistory) % Options.HistoryFrames; + while (historyFrameIndex != currentFrameNumber) { + OnSendAudio(sampleRingBuffer, historyFrameIndex * frameSamples, frameSamples); + Output.SamplesSent += frameSamples; + historyFrameIndex = (historyFrameIndex + 1) % Options.HistoryFrames; + } + } + OnSendAudio(sampleRingBuffer, frameBase, subFrameSamples); + Output.SamplesSent += subFrameSamples; + } + + streamFramePos += 1; + Output.StreamSamplePos += subFrameSamples; + currentFrameNumber = (currentFrameNumber + 1) % Options.HistoryFrames; + } + } + } + + private void ProcessFrame(float[] floats, int start = 0, int length = -1) { + AnalyzeAudioFrame(in floats, start, length); + AutoControlListening(); + } + + private void AnalyzeAudioFrame(in float[] waveData, int s, int frameSamples) { + if (this.Vad != null && this.Vad.Options.Enabled) { + Vad.ProcessFrame(waveData, s, frameSamples); + } + } + + private void AutoControlListening() { + if (this.Vad != null && this.Vad.Options.Enabled && this.Options.VADControlsListening) { + if (Output.IsSignalDetected != this.wasSignalDetected) { + OnVadStateChange(Output.IsSignalDetected); + this.wasSignalDetected = Output.IsSignalDetected; + } + } + } + } +} diff --git a/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs.meta b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs.meta new file mode 100644 index 0000000..fe791df --- /dev/null +++ b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioProcessor.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 14739639db7e64df389dc5ff99ace14a +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/speechly-unity/Assets/Speechly/SLUClient/AudioTools.cs b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioTools.cs similarity index 100% rename from speechly-unity/Assets/Speechly/SLUClient/AudioTools.cs rename to speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioTools.cs diff --git a/speechly-unity/Assets/Speechly/SLUClient/AudioTools.cs.meta b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioTools.cs.meta similarity index 100% rename from speechly-unity/Assets/Speechly/SLUClient/AudioTools.cs.meta rename to speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/AudioTools.cs.meta diff --git a/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs new file mode 100644 index 0000000..ca673e9 --- /dev/null +++ b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs @@ -0,0 +1,113 @@ +using System; +using Speechly.Types; + +#if UNITY_EDITOR +using UnityEngine; +#endif + +namespace Speechly.Tools { +/// +/// Adaptive energy threshold voice activity detection (VAD) implementation. +/// It can be used to enable hands-free operation of the SLU decoder. +/// +/// When enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time. +/// Use its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time. +/// The background noise level gradually adapts when no signal is detected. +/// +/// IsSignalDetected can be used to drive SpeechlyClient's Start and Stop automatically by setting ControlListening true. +/// + [System.Serializable] + + public class EnergyThresholdVAD { + public VADOptions Options {get; private set; } + public AudioInfo Output {get; private set; } + + private float energy = 0f; + private float baselineEnergy = -1f; + private int loudFrameBits = 0; + private float vadSustainMillisLeft = 0; + private int frameMillis = 30; + + public EnergyThresholdVAD(VADOptions options, AudioInfo output) { + this.Output = output; + this.Options = options; + } + + public void ProcessFrame(float[] floats, int start = 0, int length = -1) { + if (!Options.Enabled) { + ResetVAD(); + return; + } + + energy = AudioTools.GetEnergy(in floats, start, length); + + if (baselineEnergy < 0f) { + baselineEnergy = energy; + } + + bool isLoudFrame = energy > Math.Max(Math.Pow(10.0, Options.NoiseGateDb / 10.0), baselineEnergy * Math.Pow(10.0, Options.SignalToNoiseDb / 10.0)); + PushFrameHistory(isLoudFrame); + + Output.IsSignalDetected = DetermineNewSignalState(Output.IsSignalDetected); + + AdaptBackgroundNoise(); + + Output.SignalDb = AudioTools.EnergyToDb(energy / baselineEnergy); + Output.NoiseLevelDb = AudioTools.EnergyToDb(baselineEnergy); + } + + private bool DetermineNewSignalState(bool currentState) { + vadSustainMillisLeft = Math.Max(vadSustainMillisLeft - frameMillis, 0); + + int loudFrames = CountLoudFrames(Options.SignalSearchFrames); + + int activationFrames = (int)Math.Round(Options.SignalActivation * Options.SignalSearchFrames); + int releaseFrames = (int)Math.Round(Options.SignalRelease * Options.SignalSearchFrames); + + if (loudFrames >= activationFrames) { + // Renew sustain time + vadSustainMillisLeft = Options.SignalSustainMillis; + return true; + } + + if (loudFrames <= releaseFrames && vadSustainMillisLeft == 0) { + return false; + } + + return currentState; + } + + private void AdaptBackgroundNoise() { + // Gradually learn background noise level + if (!Output.IsSignalDetected) { + if (Options.NoiseLearnHalftimeMillis > 0f) { + var decay = (float)Math.Pow(2.0, -frameMillis / (double)Options.NoiseLearnHalftimeMillis); + baselineEnergy = (baselineEnergy * decay) + (energy * (1f - decay)); + } + } + } + + private void PushFrameHistory(bool isLoud) { + loudFrameBits = (isLoud ? 1 : 0) | (loudFrameBits << 1); + } + + private int CountLoudFrames(int numHistoryFrames) { + int numActiveFrames = 0; + int t = loudFrameBits; + while (numHistoryFrames > 0) { + if ((t & 1) == 1) numActiveFrames++; + t = t >> 1; + numHistoryFrames--; + } + return numActiveFrames; + } + + public void ResetVAD() { + Output.IsSignalDetected = false; + loudFrameBits = 0; + energy = 0f; + baselineEnergy = -1f; + } + } + +} \ No newline at end of file diff --git a/speechly-unity/Assets/Speechly/SLUClient/EnergyTresholdVAD.cs.meta b/speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs.meta similarity index 100% rename from speechly-unity/Assets/Speechly/SLUClient/EnergyTresholdVAD.cs.meta rename to speechly-unity/Assets/Speechly/SLUClient/AudioProcessing/EnergyThresholdVAD.cs.meta diff --git a/speechly-unity/Assets/Speechly/SLUClient/CloudDecoder.cs b/speechly-unity/Assets/Speechly/SLUClient/CloudDecoder.cs index 2ab7ef3..040b9e3 100644 --- a/speechly-unity/Assets/Speechly/SLUClient/CloudDecoder.cs +++ b/speechly-unity/Assets/Speechly/SLUClient/CloudDecoder.cs @@ -11,8 +11,8 @@ namespace Speechly.SLUClient { /// Provides speech processing with Speechly's cloud SLU service. /// /// Internally handles authentication using https and audio streaming via secure websocket. -/// Audio is streamed when listening is started with SpeechlyClient.StartContext(). -/// Streaming stops upon call to SpeechlyClient.StopContext(). +/// Audio is streamed when listening is started with SpeechlyClient.Start(). +/// Streaming stops upon call to SpeechlyClient.Stop(). /// public class CloudDecoder: IDecoder { @@ -27,6 +27,7 @@ public class CloudDecoder: IDecoder { private WsClient wsClient = null; private ConcurrentQueue> startContextTCS = new ConcurrentQueue>(); private ConcurrentQueue> stopContextTCS = new ConcurrentQueue>(); + private StartMessage startMessage; /// /// Initialize speech processing with Speechly's cloud SLU service. @@ -65,7 +66,7 @@ public CloudDecoder( this.projectId = projectId; } - override internal async Task Initialize() { + override internal async Task Initialize(AudioProcessorOptions audioProcessorOptions, ContextOptions contextOptions) { if (debug) Logger.Log("Initializing and connecting Cloud SLU..."); var tokenFetcher = new LoginToken(); string token = await tokenFetcher.FetchToken(loginUrl, projectId, appId, deviceId); @@ -75,18 +76,25 @@ override internal async Task Initialize() { wsClient = new WsClient(); wsClient.OnResponseReceived = OnResponse; + // Prebuild the start message + startMessage = new StartMessage() {eventType = "start", appId = this.appId}; + startMessage.options = new StartMessage.Options(); + startMessage.options.silence_triggered_segmentation = new[] {Convert.ToString(contextOptions.SilenceSegmentationMillis)}; + if (contextOptions.BoostVocabulary != null && !string.IsNullOrEmpty(contextOptions.BoostVocabulary.Vocabulary)) { + startMessage.options.vocabulary = contextOptions.BoostVocabulary.Vocabulary.ToUpper().Split('\n'); + startMessage.options.vocabulary_bias = new[] {Convert.ToString(contextOptions.BoostVocabulary.Weight)}; + } + await wsClient.ConnectAsync(apiUrl, token); if (debug) Logger.Log("Cloud SLU ready"); } - override internal Task StartContext() { + override internal Task Start() { var tcs = new TaskCompletionSource(); startContextTCS.Enqueue(tcs); - if (appId != null) { - wsClient.SendText($"{{\"event\": \"start\", \"appId\": \"{appId}\"}}"); - } else { - wsClient.SendText($"{{\"event\": \"start\"}}"); - } + + wsClient.SendText(JSON.Stringify(startMessage)); + return tcs.Task; } @@ -133,7 +141,7 @@ override internal void SendAudio(float[] floats, int start = 0, int length = -1) wsClient.SendBytes(new ArraySegment(buf)); } - override internal Task StopContext() { + override internal Task Stop() { var tcs = new TaskCompletionSource(); stopContextTCS.Enqueue(tcs); wsClient.SendText($"{{\"event\": \"stop\"}}"); diff --git a/speechly-unity/Assets/Speechly/SLUClient/EnergyTresholdVAD.cs b/speechly-unity/Assets/Speechly/SLUClient/EnergyTresholdVAD.cs deleted file mode 100644 index 8a1c620..0000000 --- a/speechly-unity/Assets/Speechly/SLUClient/EnergyTresholdVAD.cs +++ /dev/null @@ -1,174 +0,0 @@ -using System; -using Speechly.Tools; - -#if UNITY_EDITOR -using UnityEngine; -#endif - -namespace Speechly.SLUClient { -/// -/// Adaptive energy threshold voice activity detection (VAD) implementation. -/// It can be used to enable hands-free operation of the SLU decoder. -/// -/// When enough frames with a signal stronger than SignalToNoiseDb have been detected, IsSignalDetected goes true. When enough silent frames have been detected, IsSignalDetected goes false after the sustain time. -/// Use its public fields to configure the static noise gate level, signal-to-noise level, activation/deactivation treshold (ratio of signal to silent frames) and the signal sustain time. -/// The background noise level gradually adapts when no signal is detected. -/// -/// IsSignalDetected can be used to drive SpeechlyClient's StartContext and StopContext automatically by setting ControlListening true. -/// - - [System.Serializable] - public class EnergyTresholdVAD { - #if UNITY_EDITOR - [Tooltip("Run energy analysis.")] - #endif - public bool Enabled = true; - - #if UNITY_EDITOR - [Range(0.0f, 10.0f)] - [Tooltip("Signal-to-noise energy ratio needed for frame to be 'loud'")] - #endif - public float SignalToNoiseDb = 3.0f; - - #if UNITY_EDITOR - [Range(-90.0f, 0.0f)] - [Tooltip("Energy threshold - below this won't trigger activation")] - #endif - public float NoiseGateDb = -24f; - - #if UNITY_EDITOR - [Range(0, 5000)] - [Tooltip("Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy.")] - #endif - public int NoiseLearnHalftimeMillis = 400; - - #if UNITY_EDITOR - [Range(1, 32)] - [Tooltip("Number of past frames analyzed for energy threshold VAD. Should be <= than HistoryFrames.")] - #endif - public int SignalSearchFrames = 5; - - #if UNITY_EDITOR - [Range(.0f, 1.0f)] - [Tooltip("Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected'")] - #endif - public float SignalActivation = 0.7f; - - #if UNITY_EDITOR - [Range(.0f, 1.0f)] - [Tooltip("Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over.")] - #endif - public float SignalRelease = 0.2f; - - #if UNITY_EDITOR - [Range(0, 8000)] - [Tooltip("Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true.")] - #endif - public int SignalSustainMillis = 3000; - - #if UNITY_EDITOR - [Header("Output")] - #endif - public bool IsSignalDetected; - - #if UNITY_EDITOR - [Range(0.0f, 10.0f)] - #endif - public float SignalDb; - - #if UNITY_EDITOR - [Range(-90.0f, 0.0f)] - #endif - public float NoiseLevelDb; - - #if UNITY_EDITOR - [Header("Signal detection controls listening")] - [Tooltip("Enable listening control if you want to use IsSignalDetected to control SpeechlyClient's StartContext/StopContext.")] - #endif - public bool ControlListening = true; - - - public float Energy {get; private set; } = 0f; - public float BaselineEnergy {get; private set; } = -1f; - private int loudFrameBits = 0; - private float vadSustainMillisLeft = 0; - private int FrameMillis = 30; - - public void ProcessFrame(float[] floats, int start = 0, int length = -1) { - if (!Enabled) { - ResetVAD(); - return; - } - - Energy = AudioTools.GetEnergy(in floats, start, length); - - if (BaselineEnergy < 0f) { - BaselineEnergy = Energy; - } - - bool isLoudFrame = Energy > Math.Max(Math.Pow(10.0, NoiseGateDb / 10.0), BaselineEnergy * Math.Pow(10.0, SignalToNoiseDb / 10.0)); - PushFrameHistory(isLoudFrame); - - IsSignalDetected = DetermineNewSignalState(IsSignalDetected); - - AdaptBackgroundNoise(); - - SignalDb = AudioTools.EnergyToDb(Energy / BaselineEnergy); - NoiseLevelDb = AudioTools.EnergyToDb(BaselineEnergy); - } - - private bool DetermineNewSignalState(bool currentState) { - vadSustainMillisLeft = Math.Max(vadSustainMillisLeft - FrameMillis, 0); - - int loudFrames = CountLoudFrames(SignalSearchFrames); - - int activationFrames = (int)Math.Round(SignalActivation * SignalSearchFrames); - int releaseFrames = (int)Math.Round(SignalRelease * SignalSearchFrames); - - if (loudFrames >= activationFrames) { - // Renew sustain time - vadSustainMillisLeft = SignalSustainMillis; - return true; - } - - if (loudFrames <= releaseFrames && vadSustainMillisLeft == 0) { - return false; - } - - return currentState; - } - - private void AdaptBackgroundNoise() { - // Gradually learn background noise level - if (!IsSignalDetected) { - if (NoiseLearnHalftimeMillis > 0f) { - var decay = (float)Math.Pow(2.0, -FrameMillis / (double)NoiseLearnHalftimeMillis); - BaselineEnergy = (BaselineEnergy * decay) + (Energy * (1f - decay)); - } - } - } - - private void PushFrameHistory(bool isLoud) { - loudFrameBits = (isLoud ? 1 : 0) | (loudFrameBits << 1); - } - - private int CountLoudFrames(int numHistoryFrames) { - int numActiveFrames = 0; - int t = loudFrameBits; - while (numHistoryFrames > 0) { - if ((t & 1) == 1) numActiveFrames++; - t = t >> 1; - numHistoryFrames--; - } - return numActiveFrames; - } - - private void ResetVAD() { - IsSignalDetected = false; - loudFrameBits = 0; - Energy = 0f; - BaselineEnergy = -1f; - } - } - -} \ No newline at end of file diff --git a/speechly-unity/Assets/Speechly/SLUClient/IDecoder.cs b/speechly-unity/Assets/Speechly/SLUClient/IDecoder.cs index 4547473..5a74801 100644 --- a/speechly-unity/Assets/Speechly/SLUClient/IDecoder.cs +++ b/speechly-unity/Assets/Speechly/SLUClient/IDecoder.cs @@ -1,4 +1,5 @@ using Speechly.Types; +using Speechly.Tools; using System.Threading.Tasks; namespace Speechly.SLUClient { @@ -6,10 +7,10 @@ namespace Speechly.SLUClient { public abstract class IDecoder { internal abstract event ResponseReceivedDelegate OnMessage; - internal abstract Task Initialize(); - internal abstract Task StartContext(); + internal abstract Task Initialize(AudioProcessorOptions audioProcessorOptions, ContextOptions contextOptions); + internal abstract Task Start(); internal abstract void SendAudio(float[] floats, int start = 0, int length = -1); - internal abstract Task StopContext(); + internal abstract Task Stop(); internal abstract Task Shutdown(); } } \ No newline at end of file diff --git a/speechly-unity/Assets/Speechly/SLUClient/Platform.cs b/speechly-unity/Assets/Speechly/SLUClient/Platform.cs index ddcb905..87079e2 100644 --- a/speechly-unity/Assets/Speechly/SLUClient/Platform.cs +++ b/speechly-unity/Assets/Speechly/SLUClient/Platform.cs @@ -37,10 +37,18 @@ public static Task Fetch(string url) { var req = UnityEngine.Networking.UnityWebRequest.Get(url); var reqOp = req.SendWebRequest(); var tsc = new TaskCompletionSource(); - reqOp.completed += asyncOp => tsc.TrySetResult(reqOp.webRequest.downloadHandler.data); - if (reqOp.isDone) { + void completeLoad() { + if (!String.IsNullOrEmpty(req.error)) { + throw new Exception($"Error while fetching from url {url}:\n{req.error}"); + } tsc.TrySetResult(reqOp.webRequest.downloadHandler.data); + }; + + if (reqOp.isDone) { + completeLoad(); + } else { + reqOp.completed += asyncOp => completeLoad(); } return tsc.Task; diff --git a/speechly-unity/Assets/Speechly/SLUClient/SpeechlyClient.cs b/speechly-unity/Assets/Speechly/SLUClient/SpeechlyClient.cs index bab811f..d64b7af 100644 --- a/speechly-unity/Assets/Speechly/SLUClient/SpeechlyClient.cs +++ b/speechly-unity/Assets/Speechly/SLUClient/SpeechlyClient.cs @@ -20,8 +20,8 @@ namespace Speechly.SLUClient { /// - (delegates are firing up as speech is processed) /// - When you don't need SLU services any more call to free resources. /// -/// You can feed audio continuously, but control when to start and stop process speech with and or -/// let voice activity detection (VAD) handle that automatically by passing to SpeechlyClient constructor. +/// You can feed audio continuously, but control when to start and stop process speech with and or +/// let voice activity detection (VAD) handle that automatically by passing to SpeechlyClient constructor. /// public class SpeechlyClient { @@ -29,7 +29,7 @@ public class SpeechlyClient { /// /// Read the combined results of automatic speech recoginition (ASR) and natural language detection (NLU). /// -/// You can control when to start and stop process speech either manually with and or +/// You can control when to start and stop process speech either manually with and or /// automatically by providing a voice activity detection (VAD) field to . /// @@ -42,96 +42,75 @@ public class SpeechlyClient { public IntentDelegate OnIntent = (msg) => {}; public StartStreamDelegate OnStartStream = () => {}; public StopStreamDelegate OnStopStream = () => {}; - public StartContextDelegate OnStartContext = () => {}; - public StopContextDelegate OnStopContext = () => {}; + public StartDelegate OnStart = () => {}; + public StopDelegate OnStop = () => {}; + + public AudioInfo Output { get; private set; } + private AudioProcessor AudioProcessor; // Returns true when StartStream has been called public bool IsAudioStreaming { get; private set; } = false; - /// Returns true when SLU Engine is ready for Start/StopContext calls + /// Returns true when SLU Engine is ready for Start/Stop calls public bool IsReady { get { return this.decoder != null; } } - /// Returns true when StartContext is called and expecting StopContext next + /// Returns true when Start is called and expecting Stop next public bool IsActive { get; private set; } = false; - public int SamplesSent { get; private set; } = 0; - public EnergyTresholdVAD Vad { get; private set; } = null; - /// Utterance identifier public string AudioInputStreamIdentifier { get; private set; } = "utterance"; - /// 0-based local index of utterance within the stream - public int UtteranceSerial { get; private set; } = -1; - - /// Current count of continuously processed samples (thru ProcessAudio) from start of stream - public int StreamSamplePos { get; private set; } = 0; - /// Enable debug prints public bool Debug = false; /// Message queue used when manualUpdate is true. Delegates are fired with a call to Update() that should be run in the desired thread (main) thread. private ConcurrentQueue messageQueue = new ConcurrentQueue(); private Dictionary> activeContexts = new Dictionary>(); + private AudioProcessorOptions audioProcessorOptions; + private ContextOptions contextOptions; private bool manualUpdate; private string saveToFolder = null; private FileStream outAudioStream; - private int inputSampleRate = 16000; - private int internalSampleRate = 16000; - private int frameMillis = 30; - - /// Total number of history frames to keep in memory. Will be sent upon a starting a new utterance. - private int historyFrames = 5; - - private int frameSamples; - - private int streamFramePos = 0; private bool streamAutoStarted; - private float[] sampleRingBuffer = null; - private int frameSamplePos; - private int currentFrameNumber = 0; + private IDecoder decoder; /// /// Create a new SpeechlyClient to process audio and fire delegates to provide SLU results. /// -/// instance to control automatic listening on/off. Null disables VAD. (default: `null`) +/// instance to control automatic listening on/off. Null disables VAD. (default: `null`) /// Count of the audio history frames (default: `5`). Total history duration will be historyFrames * frameSamples. -/// Size of one audio frame (default: `30` ms). Total history duration will be historyFrames*frameSamples. History is sent upon StartContext to capture the start of utterance which especially important with VAD, which activates with a constant delay. +/// Size of one audio frame (default: `30` ms). Total history duration will be historyFrames*frameSamples. History is sent upon Start to capture the start of utterance which especially important with VAD, which activates with a constant delay. /// Setting `manualUpdate = true` postpones SpeechlyClient's delegates (OnSegmentChange, OnTranscript...) until you manually run . This enables you to call Unity API in SpeechlyClient's delegates, as Unity API should only be used in the main Unity thread. (Default: false) /// Defines a local folder to save utterance files as 16 bit, 16000 hZ mono raw. Null disables saving. (default: `null`) /// Define the sample rate of incoming audio (default: `16000`) /// Enable debug prints thru delegate. (default: `false`) public SpeechlyClient( - int frameMillis = 30, - int historyFrames = 5, - int inputSampleRate = 16000, bool manualUpdate = false, string saveToFolder = null, // @TODO Future: Allow storing to memory stream as well for replay? - EnergyTresholdVAD vad = null, // @TODO Future: Allow different VAD implementation thru IVAD interface + AudioInfo output = null, bool debug = false ) { - this.frameMillis = Math.Max(frameMillis, 1); - this.historyFrames = Math.Max(historyFrames, 1); // Need at least 1 frame; the current one - this.inputSampleRate = inputSampleRate; this.manualUpdate = manualUpdate; this.saveToFolder = saveToFolder; - this.Vad = vad; this.Debug = debug; - frameSamples = internalSampleRate * frameMillis / 1000; + if (output == null) { + this.Output = new AudioInfo(); + } else { + this.Output = output; + } if (saveToFolder != null) { Directory.CreateDirectory(saveToFolder); } - - sampleRingBuffer = new float[frameSamples * historyFrames]; } /// @@ -142,39 +121,73 @@ public SpeechlyClient( /// /// SLU decoder implementing IDecoder interface like . /// Task that completes when the decoder is ready. - public async Task Initialize(IDecoder decoder) { - if (this.decoder == null) { + public async Task Initialize(IDecoder decoder, AudioProcessorOptions audioProcessorOptions = null, ContextOptions contextOptions = null, bool preferLibSpeechlyAudioProcessor = false) { + if (audioProcessorOptions == null) { + audioProcessorOptions = new AudioProcessorOptions(); + } + this.audioProcessorOptions = audioProcessorOptions; + + if (contextOptions == null) { + contextOptions = new ContextOptions(); + } + this.contextOptions = contextOptions; + + if (this.decoder == null && decoder != null) { try { if (this.manualUpdate) { decoder.OnMessage += QueueMessage; } else { decoder.OnMessage += OnMessage; } - await decoder.Initialize(); + await decoder.Initialize( + audioProcessorOptions, + contextOptions + ); this.decoder = decoder; } catch (Exception e) { Logger.LogError(e.ToString()); throw; } } + + if (!preferLibSpeechlyAudioProcessor) { + this.AudioProcessor = new AudioProcessor( + audioProcessorOptions, + this.Output, + this.Debug + ); + + this.AudioProcessor.OnSendAudio += SendAudio; + this.AudioProcessor.OnVadStateChange += (isSignalDetected) => { + if (isSignalDetected) { + _ = Start(); + } else { + _ = Stop(); + } + }; + } + } /// -/// `StartStream` should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and StartContext ensure it's been called. +/// `StartStream` should be called at start of a continuous audio stream. It resets the stream sample counters and history. For backwards compability, ProcessAudio and Start ensure it's been called. /// `OnStreamStart` delegate is triggered upon a call to StartStream. /// public void StartStream(string streamIdentifier, bool auto = false) { if (!IsAudioStreaming) { - IsAudioStreaming = true; streamAutoStarted = auto; - streamFramePos = 0; - StreamSamplePos = 0; - frameSamplePos = 0; - currentFrameNumber = 0; - UtteranceSerial = -1; - this.AudioInputStreamIdentifier = streamIdentifier; + + IsAudioStreaming = true; + AudioInputStreamIdentifier = streamIdentifier; + AudioProcessor?.Reset(); OnStartStream(); + + // Start receiving results if using libSpeechly AudioProcessor + if (AudioProcessor == null && audioProcessorOptions.VADControlsListening) { + _ = Start(); + } + } } @@ -186,12 +199,9 @@ public void StopStream(bool auto = false) { if (IsAudioStreaming) { if ((auto && streamAutoStarted) || !streamAutoStarted) { if (IsActive) { - _ = StopContext(); + _ = Stop(); } - // Process remaining frame samples - ProcessAudio(sampleRingBuffer, 0, frameSamplePos, true); - IsAudioStreaming = false; OnStopStream(); @@ -199,16 +209,37 @@ public void StopStream(bool auto = false) { } } +/// +/// Control AudioProcessor parameters. +/// +/// `true` enables VAD to control listening. `false` disables VAD feature and stops listening immediately. `null` for no change. + + public void AdjustAudioProcessor(bool? vadControlsListening = null) { + if (vadControlsListening != null) { + this.audioProcessorOptions.VADControlsListening = (bool)vadControlsListening; + // Start audio flow if using libSpeechly + if (AudioProcessor == null) { + if (this.audioProcessorOptions.VADControlsListening && !IsActive) { + _ = Start(); + } + } + // Ensure listening is stopped when VAD control is toggled off + if (!this.audioProcessorOptions.VADControlsListening && IsActive) { + _ = Stop(); + } + } + } + /// /// Start listening for user speech and feeding it to the SLU decoder. -/// `OnContextStart` is triggered upon a call to StartContext. It's also triggered by automatic VAD activation. +/// `OnContextStart` is triggered upon a call to Start. It's also triggered by automatic VAD activation. /// /// You don't need to await this call if you don't need the utterance id. /// /// Cloud decoder only: The Speechly app id to connect to, if not the default. If specified, you must use project id based login with cloud decoder. /// An unique utterance id. - public Task StartContext(string appId = null) { + public Task Start(string appId = null) { if (IsActive) { throw new Exception("Already listening."); } @@ -218,21 +249,25 @@ public Task StartContext(string appId = null) { } IsActive = true; - SamplesSent = 0; - UtteranceSerial++; - - string localBaseName = $"{AudioInputStreamIdentifier}_{UtteranceSerial.ToString().PadLeft(4, '0')}"; + string localBaseName; + + if (AudioProcessor != null) { + AudioProcessor.Start(); + localBaseName = $"{AudioInputStreamIdentifier}_{Output.UtteranceSerial.ToString().PadLeft(4, '0')}"; + } else { + localBaseName = $"{AudioInputStreamIdentifier}"; + } string contextId = localBaseName; if (saveToFolder != null) { outAudioStream = new FileStream(Path.Combine(saveToFolder, $"{localBaseName}.raw"), FileMode.OpenOrCreate, FileAccess.Write, FileShare.None); } - OnStartContext(); + OnStart(); if (this.decoder != null) { try { - return this.decoder.StartContext(); + return this.decoder.Start(); } catch (Exception e) { IsActive = false; Logger.LogError(e.ToString()); @@ -257,87 +292,39 @@ public void ProcessAudioFile(string fileName) { /// /// It's recommended to constantly feed new audio as long as you want to use Speechly's SLU services. /// -/// You can control when to start and stop process speech either manually with and or +/// You can control when to start and stop process speech either manually with and or /// automatically by providing a voice activity detection (VAD) field to . /// /// The audio is handled as follows: /// - Downsample to 16kHz if needed /// - Add to history ringbuffer /// - Calculate energy (VAD) -/// - Automatic Start/StopContext (VAD) +/// - Automatic Start/Stop (VAD) /// - Send utterance audio to a file /// - Send utterance audio to Speechly SLU decoder /// /// Array of float containing samples to feed to the audio pipeline. Each sample needs to be in range -1f..1f. /// Start index of audio to process in samples (default: `0`). /// Length of audio to process in samples or `-1` to process the whole array (default: `-1`). -/// internally uses this to force processing of last subframe at end of audio stream (default: `false`). - public void ProcessAudio(float[] floats, int start = 0, int length = -1, bool forceSubFrameProcess = false) { + public void ProcessAudio(float[] floats, int start = 0, int length = -1) { if (!IsAudioStreaming) { StartStream(AudioInputStreamIdentifier, auto: false); // Assume no auto-start/stop if ProcessAudio call encountered before startContext call } - if (length < 0) length = floats.Length; - if (length == 0) return; - - int i = start; - int endIndex = start + length; - - while (i < endIndex) { - int frameBase = currentFrameNumber * frameSamples; - - if (inputSampleRate == internalSampleRate) { - // Copy input samples to fill current ringbuffer frame - int samplesToFillFrame = Math.Min(endIndex - i, frameSamples - frameSamplePos); - int frameEndIndex = frameSamplePos + samplesToFillFrame; - while (frameSamplePos < frameEndIndex) { - sampleRingBuffer[frameBase + frameSamplePos++] = floats[i++]; - } - } else { - // Downsample input samples to fill current ringbuffer frame - float ratio = 1f * inputSampleRate / internalSampleRate; - int inputSamplesToFillFrame = Math.Min(endIndex - i, (int)Math.Round(ratio * (frameSamples - frameSamplePos))); - int samplesToFillFrame = Math.Min((int)Math.Round((endIndex - i) / ratio), frameSamples - frameSamplePos); - AudioTools.Downsample(floats, ref sampleRingBuffer, i,inputSamplesToFillFrame, frameBase+frameSamplePos,samplesToFillFrame); - i += inputSamplesToFillFrame; - frameSamplePos += samplesToFillFrame; - } - - // Process frame - if (frameSamplePos == frameSamples || forceSubFrameProcess) { - frameSamplePos = 0; - int subFrameSamples = forceSubFrameProcess ? frameSamplePos : frameSamples; - - if (!forceSubFrameProcess) { - ProcessFrame(sampleRingBuffer, frameBase, subFrameSamples); - } - - if (IsActive) { - - if (SamplesSent == 0) { - // Start of the utterance - send history frames - int sendHistory = Math.Min(streamFramePos, historyFrames - 1); - int historyFrameIndex = (currentFrameNumber + historyFrames - sendHistory) % historyFrames; - while (historyFrameIndex != currentFrameNumber) { - SendAudio(sampleRingBuffer, historyFrameIndex * frameSamples, frameSamples); - historyFrameIndex = (historyFrameIndex + 1) % historyFrames; - } - } - SendAudio(sampleRingBuffer, frameBase, subFrameSamples); - } - - streamFramePos += 1; - StreamSamplePos += subFrameSamples; - currentFrameNumber = (currentFrameNumber + 1) % historyFrames; + if (AudioProcessor != null) { + AudioProcessor.ProcessAudio(floats, start, length); + } else { + if (IsActive) { + SendAudio(floats, start, length); } } } public void ProcessAudio(Stream fileStream) { - // @TODO Use a pre-allocated buf - var bytes = new byte[frameSamples * 2]; - var floats = new float[frameSamples]; + const int CHUNK_SAMPLES = 16000; + var bytes = new byte[CHUNK_SAMPLES * 2]; + var floats = new float[CHUNK_SAMPLES]; while (true) { int bytesRead = fileStream.Read(bytes, 0, bytes.Length); @@ -352,32 +339,7 @@ public void ProcessAudio(Stream fileStream) { } } - private void ProcessFrame(float[] floats, int start = 0, int length = -1) { - AnalyzeAudioFrame(in floats, start, length); - AutoControlListening(); - } - - private void AnalyzeAudioFrame(in float[] waveData, int s, int frameSamples) { - if (this.Vad != null && this.Vad.Enabled) { - Vad.ProcessFrame(waveData, s, frameSamples); - } - } - - private void AutoControlListening() { - if (this.Vad != null && this.Vad.Enabled && this.Vad.ControlListening) { - if (!IsActive && Vad.IsSignalDetected) { - _ = StartContext(); - } - - if (IsActive && !Vad.IsSignalDetected) { - _ = StopContext(); - } - } - } - - private void SendAudio(float[] floats, int start = 0, int length = -1) { - SamplesSent += length; - + internal void SendAudio(float[] floats, int start = 0, int length = -1) { // Stream to file if (saveToFolder != null) { SaveToDisk(floats, start, length); @@ -406,30 +368,31 @@ private void SaveToDisk(float[] floats, int start = 0, int length = -1) { /// /// Stop listening for user speech. -/// `OnContextStop` is triggered upon a call to StopContext. It's also triggered by automatic VAD deactivation. +/// `OnContextStop` is triggered upon a call to Stop. It's also triggered by automatic VAD deactivation. /// /// You don't need to await this call if you don't need the utterance id. /// /// An unique utterance id. - public Task StopContext() { + public Task Stop() { if (!IsActive) { throw new Exception("Already stopped listening."); } + AudioProcessor?.Stop(); IsActive = false; - string localBaseName = $"{AudioInputStreamIdentifier}_{UtteranceSerial.ToString().PadLeft(4, '0')}"; + string localBaseName = $"{AudioInputStreamIdentifier}_{Output.UtteranceSerial.ToString().PadLeft(4, '0')}"; string contextId = localBaseName; if (saveToFolder != null) { outAudioStream.Close(); } - OnStopContext(); + OnStop(); if (this.decoder != null) { try { - return this.decoder.StopContext(); + return this.decoder.Stop(); } catch (Exception e) { Logger.LogError(e.ToString()); throw; diff --git a/speechly-unity/Assets/Speechly/SLUClient/Types.cs b/speechly-unity/Assets/Speechly/SLUClient/Types.cs index a2f74e3..049dac1 100644 --- a/speechly-unity/Assets/Speechly/SLUClient/Types.cs +++ b/speechly-unity/Assets/Speechly/SLUClient/Types.cs @@ -1,8 +1,13 @@ using System; using System.Runtime.Serialization; +using System.Collections.Generic; using System.Text; using System.IO; +#if UNITY_EDITOR +using UnityEngine; +#endif + namespace Speechly.Types { public delegate void SegmentChangeDelegate(Speechly.SLUClient.Segment segment); @@ -13,12 +18,240 @@ namespace Speechly.Types { public delegate void IntentDelegate(MsgIntent msg); public delegate void StartStreamDelegate(); public delegate void StopStreamDelegate(); - public delegate void StartContextDelegate(); - public delegate void StopContextDelegate(); + public delegate void StartDelegate(); + public delegate void StopDelegate(); public delegate string BeautifyIntent (string intent); public delegate string BeautifyEntity (string entityValue, string entityType); + + public class ModelExpiredException : Exception + { + public ModelExpiredException() {} + public ModelExpiredException(string message) : base(message) {} + public ModelExpiredException(string message, Exception inner) : base(message, inner) {} + } + + /// + /// Statistics calculated by the Audio Processor. Note that this information is not currently available when using libSpeechly AudioProcessor. + /// + [System.Serializable] + public class AudioInfo { + /// + /// True if VAD has detected a loud signal. + /// + public bool IsSignalDetected; + + /// + /// Signal level in dB above noise level. + /// + #if UNITY_EDITOR + [Range(0.0f, 10.0f)] + #endif + public float SignalDb; + + /// + /// Current noise level in dB. + /// + #if UNITY_EDITOR + [Range(-90.0f, 0.0f)] + #endif + public float NoiseLevelDb; + + /// + /// Current count of continuously processed samples (thru ProcessAudio) since StartStream + /// + public int StreamSamplePos { get; internal set; } = 0; + + /// + /// Current count of processed samples since Start + /// + public int SamplesSent { get; internal set; } = 0; + + /// + /// 0-based local index of utterance within the stream. -1 if no utterances have been processed. + /// + public int UtteranceSerial { get; internal set; } = -1; + } + + /// + /// Options for Audio Processor and Voice Activity Detection (VAD) + /// + [System.Serializable] + public class AudioProcessorOptions { + /// + /// Input sample rate in Hz. + /// + public int InputSampleRate = 16000; + + /// + /// Internal Speechly sample rate in Hz. Currently only 16000 Hz is supported. + /// + public int InternalSampleRate = 16000; + + /// + /// Internal frame length. Affects audio caching and VAD energy analysis. + /// + public int FrameMillis = 30; + + /// + /// Total number of history frames to keep in memory. Will be sent upon a starting a new utterance. + /// + #if UNITY_EDITOR + [Range(1, 32)] + [Tooltip("Number of frames to keep in memory. When listening is started, history frames are sent to capture the lead-in audio.")] + #endif + public int HistoryFrames = 8; + + /// + /// Allows VAD's IsSignalDetected to control SpeechlyClient's Start/Stop. + /// + #if UNITY_EDITOR + [Tooltip("Allows VAD's IsSignalDetected to control SpeechlyClient's Start/Stop.")] + #endif + public bool VADControlsListening = false; + + #if UNITY_EDITOR + [SerializeField] + #endif + public VADOptions VADSettings = new VADOptions(); + } + + /// + /// Options for Voice Activity Detection (VAD) + /// + [System.Serializable] + public class VADOptions { + /// + /// Enable energy-level calculations + /// + public bool Enabled { get; set; } = true; + + /// + /// Signal-to-noise energy ratio needed for frame to be 'loud' + /// + #if UNITY_EDITOR + [Range(0.0f, 10.0f)] + [Tooltip("Signal-to-noise energy ratio needed for frame to be 'loud'")] + #endif + public float SignalToNoiseDb = 3.0f; /// Signal-to-noise energy ratio needed for frame to be 'loud' + + /// + /// Energy threshold - below this won't trigger activation + /// + #if UNITY_EDITOR + [Range(-90.0f, 0.0f)] + [Tooltip("Energy threshold - below this won't trigger activation")] + #endif + public float NoiseGateDb = -24f; + + /// + /// Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy. + /// + #if UNITY_EDITOR + [Range(0, 5000)] + [Tooltip("Rate of background noise learn. Defined as duration in which background noise energy is moved halfway towards current frame's energy.")] + #endif + public int NoiseLearnHalftimeMillis = 400; + + /// + /// Number of past frames analyzed for energy threshold VAD. Should be <= than HistoryFrames. + /// + #if UNITY_EDITOR + [Range(1, 32)] + [Tooltip("Number of past frames analyzed for energy threshold VAD. Should be <= than HistoryFrames.")] + #endif + public int SignalSearchFrames = 5; + + /// + /// Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected' + /// + #if UNITY_EDITOR + [Range(.0f, 1.0f)] + [Tooltip("Minimum 'signal' to 'silent' frame ratio in history to activate 'IsSignalDetected'")] + #endif + public float SignalActivation = 0.7f; + + /// + /// Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over. + /// + #if UNITY_EDITOR + [Range(.0f, 1.0f)] + [Tooltip("Maximum 'signal' to 'silent' frame ratio in history to inactivate 'IsSignalDetected'. Only evaluated when the sustain period is over.")] + #endif + public float SignalRelease = 0.2f; + + /// + /// Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true. + /// + #if UNITY_EDITOR + [Range(0, 8000)] + [Tooltip("Duration to keep 'IsSignalDetected' active. Renewed as long as VADActivation is holds true.")] + #endif + public int SignalSustainMillis = 3000; + } + + /// + /// Options for speech recognition + /// + [System.Serializable] + public class ContextOptions { + /// + /// Increase or decrease the probability of recognizing the provided words + /// + [System.Serializable] + public class ShallowFusionSettings { + /// + /// Newline-delimited words that specify the vocabulary for score biasing. + /// + #if UNITY_EDITOR + [TextArea] + [Tooltip("Newline-delimited words that specify the vocabulary for score biasing.")] + #endif + public string Vocabulary; + + /// + /// Biasing weight. Positive values increase the probability of recognition, negative values decrease it. + /// + #if UNITY_EDITOR + [Range(-4.0f, 4.0f)] + [Tooltip("Biasing weight. Positive values increase the probability of recognition, negative values decrease it.")] + #endif + public float Weight; + } + + #if UNITY_EDITOR + [Range(0, 1200)] + [Tooltip("Duration of silence in milliseconds that creates a new segment. Set to 0 to disable speech segmentation.")] + [SerializeField] + #endif + public int SilenceSegmentationMillis = 720; + + #if UNITY_EDITOR + [SerializeField] + #endif + public ShallowFusionSettings BoostVocabulary; + } + + [DataContract] + public class StartMessage { + [DataContract] + public class Options { + [DataMember(Name = "vocabulary", EmitDefaultValue=false)] + public string[] vocabulary = null; + [DataMember(Name = "vocabulary_bias", EmitDefaultValue=false)] + public string[] vocabulary_bias = null; + [DataMember(Name = "silence_triggered_segmentation", EmitDefaultValue=false)] + public string[] silence_triggered_segmentation; + } + [DataMember(Name = "event")] + public string eventType; + [DataMember(Name = "appId", EmitDefaultValue=false)] + public string appId; + [DataMember(Name = "options", EmitDefaultValue=false)] + public Options options; + } + [DataContract] public class Word { [DataMember(Name = "word")] diff --git a/speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/SLUClientTest/SpeechlyClientTest.cs b/speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/SLUClientTest/SpeechlyClientTest.cs index 29ebf9d..bbf34cf 100644 --- a/speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/SLUClientTest/SpeechlyClientTest.cs +++ b/speechly-unity/Assets/SpeechlyExamples/AudioFileToSpeechly/SLUClientTest/SpeechlyClientTest.cs @@ -5,6 +5,7 @@ using System.Linq; using System.Diagnostics; using Speechly.Tools; +using Speechly.Types; namespace Speechly.SLUClient { internal class SpeechlyClientTest { @@ -49,10 +50,10 @@ public static async Task TestCloudProcessing(string fileName) { var connectTime = stopWatch.ElapsedMilliseconds; stopWatch.Restart(); - _ = client.StartContext(); + _ = client.Start(); client.ProcessAudioFile(fileName); - await client.StopContext(); + await client.Stop(); var sluTime = stopWatch.ElapsedMilliseconds; Logger.Log($"==== STATS ===="); @@ -60,10 +61,13 @@ public static async Task TestCloudProcessing(string fileName) { Logger.Log($"SLU time: {sluTime} ms"); } - public static void SplitWithVAD(string fileName, string saveToFolder = null, string logUtteranceFolder = null) { + public static async Task SplitWithVAD(string fileName, string saveToFolder = null, string logUtteranceFolder = null) { Stopwatch stopWatch = new Stopwatch(); - EnergyTresholdVAD vad = new EnergyTresholdVAD(); + EnergyThresholdVAD vad = new EnergyThresholdVAD( + new VADOptions(), + new AudioInfo() + ); StreamWriter logUtteranceStream = null; int utteranceStartSamplePos = 0; @@ -74,10 +78,11 @@ public static void SplitWithVAD(string fileName, string saveToFolder = null, str var client = new SpeechlyClient( saveToFolder: saveToFolder, - vad: vad, debug: true ); + await client.Initialize(decoder: null, audioProcessorOptions: new AudioProcessorOptions() { VADControlsListening = true } ); + client.OnStartStream = () => { Logger.Log("client.OnStartStream"); if (logUtteranceFolder != null) { @@ -91,21 +96,21 @@ public static void SplitWithVAD(string fileName, string saveToFolder = null, str logUtteranceStream = null; }; - client.OnStartContext = () => { - Logger.Log($"client.OnStartContext {client.StreamSamplePos}"); - utteranceStartSamplePos = client.StreamSamplePos; + client.OnStart = () => { + Logger.Log($"client.OnStart {client.Output.StreamSamplePos}"); + utteranceStartSamplePos = client.Output.StreamSamplePos; }; - client.OnStopContext = () => { - Logger.Log("client.OnStopContext"); - string serialString = client.UtteranceSerial.ToString().PadLeft(4, '0'); - logUtteranceStream.WriteLine($"{client.AudioInputStreamIdentifier}\t{serialString}\t{utteranceStartSamplePos}\t{client.SamplesSent}"); + client.OnStop = () => { + Logger.Log("client.OnStop"); + string serialString = client.Output.UtteranceSerial.ToString().PadLeft(4, '0'); + logUtteranceStream.WriteLine($"{client.AudioInputStreamIdentifier}\t{serialString}\t{utteranceStartSamplePos}\t{client.Output.SamplesSent}"); }; stopWatch.Restart(); - // _ = client.StartContext(); + // _ = client.Start(); client.ProcessAudioFile(fileName); - // await client.StopContext(); + // await client.Stop(); var processTime = stopWatch.ElapsedMilliseconds; Logger.Log($"==== STATS ===="); diff --git a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening.meta b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening.meta index e55362d..e07fbb4 100644 --- a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening.meta +++ b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 229a06f95a1114036ac4ede995b373ab +guid: 5b8a6594342b541c697f0664bdd33be8 folderAsset: yes DefaultImporter: externalObjects: {} diff --git a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity index a36506b..c74e94c 100644 --- a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity +++ b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity @@ -506,10 +506,10 @@ MonoBehaviour: m_FillRect: {fileID: 281230170} m_HandleRect: {fileID: 33476814} m_Direction: 0 - m_MinValue: 0 - m_MaxValue: 0.5 + m_MinValue: -90 + m_MaxValue: 0 m_WholeNumbers: 0 - m_Value: 0.4 + m_Value: 0 m_OnValueChanged: m_PersistentCalls: m_Calls: [] @@ -923,10 +923,10 @@ MonoBehaviour: m_FillRect: {fileID: 1796486933} m_HandleRect: {fileID: 1073776682} m_Direction: 0 - m_MinValue: 0 - m_MaxValue: 0.5 + m_MinValue: -90 + m_MaxValue: 0 m_WholeNumbers: 0 - m_Value: 0.1 + m_Value: 0 m_OnValueChanged: m_PersistentCalls: m_Calls: [] @@ -1179,7 +1179,7 @@ MonoBehaviour: m_GameObject: {fileID: 758041406} m_Enabled: 1 m_EditorHideFlags: 0 - m_Script: {fileID: 11500000, guid: 979204ce5b94d4780a3c33f9a0802125, type: 3} + m_Script: {fileID: 11500000, guid: 1facb91a63f504a0983722fe61005293, type: 3} m_Name: m_EditorClassIdentifier: SliderEnergy: {fileID: 275751998} @@ -1787,23 +1787,31 @@ MonoBehaviour: SpeechlyEnv: 0 AppId: 8fb67f1e-69df-4d25-811b-4413a3264be2 CaptureDeviceName: - MicSampleRate: 16000 - FrameMillis: 30 - HistoryFrames: 8 - EnergyLevels: - Enabled: 1 - SignalToNoiseDb: 3 - NoiseGateDb: -24 - NoiseLearnHalftimeMillis: 400 - SignalSearchFrames: 5 - SignalActivation: 0.7 - SignalRelease: 0.2 - SignalSustainMillis: 3000 + ModelBundle: + DebugPrint: 0 + AudioProcessorSettings: + InputSampleRate: 16000 + InternalSampleRate: 16000 + FrameMillis: 30 + HistoryFrames: 8 + VADControlsListening: 1 + VADSettings: + SignalToNoiseDb: 3 + NoiseGateDb: -24 + NoiseLearnHalftimeMillis: 400 + SignalSearchFrames: 5 + SignalActivation: 0.7 + SignalRelease: 0.2 + SignalSustainMillis: 3000 + SpeechRecognitionSettings: + SilenceSegmentationMillis: 720 + BoostVocabulary: + Vocabulary: + Weight: 0 + Output: IsSignalDetected: 0 SignalDb: 0 NoiseLevelDb: 0 - ControlListening: 1 - DebugPrint: 0 --- !u!1 &2069320975 GameObject: m_ObjectHideFlags: 0 diff --git a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity.meta b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity.meta index 2400e92..f51d2e1 100644 --- a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity.meta +++ b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/HandsFreeListeningScene.unity.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: a3cab7551a8f648efba133559640637e +guid: d325ecd93be5f4b4fafda54abcab7bb0 DefaultImporter: externalObjects: {} userData: diff --git a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs index 9521ba0..18249d6 100644 --- a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs +++ b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs @@ -25,7 +25,7 @@ void Start() TranscriptText.text = segment.ToString( (intent) => "", (words, entityType) => $"{words}", - "" + "." ); }; } @@ -33,10 +33,10 @@ void Start() void Update() { speechlyClient = MicToSpeechly.Instance.SpeechlyClient; - SliderEnergy.value = speechlyClient.Vad.Energy; - SliderBaselineEnergy.value = speechlyClient.Vad.BaselineEnergy; - Fill.color = speechlyClient.Vad.IsSignalDetected ? Color.red : Color.white; - ButtonText.text = speechlyClient.Vad.IsSignalDetected ? "Signal Detected" : "No Signal"; + SliderBaselineEnergy.value = speechlyClient.Output.NoiseLevelDb; + SliderEnergy.value = speechlyClient.Output.NoiseLevelDb + speechlyClient.Output.SignalDb; + Fill.color = speechlyClient.Output.IsSignalDetected ? Color.red : Color.white; + ButtonText.text = speechlyClient.Output.IsSignalDetected ? "Signal Detected" : "Signal Status"; } } diff --git a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs.meta b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs.meta index beac8a8..41ffdda 100644 --- a/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs.meta +++ b/speechly-unity/Assets/SpeechlyExamples/HandsFreeListening/UseSpeechly.cs.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: 979204ce5b94d4780a3c33f9a0802125 +guid: 1facb91a63f504a0983722fe61005293 MonoImporter: externalObjects: {} serializedVersion: 2 diff --git a/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/MicToSpeechlyScene.unity b/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/MicToSpeechlyScene.unity index 466f5fa..b073d58 100644 --- a/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/MicToSpeechlyScene.unity +++ b/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/MicToSpeechlyScene.unity @@ -777,9 +777,9 @@ MonoBehaviour: m_HandleRect: {fileID: 885213177} m_Direction: 0 m_MinValue: 0 - m_MaxValue: 0.5 + m_MaxValue: 12 m_WholeNumbers: 0 - m_Value: 0.2 + m_Value: 1 m_OnValueChanged: m_PersistentCalls: m_Calls: [] @@ -1515,10 +1515,16 @@ MonoBehaviour: SpeechlyEnv: 0 AppId: 629379fd-7071-4cae-9ab1-a3ee61ac3a07 CaptureDeviceName: - MicSampleRate: 16000 - FrameMillis: 30 - HistoryFrames: 5 - EnergyLevels: + ModelBundle: + ListenOnLaunch: 0 + DebugPrint: 1 + AudioProcessorOptions: + InputSampleRate: 16000 + InternalSampleRate: 16000 + FrameMillis: 30 + HistoryFrames: 8 + Handsfree: 0 + VADOptions: Enabled: 1 SignalToNoiseDb: 3 NoiseGateDb: -24 @@ -1527,8 +1533,7 @@ MonoBehaviour: SignalActivation: 0.7 SignalRelease: 0.2 SignalSustainMillis: 3000 + Output: IsSignalDetected: 0 SignalDb: 0 NoiseLevelDb: 0 - ControlListening: 0 - DebugPrint: 1 diff --git a/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/UseSpeechly.cs b/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/UseSpeechly.cs index d470579..d4ab5cf 100644 --- a/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/UseSpeechly.cs +++ b/speechly-unity/Assets/SpeechlyExamples/MicToSpeechly/UseSpeechly.cs @@ -18,21 +18,21 @@ void Start() TranscriptText.text = segment.ToString( (intent) => "", (words, entityType) => $"{words}", - "" + "." ); }; } void Update() { - SliderAudioPeak.value = MicToSpeechly.Instance.SpeechlyClient.Vad.Energy; + SliderAudioPeak.value = MicToSpeechly.Instance.SpeechlyClient.Output.SignalDb; } public void OnMouseDown() { if (!speechlyClient.IsActive) { - _ = speechlyClient.StartContext(); + _ = speechlyClient.Start(); } } @@ -40,7 +40,7 @@ public void OnMouseUp() { if (speechlyClient.IsActive) { - _ = speechlyClient.StopContext(); + _ = speechlyClient.Stop(); } } diff --git a/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/PointAndTalkScene.unity b/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/PointAndTalkScene.unity index 7aa83bc..f165591 100644 --- a/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/PointAndTalkScene.unity +++ b/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/PointAndTalkScene.unity @@ -1258,9 +1258,9 @@ MonoBehaviour: m_HandleRect: {fileID: 885213177} m_Direction: 0 m_MinValue: 0 - m_MaxValue: 0.5 + m_MaxValue: 12 m_WholeNumbers: 0 - m_Value: 0.05 + m_Value: 1 m_OnValueChanged: m_PersistentCalls: m_Calls: [] @@ -2881,10 +2881,16 @@ MonoBehaviour: SpeechlyEnv: 0 AppId: 28e50e5e-8f65-4f94-8903-247245910130 CaptureDeviceName: - MicSampleRate: 16000 - FrameMillis: 30 - HistoryFrames: 5 - EnergyLevels: + ModelBundle: + ListenOnLaunch: 0 + DebugPrint: 0 + AudioProcessorOptions: + InputSampleRate: 16000 + InternalSampleRate: 16000 + FrameMillis: 30 + HistoryFrames: 8 + Handsfree: 0 + VADOptions: Enabled: 1 SignalToNoiseDb: 3 NoiseGateDb: -24 @@ -2893,8 +2899,7 @@ MonoBehaviour: SignalActivation: 0.7 SignalRelease: 0.2 SignalSustainMillis: 3000 + Output: IsSignalDetected: 0 SignalDb: 0 NoiseLevelDb: 0 - ControlListening: 0 - DebugPrint: 0 diff --git a/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/UseSpeechly.cs b/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/UseSpeechly.cs index 75dbd23..f7f7d95 100644 --- a/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/UseSpeechly.cs +++ b/speechly-unity/Assets/SpeechlyExamples/PointAndTalk/UseSpeechly.cs @@ -68,13 +68,13 @@ void Start() void Update() { - SliderAudioPeak.value = MicToSpeechly.Instance.SpeechlyClient.Vad.Energy; + SliderAudioPeak.value = MicToSpeechly.Instance.SpeechlyClient.Output.SignalDb; if (Input.GetMouseButtonDown(0)) { TranscriptText.text = "LISTENING..."; if (!speechlyClient.IsActive) { - _ = speechlyClient.StartContext(); + _ = speechlyClient.Start(); } RaycastHit hit; @@ -98,7 +98,7 @@ void Update() if (outline != null) outline.enabled = false; } if (speechlyClient.IsActive) { - _ = speechlyClient.StopContext(); + _ = speechlyClient.Stop(); } } } diff --git a/speechly-unity/Packages/manifest.json b/speechly-unity/Packages/manifest.json index de43ffa..eaa92b4 100644 --- a/speechly-unity/Packages/manifest.json +++ b/speechly-unity/Packages/manifest.json @@ -1,10 +1,10 @@ { "dependencies": { - "com.unity.collab-proxy": "1.14.12", + "com.unity.collab-proxy": "1.14.18", "com.unity.ide.rider": "1.2.1", - "com.unity.ide.visualstudio": "2.0.14", - "com.unity.ide.vscode": "1.2.4", - "com.unity.test-framework": "1.1.30", + "com.unity.ide.visualstudio": "2.0.15", + "com.unity.ide.vscode": "1.2.5", + "com.unity.test-framework": "1.1.31", "com.unity.textmeshpro": "2.1.6", "com.unity.timeline": "1.2.18", "com.unity.ugui": "1.0.0", diff --git a/speechly-unity/Packages/packages-lock.json b/speechly-unity/Packages/packages-lock.json index 2f71155..3fd72d2 100644 --- a/speechly-unity/Packages/packages-lock.json +++ b/speechly-unity/Packages/packages-lock.json @@ -1,7 +1,7 @@ { "dependencies": { "com.unity.collab-proxy": { - "version": "1.14.12", + "version": "1.14.18", "depth": 0, "source": "registry", "dependencies": {}, @@ -24,7 +24,7 @@ "url": "https://packages.unity.com" }, "com.unity.ide.visualstudio": { - "version": "2.0.14", + "version": "2.0.15", "depth": 0, "source": "registry", "dependencies": { @@ -33,14 +33,14 @@ "url": "https://packages.unity.com" }, "com.unity.ide.vscode": { - "version": "1.2.4", + "version": "1.2.5", "depth": 0, "source": "registry", "dependencies": {}, "url": "https://packages.unity.com" }, "com.unity.test-framework": { - "version": "1.1.30", + "version": "1.1.31", "depth": 0, "source": "registry", "dependencies": { diff --git a/speechly-unity/ProjectSettings/EditorBuildSettings.asset b/speechly-unity/ProjectSettings/EditorBuildSettings.asset index f0616f3..f60538e 100644 --- a/speechly-unity/ProjectSettings/EditorBuildSettings.asset +++ b/speechly-unity/ProjectSettings/EditorBuildSettings.asset @@ -6,6 +6,6 @@ EditorBuildSettings: serializedVersion: 2 m_Scenes: - enabled: 1 - path: Assets/SpeechlyExamples/MicToSpeechly/MicToSpeechlyScene.unity - guid: 4b5d0623ad0914a85bf7725caceeaae6 + path: Assets/SpeechlyExamples/PointAndTalk/PointAndTalkScene.unity + guid: a00d3f6bd307c4dab91fd7357cf15f63 m_configObjects: {}