porcupine/demo/c/pvrecorder/include/pv_recorder.h

Go to the documentation of this file.

/*
    Copyright 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_RECORDER_H
#define PV_RECORDER_H
 
#include <stdbool.h>
#include <stdint.h>
 
#define PV_API __attribute__((visibility ("default")))
 
#define PV_RECORDER_DEFAULT_DEVICE_INDEX (-1)
 
typedef struct pv_recorder pv_recorder_t;
 
typedef enum {
    PV_RECORDER_STATUS_SUCCESS = 0,
    PV_RECORDER_STATUS_OUT_OF_MEMORY,
    PV_RECORDER_STATUS_INVALID_ARGUMENT,
    PV_RECORDER_STATUS_INVALID_STATE,
    PV_RECORDER_STATUS_BACKEND_ERROR,
    PV_RECORDER_STATUS_DEVICE_ALREADY_INITIALIZED,
    PV_RECORDER_STATUS_DEVICE_NOT_INITIALIZED,
    PV_RECORDER_STATUS_IO_ERROR,
    PV_RECORDER_STATUS_RUNTIME_ERROR
} pv_recorder_status_t;
 
PV_API pv_recorder_status_t pv_recorder_init(
        int32_t device_index,
        int32_t frame_length,
        int32_t buffer_size_msec,
        bool log_overflow,
        pv_recorder_t **object);
 
PV_API void pv_recorder_delete(pv_recorder_t *object);
 
PV_API pv_recorder_status_t pv_recorder_start(pv_recorder_t *object);
 
PV_API pv_recorder_status_t pv_recorder_stop(pv_recorder_t *object);
 
PV_API pv_recorder_status_t pv_recorder_read(pv_recorder_t *object, int16_t *pcm);
 
PV_API const char *pv_recorder_get_selected_device(pv_recorder_t *object);
 
PV_API pv_recorder_status_t pv_recorder_get_audio_devices(int32_t *count, char ***devices);
 
PV_API void pv_recorder_free_device_list(int32_t count, char **devices);
 
PV_API const char *pv_recorder_status_to_string(pv_recorder_status_t status);
 
PV_API const char *pv_recorder_version(void);
 
#endif //PV_RECORDER_H