Public Member Functions | Private Member Functions | Private Attributes | List of all members
ai.picovoice.porcupine.Porcupine.Builder Class Reference

Public Member Functions

Porcupine build () throws PorcupineException
 
Porcupine build (Context context) throws PorcupineException
 
Builder setAccessKey (String accessKey)
 
Builder setAccessKey (String accessKey)
 
Builder setBuiltInKeyword (BuiltInKeyword keyword)
 
Builder setBuiltInKeywords (BuiltInKeyword[] keywords)
 
Builder setKeyword (BuiltInKeyword keyword)
 
Builder setKeywordPath (String keywordPaths)
 
Builder setKeywordPath (String keywordPaths)
 
Builder setKeywordPaths (String[] keywordPaths)
 
Builder setKeywordPaths (String[] keywordPaths)
 
Builder setKeywords (BuiltInKeyword[] keywords)
 
Builder setLibraryPath (String libraryPath)
 
Builder setModelPath (String modelPath)
 
Builder setModelPath (String modelPath)
 
Builder setSensitivities (float[] sensitivities)
 
Builder setSensitivities (float[] sensitivities)
 
Builder setSensitivity (float sensitivity)
 
Builder setSensitivity (float sensitivity)
 

Private Member Functions

void extractPackageResources (Context context) throws PorcupineIOException
 
String extractResource (Context context, InputStream srcFileStream, String dstFilename) throws IOException
 

Private Attributes

String accessKey = null
 
String[] keywordPaths = null
 
BuiltInKeyword[] keywords = null
 
String libraryPath = null
 
String modelPath = null
 
float[] sensitivities = null
 

Detailed Description

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

Definition at line 165 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

Member Function Documentation

◆ build() [1/2]

Porcupine ai.picovoice.porcupine.Porcupine.Builder.build ( ) throws PorcupineException
inline

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

Returns
An instance of Porcupine wake word engine
Exceptions
PorcupineExceptionif there is an error while initializing Porcupine.

Definition at line 202 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ build() [2/2]

Porcupine ai.picovoice.porcupine.Porcupine.Builder.build ( Context  context) throws PorcupineException
inline

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

Parameters
contextAndroid app context (for extracting Porcupine resources)
Returns
An instance of Porcupine wake word engine
Exceptions
PorcupineExceptionif there is an error while initializing Porcupine.

Definition at line 256 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ extractPackageResources()

void ai.picovoice.porcupine.Porcupine.Builder.extractPackageResources ( Context  context) throws PorcupineIOException
inlineprivate

Definition at line 213 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ extractResource()

String ai.picovoice.porcupine.Porcupine.Builder.extractResource ( Context  context,
InputStream  srcFileStream,
String  dstFilename 
) throws IOException
inlineprivate

Definition at line 235 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setAccessKey() [1/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setAccessKey ( String  accessKey)
inline

Definition at line 151 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setAccessKey() [2/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setAccessKey ( String  accessKey)
inline

Definition at line 173 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setBuiltInKeyword()

Builder ai.picovoice.porcupine.Porcupine.Builder.setBuiltInKeyword ( BuiltInKeyword  keyword)
inline

Definition at line 181 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setBuiltInKeywords()

Builder ai.picovoice.porcupine.Porcupine.Builder.setBuiltInKeywords ( BuiltInKeyword[]  keywords)
inline

Definition at line 176 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setKeyword()

Builder ai.picovoice.porcupine.Porcupine.Builder.setKeyword ( BuiltInKeyword  keyword)
inline

Definition at line 198 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setKeywordPath() [1/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setKeywordPath ( String  keywordPaths)
inline

Definition at line 171 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setKeywordPath() [2/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setKeywordPath ( String  keywordPaths)
inline

Definition at line 188 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setKeywordPaths() [1/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setKeywordPaths ( String[]  keywordPaths)
inline

Definition at line 166 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setKeywordPaths() [2/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setKeywordPaths ( String[]  keywordPaths)
inline

Definition at line 183 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setKeywords()

Builder ai.picovoice.porcupine.Porcupine.Builder.setKeywords ( BuiltInKeyword[]  keywords)
inline

Definition at line 193 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setLibraryPath()

Builder ai.picovoice.porcupine.Porcupine.Builder.setLibraryPath ( String  libraryPath)
inline

Definition at line 156 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setModelPath() [1/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setModelPath ( String  modelPath)
inline

Definition at line 161 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setModelPath() [2/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setModelPath ( String  modelPath)
inline

Definition at line 178 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setSensitivities() [1/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setSensitivities ( float[]  sensitivities)
inline

Definition at line 186 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setSensitivities() [2/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setSensitivities ( float[]  sensitivities)
inline

Definition at line 203 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ setSensitivity() [1/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setSensitivity ( float  sensitivity)
inline

Definition at line 191 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ setSensitivity() [2/2]

Builder ai.picovoice.porcupine.Porcupine.Builder.setSensitivity ( float  sensitivity)
inline

Definition at line 208 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

Member Data Documentation

◆ accessKey

String ai.picovoice.porcupine.Porcupine.Builder.accessKey = null
private

Definition at line 167 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ keywordPaths

String [] ai.picovoice.porcupine.Porcupine.Builder.keywordPaths = null
private

Definition at line 169 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ keywords

BuiltInKeyword [] ai.picovoice.porcupine.Porcupine.Builder.keywords = null
private

Definition at line 170 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ libraryPath

String ai.picovoice.porcupine.Porcupine.Builder.libraryPath = null
private

Definition at line 145 of file java/src/ai/picovoice/porcupine/Porcupine.java.

◆ modelPath

String ai.picovoice.porcupine.Porcupine.Builder.modelPath = null
private

Definition at line 168 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

◆ sensitivities

float [] ai.picovoice.porcupine.Porcupine.Builder.sensitivities = null
private

Definition at line 171 of file android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java.

The documentation for this class was generated from the following file:

picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:15:20