lib/ios/PvRhino.xcframework/ios-arm64_i386_x86_64-simulator/PvRhino.framework/Headers/pv_rhino.h

Go to the documentation of this file.

/*
    Copyright 2018-2021 Picovoice Inc.
 
    You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
    file accompanying this source.
 
    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
    an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
    specific language governing permissions and limitations under the License.
*/
 
#ifndef PV_RHINO_H
#define PV_RHINO_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "picovoice.h"
 
#ifdef __cplusplus
 
extern "C" {
 
#endif
 
typedef struct pv_rhino pv_rhino_t;
 
#if defined(__PV_NO_DYNAMIC_MEMORY__) && defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_rhino_init(
        const char *access_key,
        void *memory_buffer,
        int32_t memory_size,
        const void *context,
        int32_t context_size,
        float sensitivity,
        bool require_endpoint,
        pv_rhino_t **object);
 
#elif !defined(__PV_NO_DYNAMIC_MEMORY__) && defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_rhino_init(
        const char *access_key,
        const void *context,
        int32_t context_size,
        float sensitivity,
        bool require_endpoint,
        pv_rhino_t **object);
 
#elif !defined(__PV_NO_DYNAMIC_MEMORY__) && !defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_rhino_init(
        const char *access_key,
        const char *model_path,
        const char *context_path,
        float sensitivity,
        bool require_endpoint,
        pv_rhino_t **object);
 
#else
 
#error
 
#endif
 
PV_API void pv_rhino_delete(pv_rhino_t *object);
 
PV_API pv_status_t pv_rhino_process(pv_rhino_t *object, const int16_t *pcm, bool *is_finalized);
 
PV_API pv_status_t pv_rhino_is_understood(const pv_rhino_t *object, bool *is_understood);
 
PV_API pv_status_t pv_rhino_get_intent(
        const pv_rhino_t *object,
        const char **intent,
        int32_t *num_slots,
        const char ***slots,
        const char ***values);
 
PV_API pv_status_t pv_rhino_free_slots_and_values(const pv_rhino_t *object, const char **slots, const char **values);
 
PV_API pv_status_t pv_rhino_reset(pv_rhino_t *object);
 
PV_API pv_status_t pv_rhino_context_info(const pv_rhino_t *object, const char **context_info);
 
#if defined(__PV_NO_DYNAMIC_MEMORY__) && defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_rhino_get_min_memory_buffer_size(
        void *preliminary_memory_buffer,
        int32_t preliminary_memory_size,
        const void *context_model,
        int32_t context_model_size,
        int32_t *min_memory_buffer_size);
 
#endif
 
PV_API const char *pv_rhino_version(void);
 
PV_API int32_t pv_rhino_frame_length(void);
 
#ifdef __cplusplus
}
 
#endif
 
#endif // PV_RHINO_H