- AcousticNoiseSuppressor - Class in io.spokestack.spokestack.webrtc
-
Acoustic Noise Suppressor (ANS) pipeline component
- AcousticNoiseSuppressor(SpeechConfig) - Constructor for class io.spokestack.spokestack.webrtc.AcousticNoiseSuppressor
-
constructs a new suppressor instance.
- activate() - Method in class io.spokestack.spokestack.SpeechPipeline
-
manually activate the speech pipeline.
- activate() - Method in class io.spokestack.spokestack.Spokestack
-
Manually activate the speech pipeline, forcing the current ASR class to
begin recognizing speech.
- ActivationTimeout - Class in io.spokestack.spokestack
-
Speech recognition activation timer.
- ActivationTimeout(SpeechConfig) - Constructor for class io.spokestack.spokestack.ActivationTimeout
-
Constructs a new timeout component.
- addListener(TraceListener) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU
-
Add a new listener to receive trace events from the NLU subsystem.
- addListener(OnSpeechEventListener) - Method in class io.spokestack.spokestack.SpeechPipeline
-
Add a new listener to receive events from the speech pipeline.
- addListener(SpokestackAdapter) - Method in class io.spokestack.spokestack.Spokestack
-
Add a new listener to receive events from Spokestack subsystems.
- addListener(SpokestackAdapter) - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Add a listener that receives events from all subsystems.
- addListener(TTSListener) - Method in class io.spokestack.spokestack.tts.TTSComponent
-
Add a TTS listener to receive events from this component.
- addListener(TTSListener) - Method in class io.spokestack.spokestack.tts.TTSManager
-
Add a new listener to receive events from the TTS subsystem.
- addOnSpeechEventListener(OnSpeechEventListener) - Method in class io.spokestack.spokestack.SpeechContext
-
attaches a speech listener.
- addOnSpeechEventListener(OnSpeechEventListener) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
adds a pipeline event listener.
- addStageClass(String) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
adds a single pipeline stage component class name.
- addTraceListener(TraceListener) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Add a listener interested in receiving NLU trace events.
- addTraceListener(TraceListener) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU.Builder
-
Adds a trace listener to receive events from the NLU system.
- addTTSListener(TTSListener) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Adds a TTS listener.
- AndroidSpeechRecognizer - Class in io.spokestack.spokestack.android
-
Speech recognition using built-in Android APIs.
- AndroidSpeechRecognizer(SpeechConfig) - Constructor for class io.spokestack.spokestack.android.AndroidSpeechRecognizer
-
Initializes a new recognizer.
- apply(SpeechPipeline.Builder) - Method in interface io.spokestack.spokestack.PipelineProfile
-
Apply this profile to the pipeline builder.
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.PushToTalkAndroidASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.PushToTalkAzureASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.PushToTalkGoogleASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.PushToTalkSpokestackASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.TFWakewordAndroidASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.TFWakewordAzureASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.TFWakewordGoogleASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.TFWakewordSpokestackASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.VADTriggerAndroidASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.VADTriggerAzureASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.VADTriggerGoogleASR
-
- apply(SpeechPipeline.Builder) - Method in class io.spokestack.spokestack.profile.VADTriggerSpokestackASR
-
- AsyncResult<T> - Class in io.spokestack.spokestack.util
-
A subclass of
FutureTask
that allows the user to register a callback
to be executed when the task's result is available.
- AsyncResult(Callable<T>) - Constructor for class io.spokestack.spokestack.util.AsyncResult
-
Create a new task.
- attachBuffer(Deque<ByteBuffer>) - Method in class io.spokestack.spokestack.SpeechContext
-
attaches a frame buffer to the context.
- audioReceived(AudioResponse) - Method in class io.spokestack.spokestack.SpeechOutput
-
Notifies the component that audio is available for immediate playback or
caching at the specified location.
- audioReceived(AudioResponse) - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
- AudioRecordError - Exception in io.spokestack.spokestack.android
-
A simple exception class that wraps error codes from AudioRecord
.
- AudioRecordError(int) - Constructor for exception io.spokestack.spokestack.android.AudioRecordError
-
Create a new error from a code code provided by the
Android system.
- AudioRecordError.Description - Enum in io.spokestack.spokestack.android
-
An enumeration of the AudioRecord error descriptions aligned with
their integer constant values.
- AudioResponse - Class in io.spokestack.spokestack.tts
-
A simple data class that represents an HTTP response from a TTS service, with
the URI containing the synthesized audio at the top level.
- AudioResponse(Uri) - Constructor for class io.spokestack.spokestack.tts.AudioResponse
-
Create a new TTS response containing only the URI containing
synthesized audio.
- AudioResponse(Map<String, Object>, Uri) - Constructor for class io.spokestack.spokestack.tts.AudioResponse
-
Create a new TTS response containing only the URI containing
synthesized audio.
- AutomaticGainControl - Class in io.spokestack.spokestack.webrtc
-
Automatic Gain Control (AGC) pipeline component
- AutomaticGainControl(SpeechConfig) - Constructor for class io.spokestack.spokestack.webrtc.AutomaticGainControl
-
constructs a new AGC instance.
- AzureSpeechRecognizer - Class in io.spokestack.spokestack.microsoft
-
microsoft azure speech service recognizer
- AzureSpeechRecognizer(SpeechConfig) - Constructor for class io.spokestack.spokestack.microsoft.AzureSpeechRecognizer
-
initializes a new recognizer instance.
- call(NLUResult) - Method in class io.spokestack.spokestack.SpokestackAdapter
-
Called when an NLU classification result is available if this class is
registered as a callback at classification time.
- call(T) - Method in interface io.spokestack.spokestack.util.Callback
-
Call the callback with the specified argument.
- callback - Variable in class io.spokestack.spokestack.tts.SpokestackTTSService
-
The callback used to process asynchronous responses from the underlying
HTTP client.
- Callback<T> - Interface in io.spokestack.spokestack.util
-
A simple interface representing a callback function called with a single
argument.
- canTrace(EventTracer.Level) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
indicates whether a message will be traced at a level.
- canTrace(EventTracer.Level) - Method in class io.spokestack.spokestack.SpeechContext
-
indicates whether a message will be traced at a level.
- canTrace(EventTracer.Level) - Method in class io.spokestack.spokestack.util.EventTracer
-
indicates whether a message will be traced at a level.
- capacity() - Method in class io.spokestack.spokestack.RingBuffer
-
- classify(String, NLUContext) - Method in interface io.spokestack.spokestack.nlu.NLUService
-
Classifies a user utterance.
- classify(String) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU
-
Classify a user utterance, returning a wrapper that can either block
until the classification is complete or call a registered callback when
the result is ready.
- classify(String, NLUContext) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU
-
- classify(String) - Method in class io.spokestack.spokestack.Spokestack
-
Classify a user utterance, returning a wrapper that can either block
until the classification is complete or call a registered callback when
the result is ready.
- close() - Method in class io.spokestack.spokestack.ActivationTimeout
-
- close() - Method in class io.spokestack.spokestack.android.AndroidSpeechRecognizer
-
- close() - Method in class io.spokestack.spokestack.android.MicrophoneInput
-
releases the resources associated with the microphone.
- close() - Method in class io.spokestack.spokestack.android.NoInput
-
- close() - Method in class io.spokestack.spokestack.android.PreASRMicrophoneInput
-
Releases the resources associated with the microphone.
- close() - Method in class io.spokestack.spokestack.asr.KeywordRecognizer
-
releases resources associated with the keyword recognizer.
- close() - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient
-
releases the resources associated with the speech client.
- close() - Method in class io.spokestack.spokestack.asr.SpokestackCloudRecognizer
-
releases the resources associated with the recognizer.
- close() - Method in class io.spokestack.spokestack.google.GoogleSpeechRecognizer
-
releases the resources associated with the recognizer.
- close() - Method in class io.spokestack.spokestack.microsoft.AzureSpeechRecognizer
-
releases the resources associated with the recognizer.
- close() - Method in class io.spokestack.spokestack.SpeechPipeline
-
shuts down the pipeline and releases its resources.
- close() - Method in class io.spokestack.spokestack.SpeechSampler
-
destroys the resources attached to the copmonent.
- close() - Method in class io.spokestack.spokestack.Spokestack
-
- close() - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel
-
releases the tensorflow interpreter.
- close() - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
- close() - Method in class io.spokestack.spokestack.tts.SpokestackTTSService
-
- close() - Method in class io.spokestack.spokestack.tts.TTSManager
-
- close() - Method in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
releases resources associated with the wakeword detector.
- close() - Method in class io.spokestack.spokestack.webrtc.AcousticNoiseSuppressor
-
destroys the unmanaged ans instance.
- close() - Method in class io.spokestack.spokestack.webrtc.AutomaticGainControl
-
destroys the unmanaged AGC instance.
- close() - Method in class io.spokestack.spokestack.webrtc.VoiceActivityDetector
-
destroys the unmanaged VAD instance.
- close() - Method in class io.spokestack.spokestack.webrtc.VoiceActivityTrigger
-
pipeline cleanup.
- confidence - Variable in class io.spokestack.spokestack.asr.SpokestackASRResponse.Hypothesis
-
the model's confidence in the hypothesis.
- connect() - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient
-
establishes a websocket connection for speech recognition.
- containsKey(String) - Method in class io.spokestack.spokestack.SpeechConfig
-
determines whether a configuration key is present.
- createAudioResponse(SpokestackSynthesisResponse, String) - Method in class io.spokestack.spokestack.tts.TTSCallback
-
- Crypto - Class in io.spokestack.spokestack.util
-
Utilities for working with Spokestack-specific cryptography such as request
signing.
- deactivate() - Method in class io.spokestack.spokestack.SpeechPipeline
-
manually deactivate the speech pipeline.
- deactivate() - Method in class io.spokestack.spokestack.Spokestack
-
Manually deactivate the speech pipeline, forcing the current ASR class to
stop recognizing speech.
- DEBUG - Static variable in class io.spokestack.spokestack.BuildConfig
-
- DEFAULT_BUFFER_WIDTH - Static variable in class io.spokestack.spokestack.SpeechPipeline
-
audio frame buffer width, in ms.
- DEFAULT_COMPRESSION_GAIN_DB - Static variable in class io.spokestack.spokestack.webrtc.AutomaticGainControl
-
default compression gain, in dB.
- DEFAULT_ENCODE_LENGTH - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-encode-length configuration value.
- DEFAULT_ENCODE_WIDTH - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-encode-width configuration value.
- DEFAULT_FFT_HOP_LENGTH - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-fft-hop-length configuration value.
- DEFAULT_FFT_HOP_LENGTH - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default fft-hop-length configuration value.
- DEFAULT_FFT_WINDOW_SIZE - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-fft-window-size configuration value.
- DEFAULT_FFT_WINDOW_SIZE - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default fft-window-size configuration value.
- DEFAULT_FFT_WINDOW_TYPE - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-fft-window-type configuration value.
- DEFAULT_FFT_WINDOW_TYPE - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default fft-window-type configuration value.
- DEFAULT_FRAME_WIDTH - Static variable in class io.spokestack.spokestack.SpeechPipeline
-
audio frame width, in ms.
- DEFAULT_MEL_FRAME_LENGTH - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-mel-frame-length configuration value.
- DEFAULT_MEL_FRAME_LENGTH - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default mel-frame-length configuration value.
- DEFAULT_MEL_FRAME_WIDTH - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-mel-frame-width configuration value.
- DEFAULT_MEL_FRAME_WIDTH - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default mel-frame-width configuration value.
- DEFAULT_MODE - Static variable in class io.spokestack.spokestack.webrtc.VoiceActivityDetector
-
default voice detection mode (high precision).
- DEFAULT_POLICY - Static variable in class io.spokestack.spokestack.webrtc.AcousticNoiseSuppressor
-
default suppressor policy.
- DEFAULT_PRE_EMPHASIS - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default keyword-pre-emphasis configuration value.
- DEFAULT_PRE_EMPHASIS - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default pre-emphasis configuration value.
- DEFAULT_RMS_ALPHA - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default rms-alpha configuration value.
- DEFAULT_RMS_TARGET - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default rms-target configuration value.
- DEFAULT_SAMPLE_MAX - Static variable in class io.spokestack.spokestack.SpeechSampler
-
default maximum number of rotated sample files.
- DEFAULT_SAMPLE_RATE - Static variable in class io.spokestack.spokestack.SpeechPipeline
-
audio sample rate default, in samples/sec.
- DEFAULT_TARGET_LEVEL_DBFS - Static variable in class io.spokestack.spokestack.webrtc.AutomaticGainControl
-
default target peak amplitude, in dBFS.
- DEFAULT_THRESHOLD - Static variable in class io.spokestack.spokestack.asr.KeywordRecognizer
-
default recognition threshold value.
- DEFAULT_WAKE_ENCODE_LENGTH - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default wake-encode-length configuration value.
- DEFAULT_WAKE_ENCODE_WIDTH - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default wake-encode-width configuration value.
- DEFAULT_WAKE_THRESHOLD - Static variable in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
default wake-threshold value.
- description - Variable in exception io.spokestack.spokestack.android.SpeechRecognizerError
-
The description of the Android system error code.
- detachBuffer() - Method in class io.spokestack.spokestack.SpeechContext
-
removes the attached frame buffer.
- DigitsParser - Class in io.spokestack.spokestack.nlu.tensorflow.parsers
-
This parser converts a string representation of a sequence of digits into the
corresponding sequence of digits.
- DigitsParser() - Constructor for class io.spokestack.spokestack.nlu.tensorflow.parsers.DigitsParser
-
Create a new digit parser.
- disconnect() - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient
-
disconnects the websocket.
- dispatch(SpeechContext.Event) - Method in class io.spokestack.spokestack.SpeechContext
-
dispatches a speech event.
- dispatch(TTSEvent) - Method in class io.spokestack.spokestack.tts.TTSComponent
-
Notify all subscribed TTS listeners that an event has occurred.
- dispatchTrace(EventTracer.Level, String) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Dispatches an NLU trace message.
- done() - Method in class io.spokestack.spokestack.util.AsyncResult
-
- IdentityParser - Class in io.spokestack.spokestack.nlu.tensorflow.parsers
-
A parser that does not alter string slot values recognized by the model.
- IdentityParser() - Constructor for class io.spokestack.spokestack.nlu.tensorflow.parsers.IdentityParser
-
Create a new identity parser.
- init() - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient
-
sends an initial empty request message to authenticate with the server.
- inputs(int) - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel
-
Get the input buffer at the specified index.
- IntegerParser - Class in io.spokestack.spokestack.nlu.tensorflow.parsers
-
This parser converts string representations of integers into integers.
- IntegerParser() - Constructor for class io.spokestack.spokestack.nlu.tensorflow.parsers.IntegerParser
-
Create a new integer parser.
- io.spokestack.spokestack - package io.spokestack.spokestack
-
The Spokestack package contains the core classes that implement the speech
recognition pipeline.
- io.spokestack.spokestack.android - package io.spokestack.spokestack.android
-
This package contains the android-specific dependencies used in
audio/speech processing.
- io.spokestack.spokestack.asr - package io.spokestack.spokestack.asr
-
This package contains classes for interacting with speech recognition
services provided by Spokestack.
- io.spokestack.spokestack.google - package io.spokestack.spokestack.google
-
This package contains google-specific components used for speech
recognition.
- io.spokestack.spokestack.microsoft - package io.spokestack.spokestack.microsoft
-
This package contains microsoft-specific components used for speech
recognition.
- io.spokestack.spokestack.nlu - package io.spokestack.spokestack.nlu
-
This package contains components used for natural language understanding.
- io.spokestack.spokestack.nlu.tensorflow - package io.spokestack.spokestack.nlu.tensorflow
-
This package contains components used to perform NLU with an on-device
TensorFlow Lite model.
- io.spokestack.spokestack.nlu.tensorflow.parsers - package io.spokestack.spokestack.nlu.tensorflow.parsers
-
This package contains slot parsers provided by default with Spokestack and
utility code used across different slot types.
- io.spokestack.spokestack.profile - package io.spokestack.spokestack.profile
-
This package contains pre-built profiles used to configure the speech
pipeline.
- io.spokestack.spokestack.tensorflow - package io.spokestack.spokestack.tensorflow
-
This package contains Tensorflow wrappers used by Spokestack.
- io.spokestack.spokestack.tts - package io.spokestack.spokestack.tts
-
This package contains a client for the Spokestack TTS service.
- io.spokestack.spokestack.util - package io.spokestack.spokestack.util
-
This package contains general utilities for Spokestack.
- io.spokestack.spokestack.wakeword - package io.spokestack.spokestack.wakeword
-
This package contains speech pipeline components used for wakeword
detection.
- io.spokestack.spokestack.webrtc - package io.spokestack.spokestack.webrtc
-
This package wraps the webrtc native modules for Voice Activity Detection
(VAD) and Automatic Gain Control (AGC).
- isActive() - Method in class io.spokestack.spokestack.SpeechContext
-
- isConnected() - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient
-
- isEmpty() - Method in class io.spokestack.spokestack.RingBuffer
-
- isFinal - Variable in class io.spokestack.spokestack.asr.SpokestackASRResponse
-
does the hypothesis represent the full transcript for the transmitted
audio?
- isFull() - Method in class io.spokestack.spokestack.RingBuffer
-
- isManaged() - Method in class io.spokestack.spokestack.SpeechContext
-
- isRunning() - Method in class io.spokestack.spokestack.SpeechPipeline
-
- isSpeech() - Method in class io.spokestack.spokestack.SpeechContext
-
- parse(Map<String, Object>, String) - Method in class io.spokestack.spokestack.nlu.tensorflow.parsers.DigitsParser
-
- parse(Map<String, Object>, String) - Method in class io.spokestack.spokestack.nlu.tensorflow.parsers.IdentityParser
-
- parse(Map<String, Object>, String) - Method in class io.spokestack.spokestack.nlu.tensorflow.parsers.IntegerParser
-
- parse(Map<String, Object>, String) - Method in class io.spokestack.spokestack.nlu.tensorflow.parsers.SelsetParser
-
- parse(Map<String, Object>, String) - Method in interface io.spokestack.spokestack.nlu.tensorflow.SlotParser
-
Parse a raw string value from an utterance into a typed value for a
concrete slot.
- pauseContent() - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
Pause playback of any current content, storing the player's state
internally for later resumption.
- PipelineProfile - Interface in io.spokestack.spokestack
-
A pipeline profile encapsulates a series of configuration values tuned for
a specific task to make building a
SpeechPipeline
more convenient.
- playContent() - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
Start or resume playback of any TTS responses.
- PreASRMicrophoneInput - Class in io.spokestack.spokestack.android
-
A variant of
MicrophoneInput
that releases its internal
AudioRecord
when ASR is activated to avoid microphone conflicts.
- PreASRMicrophoneInput(SpeechConfig) - Constructor for class io.spokestack.spokestack.android.PreASRMicrophoneInput
-
initializes a new microphone instance and opens the audio recorder.
- prepare() - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
Establish the media player and allocate its internal resources.
- prepare() - Method in class io.spokestack.spokestack.tts.TTSManager
-
Dynamically constructs TTS component classes, allocating any resources
they control.
- prepareTts() - Method in class io.spokestack.spokestack.Spokestack
-
Dynamically constructs TTS component classes, allocating any resources
they control.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.ActivationTimeout
-
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.android.AndroidSpeechRecognizer
-
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.asr.KeywordRecognizer
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.asr.SpokestackCloudRecognizer
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.google.GoogleSpeechRecognizer
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.microsoft.AzureSpeechRecognizer
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in interface io.spokestack.spokestack.SpeechProcessor
-
processes the current speech frame.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.SpeechSampler
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.webrtc.AcousticNoiseSuppressor
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.webrtc.AutomaticGainControl
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.webrtc.VoiceActivityDetector
-
processes a frame of audio.
- process(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.webrtc.VoiceActivityTrigger
-
processes a frame of audio.
- PushToTalkAndroidASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that relies on manual pipeline activation,
using Android's SpeechRecognizer
API for ASR.
- PushToTalkAndroidASR() - Constructor for class io.spokestack.spokestack.profile.PushToTalkAndroidASR
-
- PushToTalkAzureASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that relies on manual pipeline activation, using
Azure Speech Service for ASR.
- PushToTalkAzureASR() - Constructor for class io.spokestack.spokestack.profile.PushToTalkAzureASR
-
- PushToTalkGoogleASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that relies on manual pipeline activation, using
Google Speech for ASR.
- PushToTalkGoogleASR() - Constructor for class io.spokestack.spokestack.profile.PushToTalkGoogleASR
-
- PushToTalkSpokestackASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that relies on manual pipeline activation, using
Spokestack's cloud-based ASR.
- PushToTalkSpokestackASR() - Constructor for class io.spokestack.spokestack.profile.PushToTalkSpokestackASR
-
- put(String, Object) - Method in class io.spokestack.spokestack.SpeechConfig
-
writes a configuration value.
- read(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.android.MicrophoneInput
-
reads a frame from the microphone.
- read(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.android.NoInput
-
simulates reading an audio frame.
- read(SpeechContext, ByteBuffer) - Method in class io.spokestack.spokestack.android.PreASRMicrophoneInput
-
Reads a frame from the microphone if the pipeline is inactive.
- read() - Method in class io.spokestack.spokestack.RingBuffer
-
reads the next value from the buffer.
- read(SpeechContext, ByteBuffer) - Method in interface io.spokestack.spokestack.SpeechInput
-
reads a set of samples into a frame buffer.
- registerCallback(Callback<T>) - Method in class io.spokestack.spokestack.util.AsyncResult
-
Register a callback to be executed when the task's result is available.
- registerLifecycle(Lifecycle) - Method in class io.spokestack.spokestack.tts.TTSManager
-
Registers the currently active lifecycle with the manager, allowing any
output classes to handle media player components based on system
lifecycle events.
- registerSlotParser(String, String) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU.Builder
-
Register a custom parser for a slot of a specified type.
- release() - Method in class io.spokestack.spokestack.tts.TTSManager
-
Stops activity in the TTS subsystem and releases any resources held by
its components.
- releaseTts() - Method in class io.spokestack.spokestack.Spokestack
-
Stops activity in the TTS subsystem and releases any resources held by
its components.
- removeListener(TraceListener) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU
-
Remove a trace listener, allowing it to be garbage collected.
- removeListener(OnSpeechEventListener) - Method in class io.spokestack.spokestack.SpeechPipeline
-
Remove a pipeline listener, allowing it to be garbage collected.
- removeListener(SpokestackAdapter) - Method in class io.spokestack.spokestack.Spokestack
-
Remove a Spokestack event listener, allowing it to be garbage collected.
- removeListener(TTSListener) - Method in class io.spokestack.spokestack.tts.TTSManager
-
Remove a TTS listener, allowing it to be garbage collected.
- removeOnSpeechEventListener(OnSpeechEventListener) - Method in class io.spokestack.spokestack.SpeechContext
-
detaches a speech listener.
- removeTraceListener(TraceListener) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Remove a trace listener, allowing it to be garbage collected.
- reset() - Method in class io.spokestack.spokestack.ActivationTimeout
-
- reset() - Method in class io.spokestack.spokestack.android.AndroidSpeechRecognizer
-
- reset() - Method in class io.spokestack.spokestack.asr.KeywordRecognizer
-
- reset() - Method in class io.spokestack.spokestack.asr.SpokestackCloudRecognizer
-
- reset() - Method in class io.spokestack.spokestack.google.GoogleSpeechRecognizer
-
- reset() - Method in class io.spokestack.spokestack.microsoft.AzureSpeechRecognizer
-
- reset() - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Resets state held by the context object, including request metadata.
- reset() - Method in class io.spokestack.spokestack.RingBuffer
-
resets the read head buffer, marking the buffer empty, but not
modifying any elements.
- reset() - Method in class io.spokestack.spokestack.SpeechContext
-
resets the context to the default state.
- reset() - Method in interface io.spokestack.spokestack.SpeechProcessor
-
resets all state internal to the stage.
- reset() - Method in class io.spokestack.spokestack.SpeechSampler
-
- reset() - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel.Loader
-
resets the loader to the default state.
- reset() - Method in class io.spokestack.spokestack.wakeword.WakewordTrigger
-
- reset() - Method in class io.spokestack.spokestack.webrtc.AcousticNoiseSuppressor
-
- reset() - Method in class io.spokestack.spokestack.webrtc.AutomaticGainControl
-
- reset() - Method in class io.spokestack.spokestack.webrtc.VoiceActivityDetector
-
- reset() - Method in class io.spokestack.spokestack.webrtc.VoiceActivityTrigger
-
- rewind() - Method in class io.spokestack.spokestack.RingBuffer
-
seeks the read head to the beginning, marking it full and
allowing all elements to be read.
- RingBuffer - Class in io.spokestack.spokestack
-
a simple circular buffer of floating point values.
- RingBuffer(int) - Constructor for class io.spokestack.spokestack.RingBuffer
-
constructs a new ring buffer instance.
- run() - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel
-
executes the model using the attached buffers.
- run(Runnable) - Method in class io.spokestack.spokestack.util.TaskHandler
-
Execute the task, either by submitting it to the main Looper
or
running it on the current thread.
- second() - Method in class io.spokestack.spokestack.util.Tuple
-
- seek(int) - Method in class io.spokestack.spokestack.RingBuffer
-
seeks the read head forward.
- SelsetParser - Class in io.spokestack.spokestack.nlu.tensorflow.parsers
-
A parser that resolves selset values to their canonical names.
- SelsetParser() - Constructor for class io.spokestack.spokestack.nlu.tensorflow.parsers.SelsetParser
-
Create a new selset parser.
- sendAudio(ByteBuffer) - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient
-
transmits an audio frame over the websocket.
- setActive(boolean) - Method in class io.spokestack.spokestack.SpeechContext
-
activates speech recognition.
- setAndroidContext(Context) - Method in class io.spokestack.spokestack.SpeechContext
-
sets the Android context.
- setAndroidContext(Context) - Method in class io.spokestack.spokestack.SpeechOutput
-
Sets the output's Android context.
- setAndroidContext(Context) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
Sets the android context for the pipeline.
- setAndroidContext(Context) - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
- setAndroidContext(Context) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Sets the Android context for the pipeline.
- setAndroidContext(Context) - Method in class io.spokestack.spokestack.tts.TTSManager
-
Sets the android context for the TTS Subsystem.
- setConfidence(double) - Method in class io.spokestack.spokestack.SpeechContext
-
updates the current speech confidence level.
- setConfig(SpeechConfig) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU.Builder
-
Attaches a configuration object, overwriting any existing
configuration.
- setConfig(SpeechConfig) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
attaches a pipeline configuration object.
- setConfig(SpeechConfig) - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Sets configuration for all subsystem builders.
- setConfig(SpeechConfig) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Attaches a configuration object.
- setCredentials(String, String) - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient.Builder
-
sets the Spokestack credentials used for authentication.
- setCredentials(String, String) - Method in class io.spokestack.spokestack.tts.SpokestackTTSClient
-
Set the API ID used for synthesis requests.
- setError(Throwable) - Method in class io.spokestack.spokestack.SpeechContext
-
raises an error with the speech context.
- setError(Throwable) - Method in class io.spokestack.spokestack.tts.TTSEvent
-
Set the error represented by this event.
- setInputClass(String) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
sets the class name of the audio input component.
- setLang(String) - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient.Builder
-
sets the language code.
- setLifecycle(Lifecycle) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Sets the manager's current lifecycle.
- setListener(SpokestackCloudClient.Listener) - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient.Builder
-
attaches the listener callback.
- setManaged(boolean) - Method in class io.spokestack.spokestack.SpeechContext
-
signals whether the speech context is being externally managed (audio is
not being read from the microphone by Spokestack's speech pipeline).
- setModelLoader(TensorflowModel.Loader) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU.Builder
-
Attaches a model loader.
- setOutputClass(String) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Sets the class name of the audio output component.
- setPath(String) - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel.Loader
-
sets the file system path to the TF-Lite model.
- setProperty(String, Object) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU.Builder
-
Sets a configuration value.
- setProperty(String, Object) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
sets a pipeline configuration value.
- setProperty(String, Object) - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Sets a configuration value.
- setProperty(String, Object) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Sets a component configuration value.
- setRequestMetadata(HashMap<String, Object>) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Set the metadata for the current request.
- setSampleRate(int) - Method in class io.spokestack.spokestack.asr.SpokestackCloudClient.Builder
-
sets the audio sample rate.
- setSpeech(boolean) - Method in class io.spokestack.spokestack.SpeechContext
-
sets speech detected indicator.
- setStageClasses(List<String>) - Method in class io.spokestack.spokestack.SpeechPipeline.Builder
-
sets the class names of the pipeline stage components in bulk.
- setStatePosition(int) - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel.Loader
-
sets the position of the model's state tensor in its input array.
- setTextEncoder(TextEncoder) - Method in class io.spokestack.spokestack.nlu.tensorflow.TensorflowNLU.Builder
-
Attaches a text encoder.
- setTranscript(String) - Method in class io.spokestack.spokestack.SpeechContext
-
updates the current speech transcript.
- setTtsCallback(TTSCallback) - Method in class io.spokestack.spokestack.tts.SpokestackTTSClient
-
Set the callback that should receive TTS responses.
- setTtsResponse(AudioResponse) - Method in class io.spokestack.spokestack.tts.TTSEvent
-
Attach response data containing the location of synthesized audio.
- setTTSServiceClass(String) - Method in class io.spokestack.spokestack.tts.TTSManager.Builder
-
Sets the class name of the external TTS service component.
- setTtsUrl(String) - Method in class io.spokestack.spokestack.tts.SpokestackTTSClient
-
Set the URL used to synthesize text.
- signBody(String, String) - Static method in class io.spokestack.spokestack.util.Crypto
-
Sign a string (presumably an http request body) and base-64 encode it.
- Slot - Class in io.spokestack.spokestack.nlu
-
A slot extracted during intent classification.
- Slot(String, String, Object) - Constructor for class io.spokestack.spokestack.nlu.Slot
-
Create a new slot.
- Slot(String, String, String, Object) - Constructor for class io.spokestack.spokestack.nlu.Slot
-
Create a new slot with a user-specified type.
- SlotParser - Interface in io.spokestack.spokestack.nlu.tensorflow
-
An interface for components capable of parsing raw string slot values into
concrete objects.
- SpeechConfig - Class in io.spokestack.spokestack
-
Spokestack component configuration
- SpeechConfig() - Constructor for class io.spokestack.spokestack.SpeechConfig
-
initializes a default configuration instance.
- SpeechConfig(Map<String, Object>) - Constructor for class io.spokestack.spokestack.SpeechConfig
-
attaches an existing configuration map.
- SpeechContext - Class in io.spokestack.spokestack
-
Spokestack speech recognition context
- SpeechContext(SpeechConfig) - Constructor for class io.spokestack.spokestack.SpeechContext
-
initializes a new configuration instance.
- SpeechContext.Event - Enum in io.spokestack.spokestack
-
speech event types.
- speechEvent(SpeechContext.Event, SpeechContext) - Method in class io.spokestack.spokestack.SpokestackAdapter
-
Receive events from the speech pipeline.
- SpeechInput - Interface in io.spokestack.spokestack
-
speech input interface.
- SpeechOutput - Class in io.spokestack.spokestack
-
Text-to-speech output.
- SpeechOutput() - Constructor for class io.spokestack.spokestack.SpeechOutput
-
- SpeechPipeline - Class in io.spokestack.spokestack
-
Spokestack speech pipeline.
- SpeechPipeline.Builder - Class in io.spokestack.spokestack
-
speech pipeline builder.
- SpeechProcessor - Interface in io.spokestack.spokestack
-
speech pipeline processor interface.
- SpeechRecognizerError - Exception in io.spokestack.spokestack.android
-
A simple exception class that wraps error codes from android.speech.SpeechRecognizer
.
- SpeechRecognizerError(int) - Constructor for exception io.spokestack.spokestack.android.SpeechRecognizerError
-
Create a new SpeechRecognizerError from an error code provided by the
Android system.
- SpeechRecognizerError.Description - Enum in io.spokestack.spokestack.android
-
An enumeration of the SpeechRecognizer error descriptions aligned with
their integer constant values.
- SpeechSampler - Class in io.spokestack.spokestack
-
speech sampling logger.
- SpeechSampler(SpeechConfig) - Constructor for class io.spokestack.spokestack.SpeechSampler
-
constructs a new sampler instance.
- Spokestack - Class in io.spokestack.spokestack
-
This class combines all Spokestack subsystems into a single component to
provide a unified interface to the library's ASR, NLU, and TTS features.
- Spokestack.Builder - Class in io.spokestack.spokestack
-
Fluent builder interface for configuring Spokestack.
- SpokestackAdapter - Class in io.spokestack.spokestack
-
An abstract adapter class for receiving events from Spokestack modules.
- SpokestackAdapter() - Constructor for class io.spokestack.spokestack.SpokestackAdapter
-
- SpokestackASRResponse - Class in io.spokestack.spokestack.asr
-
A simple data class for deserializing responses from Spokestack's cloud-based
ASR service.
- SpokestackASRResponse(String, String, boolean, SpokestackASRResponse.Hypothesis[]) - Constructor for class io.spokestack.spokestack.asr.SpokestackASRResponse
-
Create a new ASR response.
- SpokestackASRResponse.Hypothesis - Class in io.spokestack.spokestack.asr
-
Data class for a single ASR hypothesis.
- SpokestackCloudClient - Class in io.spokestack.spokestack.asr
-
Spokestack cloud speech client.
- SpokestackCloudClient.Builder - Class in io.spokestack.spokestack.asr
-
Spokestack speech client builder.
- SpokestackCloudClient.Listener - Interface in io.spokestack.spokestack.asr
-
speech client listener callback interface.
- SpokestackCloudRecognizer - Class in io.spokestack.spokestack.asr
-
Spokestack cloud speech recognizer
- SpokestackCloudRecognizer(SpeechConfig) - Constructor for class io.spokestack.spokestack.asr.SpokestackCloudRecognizer
-
initializes a new recognizer instance.
- SpokestackCloudRecognizer(SpeechConfig, SpokestackCloudClient.Builder) - Constructor for class io.spokestack.spokestack.asr.SpokestackCloudRecognizer
-
initializes a new recognizer instance, useful for testing.
- SpokestackModule - Enum in io.spokestack.spokestack
-
A simple list of Spokestack modules used for unified event dispatching.
- SpokestackSynthesisResponse - Class in io.spokestack.spokestack.tts
-
A simple wrapper class used for parsing GraphQL responses from the Spokestack
TTS service.
- SpokestackSynthesisResponse() - Constructor for class io.spokestack.spokestack.tts.SpokestackSynthesisResponse
-
- SpokestackTTSClient - Class in io.spokestack.spokestack.tts
-
Spokestack TTS client.
- SpokestackTTSClient(TTSCallback) - Constructor for class io.spokestack.spokestack.tts.SpokestackTTSClient
-
Create a new Spokestack TTS client.
- SpokestackTTSClient(TTSCallback, OkHttpClient) - Constructor for class io.spokestack.spokestack.tts.SpokestackTTSClient
-
Create a new Spokestack TTS client with an API ID and a provided HTTP
client.
- SpokestackTTSOutput - Class in io.spokestack.spokestack.tts
-
Audio player component for the TTS subsystem.
- SpokestackTTSOutput(SpeechConfig) - Constructor for class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
Creates a new audio output component.
- SpokestackTTSService - Class in io.spokestack.spokestack.tts
-
- SpokestackTTSService(SpeechConfig) - Constructor for class io.spokestack.spokestack.tts.SpokestackTTSService
-
Creates a new TTS service component.
- start() - Method in class io.spokestack.spokestack.SpeechPipeline
-
starts up the speech pipeline.
- start() - Method in class io.spokestack.spokestack.Spokestack
-
Starts the speech pipeline in order to process user input via the
microphone (or chosen input class).
- states() - Method in class io.spokestack.spokestack.tensorflow.TensorflowModel
-
- status - Variable in class io.spokestack.spokestack.asr.SpokestackASRResponse
-
server status: "ok" or "error".
- stop() - Method in class io.spokestack.spokestack.SpeechPipeline
-
stops the speech pipeline and releases all resources.
- stop() - Method in class io.spokestack.spokestack.Spokestack
-
Stops the speech pipeline and releases all its internal resources.
- stopPlayback() - Method in class io.spokestack.spokestack.SpeechOutput
-
Stops playback of any currently playing and queued synthesis results and
clears the play queue.
- stopPlayback() - Method in class io.spokestack.spokestack.Spokestack
-
Stops playback of any playing or queued synthesis results.
- stopPlayback() - Method in class io.spokestack.spokestack.tts.SpokestackTTSOutput
-
- stopPlayback() - Method in class io.spokestack.spokestack.tts.TTSManager
-
Stops playback of any playing or queued synthesis results.
- SynthesisRequest - Class in io.spokestack.spokestack.tts
-
A simple wrapper class comprising the options available when making a
synthesis request.
- SynthesisRequest(CharSequence, SynthesisRequest.Mode, String, Map<String, String>) - Constructor for class io.spokestack.spokestack.tts.SynthesisRequest
-
Construct a fully specified synthesis request object.
- SynthesisRequest.Builder - Class in io.spokestack.spokestack.tts
-
A fluent interface for constructing a TTSInput
object piecemeal.
- SynthesisRequest.Mode - Enum in io.spokestack.spokestack.tts
-
The types of input available for synthesized speech.
- synthesize(SynthesisRequest) - Method in class io.spokestack.spokestack.Spokestack
-
Synthesizes a piece of text or SSML, dispatching the result to any
registered listeners.
- synthesize(SynthesisRequest) - Method in class io.spokestack.spokestack.tts.SpokestackTTSClient
-
Synthesize speech via the Spokestack TTS API.
- synthesize(SynthesisRequest) - Method in class io.spokestack.spokestack.tts.SpokestackTTSService
-
- synthesize(SynthesisRequest) - Method in class io.spokestack.spokestack.tts.TTSManager
-
Synthesizes a piece of text or SSML, dispatching the result to any
registered listeners.
- synthesize(SynthesisRequest) - Method in class io.spokestack.spokestack.tts.TTSService
-
Synthesizes a piece of text or SSML, dispatching the result to any
registered listeners.
- TaskHandler - Class in io.spokestack.spokestack.util
-
A generic task handler that executes Runnable
s on either the current
thread or the application's main thread.
- TaskHandler(boolean) - Constructor for class io.spokestack.spokestack.util.TaskHandler
-
Initialize a new task handler.
- TensorflowModel - Class in io.spokestack.spokestack.tensorflow
-
Tensorflow-Lite model wrapper and loader
- TensorflowModel(TensorflowModel.Loader) - Constructor for class io.spokestack.spokestack.tensorflow.TensorflowModel
-
constructs a new tensorflow model.
- TensorflowModel.Loader - Class in io.spokestack.spokestack.tensorflow
-
loader (builder) class for the tensorflow model.
- TensorflowModel.Loader.DType - Enum in io.spokestack.spokestack.tensorflow
-
tensor data types.
- TensorflowNLU - Class in io.spokestack.spokestack.nlu.tensorflow
-
On-device natural language understanding powered by DistilBERT and TensorFlow
Lite.
- TensorflowNLU.Builder - Class in io.spokestack.spokestack.nlu.tensorflow
-
Fluent builder interface for initializing a TensorFlow NLU model.
- text - Variable in class io.spokestack.spokestack.tts.SynthesisRequest
-
The text to be synthesized.
- TextEncoder - Interface in io.spokestack.spokestack.nlu.tensorflow
-
A simple interface for translating between raw text and neural model
input.
- TFWakewordAndroidASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses TensorFlow Lite for wakeword detection
and Android's SpeechRecognizer
API for ASR.
- TFWakewordAndroidASR() - Constructor for class io.spokestack.spokestack.profile.TFWakewordAndroidASR
-
- TFWakewordAzureASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses TensorFlow Lite for wakeword detection
and Azure Speech Service for ASR.
- TFWakewordAzureASR() - Constructor for class io.spokestack.spokestack.profile.TFWakewordAzureASR
-
- TFWakewordGoogleASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses TensorFlow Lite for wakeword detection
and Google Speech for ASR.
- TFWakewordGoogleASR() - Constructor for class io.spokestack.spokestack.profile.TFWakewordGoogleASR
-
- TFWakewordSpokestackASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses TensorFlow Lite for wakeword detection
and Spokestack's cloud-based ASR.
- TFWakewordSpokestackASR() - Constructor for class io.spokestack.spokestack.profile.TFWakewordSpokestackASR
-
- toString() - Method in class io.spokestack.spokestack.nlu.Slot
-
- toString() - Method in enum io.spokestack.spokestack.SpeechContext.Event
-
- trace(EventTracer.Level, String, Object...) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Raises a trace event.
- trace(EventTracer.Level, String, Object...) - Method in class io.spokestack.spokestack.SpeechContext
-
raises a trace event.
- trace(SpokestackModule, String) - Method in class io.spokestack.spokestack.SpokestackAdapter
-
Receive trace messages from any module.
- traceDebug(String, Object...) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Traces a debug level message.
- traceDebug(String, Object...) - Method in class io.spokestack.spokestack.SpeechContext
-
traces a debug level message.
- traceError(String, Object...) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Traces an error level message.
- traceInfo(String, Object...) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Traces an informational level message.
- traceInfo(String, Object...) - Method in class io.spokestack.spokestack.SpeechContext
-
traces an informational level message.
- TraceListener - Interface in io.spokestack.spokestack.nlu
-
A simple interface implemented by classes interested in receiving trace
events.
- tracePerf(String, Object...) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Traces a performance level message.
- tracePerf(String, Object...) - Method in class io.spokestack.spokestack.SpeechContext
-
traces a performance level message.
- traceWarn(String, Object...) - Method in class io.spokestack.spokestack.nlu.NLUContext
-
Traces a warning level message.
- transcript - Variable in class io.spokestack.spokestack.asr.SpokestackASRResponse.Hypothesis
-
text of the hypothesis.
- TranscriptEditor - Interface in io.spokestack.spokestack
-
A functional interface used to edit an ASR transcript before it is passed to
the NLU subsystem for classification.
- TTSCallback - Class in io.spokestack.spokestack.tts
-
An interface used to receive playback URLs asynchronously from the Spokestack
TTS service.
- TTSCallback() - Constructor for class io.spokestack.spokestack.tts.TTSCallback
-
- TTSComponent - Class in io.spokestack.spokestack.tts
-
The basic interface required of all TTS components.
- TTSComponent() - Constructor for class io.spokestack.spokestack.tts.TTSComponent
-
- ttsEvent(TTSEvent) - Method in class io.spokestack.spokestack.SpokestackAdapter
-
Receive events from the TTS module.
- TTSEvent - Class in io.spokestack.spokestack.tts
-
A wrapper for events in the TTS subsystem.
- TTSEvent(TTSEvent.Type) - Constructor for class io.spokestack.spokestack.tts.TTSEvent
-
Create an event with the specified type containing no other data.
- TTSEvent.Type - Enum in io.spokestack.spokestack.tts
-
Enum representing the type of event being dispatched.
- TTSListener - Interface in io.spokestack.spokestack.tts
-
Text-to-speech event callback interface.
- TTSManager - Class in io.spokestack.spokestack.tts
-
Manager for text-to-speech output in Spokestack.
- TTSManager.Builder - Class in io.spokestack.spokestack.tts
-
TTS manager builder.
- TTSService - Class in io.spokestack.spokestack.tts
-
Text-to-speech service interface.
- TTSService() - Constructor for class io.spokestack.spokestack.tts.TTSService
-
- Tuple<T,U> - Class in io.spokestack.spokestack.util
-
A simple wrapper for an immutable tuple of objects.
- Tuple(T, U) - Constructor for class io.spokestack.spokestack.util.Tuple
-
Create a new tuple.
- type - Variable in class io.spokestack.spokestack.tts.TTSEvent
-
The event type.
- VADTriggerAndroidASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses voice activity detection to activate
Android's SpeechRecognizer
API for ASR.
- VADTriggerAndroidASR() - Constructor for class io.spokestack.spokestack.profile.VADTriggerAndroidASR
-
- VADTriggerAzureASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses voice activity detection to activate ASR
via Azure Speech Service.
- VADTriggerAzureASR() - Constructor for class io.spokestack.spokestack.profile.VADTriggerAzureASR
-
- VADTriggerGoogleASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses voice activity detection to activate
Google Speech ASR.
- VADTriggerGoogleASR() - Constructor for class io.spokestack.spokestack.profile.VADTriggerGoogleASR
-
- VADTriggerSpokestackASR - Class in io.spokestack.spokestack.profile
-
A speech pipeline profile that uses voice activity detection to activate
Spokestack's cloud-based ASR.
- VADTriggerSpokestackASR() - Constructor for class io.spokestack.spokestack.profile.VADTriggerSpokestackASR
-
- value() - Method in enum io.spokestack.spokestack.util.EventTracer.Level
-
- valueOf(String) - Static method in enum io.spokestack.spokestack.android.AudioRecordError.Description
-
Returns the enum constant of this type with the specified name.
- valueOf(int) - Static method in enum io.spokestack.spokestack.android.AudioRecordError.Description
-
Retrieve an error description by code.
- valueOf(String) - Static method in enum io.spokestack.spokestack.android.SpeechRecognizerError.Description
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.spokestack.spokestack.SpeechContext.Event
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.spokestack.spokestack.SpokestackModule
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.spokestack.spokestack.tensorflow.TensorflowModel.Loader.DType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.spokestack.spokestack.tts.SynthesisRequest.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.spokestack.spokestack.tts.TTSEvent.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.spokestack.spokestack.util.EventTracer.Level
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.spokestack.spokestack.android.AudioRecordError.Description
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- VALUES - Static variable in enum io.spokestack.spokestack.android.SpeechRecognizerError.Description
-
A cache of the error descriptions to reduce overhead accessing them.
- values() - Static method in enum io.spokestack.spokestack.android.SpeechRecognizerError.Description
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.spokestack.spokestack.SpeechContext.Event
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.spokestack.spokestack.SpokestackModule
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.spokestack.spokestack.tensorflow.TensorflowModel.Loader.DType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.spokestack.spokestack.tts.SynthesisRequest.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.spokestack.spokestack.tts.TTSEvent.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.spokestack.spokestack.util.EventTracer.Level
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- voice - Variable in class io.spokestack.spokestack.tts.SynthesisRequest
-
The voice in which the text should be synthesized.
- VoiceActivityDetector - Class in io.spokestack.spokestack.webrtc
-
Voice Activity Detection (VAD) pipeline component
- VoiceActivityDetector(SpeechConfig) - Constructor for class io.spokestack.spokestack.webrtc.VoiceActivityDetector
-
constructs a new trigger instance.
- VoiceActivityTrigger - Class in io.spokestack.spokestack.webrtc
-
Voice Activity Detector (VAD) trigger pipeline component
- VoiceActivityTrigger(SpeechConfig) - Constructor for class io.spokestack.spokestack.webrtc.VoiceActivityTrigger
-
constructs a new trigger instance.
- WakewordTrigger - Class in io.spokestack.spokestack.wakeword
-
wakeword Detection pipeline component
- WakewordTrigger(SpeechConfig) - Constructor for class io.spokestack.spokestack.wakeword.WakewordTrigger
-
constructs a new trigger instance.
- WakewordTrigger(SpeechConfig, TensorflowModel.Loader) - Constructor for class io.spokestack.spokestack.wakeword.WakewordTrigger
-
constructs a new trigger instance, for testing.
- withAndroidContext(Context) - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Sets the Android Context for the pipeline.
- withConfidence(float) - Method in class io.spokestack.spokestack.nlu.NLUResult.Builder
-
Set the confidence for the intent classification.
- withContext(Map<String, Object>) - Method in class io.spokestack.spokestack.nlu.NLUResult.Builder
-
Attaches the context returned by the NLU service.
- withData(Map<String, String>) - Method in class io.spokestack.spokestack.tts.SynthesisRequest.Builder
-
Specify additional data to be used for the synthesis request.
- withError(Throwable) - Method in class io.spokestack.spokestack.nlu.NLUResult.Builder
-
Attaches an error encountered while performing NLU.
- withIntent(String) - Method in class io.spokestack.spokestack.nlu.NLUResult.Builder
-
Attaches the user intent classified by the NLU service.
- withLifecycle(Lifecycle) - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Sets the Android Lifecycle used for management of TTS playback.
- withMode(SynthesisRequest.Mode) - Method in class io.spokestack.spokestack.tts.SynthesisRequest.Builder
-
Specify the synthesis mode.
- withoutAutoClassification() - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Signal that Spokestack's NLU subsystem should not be automatically
run on ASR transcripts.
- withoutAutoPlayback() - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Signal that Spokestack should not automatically manage TTS playback.
- withoutNlu() - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Signal that Spokestack's NLU subsystem should not be used.
- withoutSpeechPipeline() - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Signal that Spokestack's speech pipeline should not be used to
recognize speech.
- withoutTts() - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Signal that Spokestack's TTS subsystem should not be used.
- withoutWakeword() - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Signal that Spokestack's TensorFlow Lite wakeword detector should not
be used.
- withSlots(Map<String, Slot>) - Method in class io.spokestack.spokestack.nlu.NLUResult.Builder
-
Attaches the slot values extracted from the user utterance.
- withTranscriptEditor(TranscriptEditor) - Method in class io.spokestack.spokestack.Spokestack.Builder
-
Sets a transcript editor used to alter ASR transcripts before they
are classified by the NLU subsystem.
- withVoice(String) - Method in class io.spokestack.spokestack.tts.SynthesisRequest.Builder
-
Specify the voice to be used for synthesis.
- write(float) - Method in class io.spokestack.spokestack.RingBuffer
-
writes the next value to the buffer.