lib/ios/PvPorcupine.xcframework/ios-arm64_armv7/PvPorcupine.framework/Headers/pv_porcupine.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_PORCUPINE_H
#define PV_PORCUPINE_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "picovoice.h"
 
#ifdef __cplusplus
 
extern "C" {
 
#endif
 
typedef struct pv_porcupine pv_porcupine_t;
 
#if defined(__PV_NO_DYNAMIC_MEMORY__) && defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_porcupine_init(
        const char *access_key,
        int32_t memory_size,
        void *memory_buffer,
        int32_t num_keywords,
        const int32_t *keyword_model_sizes,
        const void *const *keyword_models,
        const float *sensitivities,
        pv_porcupine_t **object);
 
#elif !defined(__PV_NO_DYNAMIC_MEMORY__) && defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_porcupine_init(
        const char *access_key,
        int32_t num_keywords,
        const int32_t *keyword_model_sizes,
        const void *const *keyword_models,
        const float *sensitivities,
        pv_porcupine_t **object);
 
#elif !defined(__PV_NO_DYNAMIC_MEMORY__) && !defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_porcupine_init(
        const char *access_key,
        const char *model_path,
        int32_t num_keywords,
        const char *const *keyword_paths,
        const float *sensitivities,
        pv_porcupine_t **object);
 
#else
 
#error
 
#endif
 
PV_API void pv_porcupine_delete(pv_porcupine_t *object);
 
PV_API pv_status_t pv_porcupine_process(pv_porcupine_t *object, const int16_t *pcm, int32_t *keyword_index);
 
#if defined(__PV_NO_DYNAMIC_MEMORY__) && defined(__PV_NO_FILE_SYSTEM__)
 
PV_API pv_status_t pv_porcupine_get_min_memory_buffer_size(
        int32_t preliminary_memory_size,
        void *preliminary_memory_buffer,
        int32_t num_keywords,
        const int32_t *keyword_model_sizes,
        const void *const *keyword_models,
        int32_t *min_memory_buffer_size);
 
#endif
 
PV_API const char *pv_porcupine_version(void);
 
PV_API int32_t pv_porcupine_frame_length(void);
 
#ifdef __cplusplus
}
 
#endif
 
#endif // PV_PORCUPINE_H