FreeSWITCH API Documentation  1.7.0
Data Fields
switch_file_handle Struct Reference

#include <switch_module_interfaces.h>

+ Collaboration diagram for switch_file_handle:

Data Fields

switch_file_interface_tfile_interface
 
uint32_t flags
 
switch_file_tfd
 
unsigned int samples
 
uint32_t samplerate
 
uint32_t native_rate
 
uint32_t channels
 
uint32_t real_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
 
int max_samples
 
switch_event_tparams
 
uint32_t cur_channels
 
uint32_t cur_samplerate
 
char * stream_name
 
char * modname
 
switch_mm_t mm
 
switch_mutex_tflag_mutex
 
int64_t duration
 
int64_t vpos
 

Detailed Description

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

Definition at line 333 of file switch_module_interfaces.h.

Field Documentation

switch_buffer_t* switch_file_handle::audio_buffer

Definition at line 368 of file switch_module_interfaces.h.

switch_buffer_t* switch_file_handle::buffer

Definition at line 377 of file switch_module_interfaces.h.

uint32_t switch_file_handle::channels
uint32_t switch_file_handle::cur_channels

Definition at line 391 of file switch_module_interfaces.h.

uint32_t switch_file_handle::cur_samplerate

Definition at line 392 of file switch_module_interfaces.h.

switch_byte_t* switch_file_handle::dbuf

Definition at line 378 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::dbuflen

Definition at line 379 of file switch_module_interfaces.h.

int64_t switch_file_handle::duration

total video duration, or total page in pdf

Definition at line 398 of file switch_module_interfaces.h.

switch_file_t* switch_file_handle::fd

a file descriptor if neceessary

Definition at line 339 of file switch_module_interfaces.h.

const char* switch_file_handle::file

Definition at line 383 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 335 of file switch_module_interfaces.h.

Referenced by main().

char* switch_file_handle::file_path

Definition at line 386 of file switch_module_interfaces.h.

Referenced by switch_ivr_wait_for_answer().

switch_mutex_t* switch_file_handle::flag_mutex

Definition at line 396 of file switch_module_interfaces.h.

uint32_t switch_file_handle::flags

flags to control behaviour

Definition at line 337 of file switch_module_interfaces.h.

unsigned int switch_file_handle::format

integer representation of the format

Definition at line 350 of file switch_module_interfaces.h.

const char* switch_file_handle::func

Definition at line 384 of file switch_module_interfaces.h.

char* switch_file_handle::handler

Definition at line 366 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 364 of file switch_module_interfaces.h.

int switch_file_handle::line

Definition at line 385 of file switch_module_interfaces.h.

int switch_file_handle::max_samples

Definition at line 389 of file switch_module_interfaces.h.

switch_memory_pool_t* switch_file_handle::memory_pool

the handle's memory pool

Definition at line 360 of file switch_module_interfaces.h.

switch_mm_t switch_file_handle::mm

Definition at line 395 of file switch_module_interfaces.h.

Referenced by video_helper_thread(), and video_write_thread().

char* switch_file_handle::modname

Definition at line 394 of file switch_module_interfaces.h.

uint32_t switch_file_handle::native_rate

the current native samplerate

Definition at line 345 of file switch_module_interfaces.h.

Referenced by switch_ivr_insert_file().

uint32_t switch_file_handle::offset_pos

Definition at line 372 of file switch_module_interfaces.h.

switch_event_t* switch_file_handle::params

Definition at line 390 of file switch_module_interfaces.h.

int64_t switch_file_handle::pos

Definition at line 367 of file switch_module_interfaces.h.

switch_buffer_t* switch_file_handle::pre_buffer

Definition at line 380 of file switch_module_interfaces.h.

unsigned char* switch_file_handle::pre_buffer_data

Definition at line 381 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::pre_buffer_datalen

Definition at line 382 of file switch_module_interfaces.h.

Referenced by switch_ivr_record_session().

uint32_t switch_file_handle::prebuf

pre-buffer x bytes for streams

Definition at line 362 of file switch_module_interfaces.h.

Referenced by CoreSession::streamFile().

const char* switch_file_handle::prefix

Definition at line 388 of file switch_module_interfaces.h.

void* switch_file_handle::private_info

Definition at line 365 of file switch_module_interfaces.h.

uint32_t switch_file_handle::real_channels

Definition at line 348 of file switch_module_interfaces.h.

switch_audio_resampler_t* switch_file_handle::resampler

Definition at line 376 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::sample_count

the sample count of the file

Definition at line 356 of file switch_module_interfaces.h.

uint32_t switch_file_handle::samplerate

the current samplerate

Definition at line 343 of file switch_module_interfaces.h.

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

unsigned int switch_file_handle::samples

samples position of the handle

Definition at line 341 of file switch_module_interfaces.h.

Referenced by CoreSession::streamFile().

switch_size_t switch_file_handle::samples_in

Definition at line 373 of file switch_module_interfaces.h.

switch_size_t switch_file_handle::samples_out

Definition at line 374 of file switch_module_interfaces.h.

Referenced by record_callback(), and send_record_stop_event().

unsigned int switch_file_handle::sections

integer representation of the sections

Definition at line 352 of file switch_module_interfaces.h.

int switch_file_handle::seekable

is the file seekable

Definition at line 354 of file switch_module_interfaces.h.

uint32_t switch_file_handle::silence_hits

Definition at line 371 of file switch_module_interfaces.h.

Referenced by CoreSession::recordFile().

switch_buffer_t* switch_file_handle::sp_audio_buffer

Definition at line 369 of file switch_module_interfaces.h.

int switch_file_handle::speed

the speed of the file playback

Definition at line 358 of file switch_module_interfaces.h.

Referenced by switch_ivr_originate(), and switch_ivr_wait_for_answer().

char* switch_file_handle::spool_path

Definition at line 387 of file switch_module_interfaces.h.

char* switch_file_handle::stream_name

Definition at line 393 of file switch_module_interfaces.h.

uint32_t switch_file_handle::thresh

Definition at line 370 of file switch_module_interfaces.h.

Referenced by CoreSession::recordFile().

int32_t switch_file_handle::vol

Definition at line 375 of file switch_module_interfaces.h.

int64_t switch_file_handle::vpos

current video position, or current page in pdf

Definition at line 400 of file switch_module_interfaces.h.


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