Package ai.picovoice.cheetah

Class Cheetah

java.lang.Object

ai.picovoice.cheetah.Cheetah

public class Cheetah
extends Object

Cheetah Class.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIBRARY_PATH
static final String	MODEL_PATH

Method Summary

Modifier and Type	Method	Description
void	delete()	Releases resources acquired by Cheetah.
CheetahTranscript	flush()	Processes any remaining audio data and returns its transcription.
int	getFrameLength()	Getter for required number of audio samples per frame.
int	getSampleRate()	Getter for required audio sample rate for PCM data.
String	getVersion()	Getter for Cheetah version.
CheetahTranscript	process(short[] pcm)	Processes given audio data and returns its transcription.
static void	setSdk(String sdk)

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 String LIBRARY_PATH

MODEL_PATH

public static final String MODEL_PATH

Method Details

setSdk

public static void setSdk(String sdk)

delete

public void delete()

Releases resources acquired by Cheetah.

process

public CheetahTranscript process(short[] pcm)
                          throws CheetahException

Processes given audio data and returns its transcription.

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, Cheetah operates on single channel audio only.

Returns:

Inferred transcription.

Throws:

CheetahException - if there is an error while processing the audio frame.

flush

public CheetahTranscript flush()
                        throws CheetahException

Processes any remaining audio data and returns its transcription.

Returns:

Inferred transcription.

Throws:

CheetahException - if there is an error while processing the audio frame.

getFrameLength

public int getFrameLength()

Getter for required number of audio samples per frame.

Returns:

Required number of audio samples per frame.

getSampleRate

public int getSampleRate()

Getter for required audio sample rate for PCM data.

Returns:

Required audio sample rate for PCM data.

getVersion

public String getVersion()

Getter for Cheetah version.

Returns:

Cheetah version.