Picovoice Platform — .NET API
API Reference for the .NET Picovoice SDK (NuGet )
Class for Picovoice.
accessKeystring : AccessKey obtained from Picovoice Console .
keywordPathstring : Absolute path to a Porcupine keyword model file (
wakeWordCallbackAction : User-defined callback invoked upon detection of the keyword phrase.
contextPathstring : Absolute path to a Rhino context file (
inferenceCallbackAction<Inference> : User-defined callback invoked upon completion of intent inference. Has a single argument of type Inference.
porcupineModelPathstring : Absolute path to the file containing Porcupine model parameters (
porcupineSensitivityfloat : Keyword sensitivity. It should be a number within [0, 1].
rhinoModelPathstring : Absolute path to the file containing Rhino model parameters (
rhinoSensitivityfloat : Inference sensitivity. It should be a number within [0, 1].
endpointDurationSecfloat : Endpoint duration in seconds. An endpoint is a chunk of silence at the end of an utterance that marks the end of spoken command. It should be a positive number within [0.5, 5]. A lower endpoint duration reduces delay and improves responsiveness. A higher endpoint duration assures Rhino doesn't return inference pre-emptively in case the user pauses before finishing the request.
requireEndpointbool : If set to
true, Rhino requires an endpoint (a chunk of silence) after the spoken command. If set to
false, Rhino tries to detect silence, but if it cannot, it still will provide inference regardless. Set to
falseonly if operating in an environment with overlapping speech (e.g. people talking in the background).
Picovoice: An instance of Picovoice.
PicovoiceException: If an error occurs while creating an instance of the Picovoice platform.
Processes a frame of the incoming audio stream and emits the detection result. 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. Picovoice operates on single-channel audio.
pcmshort : A frame of audio samples.
PicovoiceException: If there is an error while processing the audio frame.
Getter for Rhino context information.
string: Returns the Rhino context information.
Getter for number of audio samples per frame.
int: Number of audio samples per frame.
Getter for audio sample rate accepted by Picovoice.
int: Audio sample rate accepted by Picovoice.
Getter for version.
Exception thrown if an error occurs within the