ai.picovoice.picovoice

Class Picovoice.Builder

java.lang.Object

ai.picovoice.picovoice.Picovoice.Builder

Enclosing class:

Picovoice

public static class Picovoice.Builder
extends java.lang.Object

Builder for creating an instance of Picovoice with a mixture of default arguments

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Picovoice	build(android.content.Context appContext) Validates properties and creates an instance of the Porcupine wake word engine.
Picovoice.Builder	setContextPath(java.lang.String contextPath) Setter for path to Rhino context file
Picovoice.Builder	setInferenceCallback(PicovoiceInferenceCallback inferenceCallback) Setter for intent inference callback
Picovoice.Builder	setKeywordPath(java.lang.String keywordPath) Setter for path to Porcupine keyword file
Picovoice.Builder	setPorcupineModelPath(java.lang.String porcupineModelPath) Setter for path to Porcupine model file
Picovoice.Builder	setPorcupineSensitivity(float porcupineSensitivity) Setter for wake word engine sensitivity
Picovoice.Builder	setRhinoModelPath(java.lang.String rhinoModelPath) Setter for path to Rhino model file
Picovoice.Builder	setRhinoSensitivity(float rhinoSensitivity) Setter for inference engine sensitivity
Picovoice.Builder	setWakeWordCallback(PicovoiceWakeWordCallback wakeWordCallback) Setter for wake word detection callback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setPorcupineModelPath

public Picovoice.Builder setPorcupineModelPath(java.lang.String porcupineModelPath)

Setter for path to Porcupine model file

Parameters:

porcupineModelPath - Absolute path to the file containing Porcupine's model parameters.

setKeywordPath

public Picovoice.Builder setKeywordPath(java.lang.String keywordPath)

Setter for path to Porcupine keyword file

Parameters:

keywordPath - Absolute path to Porcupine's keyword model file.

setPorcupineSensitivity

public Picovoice.Builder setPorcupineSensitivity(float porcupineSensitivity)

Setter for wake word engine sensitivity

Parameters:

porcupineSensitivity - Wake word detection sensitivity. It should be a number within [0, 1]. A higher sensitivity results in fewer misses at the cost of increasing the false alarm rate.

setWakeWordCallback

public Picovoice.Builder setWakeWordCallback(PicovoiceWakeWordCallback wakeWordCallback)

Setter for wake word detection callback

Parameters:

wakeWordCallback - User-defined callback invoked upon detection of the wake phrase. $PicovoiceWakeWordCallback defines the interface of the callback.

setRhinoModelPath

public Picovoice.Builder setRhinoModelPath(java.lang.String rhinoModelPath)

Setter for path to Rhino model file

Parameters:

rhinoModelPath - Absolute path to the file containing Rhino's model parameters.

setContextPath

public Picovoice.Builder setContextPath(java.lang.String contextPath)

Setter for path to Rhino context file

Parameters:

contextPath - Absolute path to file containing context parameters. A context represents the set of expressions (spoken commands), intents, and intent arguments (slots) within a domain of interest.

setRhinoSensitivity

public Picovoice.Builder setRhinoSensitivity(float rhinoSensitivity)

Setter for inference engine sensitivity

Parameters:

rhinoSensitivity - Inference sensitivity. It should be a number within [0, 1]. A higher sensitivity value results in fewer misses at the cost of (potentially) increasing the erroneous inference rate.

setInferenceCallback

public Picovoice.Builder setInferenceCallback(PicovoiceInferenceCallback inferenceCallback)

Setter for intent inference callback

Parameters:

inferenceCallback - User-defined callback invoked upon completion of intent inference. #PicovoiceInferenceCallback defines the interface of the callback.

build

public Picovoice build(android.content.Context appContext)
                throws PicovoiceException

Validates properties and creates an instance of the Porcupine wake word engine.

Parameters:

appContext - Android app context (for extracting Porcupine resources)

Returns:

An instance of Porcupine wake word engine

Throws:

PicovoiceException - if there is an error while initializing Porcupine.