Leopard Speech-to-Text
React Native API
API Reference for the React Native Leopard SDK (npm )
Leopard
Class for the Leopard Speech-to-Text engine.
Leopard.create()
Leopard
constructor.
Parameters
accessKey
string : AccessKey obtained from Picovoice Console .modelPath
string : Path to the file containing model parameters (.pv
). Can be either a path that is relative to the assets/resource folder or an absolute path to the file on device.options
LeopardOptions : Optional configuration arguments:enableAutomaticPunctuation
boolean : Whether to enable automatic punctuation.
Returns
Promise<Leopard>
: An instance of Leopard platform.
Leopard.delete()
Releases resources acquired by Leopard
.
Leopard.sampleRate
Getter for audio sample rate accepted by Leopard.
Returns
number
: Audio sample rate accepted by Leopard.
Leopard.version
Getter for version.
Returns
string
: CurrentLeopard
version.
Leopard.process()
Processes given audio data with the speech-to-text engine. The incoming audio needs to have a sample rate equal to .sampleRate
and be 16-bit linearly-encoded. Leopard operates on single-channel audio.
Parameters
frame
number[] : A frame of audio samples.
Returns
Promise<LeopardTranscript>
:LeopardTranscript
object which contains the transcription results of the engine.
Leopard.processFile()
Processes an audio file with the speech-to-text engine.
Parameters
audioPath
string : Absolute path to the audio file. The supported formats are:3gp (AMR)
,FLAC
,MP3
,MP4/m4a (AAC)
,Ogg
,WAV
andWebM
.
Returns
Promise<LeopardTranscript>
:LeopardTranscript
object which contains the transcription results of the engine.
LeopardError
Exception thrown if an error occurs within Leopard
Speech-to-Text engine.
Exceptions:
LeopardOptions
Class containing optional configuration parameters for Leopard.
enableAutomaticPunctuation
boolean : Flag to enable automatic punctuation insertion.
LeopardTranscript
Class containing results from a Leopard process function.
transcript
string : Inferred transcription.words
LeopardWord[]
: Transcribed words and their associated metadata.
LeopardWord
Class containing results word transcribed by Leopard and their associated metadata.
word
string : Transcribed word.startSec
number : Start of word in seconds.endSec
number : End of word in seconds.confidenc
number : Transcription confidence. It is a number within [0, 1].