switch_file_interface Struct Reference

#include <switch_module_interfaces.h>

Collaboration diagram for switch_file_interface:

[legend]

---

Detailed Description

Abstract interface to a file format module.

Data Fields
const char *	interface_name
switch_status_t(*	file_open )(switch_file_handle_t *, const char *file_path)
switch_status_t(*	file_close )(switch_file_handle_t *)
switch_status_t(*	file_read )(switch_file_handle_t *, void *data, switch_size_t *len)
switch_status_t(*	file_write )(switch_file_handle_t *, void *data, switch_size_t *len)
switch_status_t(*	file_seek )(switch_file_handle_t *, unsigned int *cur_pos, int64_t samples, int whence)
switch_status_t(*	file_set_string )(switch_file_handle_t *fh, switch_audio_col_t col, const char *string)
switch_status_t(*	file_get_string )(switch_file_handle_t *fh, switch_audio_col_t col, const char **string)
char **	extens
switch_thread_rwlock_t *	rwlock
switch_file_interface *	next

---

Field Documentation

char** switch_file_interface::extens

list of supported file extensions

switch_status_t(* switch_file_interface::file_close)(switch_file_handle_t *)

function to close the file

switch_status_t(* switch_file_interface::file_get_string)(switch_file_handle_t *fh, switch_audio_col_t col, const char **string)

function to get meta data

switch_status_t(* switch_file_interface::file_open)(switch_file_handle_t *, const char *file_path)

function to open the file

switch_status_t(* switch_file_interface::file_read)(switch_file_handle_t *, void *data, switch_size_t *len)

function to read from the file

switch_status_t(* switch_file_interface::file_seek)(switch_file_handle_t *, unsigned int *cur_pos, int64_t samples, int whence)

function to seek to a certian position in the file

switch_status_t(* switch_file_interface::file_set_string)(switch_file_handle_t *fh, switch_audio_col_t col, const char *string)

function to set meta data

switch_status_t(* switch_file_interface::file_write)(switch_file_handle_t *, void *data, switch_size_t *len)

function to write from the file

const char* switch_file_interface::interface_name

the name of the interface

struct switch_file_interface* switch_file_interface::next

switch_thread_rwlock_t* switch_file_interface::rwlock

---

The documentation for this struct was generated from the following file:

• switch_module_interfaces.h

---