Index

A B C D E F G H I J L M N O P R S T U V W _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abort() - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Aborts the audio playback immediately.

abort() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Aborts the playback of audio data.

absolutePath(String) - Static method in class com.vivoka.vsdk.util.FileSystem

Converts a relative path to an absolute path.

ACCEPTED - Enum constant in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultStatus

Accepted: Audio was sent and something was recognized

activeStartRules - Variable in class com.vivoka.vsdk.asr.utils.AsrResult

A list of start rules from all active search contexts at the time the result was generated.

addData(String, String) - Method in class com.vivoka.vsdk.asr.DynamicModel

Adds a slot value to the model.

addData(String, String, ArrayList<String>) - Method in class com.vivoka.vsdk.asr.DynamicModel

Adds a slot value with custom phonetic transcriptions to the model.

addData(String, ArrayList<String>) - Method in class com.vivoka.vsdk.asr.DynamicModel

Adds a slot values to the model.

addMarker(WordMarker) - Method in class com.vivoka.vsdk.tts.utils.WordMarkerManager

addRecord(String, Buffer) - Method in class com.vivoka.vsdk.biometrics.Model

Add a record from a buffer to the model for a specific user.

addRecord(String, String) - Method in class com.vivoka.vsdk.biometrics.Model

Add a record from file to the model for a specific user.

addRecords(String, List<Buffer>) - Method in class com.vivoka.vsdk.biometrics.Model

Add records from a list of buffers to the model for a specific user.

analyseRecord(Buffer) - Method in class com.vivoka.vsdk.biometrics.Model

Analyse a record from a buffer.

analyseRecord(String) - Method in class com.vivoka.vsdk.biometrics.Model

Analyse a record from a file.

append(byte[]) - Method in class com.vivoka.vsdk.audio.Buffer

Appends raw byte array audio data to the buffer.

append(short[]) - Method in class com.vivoka.vsdk.audio.Buffer

Appends raw short array audio data to the buffer.

append(Buffer) - Method in class com.vivoka.vsdk.audio.Buffer

Appends the contents of another buffer to this buffer.

append(ArrayList<T>) - Method in class com.vivoka.vsdk.audio.Buffer

Appends audio data from a generic list to the buffer.

ASR - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.ResultType

AsrResult - Class in com.vivoka.vsdk.asr.utils

Represents the top-level ASR (Automatic Speech Recognition) result.

AsrResult() - Constructor for class com.vivoka.vsdk.asr.utils.AsrResult

Constructs an AsrResult object with empty values.

AsrResultHypothesis - Class in com.vivoka.vsdk.asr.utils

Represents a single hypothesis within an AsrResult.

AsrResultHypothesis() - Constructor for class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

Constructs an AsrResultHypothesis object with empty values.

AsrResultItem - Class in com.vivoka.vsdk.asr.utils

Abstract base class representing a recognized item in an ASR hypothesis.

AsrResultItem() - Constructor for class com.vivoka.vsdk.asr.utils.AsrResultItem

AsrResultParser - Class in com.vivoka.vsdk.asr.utils

Utility class responsible for parsing ASR result data from JSON into structured Java objects.

AsrResultParser() - Constructor for class com.vivoka.vsdk.asr.utils.AsrResultParser

AsrResultTag - Class in com.vivoka.vsdk.asr.utils

Represents a tag item that can group terminals and/or other tags.

AsrResultTag() - Constructor for class com.vivoka.vsdk.asr.utils.AsrResultTag

Constructs an AsrResultTag object with empty values.

AsrResultTerminal - Class in com.vivoka.vsdk.asr.utils

Represents a terminal item — a transcribed word or token recognized in the audio stream.

AsrResultTerminal() - Constructor for class com.vivoka.vsdk.asr.utils.AsrResultTerminal

Constructs an AsrResultTerminal object with empty values.

AssetsExtractor - Class in com.vivoka.vsdk.util

Utility class for extracting static assets from the APK at runtime.

AssetsExtractor() - Constructor for class com.vivoka.vsdk.util.AssetsExtractor

AudioPlayer - Class in com.vivoka.vsdk.audio.consumers

AudioPlayer is a consumer module that plays audio buffers.

AudioPlayer(int, int) - Constructor for class com.vivoka.vsdk.audio.consumers.AudioPlayer

Constructs an AudioPlayer with the specified sample rate and channel count that plays audio on the default audio output device.

AudioPlayer(int, int, AudioAttributes) - Constructor for class com.vivoka.vsdk.audio.consumers.AudioPlayer

Constructs an AudioPlayer with the specified sample rate, channel count, and audio attributes.

AudioProgress - Class in com.vivoka.vsdk.audio

Represents the progress of audio playback.

AudioProgress(long, int, int, byte[], boolean) - Constructor for class com.vivoka.vsdk.audio.AudioProgress

Constructs an AudioProgress object with the specified parameters.

AudioRecorder - Class in com.vivoka.vsdk.audio.producers

AudioRecorder is a producer module that captures audio from the device's microphone.

AudioRecorder() - Constructor for class com.vivoka.vsdk.audio.producers.AudioRecorder

Constructs an AudioRecorder with default parameters.

AudioRecorder(int) - Constructor for class com.vivoka.vsdk.audio.producers.AudioRecorder

Constructs an AudioRecorder with the specified audio source.

AudioRecorder(int, int, int) - Constructor for class com.vivoka.vsdk.audio.producers.AudioRecorder

Constructs an AudioRecorder with the specified sample rate, channel configuration, and buffer size.

AudioRecorder(int, int, int, int) - Constructor for class com.vivoka.vsdk.audio.producers.AudioRecorder

Constructs an AudioRecorder with the specified sample rate, channel configuration, buffer size, and audio source.

AUTHENTICATION - Enum constant in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultType

Authenticator - Class in com.vivoka.vsdk.biometrics

Base class for biometric authenticators.

Authenticator(String, Model, IRecognizerListener) - Constructor for class com.vivoka.vsdk.biometrics.Authenticator

B

bAssert(boolean, String) - Static method in exception class com.vivoka.vsdk.Exception

beginTime - Variable in class com.vivoka.vsdk.asr.utils.AsrResult

Start timestamp of the audio segment this result corresponds to.

beginTime - Variable in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

Start time of the audio segment specific to this hypothesis.

beginTime - Variable in class com.vivoka.vsdk.asr.utils.AsrResultItem

Start timestamp (in ms) of the recognized item in the audio stream.

buffer - Variable in class com.vivoka.vsdk.audio.AudioProgress

Represents the audio buffer being played.

Buffer - Class in com.vivoka.vsdk.audio

The Buffer class provides an abstraction for handling audio data in different formats.

Buffer(int, int) - Constructor for class com.vivoka.vsdk.audio.Buffer

Constructs a new Buffer with specified channel count and sample rate.

Buffer(int, int, byte[]) - Constructor for class com.vivoka.vsdk.audio.Buffer

Constructs a new Buffer with the given byte array of audio data.

Buffer(int, int, short[]) - Constructor for class com.vivoka.vsdk.audio.Buffer

Constructs a new Buffer with the given short array of audio data.

Buffer(int, int, ArrayList<T>) - Constructor for class com.vivoka.vsdk.audio.Buffer

Constructs a new Buffer with audio data in a generic list format.

Buffer(Buffer) - Constructor for class com.vivoka.vsdk.audio.Buffer

Constructs a new Buffer as a deep copy of another buffer.

