FreeSWITCH API Documentation
1.7.0
|
An abstraction of a data frame. More...
#include <switch_frame.h>
Data Fields | |
switch_codec_t * | codec |
const char * | source |
void * | packet |
uint32_t | packetlen |
void * | extra_data |
void * | data |
uint32_t | datalen |
uint32_t | buflen |
uint32_t | samples |
uint32_t | rate |
uint32_t | channels |
switch_payload_t | payload |
uint32_t | timestamp |
uint16_t | seq |
uint32_t | ssrc |
switch_bool_t | m |
switch_frame_flag_t | flags |
void * | user_data |
payload_map_t * | pmap |
switch_image_t * | img |
An abstraction of a data frame.
Definition at line 43 of file switch_frame.h.
uint32_t switch_frame::buflen |
the entire size of the buffer
Definition at line 59 of file switch_frame.h.
Referenced by audio_bridge_thread(), eavesdrop_callback(), find_free_frame(), record_callback(), speech_callback(), switch_core_init(), switch_core_session_request_uuid(), switch_frame_alloc(), switch_frame_dup(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_sleep(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), unicast_thread_run(), video_bug_thread(), video_helper_thread(), and video_write_thread().
uint32_t switch_frame::channels |
the number of channels in the frame
Definition at line 65 of file switch_frame.h.
Referenced by eavesdrop_callback(), find_free_frame(), record_callback(), switch_core_media_set_codec(), switch_core_session_read_frame(), switch_core_session_write_frame(), and switch_ivr_play_file().
switch_codec_t* switch_frame::codec |
a pointer to the codec information
Definition at line 45 of file switch_frame.h.
Referenced by audio_bridge_thread(), find_free_frame(), setup_ringback(), switch_core_media_set_codec(), switch_core_media_set_video_codec(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_frame_dup(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_sleep(), switch_ivr_speak_text(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), and switch_ivr_wait_for_silence().
void* switch_frame::data |
the frame data
Definition at line 55 of file switch_frame.h.
Referenced by audio_bridge_thread(), early_thread_run(), eavesdrop_callback(), find_free_frame(), inband_dtmf_callback(), inband_dtmf_generate_callback(), is_silence_frame(), preprocess_callback(), read_displace_callback(), record_callback(), session_audio_callback(), setup_ringback(), speech_callback(), switch_core_init(), switch_core_session_read_frame(), switch_core_session_request_uuid(), switch_core_session_write_frame(), switch_frame_alloc(), switch_frame_dup(), switch_frame_free(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), tone_detect_callback(), unicast_thread_run(), video_bug_thread(), video_helper_thread(), video_write_thread(), and write_displace_callback().
uint32_t switch_frame::datalen |
the size of the buffer that is in use
Definition at line 57 of file switch_frame.h.
Referenced by audio_bridge_thread(), early_thread_run(), eavesdrop_callback(), find_free_frame(), inband_dtmf_generate_callback(), is_silence_frame(), preprocess_callback(), read_displace_callback(), record_callback(), session_audio_callback(), setup_ringback(), speech_callback(), switch_core_init(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_sleep(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), unicast_thread_run(), and write_displace_callback().
void* switch_frame::extra_data |
the extra frame data
Definition at line 53 of file switch_frame.h.
Referenced by find_free_frame(), and switch_frame_buffer_free().
switch_frame_flag_t switch_frame::flags |
frame flags
Definition at line 74 of file switch_frame.h.
Referenced by find_free_frame(), perform_write(), switch_core_media_read_frame(), switch_core_session_read_frame(), and video_bug_thread().
switch_image_t* switch_frame::img |
Definition at line 77 of file switch_frame.h.
Referenced by eavesdrop_callback(), find_free_frame(), record_callback(), switch_core_media_read_frame(), switch_core_session_write_video_frame(), switch_frame_buffer_free(), switch_frame_dup(), switch_frame_free(), video_bug_thread(), video_eavesdrop_callback(), video_helper_thread(), video_write_overlay_callback(), and video_write_thread().
switch_bool_t switch_frame::m |
Definition at line 72 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_media_read_frame(), switch_core_session_read_frame(), and switch_core_session_write_frame().
void* switch_frame::packet |
the raw packet
Definition at line 49 of file switch_frame.h.
Referenced by find_free_frame(), switch_frame_dup(), switch_frame_free(), switch_ivr_delay_echo(), video_bug_thread(), video_helper_thread(), and video_write_thread().
uint32_t switch_frame::packetlen |
the size of the raw packet when applicable
Definition at line 51 of file switch_frame.h.
Referenced by find_free_frame(), switch_ivr_delay_echo(), video_bug_thread(), video_helper_thread(), and video_write_thread().
switch_payload_t switch_frame::payload |
the payload of the frame
Definition at line 67 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_media_read_frame(), switch_core_session_read_frame(), and switch_core_session_write_frame().
payload_map_t* switch_frame::pmap |
Definition at line 76 of file switch_frame.h.
Referenced by find_free_frame(), and switch_frame_dup().
uint32_t switch_frame::rate |
the rate of the frame
Definition at line 63 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_media_read_frame(), switch_core_media_set_codec(), switch_core_media_set_video_codec(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_eavesdrop_session(), switch_ivr_play_file(), and switch_ivr_speak_text_handle().
uint32_t switch_frame::samples |
the number of audio samples present (audio only)
Definition at line 61 of file switch_frame.h.
Referenced by audio_bridge_thread(), eavesdrop_callback(), find_free_frame(), inband_dtmf_callback(), read_displace_callback(), setup_ringback(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_collect_digits_count(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), tone_detect_callback(), unicast_thread_run(), and write_displace_callback().
uint16_t switch_frame::seq |
Definition at line 70 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_media_read_frame(), switch_core_session_read_frame(), and switch_core_session_write_frame().
const char* switch_frame::source |
the originating source of the frame
Definition at line 47 of file switch_frame.h.
uint32_t switch_frame::ssrc |
Definition at line 71 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_session_read_frame(), and switch_core_session_write_frame().
uint32_t switch_frame::timestamp |
the timestamp of the frame
Definition at line 69 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_play_file(), and switch_ivr_speak_text_handle().
void* switch_frame::user_data |
Definition at line 75 of file switch_frame.h.
Referenced by switch_ivr_collect_digits_callback(), switch_ivr_gentones(), switch_ivr_play_file(), switch_ivr_record_file(), and switch_ivr_speak_text_handle().