androidRhino - Android API

API Reference for the Android Rhino SDK (rhino-android)

package: ai.picovoice.rhino


Rhino

public class Rhino { }

Class for the Rhino Speech-to-Intent engine.

Rhino can be initialized using the Rhino.Builder Class. Resources should be cleaned when you are done using the delete() function.


Rhino.delete()

public void delete()

Releases resources acquired by Rhino.


Rhino.getFrameLength()

public int getFrameLength()

Getter for number of audio samples per frame.

Returns

  • int: Number of audio samples per frame.

Rhino.getSampleRate()

public int getSampleRate()

Getter for audio sample rate accepted by Picovoice.

Returns

  • int: Audio sample rate accepted by Picovoice.

Rhino.getVersion()

public String getVersion()

Getter for version.

Returns

  • String: Current Rhino version.

Rhino.getContextInformation()

public String getContextInformation()

Getter for context information.

Returns

  • String: Returns the context information.

Rhino.process()

public boolean process(short[] pcm) throws RhinoException

Processes a frame of the incoming audio stream and emits a flag indicating if the inference is finalized. 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.

Parameters

  • pcm short[] : A frame of audio samples.

Returns

  • boolean: Flag indicating whether the engine has finalized intent inference.

Throws

  • RhinoException: If there is an error while processing the audio frame.

Rhino.getInference()

public RhinoInference getInference() throws RhinoException

Gets inference result. 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

Throws


Rhino.Builder

public static class Builder { }

Builder for creating an instance of Rhino with a mixture of default arguments.


Rhino.Builder.build()

public Rhino build() throws RhinoException

Creates an instance of Rhino Speech-to-Intent engine.

Returns

  • Rhino: An instance of Rhino Speech-to-Intent engine.

Throws

  • RhinoException: If an error occurs while creating an instance of Rhino Speech-to-Intent engine.

Rhino.Builder.setAccessKey()

public Rhino.Builder setAccessKey(String accessKey)

Sets the AccessKey of the builder.

Parameters

Returns


Rhino.Builder.setContextPath()

public Rhino.Builder setContextPath(String contextPath)

Sets the context path of the builder.

Parameters

  • contextPath String : Absolute path to the context file (.rhn).

Returns


Rhino.Builder.setModelPath()

public Rhino.Builder setModelPath(String modelPath)

Sets the model path of the builder. If not set it will be set to the default location.

Parameters

  • modelPath String : Absolute path to the file containing model parameters (.pv).

Returns


Rhino.Builder.setSensitivity()

public Rhino.Builder setSensitivity(float sensitivity)

Sets sensitivity of the builder. Value should be a number within [0, 1]. A higher sensitivity results in fewer misses at the cost of increasing the false alarm rate.

Parameters

  • sensitivity float: Sensitivity for inference.

Returns


Rhino.Builder.setRequireEndpoint()

public Rhino.Builder setRequireEndpoint(boolean requireEndpoint)

Sets requireEndpoint of the builder. If set to false, Rhino does not require an endpoint (chunk of silence) before finishing inference.

Parameters

  • requireEndpoint boolean: Indicates whether an endpoint is required for Rhino to finish inference.

Returns


RhinoInference

public class RhinoInference { }

Class that contains Rhino inference data.


RhinoInference.getIsUnderstood()

public boolean getIsUnderstood()

Getter for the isUnderstood flag.

Returns

  • boolean: If true, Rhino understood the inference.

RhinoInference.getIntent()

public String getIntent()

Getter for the inference intent name.

Returns

  • String: Inference intent name.

RhinoInference.getSlots()

public Map<String, String> getSlots()

Getter for the inference slots and values.

Returns

  • Map<String, String>: Map for inference slots and values.

RhinoException

public class RhinoException extends Exception { }

Exception thrown if an error occurs within the Rhino engine.

Exceptions:

public class RhinoActivationException extends RhinoException { }
public class RhinoActivationLimitException extends RhinoException { }
public class RhinoActivationRefusedException extends RhinoException { }
public class RhinoActivationThrottledException extends RhinoException { }
public class RhinoIOException extends RhinoException { }
public class RhinoInvalidArgumentException extends RhinoException { }
public class RhinoInvalidStateException extends RhinoException { }
public class RhinoKeyException extends RhinoException { }
public class RhinoMemoryException extends RhinoException { }
public class RhinoRuntimeException extends RhinoException { }
public class RhinoStopIterationException extends RhinoException { }

RhinoManager

public class RhinoManager { }

High-level Android binding for Rhino Speech-to-Intent engine. It handles recording audio from microphone, processes it in real-time using Rhino, and notifies the client when an intent is inferred from the spoken command.


RhinoManager.delete()

public void delete()

Releases resources acquired by RhinoManager.


RhinoManager.getVersion()

public String getVersion()

Getter for version.

Returns

  • String: Current Rhino version.

RhinoManager.process()

public void process()

Start recording audio from the microphone and infers the user's intent from the spoken command. Once the inference is finalized it will invoke the user provided callback and terminate recording.


RhinoManager.getContextInformation()

public String getContextInformation()

Getter for context information.

Returns

  • String: Returns the context information.

RhinoManager.Builder

public static class Builder { }

Builder for creating an instance of RhinoManager with a mixture of default arguments.


RhinoManager.Builder.build()

public RhinoManager build(Context context, RhinoManagerCallback callback) throws RhinoException

Creates an instance of RhinoManager.

Parameters

  • context Context : The Android app context.
  • callback RhinoManagerCallback : A callback function that is invoked when intent has been inferred. The callback must be an instance of RhinoManagerCallback.

Returns

Throws

  • RhinoException: If an error occurs while creating an instance of RhinoManager.

RhinoManager.Builder.setAccessKey()

public Rhino.Builder setAccessKey(String accessKey)

Sets the AccessKey of the builder.

Parameters

Returns


RhinoManager.Builder.setContextPath()

public Rhino.Builder setContextPath(String contextPath)

Sets the context path of the builder.

Parameters

  • contextPath String : Absolute path to the context file (.rhn).

Returns


RhinoManager.Builder.setModelPath()

public Rhino.Builder setModelPath(String modelPath)

Sets the model path of the builder. If not set it will be set to the default location.

Parameters

  • modelPath String : Absolute path to the file containing model parameters (.pv).

Returns


RhinoManager.Builder.setSensitivity()

public Rhino.Builder setSensitivity(float sensitivity)

Sets sensitivity of the builder. Value should be a number within [0, 1]. A higher sensitivity results in fewer misses at the cost of increasing the false alarm rate.

Parameters

  • sensitivity float: Sensitivity for inference.

Returns


RhinoManager.Builder.setRequireEndpoint()

public Rhino.Builder setRequireEndpoint(boolean requireEndpoint)

Sets requireEndpoint of the builder. If set to false, Rhino does not require an endpoint (chunk of silence) before finishing inference.

Parameters

  • requireEndpoint boolean: Indicates whether an endpoint is required for Rhino to finish inference.

Returns


RhinoManager.Builder.setErrorCallback()

public RhinoManager.Builder setErrorCallback(RhinoManagerErrorCallback errorCallback)

Sets errorCallback of the builder.

Parameters

Returns


RhinoManagerCallback

public interface RhinoManagerCallback {
void invoke(RhinoInference inference);
}

Callback interface invoked when inference has been finalized.


RhinoManagerErrorCallback

public interface RhinoManagerErrorCallback {
void invoke(RhinoException error);
}

Callback interface invoked when an error occurs while processing audio.


Issue with this doc? Please let us know.