BufferForwarder - Class in com.vivoka.vsdk.audio.producers

BufferForwarder is a producer module that allows the user to forward audio buffers to a pipeline consumers.

BufferForwarder() - Constructor for class com.vivoka.vsdk.audio.producers.BufferForwarder

Constructs a BufferForwarder that can forward audio buffers to consumers.

BufferForwarder(boolean) - Constructor for class com.vivoka.vsdk.audio.producers.BufferForwarder

Constructs a BufferForwarder that can forward audio buffers to consumers.

BufferModule - Class in com.vivoka.vsdk.audio

The BufferModule acts as both a consumer and a producer, enabling the forwarding of buffers from a source pipeline to a target pipeline.

BufferModule() - Constructor for class com.vivoka.vsdk.audio.BufferModule

BufferModuleIn - Class in com.vivoka.vsdk.audio.consumers

Represents a module that consumes audio buffers and appends them to a buffer that can be retrieved for playback or further processing.

BufferModuleIn(int, int) - Constructor for class com.vivoka.vsdk.audio.consumers.BufferModuleIn

Constructs a BufferModuleIn with the specified channel count and sample rate.

BufferModuleOut - Class in com.vivoka.vsdk.audio.producers

Deprecated.

BufferModuleOut(BufferModuleIn) - Constructor for class com.vivoka.vsdk.audio.producers.BufferModuleOut

Deprecated.

BufferStreamer - Class in com.vivoka.vsdk.audio.producers

BufferStreamer is a producer module that allows the user to dispatch audio buffers to a pipeline consumers.

BufferStreamer() - Constructor for class com.vivoka.vsdk.audio.producers.BufferStreamer

Constructs a BufferStreamer with the default acceleration rate of 1.0.

BufferStreamer(double) - Constructor for class com.vivoka.vsdk.audio.producers.BufferStreamer

Constructs a BufferStreamer with the specified acceleration rate.

BufferUtils - Class in com.vivoka.vsdk.util

Utility class for working with audio buffers.

BufferUtils() - Constructor for class com.vivoka.vsdk.util.BufferUtils

C

cAssert(int, String) - Static method in exception class com.vivoka.vsdk.Exception

Channel - Class in com.vivoka.vsdk.tts

Abstract class representing a channel in the TTS system.

Channel(String, String, IChannelListener) - Constructor for class com.vivoka.vsdk.tts.Channel

Channel.ErrorCode - Enum Class in com.vivoka.vsdk.tts

Enumeration of error codes for channel errors.

Channel.EventCode - Enum Class in com.vivoka.vsdk.tts

Enumeration of event codes for channel events.

ChannelExtractor - Class in com.vivoka.vsdk.audio.modifiers

ChannelExtractor is a module that extracts a specific channel from a multi-channel audio buffer.

ChannelExtractor() - Constructor for class com.vivoka.vsdk.audio.modifiers.ChannelExtractor

Constructs a ChannelExtractor that will extract the first channel from the audio buffer.

ChannelExtractor(int) - Constructor for class com.vivoka.vsdk.audio.modifiers.ChannelExtractor

Constructs a ChannelExtractor that will extract the specified channel index from the audio buffer.

channels - Static variable in class com.vivoka.vsdk.Constants

clearAllSlots() - Method in class com.vivoka.vsdk.asr.DynamicModel

Clears all slots values from the model.

clearData() - Method in class com.vivoka.vsdk.audio.Buffer

Clears all audio data from the buffer.

clearPendingData() - Method in class com.vivoka.vsdk.audio.BufferModule

Clears all pending data in the queue.

clearReferenceBuffer() - Method in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

Clears the internal reference buffer used by the speech enhancer.

clearSlot(String) - Method in class com.vivoka.vsdk.asr.DynamicModel

Clears the values of a specific slot.

CLOSED - Enum constant in enum class com.vivoka.vsdk.audio.ProducerModule.State

closeImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Closes the producer module.

closeImpl() - Method in class com.vivoka.vsdk.audio.producers.File

code - Variable in class com.vivoka.vsdk.common.Error

The code of the error

code - Variable in class com.vivoka.vsdk.common.Event

The code of the event

codeString - Variable in class com.vivoka.vsdk.common.Error

The code string of the error

codeString - Variable in class com.vivoka.vsdk.common.Event

The code string of the event

com.vivoka.vsdk - package com.vivoka.vsdk

com.vivoka.vsdk.asr - package com.vivoka.vsdk.asr

com.vivoka.vsdk.asr.utils - package com.vivoka.vsdk.asr.utils

com.vivoka.vsdk.audio - package com.vivoka.vsdk.audio

com.vivoka.vsdk.audio.consumers - package com.vivoka.vsdk.audio.consumers

com.vivoka.vsdk.audio.modifiers - package com.vivoka.vsdk.audio.modifiers

com.vivoka.vsdk.audio.producers - package com.vivoka.vsdk.audio.producers

com.vivoka.vsdk.biometrics - package com.vivoka.vsdk.biometrics

com.vivoka.vsdk.common - package com.vivoka.vsdk.common

com.vivoka.vsdk.nlu - package com.vivoka.vsdk.nlu

com.vivoka.vsdk.nlu.result - package com.vivoka.vsdk.nlu.result

com.vivoka.vsdk.speechenhancement - package com.vivoka.vsdk.speechenhancement

com.vivoka.vsdk.tts - package com.vivoka.vsdk.tts

com.vivoka.vsdk.tts.utils - package com.vivoka.vsdk.tts.utils

com.vivoka.vsdk.util - package com.vivoka.vsdk.util

compile() - Method in class com.vivoka.vsdk.asr.DynamicModel

Compiles the model, preparing it for use after adding slot values.

compile() - Method in class com.vivoka.vsdk.biometrics.Model

Compile the model and save it.

confidence - Variable in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

Normalized confidence score for this hypothesis.

confidence - Variable in class com.vivoka.vsdk.asr.utils.AsrResultItem

Confidence of the item.

Constants - Class in com.vivoka.vsdk

Constants() - Constructor for class com.vivoka.vsdk.Constants

convertBytesToShorts(byte[]) - Static method in class com.vivoka.vsdk.util.BufferUtils

Converts an array of bytes to an array of shorts.

convertShortsToBytes(short[]) - Static method in class com.vivoka.vsdk.util.BufferUtils

Converts an array of shorts to an array of bytes.

D

data_path - Static variable in class com.vivoka.vsdk.Constants

dispatchAudio(int, int, byte[], boolean) - Method in class com.vivoka.vsdk.audio.ProducerModule

Dispatches audio data to the subscribers.

