Package ai.picovoice.porcupine

Class Porcupine.Builder

java.lang.Object

ai.picovoice.porcupine.Porcupine.Builder

Enclosing class:

Porcupine

public static class Porcupine.Builder
extends java.lang.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(android.content.Context context)	Validates properties and creates an instance of the Porcupine wake word engine.
Porcupine.Builder	setAccessKey(java.lang.String accessKey)
Porcupine.Builder	setKeyword(Porcupine.BuiltInKeyword keyword)
Porcupine.Builder	setKeywordPath(java.lang.String keywordPaths)
Porcupine.Builder	setKeywordPaths(java.lang.String[] keywordPaths)
Porcupine.Builder	setKeywords(Porcupine.BuiltInKeyword[] keywords)
Porcupine.Builder	setModelPath(java.lang.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 Detail

Builder

public Builder()

Method Detail

setAccessKey

public Porcupine.Builder setAccessKey(java.lang.String accessKey)

setModelPath

public Porcupine.Builder setModelPath(java.lang.String modelPath)

setKeywordPaths

public Porcupine.Builder setKeywordPaths(java.lang.String[] keywordPaths)

setKeywordPath

public Porcupine.Builder setKeywordPath(java.lang.String keywordPaths)

setKeywords

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

setKeyword

public Porcupine.Builder setKeyword(Porcupine.BuiltInKeyword keyword)

setSensitivities

public Porcupine.Builder setSensitivities(float[] sensitivities)

setSensitivity

public Porcupine.Builder setSensitivity(float sensitivity)

build

public Porcupine build(android.content.Context context)
                throws PorcupineException

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

Parameters:

context - Android app context (for extracting Porcupine resources)

Returns:

An instance of Porcupine wake word engine

Throws:

PorcupineException - if there is an error while initializing Porcupine.