Leopard Speech-to-Text
Flutter API

API Reference for the Flutter Leopard SDK (pub.dev)

Leopard

class Leopard { }

Class for the Leopard Speech-to-Text engine. Leopard must be initialized using create(). Resources should be cleaned when you are done using the delete() function.

Leopard.`create()`

Static creator for initializing Leopard.

static Future<Leopard> create(
    String accessKey, 
    String modelPath,
    {enableAutomaticPunctuation = false})

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 project's assets folder or an absolute path to the file on device.
enableAutomaticPunctuation bool? : (Optional) Set to true to enable automatic punctuation insertion.

Returns

Future<Leopard> an instance of the speech-to-text engine.

Throws

LeopardException : If not initialized correctly.

Leopard.`process()`

Process a frame of pcm audio with the speech-to-text engine.

Future<LeopardTranscript> process(List<int>? frame)

Parameters

frame List<int> : a frame of audio samples to be assessed by Leopard. The required audio format is found by calling .sampleRate to get the required sample rate. Audio must be single-channel and 16-bit linearly-encoded.

Returns

Future<LeopardTranscript>: LeopardTranscript object which contains the transcription results of the engine.

Throws

LeopardException : If process fails.

Leopard.`processFile()`

Processes a given audio file with the speech-to-text-engine.

Future<LeopardTranscript> processFile(String path)

Parameters

path String : Absolute path to the audio file. The supported formats are: 3gp (AMR), FLAC, MP3, MP4/m4a (AAC), Ogg, WAV and WebM.

Returns

Future<LeopardTranscript>: LeopardTranscript object which contains the transcription results of the engine.

Throws

LeopardException : If process fails.

Leopard.`delete()`

Frees memory that was allocated for Leopard

Future<void> delete()

Leopard.`sampleRate`

int get sampleRate

Getter for the audio sample rate required by Leopard.

Leopard.`version`

String get version

Getter for Leopard version string.

LeopardException

class LeopardException implements Exception { }

Exception thrown if an error occurs within Leopard:

class LeopardMemoryException extends LeopardException { }
class LeopardIOException extends LeopardException { }
class LeopardInvalidArgumentException extends LeopardException { }
class LeopardStopIterationException extends LeopardException { }
class LeopardKeyException extends LeopardException { }
class LeopardInvalidStateException extends LeopardException { }
class LeopardRuntimeException extends LeopardException { }
class LeopardActivationException extends LeopardException { }
class LeopardActivationLimitException extends LeopardException { }
class LeopardActivationThrottledException extends LeopardException { }
class LeopardActivationRefusedException extends LeopardException { }