switch_file_handle Struct Reference

#include <switch_module_interfaces.h>

Collaboration diagram for switch_file_handle:

[legend]

Data Fields

switch_file_interface_tfile_interface
uint32_t flags
switch_file_tfd
unsigned int samples
uint32_t samplerate
uint32_t native_rate
uint8_t channels
unsigned int format
unsigned int sections
int seekable
switch_size_t sample_count
int speed
switch_memory_pool_tmemory_pool
uint32_t prebuf
uint32_t interval
void * private_info
char * handler
int64_t pos
switch_buffer_taudio_buffer
switch_buffer_tsp_audio_buffer
uint32_t thresh
uint32_t silence_hits
uint32_t offset_pos
switch_size_t samples_in
switch_size_t samples_out
int32_t vol
switch_audio_resampler_tresampler
switch_buffer_tbuffer
switch_byte_tdbuf
switch_size_t dbuflen
switch_buffer_tpre_buffer
unsigned char * pre_buffer_data
switch_size_t pre_buffer_datalen
const char * file
const char * func
int line
char * file_path
char * spool_path
const char * prefix

Detailed Description

an abstract representation of a file handle (some parameters based on compat with libsndfile)

Definition at line 291 of file switch_module_interfaces.h.


Field Documentation

switch_buffer_t* switch_file_handle::audio_buffer

Definition at line 325 of file switch_module_interfaces.h.

switch_buffer_t* switch_file_handle::buffer

Definition at line 334 of file switch_module_interfaces.h.

uint8_t switch_file_handle::channels

the number of channels

Definition at line 305 of file switch_module_interfaces.h.

Referenced by setup_ringback(), switch_ivr_insert_file(), switch_ivr_record_file(), and switch_ivr_wait_for_answer().

switch_byte_t* switch_file_handle::dbuf

Definition at line 335 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::dbuflen

Definition at line 336 of file switch_module_interfaces.h.

switch_file_t* switch_file_handle::fd

a file descriptor if neceessary

Definition at line 297 of file switch_module_interfaces.h.

const char* switch_file_handle::file

Definition at line 340 of file switch_module_interfaces.h.

switch_file_interface_t* switch_file_handle::file_interface

the interface of the module that implemented the current file type

Definition at line 293 of file switch_module_interfaces.h.

char* switch_file_handle::file_path

Definition at line 343 of file switch_module_interfaces.h.

Referenced by switch_ivr_wait_for_answer().

uint32_t switch_file_handle::flags

flags to control behaviour

Definition at line 295 of file switch_module_interfaces.h.

unsigned int switch_file_handle::format

integer representation of the format

Definition at line 307 of file switch_module_interfaces.h.

const char* switch_file_handle::func

Definition at line 341 of file switch_module_interfaces.h.

char* switch_file_handle::handler

Definition at line 323 of file switch_module_interfaces.h.

uint32_t switch_file_handle::interval

private data for the format module to store handle specific info

Definition at line 321 of file switch_module_interfaces.h.

int switch_file_handle::line

Definition at line 342 of file switch_module_interfaces.h.

switch_memory_pool_t* switch_file_handle::memory_pool

the handle's memory pool

Definition at line 317 of file switch_module_interfaces.h.

uint32_t switch_file_handle::native_rate

the current native samplerate

Definition at line 303 of file switch_module_interfaces.h.

Referenced by switch_ivr_insert_file().

uint32_t switch_file_handle::offset_pos

Definition at line 329 of file switch_module_interfaces.h.

int64_t switch_file_handle::pos

Definition at line 324 of file switch_module_interfaces.h.

switch_buffer_t* switch_file_handle::pre_buffer

Definition at line 337 of file switch_module_interfaces.h.

unsigned char* switch_file_handle::pre_buffer_data

Definition at line 338 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::pre_buffer_datalen

Definition at line 339 of file switch_module_interfaces.h.

uint32_t switch_file_handle::prebuf

pre-buffer x bytes for streams

Definition at line 319 of file switch_module_interfaces.h.

const char* switch_file_handle::prefix

Definition at line 345 of file switch_module_interfaces.h.

void* switch_file_handle::private_info

Definition at line 322 of file switch_module_interfaces.h.

switch_audio_resampler_t* switch_file_handle::resampler

Definition at line 333 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::sample_count

the sample count of the file

Definition at line 313 of file switch_module_interfaces.h.

uint32_t switch_file_handle::samplerate

the current samplerate

Definition at line 301 of file switch_module_interfaces.h.

Referenced by record_callback(), setup_ringback(), and switch_ivr_wait_for_answer().

unsigned int switch_file_handle::samples

samples position of the handle

Definition at line 299 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::samples_in

Definition at line 330 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::samples_out

Definition at line 331 of file switch_module_interfaces.h.

Referenced by record_callback().

unsigned int switch_file_handle::sections

integer representation of the sections

Definition at line 309 of file switch_module_interfaces.h.

int switch_file_handle::seekable

is the file seekable

Definition at line 311 of file switch_module_interfaces.h.

uint32_t switch_file_handle::silence_hits

Definition at line 328 of file switch_module_interfaces.h.

switch_buffer_t* switch_file_handle::sp_audio_buffer

Definition at line 326 of file switch_module_interfaces.h.

int switch_file_handle::speed

the speed of the file playback

Definition at line 315 of file switch_module_interfaces.h.

Referenced by switch_ivr_wait_for_answer().

char* switch_file_handle::spool_path

Definition at line 344 of file switch_module_interfaces.h.

uint32_t switch_file_handle::thresh

Definition at line 327 of file switch_module_interfaces.h.

int32_t switch_file_handle::vol

Definition at line 332 of file switch_module_interfaces.h.


The documentation for this struct was generated from the following file:
Generated on Wed May 16 04:00:29 2012 for FreeSWITCH API Documentation by  doxygen 1.4.7