Package ai.picovoice.rhino

Class Rhino

java.lang.Object
ai.picovoice.rhino.Rhino
public class Rhino
extends java.lang.Object
Android binding for Rhino Speech-to-Intent engine. It directly infers the user's intent from spoken commands in real-time. Rhino processes incoming audio in consecutive frames and indicates if the inference is finalized. When finalized, the inferred intent can be retrieved as structured data in the form of an intent string and pairs of slots and values. 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. Rhino operates on single-channel audio.

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type Method Description
    void delete()
    Releases resources acquired by Rhino.
    java.lang.String getContextInformation()
    Getter for context information.
    int getFrameLength()
    Getter for number of audio samples per frame.
    RhinoInference getInference()
    Gets inference result from Rhino.
    int getSampleRate()
    Getter for audio sample rate accepted by Picovoice.
    java.lang.String getVersion()
    Getter for version.
    boolean process​(short[] pcm)
    Processes a frame of audio and emits a flag indicating if the inference is finalized.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • delete

      public void delete()
      Releases resources acquired by Rhino.

    • process

      public boolean process​(short[] pcm) throws RhinoException
      Processes a frame of audio and emits a flag indicating if the inference is finalized. When finalized, getInference() should be called to retrieve the intent and slots, if the spoken command is considered valid.
      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. Furthermore, Rhino operates on single channel audio.
      Returns:
      Flag indicating whether the engine has finalized intent extraction.
      Throws:
      RhinoException - if there is an error while processing the audio frame.

    • getInference

      public RhinoInference getInference() throws RhinoException
      Gets inference result from Rhino. If the spoken command was understood, it includes the specific intent name that was inferred, and (if applicable) slot keys and specific slot values. Should only be called after the process function returns true, otherwise Rhino has not yet reached an inference conclusion.
      Returns:
      The result of inference as a RhinoInference object.
      Throws:
      RhinoException - if inference retrieval fails.

    • getContextInformation

      public java.lang.String getContextInformation()
      Getter for context information.
      Returns:
      Context information.

    • 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.

    • getVersion

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