porcupine/include/picovoice.h File Reference

#include <stdint.h>

Include dependency graph for porcupine/include/picovoice.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	PV_API   __attribute__((visibility("default")))

Enumerations
enum	pv_status_t {   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED,   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED,   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED,   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED,   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED,   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED,   PV_STATUS_SUCCESS = 0, PV_STATUS_OUT_OF_MEMORY, PV_STATUS_IO_ERROR, PV_STATUS_INVALID_ARGUMENT,   PV_STATUS_STOP_ITERATION, PV_STATUS_KEY_ERROR, PV_STATUS_INVALID_STATE, PV_STATUS_RUNTIME_ERROR,   PV_STATUS_ACTIVATION_ERROR, PV_STATUS_ACTIVATION_LIMIT_REACHED, PV_STATUS_ACTIVATION_THROTTLED, PV_STATUS_ACTIVATION_REFUSED }

Functions
PV_API int32_t	pv_sample_rate (void)
const PV_API char *	pv_status_to_string (pv_status_t status)

Macro Definition Documentation

PV_API

#define PV_API   __attribute__((visibility("default")))

Definition at line 23 of file porcupine/include/picovoice.h.

Enumeration Type Documentation

pv_status_t

enum pv_status_t

Status codes.

Enumerator
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED
PV_STATUS_SUCCESS
PV_STATUS_OUT_OF_MEMORY
PV_STATUS_IO_ERROR
PV_STATUS_INVALID_ARGUMENT
PV_STATUS_STOP_ITERATION
PV_STATUS_KEY_ERROR
PV_STATUS_INVALID_STATE
PV_STATUS_RUNTIME_ERROR
PV_STATUS_ACTIVATION_ERROR
PV_STATUS_ACTIVATION_LIMIT_REACHED
PV_STATUS_ACTIVATION_THROTTLED
PV_STATUS_ACTIVATION_REFUSED

Definition at line 33 of file porcupine/include/picovoice.h.

Function Documentation

pv_sample_rate()

PV_API int32_t pv_sample_rate

(

void

)

Audio sample rate accepted by Picovoice.

pv_status_to_string()

const PV_API char* pv_status_to_string

(

pv_status_t

status

)

Provides string representations of status codes.

Parameters

status

Status code.

Returns

String representation.