dispatchBuffer(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.ProducerModule

Dispatches audio data to the subscribers.

DynamicModel - Class in com.vivoka.vsdk.asr

Abstract class representing a dynamic model for speech recognition.

DynamicModel(String) - Constructor for class com.vivoka.vsdk.asr.DynamicModel

E

endTime - Variable in class com.vivoka.vsdk.asr.utils.AsrResult

End timestamp of the audio segment this result corresponds to.

endTime - Variable in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

End time of the audio segment specific to this hypothesis.

endTime - Variable in class com.vivoka.vsdk.asr.utils.AsrResultItem

End timestamp (in ms) of the recognized item in the audio stream.

Engine - Class in com.vivoka.vsdk.asr

Abstract class representing the ASR engine.

Engine - Class in com.vivoka.vsdk.biometrics

Abstract class representing the biometric engine.

Engine - Class in com.vivoka.vsdk.nlu

Abstract class representing the NLU engine.

Engine - Class in com.vivoka.vsdk.speechenhancement

Abstract class representing the speech enhancement engine.

Engine - Class in com.vivoka.vsdk.tts

Abstract class representing the TTS engine.

Engine() - Constructor for class com.vivoka.vsdk.asr.Engine

Engine() - Constructor for class com.vivoka.vsdk.biometrics.Engine

Engine() - Constructor for class com.vivoka.vsdk.nlu.Engine

Engine() - Constructor for class com.vivoka.vsdk.speechenhancement.Engine

Engine() - Constructor for class com.vivoka.vsdk.tts.Engine

Entity - Class in com.vivoka.vsdk.nlu.result

Represents a named entity in the NLU result.

Entity(JSONObject) - Constructor for class com.vivoka.vsdk.nlu.result.Entity

eraseConsumer(Iterator<IConsumerModule>) - Method in class com.vivoka.vsdk.audio.Pipeline

Removes a consumer module from the consumer list using the provided iterator.

eraseModifier(Iterator<IModifierModule>) - Method in class com.vivoka.vsdk.audio.Pipeline

Removes a modifier module from the modifier list using the provided iterator.

eraseUser(String) - Method in class com.vivoka.vsdk.biometrics.Model

Erase a user from the model.

Error<ErrorCode> - Class in com.vivoka.vsdk.common

Holds informations about an error.

Error(ErrorType, ErrorCode, String) - Constructor for class com.vivoka.vsdk.common.Error

Constructs a new error.

Error(ErrorType, ErrorCode, String, String) - Constructor for class com.vivoka.vsdk.common.Error

Constructs a new error.

ERROR - Enum constant in enum class com.vivoka.vsdk.common.ErrorType

ErrorType - Enum Class in com.vivoka.vsdk.common

Event<EventCode> - Class in com.vivoka.vsdk.common

Holds informations about an event.

Event(EventCode, String) - Constructor for class com.vivoka.vsdk.common.Event

Constructs an event

Event(EventCode, String, String) - Constructor for class com.vivoka.vsdk.common.Event

Constructs an event

Event(EventCode, String, String, long) - Constructor for class com.vivoka.vsdk.common.Event

Constructs an event

Exception - Exception Class in com.vivoka.vsdk

Base class for all exceptions thrown by the VSDK

Exception(String) - Constructor for exception class com.vivoka.vsdk.Exception

Create a new exception

Exception(String, Throwable) - Constructor for exception class com.vivoka.vsdk.Exception

Create a new exception with a message and a cause

extract(Context, String, String) - Static method in class com.vivoka.vsdk.util.AssetsExtractor

⚠️ [Test-Only] Avoid using this method in production.

extract(Context, String, String, boolean) - Static method in class com.vivoka.vsdk.util.AssetsExtractor

⚠️ [Test-Only] Avoid using this method in production.

F

fAssert(Runnable, String) - Static method in exception class com.vivoka.vsdk.Exception

File - Class in com.vivoka.vsdk.audio.consumers

Represents a module that consumes audio buffers and writes them to a file in raw format.

File - Class in com.vivoka.vsdk.audio.producers

File producer module that reads audio data from a raw file and dispatches it as buffers.

File(String, boolean) - Constructor for class com.vivoka.vsdk.audio.consumers.File

Constructs a File consumer module that writes audio data to the specified file path.

File(String, int, int, int) - Constructor for class com.vivoka.vsdk.audio.producers.File

Constructs a File producer module with the specified parameters.

FileSystem - Class in com.vivoka.vsdk.util

Utility class for working with file system

FileSystem() - Constructor for class com.vivoka.vsdk.util.FileSystem

formattedTimeMarker() - Method in class com.vivoka.vsdk.common.Event

Returns the formatted time marker of the event as string in the format "HH:MM:SS.mmm".

forward(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.producers.BufferForwarder

Forwards the provided audio buffer to the consumers.

fromJson(String) - Static method in class com.vivoka.vsdk.tts.utils.WordMarker

Creates a word marker from a JSON object.

G

GENERATION_ENDED - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

The generation has ended.

GENERATION_STARTED - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

The generation has started.

get(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path.

get(JSONObject, String, Object) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path.

getAccelerationRate() - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

Gets the current acceleration rate of the BufferStreamer.

getActivePipelines() - Static method in class com.vivoka.vsdk.audio.Pipeline

Returns a list of all currently active pipelines.

getAudioData() - Method in class com.vivoka.vsdk.audio.Buffer

Returns the internal audio data.

getAudioData() - Method in class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

getAuthenticator(String, Model, IRecognizerListener) - Method in class com.vivoka.vsdk.biometrics.Engine

Gets or creates an authenticator with the specified name and listener.

getBestHypothesis() - Method in class com.vivoka.vsdk.asr.utils.AsrResult

Get the best hypothesis from the list of hypotheses.

getBoolean(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a boolean.

getBoolean(JSONObject, String, boolean) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a boolean.

getBuffer() - Method in class com.vivoka.vsdk.audio.consumers.BufferModuleIn

Retrieves the Buffer that this module is consuming audio into.

getBufferFromByteList(ArrayList<byte[]>) - Static method in class com.vivoka.vsdk.util.BufferUtils

Converts a list of byte arrays into a single byte array.

getBufferFromShortList(ArrayList<short[]>) - Static method in class com.vivoka.vsdk.util.BufferUtils

Converts a list of short arrays into a single byte array.

getCacheDirPath() - Static method in class com.vivoka.vsdk.Vsdk

getChannel(String, String, IChannelListener) - Method in class com.vivoka.vsdk.tts.Engine

Gets or creates a channel with the specified name and voice.

getChannelCount() - Method in class com.vivoka.vsdk.audio.Buffer

Returns the number of audio channels.

getChannelCount() - Method in class com.vivoka.vsdk.tts.Channel

Gets the number of channels of the audio generated by this channel.

getChannelCount() - Method in class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

getConfiddence() - Method in class com.vivoka.vsdk.nlu.result.Intent

getConfidence() - Method in class com.vivoka.vsdk.nlu.result.Entity

getConfigDirPath() - Static method in class com.vivoka.vsdk.Vsdk

getConfigPath() - Static method in class com.vivoka.vsdk.Vsdk

getConfiguration() - Static method in class com.vivoka.vsdk.Vsdk

getContext() - Static method in class com.vivoka.vsdk.Vsdk

getCurrentVoice() - Method in class com.vivoka.vsdk.tts.Channel

Get the current voice of the channel

getDouble(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a double.

getDouble(JSONObject, String, double) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a double.

getDynamicModel(String) - Method in class com.vivoka.vsdk.asr.Engine

Gets or creates a dynamic model with the specified name.

getEndIndex() - Method in class com.vivoka.vsdk.nlu.result.Entity

getEndPosInAudio() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

getEndPosInText() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

getEnrollmentModelPath() - Method in class com.vivoka.vsdk.biometrics.Model

getEntities() - Method in class com.vivoka.vsdk.nlu.result.Result

getFormattedMessage() - Method in exception class com.vivoka.vsdk.Exception

Get a formatted message for the exception.

getIdentificator(String, Model, IRecognizerListener) - Method in class com.vivoka.vsdk.biometrics.Engine

Gets or creates a identificator with the specified name and listener.

getIndex() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

getInputChannelCount() - Method in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

getInt(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as an int.

getInt(JSONObject, String, int) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as an int.

getIntent() - Method in class com.vivoka.vsdk.nlu.result.Result

getJSONArray(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a JSONArray.

getJSONArray(JSONObject, String, JSONArray) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a json array.

getJSONObject(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a JSONObject.

getJSONObject(JSONObject, String, JSONObject) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a json object.

getLang() - Method in class com.vivoka.vsdk.nlu.result.Result

getLastError() - Method in class com.vivoka.vsdk.audio.ProducerModule

Gets the last error message associated with the producer module.

getLong(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a long.

getLong(JSONObject, String, long) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a long.

getModel() - Method in class com.vivoka.vsdk.biometrics.Recognizer

Get the current model associated with the recognizer.

getModel(String, ModelType) - Method in class com.vivoka.vsdk.biometrics.Engine

Gets or creates a model with the specified name and listener.

getName() - Method in class com.vivoka.vsdk.asr.DynamicModel

Get the name of the model

getName() - Method in class com.vivoka.vsdk.asr.Recognizer

Get the name of the recognizer.

getName() - Method in class com.vivoka.vsdk.biometrics.Model

getName() - Method in class com.vivoka.vsdk.biometrics.Recognizer

Get the name of the recognizer.

getName() - Method in class com.vivoka.vsdk.nlu.Parser

getName() - Method in class com.vivoka.vsdk.nlu.result.Entity

getName() - Method in class com.vivoka.vsdk.nlu.result.Intent

getName() - Method in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

getName() - Method in class com.vivoka.vsdk.tts.Channel

Get the name of the channel

getObject() - Method in class com.vivoka.vsdk.util.Iterator

getOriginalSentence() - Method in class com.vivoka.vsdk.nlu.result.Result

getOutputChannelCount() - Method in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

getParser(String, IParserListener) - Method in class com.vivoka.vsdk.nlu.Engine

Gets or creates a parser with the specified name and listener.

getPath(String, String...) - Static method in class com.vivoka.vsdk.util.FileSystem

Builds a path from the given parts.

getPosition() - Method in class com.vivoka.vsdk.util.Iterator

getPrediction() - Method in class com.vivoka.vsdk.tts.utils.WordMarkerManager

getRecognizer(String, IRecognizerListener) - Method in class com.vivoka.vsdk.asr.Engine

Gets or creates a recognizer with the specified name and listener.

getSampleCount() - Method in class com.vivoka.vsdk.audio.Buffer

Returns the number of samples in the buffer.

getSampleRate() - Method in class com.vivoka.vsdk.audio.Buffer

Returns the sample rate.

getSampleRate() - Method in class com.vivoka.vsdk.tts.Channel

Gets the sample rate of the audio generated by this channel.

getSampleRate() - Method in class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

getSelectedChannelIndex() - Method in class com.vivoka.vsdk.audio.modifiers.ChannelExtractor

Gets the index of the currently selected channel.

getSize() - Method in class com.vivoka.vsdk.audio.Buffer

Returns the size of the audio buffer in bytes.

getSpeechEnhancer(String) - Method in class com.vivoka.vsdk.speechenhancement.Engine

Gets or creates a speech enhancer with the specified name.

getStartIndex() - Method in class com.vivoka.vsdk.nlu.result.Entity

getStartPosInAudio() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

getStartPosInText() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

getState() - Method in class com.vivoka.vsdk.audio.ProducerModule

Gets the current state of the producer module.

getState() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Gets the current state of the audio player.

getString(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a string.

getString(JSONObject, String, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

Returns the value at the given path as a string.

getTags() - Method in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

Create a list of all tags specific to this hypothesis and returns them.

getTags() - Method in class com.vivoka.vsdk.asr.utils.AsrResultTag

Get all tags specific to this tag.

getTerminals() - Method in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

Create a list of all terminals specific to this hypothesis and returns them.

getTerminals() - Method in class com.vivoka.vsdk.asr.utils.AsrResultTag

Get all terminals specific to this tag.

getText() - Method in class com.vivoka.vsdk.asr.utils.AsrResultTag

Get the text representation of this tag.

getText() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

getType() - Method in class com.vivoka.vsdk.biometrics.Model

getUpTime() - Method in class com.vivoka.vsdk.asr.Recognizer

Get the uptime of the recognizer.

getUsers() - Method in class com.vivoka.vsdk.biometrics.Model

Get the list of users in the model.

getUserToRecognize() - Method in class com.vivoka.vsdk.biometrics.Authenticator

Gets the current user to recognize.

getValue() - Method in class com.vivoka.vsdk.nlu.result.Entity

getVersion() - Static method in class com.vivoka.vsdk.Vsdk

getVolume() - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Gets the current volume of the audio player.

getVolume() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Gets the current volume of the audio player.

getWord() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

H

has(JSONObject, String) - Static method in class com.vivoka.vsdk.util.JsonUtils

hypotheses - Variable in class com.vivoka.vsdk.asr.utils.AsrResult

A list of recognition hypotheses generated by the recognizer.

I

IAudioCallback - Interface in com.vivoka.vsdk.audio

IChannelListener - Interface in com.vivoka.vsdk.tts

A callback used to retrieve the channel results.

IConsumerModule - Interface in com.vivoka.vsdk.audio

Represents a module that consumes audio buffers.

IDENTIFICATION - Enum constant in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultType

Identificator - Class in com.vivoka.vsdk.biometrics

Base class for biometric identificators.

Identificator(String, Model, IRecognizerListener) - Constructor for class com.vivoka.vsdk.biometrics.Identificator

IDLE - Enum constant in enum class com.vivoka.vsdk.audio.ProducerModule.State

IDLE - Enum constant in enum class com.vivoka.vsdk.audio.StandalonePlayer.State

IEngine - Interface in com.vivoka.vsdk.common

IEngineCallback - Interface in com.vivoka.vsdk.common

Deprecated.

IModifierModule - Interface in com.vivoka.vsdk.audio

Represents a module that modifies audio buffers.

init(Context, IEngineCallback) - Method in interface com.vivoka.vsdk.common.IEngine

Deprecated, for removal: This API element is subject to removal in a future version.

Use #init(Consumer<Boolean>) instead (for removal).

init(Context, String, Consumer<Boolean>) - Static method in class com.vivoka.vsdk.Vsdk

Initializes the SDK with the given application Context and configuration path.

init(Consumer<Boolean>) - Method in interface com.vivoka.vsdk.common.IEngine

Initializes the engine with the given callback.

insertConsumer(int, IConsumerModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Inserts a consumer module at the specified position in the consumer list.

insertModifier(int, IModifierModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Inserts a modifier module at the specified position in the modifier list.

Intent - Class in com.vivoka.vsdk.nlu.result

Represents an intent in the NLU result.

Intent(JSONObject) - Constructor for class com.vivoka.vsdk.nlu.result.Intent

IParserListener - Interface in com.vivoka.vsdk.nlu

Interface for handling parser events.

IRecognizerListener - Interface in com.vivoka.vsdk.asr

Interface for listening to asr recognizer events.

IRecognizerListener - Interface in com.vivoka.vsdk.biometrics

Listener interface for biometric recognizer events.

IRecognizerListener.ResultStatus - Enum Class in com.vivoka.vsdk.biometrics

Result status

IRecognizerListener.ResultType - Enum Class in com.vivoka.vsdk.biometrics

Result type

isAbsolutePath(String) - Static method in class com.vivoka.vsdk.util.FileSystem

Checks if the given path is absolute.

isActive() - Method in class com.vivoka.vsdk.audio.Pipeline

Checks if the pipeline is currently active in synchronous or asynchronous mode.

isBusy() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently busy.

isClosed() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently closed and ready to start() or run() a new pipeline operation.

isEmpty() - Method in class com.vivoka.vsdk.audio.Buffer

Returns whether the buffer is currently empty.

isIdle() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently idle.

isInitialized() - Static method in class com.vivoka.vsdk.Vsdk

Checks whether the Vsdk has been successfully initialized.

isNativeEventsEnabled() - Method in class com.vivoka.vsdk.tts.Channel

Checks if the native events are enabled.

isOpened() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently opened.

isPaused() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently paused.

isRunning() - Method in class com.vivoka.vsdk.asr.Recognizer

Check if the recognizer is currently running.

isRunning() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently running.

isRunning() - Method in class com.vivoka.vsdk.audio.producers.AudioRecorder

Checks if the AudioRecorder is currently running.

isSsml(String) - Static method in class com.vivoka.vsdk.tts.utils.Ssml

Checks if the given text has SSML signature.

isStarted() - Method in class com.vivoka.vsdk.audio.ProducerModule

Checks if the producer module is currently started.

items - Variable in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

List of recognized items (terminals or tags) forming a hierarchical structure.

items - Variable in class com.vivoka.vsdk.asr.utils.AsrResultTag

Nested items within this tag, forming a tree structure.

Iterator<T> - Class in com.vivoka.vsdk.util

Utility class for working with iterators.

Iterator(int, T) - Constructor for class com.vivoka.vsdk.util.Iterator

J

json - Variable in class com.vivoka.vsdk.asr.utils.AsrResult

Raw JSON representation of this ASR result.

JsonUtils - Class in com.vivoka.vsdk.util

Utility class for working with json

JsonUtils() - Constructor for class com.vivoka.vsdk.util.JsonUtils

L

last - Variable in class com.vivoka.vsdk.audio.AudioProgress

True if this is the last audio buffer to be played.

loadJsonObjectFromAssets(String) - Static method in class com.vivoka.vsdk.util.FileSystem

Loads a json file from assets and returns it as a JSONObject.

loadJsonObjectFromStorage(String) - Static method in class com.vivoka.vsdk.util.FileSystem

Loads a json file from storage and returns it as a JSONObject.

M

makeAuthenticator(String, Model, IRecognizerListener) - Method in class com.vivoka.vsdk.biometrics.Engine

makeChannel(String, String, IChannelListener) - Method in class com.vivoka.vsdk.tts.Engine

makeCopy() - Method in class com.vivoka.vsdk.audio.Buffer

Creates and returns a deep copy of this buffer.

makeDynamicModel(String) - Method in class com.vivoka.vsdk.asr.Engine

makeIdentificator(String, Model, IRecognizerListener) - Method in class com.vivoka.vsdk.biometrics.Engine

makeJsonArray(Object...) - Static method in class com.vivoka.vsdk.util.JsonUtils

Creates a json array from the given objects.

makeModel(String, ModelType) - Method in class com.vivoka.vsdk.biometrics.Engine

makeParser(String, IParserListener) - Method in class com.vivoka.vsdk.nlu.Engine

makeRecognizer(String, IRecognizerListener) - Method in class com.vivoka.vsdk.asr.Engine

makeSpeechEnhancer(String) - Method in class com.vivoka.vsdk.speechenhancement.Engine

MARKER - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

A marker tag has been reached (Deprecated).

message - Variable in class com.vivoka.vsdk.common.Error

The message of the error

message - Variable in class com.vivoka.vsdk.common.Event

The message of the event

Model - Class in com.vivoka.vsdk.biometrics

Abstract class representing a biometric model.

Model(String, ModelType) - Constructor for class com.vivoka.vsdk.biometrics.Model

ModelType - Enum Class in com.vivoka.vsdk.biometrics

monitor() - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

N

name - Variable in class com.vivoka.vsdk.asr.utils.AsrResultTag

Name of the tag, which can identify the semantic meaning or structure (e.g.

name - Static variable in class com.vivoka.vsdk.Constants

NATIVE_ERROR - Enum constant in enum class com.vivoka.vsdk.tts.Channel.ErrorCode

A native error

NATIVE_EVENT - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

A native event

NLU - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.ResultType

O

onAudio(Buffer, boolean) - Method in interface com.vivoka.vsdk.audio.IAudioCallback

onCompleted(boolean) - Method in interface com.vivoka.vsdk.common.IEngineCallback

Deprecated.

Callback called when the engine initialization is complete.

onError(Error<Recognizer.ErrorCode>) - Method in interface com.vivoka.vsdk.asr.IRecognizerListener

Called when an error is received from the recognizer.

onError(Error<Channel.ErrorCode>) - Method in interface com.vivoka.vsdk.tts.IChannelListener

Invoked when an error is received.

onError(String) - Method in interface com.vivoka.vsdk.nlu.IParserListener

Called when an error occurs in the parser.

onEvent(Event<Recognizer.EventCode>) - Method in interface com.vivoka.vsdk.asr.IRecognizerListener

Called when an event is received from the recognizer.

onEvent(Event<Channel.EventCode>) - Method in interface com.vivoka.vsdk.tts.IChannelListener

Invoked when an event is received.

onEvent(WordMarker) - Method in interface com.vivoka.vsdk.tts.utils.WordMarkerManager.WordMarkerNotifier

onMarkerReached(AudioTrack) - Method in class com.vivoka.vsdk.tts.utils.WordMarkerManager

onNativeEventsStateChanged(boolean) - Method in class com.vivoka.vsdk.tts.Channel

onNewModelSet() - Method in class com.vivoka.vsdk.biometrics.Recognizer

onPeriodicNotification(AudioTrack) - Method in class com.vivoka.vsdk.tts.utils.WordMarkerManager

onResult(Recognizer.ResultType, String, boolean) - Method in interface com.vivoka.vsdk.asr.IRecognizerListener

Called when a result is received from the recognizer.

onResult(IRecognizerListener.ResultType, IRecognizerListener.ResultStatus, JSONObject, boolean) - Method in interface com.vivoka.vsdk.biometrics.IRecognizerListener

Called when a result is received from the recognizer.

onResult(String) - Method in interface com.vivoka.vsdk.nlu.IParserListener

Called when a result is received from the parser.

OPENED - Enum constant in enum class com.vivoka.vsdk.audio.ProducerModule.State

openImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Opens the producer module.

openImpl() - Method in class com.vivoka.vsdk.audio.producers.AudioRecorder

openImpl() - Method in class com.vivoka.vsdk.audio.producers.File

orthography - Variable in class com.vivoka.vsdk.asr.utils.AsrResultTerminal

The transcribed word or token as recognized from the audio input.

P

Parser - Class in com.vivoka.vsdk.nlu

Abstract class representing a parser.

Parser(String, IParserListener) - Constructor for class com.vivoka.vsdk.nlu.Parser

parseResult(String) - Static method in class com.vivoka.vsdk.asr.utils.AsrResultParser

Parses a raw JSON string into an AsrResult object.

pause() - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Pauses the audio playback.

pause() - Method in class com.vivoka.vsdk.audio.Pipeline

Pauses the audio processing pipeline if it is currently running in asynchronous mode.

pause() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Pauses the playback of audio data.

PAUSED - Enum constant in enum class com.vivoka.vsdk.audio.ProducerModule.State

PAUSED - Enum constant in enum class com.vivoka.vsdk.audio.StandalonePlayer.State

pauseImpl() - Method in class com.vivoka.vsdk.audio.BufferModule

pauseImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Pauses the producer module.

pauseImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

pauseImpl() - Method in class com.vivoka.vsdk.audio.producers.File

Pipeline - Class in com.vivoka.vsdk.audio

Represents an audio processing pipeline.

Pipeline() - Constructor for class com.vivoka.vsdk.audio.Pipeline

Creates a new audio processing pipeline.

PLAYING - Enum constant in enum class com.vivoka.vsdk.audio.StandalonePlayer.State

pos - Variable in class com.vivoka.vsdk.audio.AudioProgress

Represents the current position in the audio stream.

printFormattedMessage() - Method in exception class com.vivoka.vsdk.Exception

Log the exception with a formatted message The method outputs the exception's message and then recursively traverses its cause chain (if any), printing each cause's message in order.

process(byte[]) - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Add an audio data chunk to the playback queue.

process(Buffer) - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Add an audio data chunk to the playback queue.

process(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.BufferModule

process(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

process(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.consumers.BufferModuleIn

process(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.consumers.File

process(Buffer, boolean) - Method in interface com.vivoka.vsdk.audio.IConsumerModule

Processes the given audio buffer.

process(Buffer, boolean) - Method in interface com.vivoka.vsdk.audio.IModifierModule

Processes the given audio buffer and modifies it in place.

process(Buffer, boolean) - Method in class com.vivoka.vsdk.audio.modifiers.ChannelExtractor

process(String) - Method in class com.vivoka.vsdk.nlu.Parser

Processes the given text.

process(List<byte[]>) - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Add a list of audio data chunks to the playback queue.

PROCESS_FINISHED - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

The process has finished

ProducerModule - Class in com.vivoka.vsdk.audio

Abstract class representing a producer module in the audio processing pipeline.

ProducerModule() - Constructor for class com.vivoka.vsdk.audio.ProducerModule

Constructor for the ProducerModule class.

ProducerModule.State - Enum Class in com.vivoka.vsdk.audio

Enum representing the state of the producer module.

push(byte[]) - Method in class com.vivoka.vsdk.audio.Buffer

Pushes raw byte array audio data into the buffer.

push(ArrayList<byte[]>) - Method in class com.vivoka.vsdk.audio.Buffer

Pushes a list of byte arrays into the buffer.

pushBackConsumer(IConsumerModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Adds a consumer module to the end of the consumer list.

pushBackModifier(IModifierModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Adds a modifier module to the end of the modifier list.

pushFrontConsumer(IConsumerModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Adds a consumer module to the end of the consumer list.

pushFrontModifier(IModifierModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Adds a modifier module to the end of the modifier list.

R

readFileFromAssets(String) - Static method in class com.vivoka.vsdk.util.FileSystem

Reads a file from assets and returns its content as a string.

readFileFromStorage(String) - Static method in class com.vivoka.vsdk.util.FileSystem

Reads a file from storage and returns its content as a string.

Recognizer - Class in com.vivoka.vsdk.asr

Abstract class representing a recognizer in the ASR (Automatic Speech Recognition) system.

Recognizer - Class in com.vivoka.vsdk.biometrics

Abstract class representing a recognizer in the Voice Biometrics system.

Recognizer(String, IRecognizerListener) - Constructor for class com.vivoka.vsdk.asr.Recognizer

Recognizer(String, Model, IRecognizerListener) - Constructor for class com.vivoka.vsdk.biometrics.Recognizer

RECOGNIZER_STARTED - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.EventCode

Event indicating that the recognizer has started successfully.

RECOGNIZER_STOPPED - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.EventCode

Event indicating that the recognizer has stopped.

Recognizer.ErrorCode - Enum Class in com.vivoka.vsdk.asr

Represents error codes that can occur in the asr recognizer.

Recognizer.EventCode - Enum Class in com.vivoka.vsdk.asr

Represents event codes for the ASR recognizer.

Recognizer.ResultType - Enum Class in com.vivoka.vsdk.asr

Represents the type of result returned by the recognizer.

referenceConsumer() - Method in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

Returns the consumer module for reference audio.

REJECTED - Enum constant in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultStatus

Rejected: Audio was sent and nothing was recognized

release() - Method in class com.vivoka.vsdk.asr.DynamicModel

release() - Method in class com.vivoka.vsdk.asr.Recognizer

release() - Method in class com.vivoka.vsdk.biometrics.Model

release() - Method in class com.vivoka.vsdk.biometrics.Recognizer

release() - Method in interface com.vivoka.vsdk.common.IEngine

Releases the engine.

release() - Method in class com.vivoka.vsdk.nlu.Parser

release() - Method in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

release() - Method in class com.vivoka.vsdk.tts.Channel

release() - Static method in class com.vivoka.vsdk.Vsdk

Releases all resources held by the Vsdk and its engines.

removeAuthenticator(String) - Method in class com.vivoka.vsdk.biometrics.Engine

Removes the authenticator with the specified name by releasing the authenticator resources.

removeChannel(String) - Method in class com.vivoka.vsdk.tts.Engine

Removes the channel with the specified name by releasing the channel resources.

removeData(String, String) - Method in class com.vivoka.vsdk.asr.DynamicModel

Removes a slot value from the model.

removeDynamicModel(String) - Method in class com.vivoka.vsdk.asr.Engine

Removes the dynamic model with the specified name by releasing the model resources.

removeIdentificator(String) - Method in class com.vivoka.vsdk.biometrics.Engine

Removes the identificator with the specified name by releasing the identificator resources.

removeModel(String) - Method in class com.vivoka.vsdk.biometrics.Engine

Removes the model with the specified name by releasing the model resources.

removeParser(String) - Method in class com.vivoka.vsdk.nlu.Engine

Removes the parser with the specified name by releasing the parser resources.

removeRecognizer(String) - Method in class com.vivoka.vsdk.asr.Engine

Removes the recognizer with the specified name by releasing the recognizer resources.

removeSpeechEnhancer(String) - Method in class com.vivoka.vsdk.speechenhancement.Engine

Removes the speech enhancer with the specified name.

reset() - Method in class com.vivoka.vsdk.tts.utils.WordMarkerManager

Result - Class in com.vivoka.vsdk.nlu.result

Represents the NLU (Natural Language Understanding) result.

Result(String) - Constructor for class com.vivoka.vsdk.nlu.result.Result

resume() - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Resumes the audio playback if it was paused.

resume() - Method in class com.vivoka.vsdk.audio.Pipeline

Resumes the audio processing pipeline if it is currently paused in asynchronous mode.

resume() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Resumes the playback of audio data.

resumeImpl() - Method in class com.vivoka.vsdk.audio.BufferModule

resumeImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Resumes the producer module.

resumeImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

resumeImpl() - Method in class com.vivoka.vsdk.audio.producers.File

run() - Method in class com.vivoka.vsdk.audio.Pipeline

Runs the audio processing pipeline in a synchronous manner.

runImpl() - Method in class com.vivoka.vsdk.audio.BufferModule

runImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Runs the producer module in a blocking manner.

runImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferModuleOut

Deprecated.

runImpl() - Method in class com.vivoka.vsdk.audio.producers.File

runImpl() - Method in class com.vivoka.vsdk.tts.Channel

RUNNING - Enum constant in enum class com.vivoka.vsdk.audio.ProducerModule.State

S

saveToFile(File, String, Consumer<File>) - Method in class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

set(JSONObject, String, Object) - Static method in class com.vivoka.vsdk.util.JsonUtils

Sets the value at the given path.

setAccelerationRate(double) - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

Sets the acceleration rate for the BufferStreamer.

setAccelerationRate(double) - Method in class com.vivoka.vsdk.audio.producers.File

Sets the acceleration rate for the audio processing.

setAudioData(byte[]) - Method in class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

setChannelCount(int) - Method in class com.vivoka.vsdk.audio.Buffer

Sets the number of audio channels.

setCurrentVoice(String) - Method in class com.vivoka.vsdk.tts.Channel

Sets the current voice of the channel that will be used for synthesis.

setLastError(String) - Method in class com.vivoka.vsdk.audio.ProducerModule

setListener(IRecognizerListener) - Method in class com.vivoka.vsdk.asr.Recognizer

Set the listener for the recognizer.

setListener(IRecognizerListener) - Method in class com.vivoka.vsdk.biometrics.Recognizer

Set the listener for recognizer events.

setListener(IParserListener) - Method in class com.vivoka.vsdk.nlu.Parser

setListener(IChannelListener) - Method in class com.vivoka.vsdk.tts.Channel

Sets the listener for this channel.

setModel(Model) - Method in class com.vivoka.vsdk.biometrics.Recognizer

Set the current model for the recognizer.

setModel(String) - Method in class com.vivoka.vsdk.asr.Recognizer

Set the current model for the recognizer.

setModel(String, int) - Method in class com.vivoka.vsdk.asr.Recognizer

Set the current model for the recognizer.

setModel(List<String>) - Method in class com.vivoka.vsdk.asr.Recognizer

Set the current models for the recognizer.

setModel(List<String>, int) - Method in class com.vivoka.vsdk.asr.Recognizer

Set the current models for the recognizer.

setNativeEventsEnabled(boolean) - Method in class com.vivoka.vsdk.tts.Channel

Enables or disables the native events.

setOnFinished(Runnable) - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Sets a callback to be invoked when the audio playback is finished.

setOnProgress(Consumer<AudioProgress>) - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Sets a callback to be invoked on audio playback progress.

setOnProgress(Consumer<AudioProgress>) - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Sets the progress callback for the audio player.

setOnStateChanged(Consumer<StandalonePlayer.State>) - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Sets the state change callback for the audio player.

setPrediction(int) - Method in class com.vivoka.vsdk.tts.utils.WordMarkerManager

setProducer(ProducerModule) - Method in class com.vivoka.vsdk.audio.Pipeline

Sets the producer module for the pipeline.

setRealTimeStreamingEnabled(boolean) - Method in class com.vivoka.vsdk.audio.producers.File

Enables or disables real-time streaming.

setSampleRate(int) - Method in class com.vivoka.vsdk.audio.Buffer

Sets the sample rate.

setSelectedChannelIndex(int) - Method in class com.vivoka.vsdk.audio.modifiers.ChannelExtractor

Sets the index of the channel to extract.

setState(ProducerModule.State) - Method in class com.vivoka.vsdk.audio.ProducerModule

setStateChanedCallback(Consumer<ProducerModule.State>) - Method in class com.vivoka.vsdk.audio.ProducerModule

setUpTime(double) - Method in class com.vivoka.vsdk.asr.Recognizer

setUserToRecognize(String) - Method in class com.vivoka.vsdk.biometrics.Authenticator

Sets the current user to recognize.

setVolume(float) - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Sets the volume of the audio player.

setVolume(float) - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Sets the volume of the audio player.

SILENCE_DETECTED - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.EventCode

Event indicating that silence has been detected.

SPEECH_DETECTED - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.EventCode

Event indicating that speech has been detected.

SpeechEnhancer - Class in com.vivoka.vsdk.speechenhancement

Abstract class representing a speech enhancement module.

SpeechEnhancer(String) - Constructor for class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

splitBytes(byte[], int) - Static method in class com.vivoka.vsdk.util.BufferUtils

Splits a large byte array into smaller byte arrays.

splitBytes(int) - Method in class com.vivoka.vsdk.audio.Buffer

Splits the buffer's audio data into chunks of the specified size.

Ssml - Class in com.vivoka.vsdk.tts.utils

Ssml() - Constructor for class com.vivoka.vsdk.tts.utils.Ssml

StandalonePlayer - Class in com.vivoka.vsdk.audio

The StandalonePlayer is a simple audio player that allows the user to play audio buffers.

StandalonePlayer(int, int) - Constructor for class com.vivoka.vsdk.audio.StandalonePlayer

Constructs a new StandalonePlayer.

StandalonePlayer(int, int, AudioAttributes) - Constructor for class com.vivoka.vsdk.audio.StandalonePlayer

Constructs a new StandalonePlayer with the specified sample rate, channel count, and audio attributes.

StandalonePlayer.State - Enum Class in com.vivoka.vsdk.audio

start() - Method in class com.vivoka.vsdk.audio.Pipeline

Starts the audio processing pipeline in asynchronous mode.

start() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Starts the playback of audio data.

STARTED - Enum constant in enum class com.vivoka.vsdk.audio.ProducerModule.State

startImpl() - Method in class com.vivoka.vsdk.audio.BufferModule

startImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Starts the producer module in a non-blocking manner.

startImpl() - Method in class com.vivoka.vsdk.audio.producers.AudioRecorder

startImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferForwarder

startImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferModuleOut

Deprecated.

startImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

startImpl() - Method in class com.vivoka.vsdk.audio.producers.File

startImpl() - Method in class com.vivoka.vsdk.tts.Channel

startRule - Variable in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

The start rule (context#rule) used to generate this hypothesis.

stop() - Method in class com.vivoka.vsdk.audio.consumers.AudioPlayer

Stops the audio playback and resets the player to the idle state.

stop() - Method in class com.vivoka.vsdk.audio.Pipeline

Stops the audio processing pipeline if it is currently running in asynchronous mode.

stop() - Method in class com.vivoka.vsdk.audio.StandalonePlayer

Stops the playback of audio data.

stopImpl() - Method in class com.vivoka.vsdk.audio.BufferModule

stopImpl() - Method in class com.vivoka.vsdk.audio.ProducerModule

Stops the producer module.

stopImpl() - Method in class com.vivoka.vsdk.audio.producers.AudioRecorder

stopImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferForwarder

stopImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferModuleOut

Deprecated.

stopImpl() - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

stopImpl() - Method in class com.vivoka.vsdk.audio.producers.File

STOPPED - Enum constant in enum class com.vivoka.vsdk.audio.StandalonePlayer.State

stream(Buffer, boolean, int) - Method in class com.vivoka.vsdk.audio.producers.BufferStreamer

Streams the audio buffer to the pipeline consumers.

subscribeFirst(IAudioCallback) - Method in class com.vivoka.vsdk.audio.ProducerModule

Subscribes an audio callback to the producer module.

subscribeLast(IAudioCallback) - Method in class com.vivoka.vsdk.audio.ProducerModule

Subscribes an audio callback to the end of the subscriber list.

SynthesisResult - Class in com.vivoka.vsdk.tts

Deprecated.

SynthesisResult() - Constructor for class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

SynthesisResult(int, int) - Constructor for class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

SynthesisResult(int, int, byte[]) - Constructor for class com.vivoka.vsdk.tts.SynthesisResult

Deprecated.

synthesize(String, boolean) - Method in class com.vivoka.vsdk.tts.Channel

synthesizeFromText(String) - Method in class com.vivoka.vsdk.tts.Channel

Synthesizes the given text.

T

takeBytes(int) - Method in class com.vivoka.vsdk.audio.Buffer

Extracts a specified number of bytes from the buffer.

takeData() - Method in class com.vivoka.vsdk.audio.Buffer

Removes and returns the current audio data from the buffer.

text - Variable in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

Recognized text specific to this hypothesis.

TEXT_DEPENDANT - Enum constant in enum class com.vivoka.vsdk.biometrics.ModelType

TEXT_INDEPENDANT - Enum constant in enum class com.vivoka.vsdk.biometrics.ModelType

TEXT_REWRITTEN - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

The text has been rewritten and ready to start generation.

time - Variable in class com.vivoka.vsdk.audio.AudioProgress

Represents the current time (in seconds) in the audio stream.

timerMarker - Variable in class com.vivoka.vsdk.common.Event

The time marker of the event in milliseconds

toBytes() - Method in class com.vivoka.vsdk.audio.Buffer

Converts the buffer contents into a single byte array.

toJson() - Method in class com.vivoka.vsdk.nlu.result.Result

toJson() - Method in class com.vivoka.vsdk.tts.utils.WordMarker

Converts the word marker to a JSON object.

toShorts() - Method in class com.vivoka.vsdk.audio.Buffer

Converts the buffer contents into a short array.

toString() - Method in class com.vivoka.vsdk.asr.utils.AsrResult

toString() - Method in class com.vivoka.vsdk.asr.utils.AsrResultHypothesis

toString() - Method in class com.vivoka.vsdk.asr.utils.AsrResultItem

toString() - Method in class com.vivoka.vsdk.asr.utils.AsrResultTag

toString() - Method in class com.vivoka.vsdk.asr.utils.AsrResultTerminal

toString() - Method in class com.vivoka.vsdk.nlu.result.Result

tts - Static variable in class com.vivoka.vsdk.Constants

type - Variable in class com.vivoka.vsdk.asr.utils.AsrResultItem

The type of item: either "terminal" or "tag".

type - Variable in class com.vivoka.vsdk.common.Error

The type of the error can be either an error or a warning.

type - Static variable in class com.vivoka.vsdk.Constants

U

UNEXPECTED_ERROR - Enum constant in enum class com.vivoka.vsdk.asr.Recognizer.ErrorCode

unsubscribe(int) - Method in class com.vivoka.vsdk.audio.ProducerModule

Unsubscribes an audio callback from the producer module.

unsubscribeFromProducer() - Method in class com.vivoka.vsdk.audio.Pipeline

Unsubscribes the pipeline from the current producer, if any.

V

valueOf(String) - Static method in enum class com.vivoka.vsdk.asr.Recognizer.ErrorCode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.asr.Recognizer.EventCode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.asr.Recognizer.ResultType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.audio.ProducerModule.State

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.audio.StandalonePlayer.State

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultStatus

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.biometrics.ModelType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.common.ErrorType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.tts.Channel.ErrorCode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.vivoka.vsdk.tts.Channel.EventCode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.vivoka.vsdk.asr.Recognizer.ErrorCode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.asr.Recognizer.EventCode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.asr.Recognizer.ResultType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.audio.ProducerModule.State

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.audio.StandalonePlayer.State

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultStatus

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.biometrics.IRecognizerListener.ResultType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.biometrics.ModelType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.common.ErrorType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.tts.Channel.ErrorCode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.vivoka.vsdk.tts.Channel.EventCode

Returns an array containing the constants of this enum class, in the order they are declared.

voices - Static variable in class com.vivoka.vsdk.Constants

Vsdk - Class in com.vivoka.vsdk

Vsdk is a static utility class providing access to configuration, paths, context, and initialization lifecycle.

Vsdk() - Constructor for class com.vivoka.vsdk.Vsdk

vsdkPath - Static variable in class com.vivoka.vsdk.Constants

W

WARNING - Enum constant in enum class com.vivoka.vsdk.common.ErrorType

WORD_MARKER_END - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

A word marker end has been reached.

WORD_MARKER_START - Enum constant in enum class com.vivoka.vsdk.tts.Channel.EventCode

A word marker start has been reached.

WordMarker - Class in com.vivoka.vsdk.tts.utils

Represents a word marker in the TTS event.

WordMarker(int, String, String, int, int, int, int) - Constructor for class com.vivoka.vsdk.tts.utils.WordMarker

WordMarkerManager - Class in com.vivoka.vsdk.tts.utils

This class is used to manage word markers.

WordMarkerManager(WordMarkerManager.WordMarkerNotifier) - Constructor for class com.vivoka.vsdk.tts.utils.WordMarkerManager

WordMarkerManager.WordMarkerNotifier - Interface in com.vivoka.vsdk.tts.utils

_

_active - Variable in class com.vivoka.vsdk.nlu.Parser

_authenticators - Variable in class com.vivoka.vsdk.biometrics.Engine

_channels - Variable in class com.vivoka.vsdk.tts.Engine

_currentVoice - Variable in class com.vivoka.vsdk.tts.Channel

_data - Variable in class com.vivoka.vsdk.asr.DynamicModel

_dynamicModels - Variable in class com.vivoka.vsdk.asr.Engine

_enhancers - Variable in class com.vivoka.vsdk.speechenhancement.Engine

_enrollmentModelPath - Variable in class com.vivoka.vsdk.biometrics.Model

_identificators - Variable in class com.vivoka.vsdk.biometrics.Engine

_isRunning - Variable in class com.vivoka.vsdk.asr.Recognizer

_listener - Variable in class com.vivoka.vsdk.asr.Recognizer

_listener - Variable in class com.vivoka.vsdk.biometrics.Recognizer

_listener - Variable in class com.vivoka.vsdk.nlu.Parser

_listener - Variable in class com.vivoka.vsdk.tts.Channel

_model - Variable in class com.vivoka.vsdk.biometrics.Recognizer

_models - Variable in class com.vivoka.vsdk.biometrics.Engine

_name - Variable in class com.vivoka.vsdk.asr.DynamicModel

_name - Variable in class com.vivoka.vsdk.asr.Recognizer

_name - Variable in class com.vivoka.vsdk.biometrics.Model

_name - Variable in class com.vivoka.vsdk.biometrics.Recognizer

_name - Variable in class com.vivoka.vsdk.nlu.Parser

_name - Variable in class com.vivoka.vsdk.speechenhancement.SpeechEnhancer

_name - Variable in class com.vivoka.vsdk.tts.Channel

_nativeEventsEnabled - Variable in class com.vivoka.vsdk.tts.Channel

_parsers - Variable in class com.vivoka.vsdk.nlu.Engine

_recognizers - Variable in class com.vivoka.vsdk.asr.Engine

_source - Variable in class com.vivoka.vsdk.tts.Channel

_type - Variable in class com.vivoka.vsdk.biometrics.Model

_upTime - Variable in class com.vivoka.vsdk.asr.Recognizer

_userToRecognize - Variable in class com.vivoka.vsdk.biometrics.Authenticator

A B C D E F G H I J L M N O P R S T U V W _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form