Zebra Translate
C API

API Reference for the Zebra C SDK.

pv_zebra_t

typedef struct pv_zebra pv_zebra_t;

Container representing the Zebra Translate object.

pv_zebra_init()

pv_status_t pv_zebra_init(
        const char *access_key,
        const char *model_path,
        const char *device,
        pv_zebra_t **object);

Creates a Zebra instance. Resources should be cleaned when you are done using the pv_zebra_delete() function.

Parameters

• access_key const char * : AccessKey obtained from Picovoice Console.
• model_path const char * : Absolute path to the file containing model parameters (.pv). Sets the source and target translation languages.
• device char * : String representation of the device (e.g., CPU or GPU) to use. If set to best, the most suitable device is selected automatically. If set to gpu, the engine uses the first available GPU device. To select a specific GPU device, set this argument to gpu:${GPU_INDEX}, where ${GPU_INDEX} is the index of the target GPU. If set to cpu, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this argument to cpu:${NUM_THREADS}, where ${NUM_THREADS} is the desired number of threads.
• object pv_zebra_t * * : Constructed instance of Zebra.

Returns

• pv_status_t : Status code.

pv_zebra_delete()

void pv_zebra_delete(pv_zebra_t *object);

Releases resources acquired by Zebra.

Parameters

• object pv_zebra_t * : Zebra object.

pv_zebra_translate()

pv_status_t pv_zebra_translate(
    pv_zebra_t *object,
    const char *text,
    char **translation);

Translates text. The maximum number of characters that can be translated at once is given by pv_zebra_max_character_limit.

Parameters

• object pv_zebra_t * : Zebra object.
• text char * : Text to translate.
• translation char ** : Translated text.

Returns

• pv_status_t : Status code.

pv_zebra_translation_delete()

void pv_zebra_translation_delete(char *translation);

Deletes translation returned from pv_zebra_translate().

Parameters

• translation char * : Translation string returned from pv_zebra_translate().

pv_zebra_version()

const char *pv_zebra_version(void);

Getter for version.

Returns

• const char * : Zebra version.

pv_zebra_max_character_limit()

pv_status_t pv_zebra_max_character_limit(
        const pv_zebra_t *object,
        int32_t *max_character_limit);

Getter for the maximum number of characters that can be translated at once.

Parameters

• object pv_zebra_t * : Zebra object.
• max_character_limit int32_t * : Maximum number of characters.

Returns

• pv_status_t : Status code.

pv_zebra_list_hardware_devices()

pv_status_t pv_zebra_list_hardware_devices(
        char ***hardware_devices,
        int32_t *num_hardware_devices);

Gets a list of hardware devices that can be specified when calling pv_zebra_init().

Parameters

• hardware_devices const char * * * : Array of available hardware devices. Devices are NULL terminated strings. The array must be freed using pv_zebra_free_hardware_devices().
• num_hardware_devices int32_t * : The number of devices in the hardware_devices array.

Returns

• pv_status_t : Returned status code.

pv_zebra_free_hardware_devices()

void pv_zebra_free_hardware_devices(
        char ***hardware_devices,
        int32_t *num_hardware_devices);

This function frees the memory allocated by pv_zebra_list_hardware_devices().

Parameters

• hardware_devices const char * * * : Array of available hardware devices allocated by pv_zebra_list_hardware_devices().
• num_hardware_devices int32_t * : The number of devices in the hardware_devices array

pv_status_t

typedef enum {
    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_t;

Status code enum.

pv_status_to_string()

const char *pv_status_to_string(pv_status_t status);

Parameters

• status int32_t : Status code.

Returns

• const char * : String representation of status code.

pv_get_error_stack()

pv_status_t pv_get_error_stack(
        char ***message_stack,
        int32_t *message_stack_depth);

If a function returns a failure (any pv_status_t other than PV_STATUS_SUCCESS), this function can be called to get a series of error messages related to the failure. This function can only be called only once per failure status on another function. The memory for message_stack must be freed using pv_free_error_stack.

Regardless of the return status of this function, if message_stack is not NULL, then message_stack contains valid memory. However, a failure status on this function indicates that future error messages may not be reported.

Parameters

• message_stack const char * * * : Array of messages relating to the failure. Messages are NULL terminated strings. The array and messages must be freed using pv_free_error_stack().
• message_stack_depth int32_t * : The number of messages in the message_stack array.

pv_free_error_stack()

void pv_free_error_stack(char **message_stack);

This function frees the memory used by error messages allocated by pv_get_error_stack().

Parameters

• message_stack const char * * : Array of messages relating to the failure.