#include <switch_module_interfaces.h>
Collaboration diagram for switch_file_handle:
Detailed Description
an abstract representation of a file handle (some parameters based on compat with libsndfile)
Definition at line 316 of file switch_module_interfaces.h.
Field Documentation
◆ audio_buffer
| switch_buffer_t* switch_file_handle::audio_buffer |
Definition at line 351 of file switch_module_interfaces.h.
Referenced by switch_ivr_play_file().
◆ buffer
| switch_buffer_t* switch_file_handle::buffer |
Definition at line 361 of file switch_module_interfaces.h.
Referenced by switch_core_file_close(), switch_core_file_read(), switch_core_file_seek(), and switch_core_file_truncate().
◆ channels
| uint32_t switch_file_handle::channels |
the number of channels
Definition at line 330 of file switch_module_interfaces.h.
Referenced by read_displace_callback(), setup_ringback(), switch_core_file_handle_dup(), switch_core_file_pre_close(), switch_core_file_read(), switch_core_file_write(), switch_core_perform_file_open(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_displace_session(), switch_ivr_insert_file(), switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), and write_displace_callback().
◆ cur_channels
| uint32_t switch_file_handle::cur_channels |
Definition at line 375 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open(), and switch_ivr_play_file().
◆ cur_samplerate
| uint32_t switch_file_handle::cur_samplerate |
Definition at line 376 of file switch_module_interfaces.h.
◆ dbuf
| switch_byte_t* switch_file_handle::dbuf |
Definition at line 362 of file switch_module_interfaces.h.
Referenced by switch_core_file_close(), switch_core_file_read(), and switch_core_file_write().
◆ dbuflen
| switch_size_t switch_file_handle::dbuflen |
Definition at line 363 of file switch_module_interfaces.h.
Referenced by switch_core_file_read(), and switch_core_file_write().
◆ duration
| int64_t switch_file_handle::duration |
total video duration, or total page in pdf
Definition at line 382 of file switch_module_interfaces.h.
◆ fd
| switch_file_t* switch_file_handle::fd |
a file descriptor if neceessary
Definition at line 322 of file switch_module_interfaces.h.
◆ file
| const char* switch_file_handle::file |
Definition at line 367 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ file_interface
| switch_file_interface_t* switch_file_handle::file_interface |
the interface of the module that implemented the current file type
Definition at line 318 of file switch_module_interfaces.h.
Referenced by main(), switch_core_file_close(), switch_core_file_command(), switch_core_file_get_string(), switch_core_file_pre_close(), switch_core_file_read(), switch_core_file_read_video(), switch_core_file_seek(), switch_core_file_set_string(), switch_core_file_truncate(), switch_core_file_write(), switch_core_file_write_video(), and switch_core_perform_file_open().
◆ file_path
| char* switch_file_handle::file_path |
Definition at line 370 of file switch_module_interfaces.h.
Referenced by get_file_size(), switch_core_file_close(), switch_core_perform_file_open(), and switch_ivr_wait_for_answer().
◆ flag_mutex
| switch_mutex_t* switch_file_handle::flag_mutex |
Definition at line 380 of file switch_module_interfaces.h.
Referenced by switch_core_file_command(), switch_core_file_handle_dup(), and switch_core_perform_file_open().
◆ flags
| uint32_t switch_file_handle::flags |
flags to control behaviour
Definition at line 320 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ format
| unsigned int switch_file_handle::format |
integer representation of the format
Definition at line 333 of file switch_module_interfaces.h.
◆ func
| const char* switch_file_handle::func |
Definition at line 368 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ handler
| char* switch_file_handle::handler |
Definition at line 349 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ interval
| uint32_t switch_file_handle::interval |
private data for the format module to store handle specific info
Definition at line 347 of file switch_module_interfaces.h.
◆ line
| int switch_file_handle::line |
Definition at line 369 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ max_samples
| int switch_file_handle::max_samples |
Definition at line 373 of file switch_module_interfaces.h.
Referenced by switch_core_file_close(), switch_core_file_read(), and switch_core_perform_file_open().
◆ memory_pool
| switch_memory_pool_t* switch_file_handle::memory_pool |
the handle's memory pool
Definition at line 343 of file switch_module_interfaces.h.
Referenced by get_file_size(), switch_core_file_close(), switch_core_file_handle_dup(), and switch_core_perform_file_open().
◆ mm
| switch_mm_t switch_file_handle::mm |
Definition at line 379 of file switch_module_interfaces.h.
Referenced by record_callback(), switch_core_perform_file_open(), switch_ivr_record_file_event(), video_helper_thread(), and video_write_thread().
◆ modname
| char* switch_file_handle::modname |
Definition at line 378 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ muxbuf
| void* switch_file_handle::muxbuf |
Definition at line 385 of file switch_module_interfaces.h.
Referenced by switch_core_file_close(), and switch_core_file_write().
◆ muxlen
| switch_size_t switch_file_handle::muxlen |
Definition at line 386 of file switch_module_interfaces.h.
Referenced by switch_core_file_write().
◆ native_rate
| uint32_t switch_file_handle::native_rate |
the current native samplerate
Definition at line 328 of file switch_module_interfaces.h.
Referenced by record_callback(), switch_core_file_read(), switch_core_file_write(), switch_core_perform_file_open(), switch_ivr_insert_file(), switch_ivr_play_file(), switch_ivr_process_fh(), and switch_ivr_record_file_event().
◆ offset_pos
| uint32_t switch_file_handle::offset_pos |
Definition at line 355 of file switch_module_interfaces.h.
Referenced by switch_core_file_seek(), switch_ivr_play_file(), and switch_ivr_process_fh().
◆ params
| switch_event_t* switch_file_handle::params |
Definition at line 374 of file switch_module_interfaces.h.
Referenced by get_recording_var(), switch_core_file_close(), switch_core_perform_file_open(), switch_ivr_play_file(), switch_ivr_record_file_event(), and switch_ivr_record_session_event().
◆ pos
| int64_t switch_file_handle::pos |
Definition at line 350 of file switch_module_interfaces.h.
Referenced by switch_core_file_truncate().
◆ pre_buffer
| switch_buffer_t* switch_file_handle::pre_buffer |
Definition at line 364 of file switch_module_interfaces.h.
Referenced by switch_core_file_command(), switch_core_file_pre_close(), switch_core_file_read(), switch_core_file_seek(), switch_core_file_truncate(), switch_core_file_write(), and switch_core_perform_file_open().
◆ pre_buffer_data
| unsigned char* switch_file_handle::pre_buffer_data |
Definition at line 365 of file switch_module_interfaces.h.
Referenced by switch_core_file_handle_dup(), switch_core_file_pre_close(), switch_core_file_read(), switch_core_file_write(), and switch_core_perform_file_open().
◆ pre_buffer_datalen
| switch_size_t switch_file_handle::pre_buffer_datalen |
Definition at line 366 of file switch_module_interfaces.h.
Referenced by switch_core_file_handle_dup(), switch_core_file_pre_close(), switch_core_file_read(), switch_core_file_write(), switch_core_perform_file_open(), switch_ivr_record_file_event(), and switch_ivr_record_session_event().
◆ prebuf
| uint32_t switch_file_handle::prebuf |
pre-buffer x bytes for streams
Definition at line 345 of file switch_module_interfaces.h.
Referenced by CoreSession::streamFile(), and switch_ivr_play_file().
◆ prefix
| const char* switch_file_handle::prefix |
Definition at line 372 of file switch_module_interfaces.h.
Referenced by switch_ivr_play_file(), and switch_ivr_record_file_event().
◆ private_info
| void* switch_file_handle::private_info |
Definition at line 348 of file switch_module_interfaces.h.
◆ real_channels
| uint32_t switch_file_handle::real_channels |
Definition at line 331 of file switch_module_interfaces.h.
Referenced by switch_core_file_read(), switch_core_file_write(), and switch_core_perform_file_open().
◆ resampler
| switch_audio_resampler_t* switch_file_handle::resampler |
Definition at line 360 of file switch_module_interfaces.h.
Referenced by switch_core_file_close(), switch_core_file_read(), and switch_core_file_write().
◆ sample_count
| switch_size_t switch_file_handle::sample_count |
the sample count of the file
Definition at line 339 of file switch_module_interfaces.h.
◆ samplerate
| uint32_t switch_file_handle::samplerate |
the current samplerate
Definition at line 326 of file switch_module_interfaces.h.
Referenced by record_callback(), setup_ringback(), switch_core_file_read(), switch_core_file_write(), switch_core_perform_file_open(), switch_ivr_displace_session(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), and switch_ivr_wait_for_answer().
◆ samples
| unsigned int switch_file_handle::samples |
samples position of the handle
Definition at line 324 of file switch_module_interfaces.h.
Referenced by CoreSession::streamFile(), switch_ivr_play_file(), and switch_ivr_record_file_event().
◆ samples_in
| switch_size_t switch_file_handle::samples_in |
Definition at line 356 of file switch_module_interfaces.h.
Referenced by switch_core_file_close(), switch_core_file_read(), switch_core_perform_file_open(), and switch_ivr_play_file().
◆ samples_out
| switch_size_t switch_file_handle::samples_out |
Definition at line 357 of file switch_module_interfaces.h.
Referenced by record_callback(), send_record_stop_event(), switch_core_file_seek(), switch_core_file_truncate(), switch_core_file_write(), and switch_ivr_record_file_event().
◆ sections
| unsigned int switch_file_handle::sections |
integer representation of the sections
Definition at line 335 of file switch_module_interfaces.h.
◆ seekable
| int switch_file_handle::seekable |
is the file seekable
Definition at line 337 of file switch_module_interfaces.h.
◆ silence_hits
| uint32_t switch_file_handle::silence_hits |
Definition at line 354 of file switch_module_interfaces.h.
Referenced by CoreSession::recordFile(), and switch_ivr_record_file_event().
◆ sp_audio_buffer
| switch_buffer_t* switch_file_handle::sp_audio_buffer |
Definition at line 352 of file switch_module_interfaces.h.
Referenced by switch_ivr_play_file().
◆ speed
| int switch_file_handle::speed |
the speed of the file playback
Definition at line 341 of file switch_module_interfaces.h.
Referenced by switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_process_fh(), and switch_ivr_wait_for_answer().
◆ spool_path
| char* switch_file_handle::spool_path |
Definition at line 371 of file switch_module_interfaces.h.
Referenced by get_file_size(), switch_core_file_close(), and switch_core_perform_file_open().
◆ stream_name
| char* switch_file_handle::stream_name |
Definition at line 377 of file switch_module_interfaces.h.
Referenced by switch_core_perform_file_open().
◆ thresh
| uint32_t switch_file_handle::thresh |
Definition at line 353 of file switch_module_interfaces.h.
Referenced by CoreSession::recordFile(), and switch_ivr_record_file_event().
◆ vol
| int32_t switch_file_handle::vol |
Definition at line 358 of file switch_module_interfaces.h.
Referenced by switch_ivr_play_file(), and switch_ivr_process_fh().
◆ volgranular
| int32_t switch_file_handle::volgranular |
Definition at line 359 of file switch_module_interfaces.h.
Referenced by switch_ivr_phrase_macro_event(), and switch_ivr_play_file().
◆ vpos
| int64_t switch_file_handle::vpos |
current video position, or current page in pdf
Definition at line 384 of file switch_module_interfaces.h.
The documentation for this struct was generated from the following file:
