|
Data Structures |
| struct | switch_channel_timetable |
Defines |
| #define | switch_channel_set_running_state(channel, state) switch_channel_perform_set_running_state(channel, state, __FILE__, __SWITCH_FUNC__, __LINE__) |
| #define | switch_channel_set_state(channel, state) switch_channel_perform_set_state(channel, __FILE__, __SWITCH_FUNC__, __LINE__, state) |
| | Set the current state of a channel.
|
| #define | switch_channel_answer(channel) switch_channel_perform_answer(channel, __FILE__, __SWITCH_FUNC__, __LINE__) |
| | Answer a channel (initiate/acknowledge a successful connection).
|
| #define | switch_channel_mark_answered(channel) switch_channel_perform_mark_answered(channel, __FILE__, __SWITCH_FUNC__, __LINE__) |
| | Mark a channel answered with no indication (for outbound calls).
|
| #define | switch_channel_mark_pre_answered(channel) switch_channel_perform_mark_pre_answered(channel, __FILE__, __SWITCH_FUNC__, __LINE__) |
| | Mark a channel pre_answered (early media) with no indication (for outbound calls).
|
| #define | switch_channel_ring_ready(channel) switch_channel_perform_ring_ready(channel, __FILE__, __SWITCH_FUNC__, __LINE__) |
| | Send Ringing message to a channel.
|
| #define | switch_channel_pre_answer(channel) switch_channel_perform_pre_answer(channel, __FILE__, __SWITCH_FUNC__, __LINE__) |
| | Indicate progress on a channel to attempt early media.
|
| #define | switch_channel_mark_ring_ready(channel) switch_channel_perform_mark_ring_ready(channel, __FILE__, __SWITCH_FUNC__, __LINE__) |
| | Indicate a channel is ready to provide ringback.
|
| #define | switch_channel_hangup(channel, hangup_cause) switch_channel_perform_hangup(channel, __FILE__, __SWITCH_FUNC__, __LINE__, hangup_cause) |
| | Hangup a channel flagging it's state machine to end.
|
| #define | switch_channel_stop_broadcast(_channel) if (switch_channel_test_flag(_channel, CF_BROADCAST)) switch_channel_set_flag(_channel, CF_BREAK | CF_STOP_BROADCAST) |
| #define | switch_channel_media_ready(_channel) ((switch_channel_test_flag(_channel, CF_ANSWERED) || switch_channel_test_flag(_channel, CF_EARLY_MEDIA)) && !switch_channel_test_flag(_channel, CF_PROXY_MODE)) |
Typedefs |
| typedef switch_channel_timetable | switch_channel_timetable_t |
Functions |
| switch_channel_state_t | switch_channel_get_state (switch_channel_t *channel) |
| | Get the current state of a channel in the state engine.
|
| switch_channel_state_t | switch_channel_get_running_state (switch_channel_t *channel) |
| uint8_t | switch_channel_ready (switch_channel_t *channel) |
| | Determine if a channel is ready for io.
|
| void | switch_channel_wait_for_state (switch_channel_t *channel, switch_channel_t *other_channel, switch_channel_state_t want_state) |
| switch_status_t | switch_channel_wait_for_flag (switch_channel_t *channel, switch_channel_flag_t want_flag, switch_bool_t pres, uint32_t to) |
| switch_channel_state_t | switch_channel_perform_set_state (switch_channel_t *channel, const char *file, const char *func, int line, switch_channel_state_t state) |
| switch_channel_state_t | switch_channel_perform_set_running_state (switch_channel_t *channel, switch_channel_state_t state, const char *file, const char *func, int line) |
| switch_call_cause_t | switch_channel_str2cause (_In_ const char *str) |
| | return a cause code for a given string
|
| switch_call_cause_t | switch_channel_get_cause (_In_ switch_channel_t *channel) |
| | return the cause code for a given channel
|
| const char * | switch_channel_cause2str (_In_ switch_call_cause_t cause) |
| | return a cause string for a given cause
|
| switch_channel_timetable_t * | switch_channel_get_timetable (_In_ switch_channel_t *channel) |
| | View the timetable of a channel.
|
| switch_status_t | switch_channel_alloc (_In_ switch_channel_t **channel, _In_ switch_memory_pool_t *pool) |
| | Allocate a new channel.
|
| switch_status_t | switch_channel_init (switch_channel_t *channel, switch_core_session_t *session, switch_channel_state_t state, uint32_t flags) |
| | Connect a newly allocated channel to a session object and setup it's initial state.
|
| void | switch_channel_presence (switch_channel_t *channel, const char *rpid, const char *status) |
| | Fire A presence event for the channel.
|
| void | switch_channel_uninit (switch_channel_t *channel) |
| | Uninitalize a channel.
|
| void | switch_channel_set_caller_profile (switch_channel_t *channel, switch_caller_profile_t *caller_profile) |
| | Set the given channel's caller profile.
|
| switch_caller_profile_t * | switch_channel_get_caller_profile (switch_channel_t *channel) |
| | Retrive the given channel's caller profile.
|
| void | switch_channel_set_originator_caller_profile (switch_channel_t *channel, switch_caller_profile_t *caller_profile) |
| | Set the given channel's originator caller profile.
|
| switch_caller_profile_t * | switch_channel_get_originator_caller_profile (switch_channel_t *channel) |
| | Retrive the given channel's originator caller profile.
|
| void | switch_channel_set_originatee_caller_profile (switch_channel_t *channel, switch_caller_profile_t *caller_profile) |
| | Set the given channel's originatee caller profile.
|
| switch_caller_profile_t * | switch_channel_get_originatee_caller_profile (switch_channel_t *channel) |
| | Retrive the given channel's originatee caller profile.
|
| char * | switch_channel_get_uuid (switch_channel_t *channel) |
| | Retrive the given channel's unique id.
|
| switch_status_t | switch_channel_set_variable (switch_channel_t *channel, const char *varname, const char *value) |
| | Set a variable on a given channel.
|
| switch_status_t | switch_channel_set_variable_partner (switch_channel_t *channel, const char *varname, const char *value) |
| const char * | switch_channel_get_variable_partner (switch_channel_t *channel, const char *varname) |
| const char * | switch_channel_get_variable (switch_channel_t *channel, const char *varname) |
| | Retrieve a variable from a given channel.
|
| switch_event_header_t * | switch_channel_variable_first (switch_channel_t *channel) |
| void | switch_channel_variable_last (switch_channel_t *channel) |
| void | switch_channel_set_caller_extension (switch_channel_t *channel, switch_caller_extension_t *caller_extension) |
| | Assign a caller extension to a given channel.
|
| switch_caller_extension_t * | switch_channel_get_caller_extension (switch_channel_t *channel) |
| | Retrieve caller extension from a given channel.
|
| uint32_t | switch_channel_test_flag (switch_channel_t *channel, switch_channel_flag_t flags) |
| | Test for presence of given flag(s) on a given channel.
|
| void | switch_channel_set_flag (switch_channel_t *channel, switch_channel_flag_t flags) |
| | Set given flag(s) on a given channel.
|
| switch_bool_t | switch_channel_set_flag_partner (switch_channel_t *channel, switch_channel_flag_t flags) |
| | Set given flag(s) on a given channel's bridge partner.
|
| switch_bool_t | switch_channel_clear_flag_partner (switch_channel_t *channel, switch_channel_flag_t flags) |
| | Clears given flag(s) on a given channel's bridge partner.
|
| void | switch_channel_set_state_flag (switch_channel_t *channel, switch_channel_flag_t flags) |
| | Set given flag(s) on a given channel to be applied on the next state change.
|
| void | switch_channel_clear_flag (switch_channel_t *channel, switch_channel_flag_t flags) |
| | Clear given flag(s) from a channel.
|
| switch_status_t | switch_channel_perform_answer (switch_channel_t *channel, const char *file, const char *func, int line) |
| switch_status_t | switch_channel_perform_mark_answered (switch_channel_t *channel, const char *file, const char *func, int line) |
| switch_status_t | switch_channel_perform_ring_ready (switch_channel_t *channel, const char *file, const char *func, int line) |
| switch_status_t | switch_channel_perform_pre_answer (switch_channel_t *channel, const char *file, const char *func, int line) |
| switch_status_t | switch_channel_perform_mark_pre_answered (switch_channel_t *channel, const char *file, const char *func, int line) |
| switch_status_t | switch_channel_perform_mark_ring_ready (switch_channel_t *channel, const char *file, const char *func, int line) |
| int | switch_channel_add_state_handler (switch_channel_t *channel, const switch_state_handler_table_t *state_handler) |
| | add a state handler table to a given channel
|
| void | switch_channel_clear_state_handler (switch_channel_t *channel, const switch_state_handler_table_t *state_handler) |
| | clear a state handler table from a given channel
|
| const switch_state_handler_table_t * | switch_channel_get_state_handler (switch_channel_t *channel, int index) |
| | Retrieve an state handler tablefrom a given channel at given index level.
|
| switch_status_t | switch_channel_set_private (switch_channel_t *channel, const char *key, const void *private_info) |
| | Set private data on channel.
|
| void * | switch_channel_get_private (switch_channel_t *channel, const char *key) |
| | Retrieve private from a given channel.
|
| switch_status_t | switch_channel_set_name (switch_channel_t *channel, const char *name) |
| | Assign a name to a given channel.
|
| char * | switch_channel_get_name (switch_channel_t *channel) |
| | Retrieve the name of a given channel.
|
| switch_channel_state_t | switch_channel_perform_hangup (switch_channel_t *channel, const char *file, const char *func, int line, switch_call_cause_t hangup_cause) |
| switch_size_t | switch_channel_has_dtmf (_In_ switch_channel_t *channel) |
| | Test for presence of DTMF on a given channel.
|
| switch_status_t | switch_channel_queue_dtmf (_In_ switch_channel_t *channel, _In_ const switch_dtmf_t *dtmf) |
| | Queue DTMF on a given channel.
|
| switch_status_t | switch_channel_queue_dtmf_string (_In_ switch_channel_t *channel, _In_ const char *dtmf_string) |
| switch_status_t | switch_channel_dequeue_dtmf (_In_ switch_channel_t *channel, _In_ switch_dtmf_t *dtmf) |
| | Retrieve DTMF digits from a given channel.
|
| void | switch_channel_flush_dtmf (_In_ switch_channel_t *channel) |
| switch_size_t | switch_channel_dequeue_dtmf_string (_In_ switch_channel_t *channel, _Out_opt_bytecapcount_(len) char *dtmf_str, _In_ switch_size_t len) |
| const char * | switch_channel_state_name (_In_ switch_channel_state_t state) |
| | Render the name of the provided state enum.
|
| switch_channel_state_t | switch_channel_name_state (_In_ const char *name) |
| | Render the enum of the provided state name.
|
| void | switch_channel_event_set_data (_In_ switch_channel_t *channel, _In_ switch_event_t *event) |
| | Add information about a given channel to an event object.
|
| char * | switch_channel_expand_variables (_In_ switch_channel_t *channel, _In_ const char *in) |
| | Expand varaibles in a string based on the variables in a paticular channel.
|
| char * | switch_channel_build_param_string (_In_ switch_channel_t *channel, _In_opt_ switch_caller_profile_t *caller_profile, _In_opt_ const char *prefix) |
| switch_status_t | switch_channel_set_timestamps (_In_ switch_channel_t *channel) |
