Picovoice WordmarkPicovoice Console
Introduction
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSNodejsPythonRaspberry PiReact NativeRustWebWindows
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
SummaryPicovoice LeopardAmazon TranscribeAzure Speech-to-TextGoogle ASRGoogle ASR (Enhanced)IBM Watson Speech-to-Text
FAQ
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
FAQ
Introduction
AndroidCiOSLinuxmacOSPythonWebWindows
AndroidCiOSPythonWeb
SummaryOctopus Speech-to-IndexGoogle Speech-to-TextMozilla DeepSpeech
FAQ
Introduction
AndroidAngularArduinoBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaMicrocontrollerNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPorcupineSnowboyPocketSphinx
Wake Word TipsFAQ
Introduction
AndroidAngularBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonlinuxmacOSNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPicovoice RhinoGoogle DialogflowAmazon LexIBM WatsonMicrosoft LUIS
Expression SyntaxFAQ
Introduction
AndroidBeagleboneCiOSNvidia JetsonLinuxmacOSPythonRaspberry PiRustWebWindows
AndroidCiOSPythonRustWeb
SummaryPicovoice CobraWebRTC VAD
FAQ
Introduction
AndroidAngularArduinoBeagleBoneC.NETFlutterlink to GoiOSJavaNvidia JetsonMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustUnityVueWeb
AndroidAngularCMicrocontroller.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
Picovoice SDK - FAQ
IntroductionSTM32F407G-DISC1 (Arm Cortex-M4)STM32F411E-DISCO (Arm Cortex-M4)STM32F769I-DISCO (Arm Cortex-M7)IMXRT1050-EVKB (Arm Cortex-M7)
FAQGlossary

Cheetah Speech-to-Text — .NET API


API Reference for the .NET Cheetah SDK (NuGet)


namespace: Pv


Cheetah

public class Cheetah : IDisposable { }

Class for the Cheetah Speech-to-Text engine.


Cheetah.Create()

public static Cheetah Create(
string accessKey,
string modelPath = null,
float endpointDurationSec = 1.0f,
bool enableAutomaticPunctuation = false)

Cheetah constructor.

Parameters

  • accessKey string : AccessKey obtained from Picovoice Console.
  • modelPath string : Absolute path to the file containing model parameters (.pv).
  • endpointDurationSec float : Duration of endpoint in seconds. A speech endpoint is detected when there is a chunk of audio (with a duration specified herein) after an utterance without any speech in it. Set duration to 0 to disable this. Default is 1 second in the Builder.
  • enableAutomaticPunctuation bool : Enable automatic punctuation. Default is false.

Returns

  • Cheetah: An instance of Cheetah Speech-To-Text engine.

Throws

  • CheetahException: If an error occurs while creating an instance of the Cheetah Speech-to-Text engine.

Cheetah.Process()

public string Process(short[] pcm)

Processes a frame of audio and returns newly-transcribed text and a flag indicating if an endpoint has been detected. Upon detection of an endpoint, the client may invoke .Flush() to retrieve any remaining transcription.

The number of samples per frame can be attained by calling .FrameLength. The incoming audio needs to have a sample rate equal to .SampleRate and be 16-bit linearly-encoded. Furthermore, Cheetah operates on single-channel audio.

Parameters

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

Returns

  • CheetahTranscript: Inferred transcription object.

Throws

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

Cheetah.Flush()

public CheetahTranscript Flush()

Processes any remaining audio data and returns its transcription.

Returns

  • CheetahTranscript: Inferred transcription object.

Throws

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

Cheetah.FrameLength

public int FrameLength { get; private set; }

Getter for number of audio samples per frame.

Returns

  • int: Number of audio samples per frame.

Cheetah.SampleRate

public int SampleRate { get; private set; }

Getter for audio sample rate accepted by Picovoice.

Returns

  • int: Audio sample rate accepted by Picovoice.

Cheetah.Version

public string Version { get; private set; }

Getter for version.

Returns

  • string: Current Cheetah version.

CheetahTranscript

public class CheetahTranscript { }

Class that contains Cheetah transcript data.


CheetahTranscript.Transcript

public string Transcript { get; private set; }

Getter for transcript data.

Returns

  • string: Inferred transcription.

CheetahTranscript.IsEndpoint

public string Transcript { get; private set; }

Getter for IsEndpoint flag.

Returns

  • boolean: If true, Cheetah detected a speech endpoint.

CheetahException

public class CheetahException : Exception

Exception thrown if an error occurs within Cheetah Speech-to-Text engine.

Exceptions:

public class CheetahActivationException : CheetahException { }
public class CheetahActivationLimitException : CheetahException { }
public class CheetahActivationRefusedException : CheetahException { }
public class CheetahActivationThrottledException : CheetahException { }
public class CheetahIOException : CheetahException { }
public class CheetahInvalidArgumentException : CheetahException { }
public class CheetahInvalidStateException : CheetahException { }
public class CheetahKeyException : CheetahException { }
public class CheetahMemoryException : CheetahException { }
public class CheetahRuntimeException : CheetahException { }
public class CheetahStopIterationException : CheetahException { }

Was this doc helpful?

Issue with this doc?

Report a GitHub Issue
Cheetah Speech-to-Text — .NET API
  • Cheetah
  • Create()
  • Process()
  • Flush()
  • FrameLength
  • SampleRate
  • Version
  • CheetahTranscript
  • Transcript
  • IsEndpoint
  • CheetahException
Platform
  • Leopard Speech-to-Text
  • Cheetah Streaming Speech-to-Text
  • Octopus Speech-to-Index
  • Porcupine Wake Word
  • Rhino Speech-to-Intent
  • Cobra Voice Activity Detection
Resources
  • Docs
  • Console
  • Blog
  • Demos
Sales
  • Pricing
  • Starter Tier
  • Enterprise
Company
  • Careers
Follow Picovoice
  • LinkedIn
  • GitHub
  • Twitter
  • Medium
  • YouTube
  • AngelList
Subscribe to our newsletter
Terms of Use
Privacy Policy
© 2019-2022 Picovoice Inc.