An abstraction of a data frame. More...
#include <switch_frame.h>
Collaboration diagram for switch_frame:
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 |
| struct switch_frame_geometry | geometry |
Detailed Description
An abstraction of a data frame.
Definition at line 54 of file switch_frame.h.
Field Documentation
◆ buflen
| uint32_t switch_frame::buflen |
the entire size of the buffer
Definition at line 70 of file switch_frame.h.
Referenced by audio_bridge_thread(), eavesdrop_callback(), find_free_frame(), record_callback(), speech_callback(), switch_core_init(), switch_core_media_bug_read(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_request_uuid(), switch_core_session_set_codec_slin(), switch_core_session_write_blank_video(), switch_core_session_write_frame(), switch_frame_alloc(), switch_frame_buffer_dup(), switch_frame_dup(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_sleep(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_jb_peek_frame(), switch_media_handle_create(), unicast_thread_run(), video_bug_thread(), video_helper_thread(), and video_write_thread().
◆ channels
| uint32_t switch_frame::channels |
the number of channels in the frame
Definition at line 76 of file switch_frame.h.
Referenced by eavesdrop_callback(), find_free_frame(), record_callback(), switch_core_media_bug_read(), switch_core_media_set_codec(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_eavesdrop_session(), and switch_ivr_play_file().
◆ codec
| switch_codec_t* switch_frame::codec |
a pointer to the codec information
Definition at line 56 of file switch_frame.h.
Referenced by audio_bridge_thread(), eavesdrop_callback(), find_free_frame(), setup_ringback(), switch_core_media_bug_read(), switch_core_media_set_codec(), switch_core_media_set_video_codec(), switch_core_session_read_frame(), switch_core_session_set_codec_slin(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_unset_read_codec(), switch_core_session_write_frame(), switch_frame_dup(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_sleep(), switch_ivr_speak_text(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), and switch_ivr_wait_for_silence().
◆ data
| void* switch_frame::data |
the frame data
Definition at line 66 of file switch_frame.h.
Referenced by audio_bridge_thread(), build_red_packet(), 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_media_bug_read(), switch_core_media_read_frame(), switch_core_session_print(), switch_core_session_printf(), switch_core_session_read_frame(), switch_core_session_request_uuid(), switch_core_session_set_codec_slin(), switch_core_session_write_blank_video(), switch_core_session_write_frame(), switch_core_session_write_text_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_detect_audio(), switch_ivr_detect_silence(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_jb_peek_frame(), switch_packetizer_read(), switch_rtp_write_frame(), switch_rtp_zerocopy_read_frame(), text_bridge_thread(), text_helper_thread(), tone_detect_callback(), unicast_thread_run(), video_bug_thread(), video_helper_thread(), video_write_thread(), and write_displace_callback().
◆ datalen
| uint32_t switch_frame::datalen |
the size of the buffer that is in use
Definition at line 68 of file switch_frame.h.
Referenced by audio_bridge_thread(), build_red_packet(), 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_codec_encode_video(), switch_core_init(), switch_core_media_bug_read(), switch_core_media_read_frame(), switch_core_media_write_frame(), switch_core_session_print(), switch_core_session_printf(), switch_core_session_read_frame(), switch_core_session_set_codec_slin(), switch_core_session_write_frame(), switch_core_session_write_text_frame(), switch_core_session_write_video_frame(), switch_frame_dup(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_sleep(), switch_ivr_speak_text_handle(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_jb_peek_frame(), switch_packetizer_read(), switch_rtp_write_frame(), switch_rtp_zerocopy_read_frame(), text_bridge_thread(), text_helper_thread(), unicast_thread_run(), and write_displace_callback().
◆ extra_data
| void* switch_frame::extra_data |
the extra frame data
Definition at line 64 of file switch_frame.h.
Referenced by find_free_frame(), and switch_frame_buffer_free().
◆ flags
| switch_frame_flag_t switch_frame::flags |
frame flags
Definition at line 85 of file switch_frame.h.
Referenced by find_free_frame(), perform_write(), switch_core_codec_encode_video(), switch_core_media_bug_read(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_core_session_write_video_frame(), switch_rtp_write_frame(), switch_rtp_zerocopy_read_frame(), video_bug_thread(), and video_write_thread().
◆ geometry
| struct switch_frame_geometry switch_frame::geometry |
Definition at line 89 of file switch_frame.h.
◆ img
| switch_image_t* switch_frame::img |
Definition at line 88 of file switch_frame.h.
Referenced by eavesdrop_callback(), find_free_frame(), record_callback(), switch_core_media_bug_patch_video(), switch_core_media_bug_push_spy_frame(), switch_core_media_read_frame(), switch_core_session_write_blank_video(), 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().
◆ m
| switch_bool_t switch_frame::m |
Definition at line 83 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_core_session_write_text_frame(), switch_core_session_write_video_frame(), switch_jb_peek_frame(), switch_packetizer_read(), switch_rtp_write_frame(), and switch_rtp_zerocopy_read_frame().
◆ packet
| void* switch_frame::packet |
the raw packet
Definition at line 60 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_session_write_blank_video(), switch_frame_dup(), switch_frame_free(), switch_ivr_delay_echo(), switch_rtp_write_frame(), switch_rtp_zerocopy_read_frame(), video_bug_thread(), video_helper_thread(), and video_write_thread().
◆ packetlen
| uint32_t switch_frame::packetlen |
the size of the raw packet when applicable
Definition at line 62 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_codec_encode_video(), switch_core_session_write_blank_video(), switch_frame_dup(), switch_ivr_delay_echo(), switch_rtp_write_frame(), switch_rtp_zerocopy_read_frame(), video_bug_thread(), video_helper_thread(), and video_write_thread().
◆ payload
| switch_payload_t switch_frame::payload |
the payload of the frame
Definition at line 78 of file switch_frame.h.
Referenced by build_red_packet(), find_free_frame(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_core_session_write_text_frame(), switch_rtp_write_frame(), and switch_rtp_zerocopy_read_frame().
◆ pmap
| payload_map_t* switch_frame::pmap |
Definition at line 87 of file switch_frame.h.
Referenced by find_free_frame(), switch_frame_dup(), switch_rtp_write_frame(), and switch_rtp_zerocopy_read_frame().
◆ rate
| uint32_t switch_frame::rate |
the rate of the frame
Definition at line 74 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_media_bug_read(), 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().
◆ samples
| uint32_t switch_frame::samples |
the number of audio samples present (audio only)
Definition at line 72 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_bug_read(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_collect_digits_count(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), 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().
◆ seq
| uint16_t switch_frame::seq |
Definition at line 81 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_wait_for_silence(), switch_jb_peek_frame(), and switch_rtp_zerocopy_read_frame().
◆ source
| const char* switch_frame::source |
the originating source of the frame
Definition at line 58 of file switch_frame.h.
Referenced by switch_rtp_zerocopy_read_frame().
◆ ssrc
| uint32_t switch_frame::ssrc |
Definition at line 82 of file switch_frame.h.
Referenced by find_free_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_rtp_write_frame(), and switch_rtp_zerocopy_read_frame().
◆ timestamp
| uint32_t switch_frame::timestamp |
the timestamp of the frame
Definition at line 80 of file switch_frame.h.
Referenced by build_red_packet(), find_free_frame(), switch_core_media_read_frame(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_core_session_write_text_frame(), switch_core_session_write_video_frame(), switch_ivr_play_file(), switch_ivr_speak_text_handle(), switch_jb_peek_frame(), switch_rtp_write_frame(), switch_rtp_zerocopy_read_frame(), and video_write_thread().
◆ user_data
| void* switch_frame::user_data |
Definition at line 86 of file switch_frame.h.
The documentation for this struct was generated from the following file:
