Package ai.picovoice.porcupine

Class Porcupine

java.lang.Object
ai.picovoice.porcupine.Porcupine
public class Porcupine
extends java.lang.Object
Java binding for Porcupine wake word engine. It detects utterances of given keywords within an incoming stream of audio in real-time. It processes incoming audio in consecutive frames and for each frame emits the detection result. The number of samples per frame can be attained by calling getFrameLength(). The incoming audio needs to have a sample rate equal to getSampleRate() and be 16-bit linearly-encoded. Porcupine operates on single-channel audio.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  Porcupine.Builder
    Builder for creating an instance of Porcupine with a mixture of default arguments

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.util.HashMap<java.lang.String,​java.lang.String> KEYWORD_PATHS  
    static java.util.Set<java.lang.String> KEYWORDS  
    static java.lang.String LIBRARY_PATH  
    static java.lang.String MODEL_PATH  

  • Constructor Summary

    Constructors
    Constructor Description
    Porcupine​(java.lang.String libraryPath, java.lang.String modelPath, java.lang.String[] keywordPaths, float[] sensitivities)
    Constructor.

  • Method Summary

    Modifier and Type Method Description
    void delete()
    Releases resources acquired by Porcupine.
    int getFrameLength()
    Getter for number of audio samples per frame.
    int getSampleRate()
    Getter for audio sample rate accepted by Picovoice.
    java.lang.String getVersion()
    Getter for version.
    int process​(short[] pcm)
    Processes a frame of the incoming audio stream and emits the detection result.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • LIBRARY_PATH

      public static final java.lang.String LIBRARY_PATH

    • MODEL_PATH

      public static final java.lang.String MODEL_PATH

    • KEYWORD_PATHS

      public static final java.util.HashMap<java.lang.String,​java.lang.String> KEYWORD_PATHS

    • KEYWORDS

      public static final java.util.Set<java.lang.String> KEYWORDS

  • Constructor Details

    • Porcupine

      public Porcupine​(java.lang.String libraryPath, java.lang.String modelPath, java.lang.String[] keywordPaths, float[] sensitivities) throws PorcupineException
      Constructor.
      Parameters:
      libraryPath - Absolute path to the native Porcupine library.
      modelPath - Absolute path to the file containing model parameters.
      keywordPaths - Absolute paths to keyword model files.
      sensitivities - Sensitivities for detecting keywords. Each value should be a number within [0, 1]. A higher sensitivity results in fewer misses at the cost of increasing the false alarm rate.
      Throws:
      PorcupineException - if there is an error while initializing Porcupine.

  • Method Details

    • delete

      public void delete()
      Releases resources acquired by Porcupine.

    • process

      public int process​(short[] pcm) throws PorcupineException
      Processes a frame of the incoming audio stream and emits the detection result.
      Parameters:
      pcm - A frame of audio samples. The number of samples per frame can be attained by calling getFrameLength(). The incoming audio needs to have a sample rate equal to getSampleRate() and be 16-bit linearly-encoded. Porcupine operates on single-channel audio.
      Returns:
      Index of observed keyword at the end of the current frame. Indexing is 0-based and matches the ordering of keyword models provided to the constructor. If no keyword is detected then it returns -1.
      Throws:
      PorcupineException - if there is an error while processing the audio frame.

    • getVersion

      public java.lang.String getVersion()
      Getter for version.
      Returns:
      Version.

    • getFrameLength

      public int getFrameLength()
      Getter for number of audio samples per frame.
      Returns:
      Number of audio samples per frame.

    • getSampleRate

      public int getSampleRate()
      Getter for audio sample rate accepted by Picovoice.
      Returns:
      Audio sample rate accepted by Picovoice.