Package ai.picovoice.porcupine

Class Porcupine.Builder

java.lang.Object

ai.picovoice.porcupine.Porcupine.Builder

Enclosing class:

Porcupine

public static class Porcupine.Builder
extends Object

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Porcupine	build()	Validates properties and creates an instance of the Porcupine wake word engine.
Porcupine.Builder	setAccessKey(String accessKey)
Porcupine.Builder	setBuiltInKeyword(Porcupine.BuiltInKeyword keyword)
Porcupine.Builder	setBuiltInKeywords(Porcupine.BuiltInKeyword[] keywords)
Porcupine.Builder	setKeywordPath(String keywordPaths)
Porcupine.Builder	setKeywordPaths(String[] keywordPaths)
Porcupine.Builder	setLibraryPath(String libraryPath)
Porcupine.Builder	setModelPath(String modelPath)
Porcupine.Builder	setSensitivities(float[] sensitivities)
Porcupine.Builder	setSensitivity(float sensitivity)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

setAccessKey

public Porcupine.Builder setAccessKey(String accessKey)

setLibraryPath

public Porcupine.Builder setLibraryPath(String libraryPath)

setModelPath

public Porcupine.Builder setModelPath(String modelPath)

setKeywordPaths

public Porcupine.Builder setKeywordPaths(String[] keywordPaths)

setKeywordPath

public Porcupine.Builder setKeywordPath(String keywordPaths)

setBuiltInKeywords

public Porcupine.Builder setBuiltInKeywords(Porcupine.BuiltInKeyword[] keywords)

setBuiltInKeyword

public Porcupine.Builder setBuiltInKeyword(Porcupine.BuiltInKeyword keyword)

setSensitivities

public Porcupine.Builder setSensitivities(float[] sensitivities)

setSensitivity

public Porcupine.Builder setSensitivity(float sensitivity)

build

public Porcupine build()
                throws PorcupineException

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

Returns:

An instance of Porcupine wake word engine

Throws:

PorcupineException - if there is an error while initializing Porcupine.