RTS API Documentation  1.10.11
Data Fields
switch_file_interface Struct Reference

Abstract interface to a file format module. More...

#include <switch_module_interfaces.h>

+ Collaboration diagram for switch_file_interface:

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_truncate )(switch_file_handle_t *, int64_t offset)
 
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_read_video )(switch_file_handle_t *, switch_frame_t *frame, switch_video_read_flag_t flags)
 
switch_status_t(* file_write_video )(switch_file_handle_t *, switch_frame_t *frame)
 
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)
 
switch_status_t(* file_pre_close )(switch_file_handle_t *fh)
 
switch_status_t(* file_command )(switch_file_handle_t *fh, switch_file_command_t command)
 
char ** extens
 
switch_thread_rwlock_trwlock
 
int refs
 
switch_mutex_treflock
 
switch_loadable_module_interface_tparent
 
struct switch_file_interfacenext
 

Detailed Description

Abstract interface to a file format module.

Definition at line 279 of file switch_module_interfaces.h.

Field Documentation

◆ extens

char** switch_file_interface::extens

list of supported file extensions

Definition at line 307 of file switch_module_interfaces.h.

Referenced by switch_loadable_module_process(), and switch_loadable_module_unprocess().

◆ file_close

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

function to close the file

Definition at line 285 of file switch_module_interfaces.h.

Referenced by switch_core_file_close(), and switch_core_perform_file_open().

◆ file_command

switch_status_t(* switch_file_interface::file_command) (switch_file_handle_t *fh, switch_file_command_t command)

function to control the underlying tech of the file

Definition at line 305 of file switch_module_interfaces.h.

Referenced by switch_core_file_command().

◆ file_get_string

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

Definition at line 301 of file switch_module_interfaces.h.

Referenced by switch_core_file_get_string().

◆ file_open

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

function to open the file

Definition at line 283 of file switch_module_interfaces.h.

Referenced by switch_core_perform_file_open().

◆ file_pre_close

switch_status_t(* switch_file_interface::file_pre_close) (switch_file_handle_t *fh)

function to pre close the file to read params

Definition at line 303 of file switch_module_interfaces.h.

Referenced by switch_core_file_pre_close().

◆ file_read

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

function to read from the file

Definition at line 289 of file switch_module_interfaces.h.

Referenced by switch_core_file_read().

◆ file_read_video

switch_status_t(* switch_file_interface::file_read_video) (switch_file_handle_t *, switch_frame_t *frame, switch_video_read_flag_t flags)

function to seek to a certian position in the file

Definition at line 293 of file switch_module_interfaces.h.

Referenced by switch_core_file_read_video(), and switch_core_perform_file_open().

◆ file_seek

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

Definition at line 297 of file switch_module_interfaces.h.

Referenced by switch_core_file_seek().

◆ file_set_string

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

Definition at line 299 of file switch_module_interfaces.h.

Referenced by switch_core_file_set_string().

◆ file_truncate

switch_status_t(* switch_file_interface::file_truncate) (switch_file_handle_t *, int64_t offset)

function to close the file

Definition at line 287 of file switch_module_interfaces.h.

Referenced by switch_core_file_truncate().

◆ file_write

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

function to write from the file

Definition at line 291 of file switch_module_interfaces.h.

Referenced by switch_core_file_pre_close(), and switch_core_file_write().

◆ file_write_video

switch_status_t(* switch_file_interface::file_write_video) (switch_file_handle_t *, switch_frame_t *frame)

function to write from the file

Definition at line 295 of file switch_module_interfaces.h.

Referenced by switch_core_file_write_video().

◆ interface_name

const char* switch_file_interface::interface_name

the name of the interface

Definition at line 281 of file switch_module_interfaces.h.

Referenced by switch_loadable_module_process(), and switch_loadable_module_unprocess().

◆ next

struct switch_file_interface* switch_file_interface::next

◆ parent

switch_loadable_module_interface_t* switch_file_interface::parent

Definition at line 311 of file switch_module_interfaces.h.

◆ reflock

switch_mutex_t* switch_file_interface::reflock

Definition at line 310 of file switch_module_interfaces.h.

◆ refs

int switch_file_interface::refs

Definition at line 309 of file switch_module_interfaces.h.

◆ rwlock

switch_thread_rwlock_t* switch_file_interface::rwlock

Definition at line 308 of file switch_module_interfaces.h.

Referenced by switch_loadable_module_unprocess().


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