FreeSDP Parsing Module


Files

file  parser.h
 Specific public header for parsing module.

Functions

fsdp_error_t fsdp_parse (const char *description, fsdp_description_t *dsc)
const char * fsdp_get_wrong_string (const fsdp_description_t *dsc)
unsigned int fsdp_get_version (const fsdp_description_t *dsc)
const char * fsdp_get_owner_username (const fsdp_description_t *dsc)
const char * fsdp_get_session_id (const fsdp_description_t *dsc)
const char * fsdp_get_announcement_version (const fsdp_description_t *dsc)
fsdp_network_type_t fsdp_get_owner_network_type (const fsdp_description_t *dsc)
fsdp_address_type_t fsdp_get_owner_address_type (const fsdp_description_t *dsc)
const char * fsdp_get_owner_address (const fsdp_description_t *dsc)
const char * fsdp_get_name (const fsdp_description_t *dsc)
const char * fsdp_get_information (const fsdp_description_t *dsc)
const char * fsdp_get_uri (const fsdp_description_t *dsc)
unsigned int fsdp_get_emails_count (const fsdp_description_t *dsc)
const char * fsdp_get_email (const fsdp_description_t *dsc, unsigned int index)
unsigned int fsdp_get_phones_count (const fsdp_description_t *dsc)
const char * fsdp_get_phone (const fsdp_description_t *dsc, unsigned int index)
fsdp_network_type_t fsdp_get_global_conn_network_type (const fsdp_description_t *dsc)
fsdp_address_type_t fsdp_get_global_conn_address_type (const fsdp_description_t *dsc)
const char * fsdp_get_global_conn_address (const fsdp_description_t *dsc)
unsigned int fsdp_get_global_conn_address_ttl (const fsdp_description_t *dsc)
unsigned int fsdp_get_global_conn_addresses_count (const fsdp_description_t *dsc)
unsigned int fsdp_get_bw_modifiers_count (const fsdp_description_t *dsc)
fsdp_bw_modifier_type_t fsdp_get_bw_modifier_type (const fsdp_description_t *dsc, unsigned int index)
const char * fsdp_get_bw_modifier_type_unknown (const fsdp_description_t *dsc, unsigned int index)
unsigned long int fsdp_get_bw_value (const fsdp_description_t *dsc, unsigned int index)
unsigned long int fsdp_get_periods_count (const fsdp_description_t *dsc)
time_t fsdp_get_period_start (const fsdp_description_t *dsc, unsigned int index)
time_t fsdp_get_period_stop (const fsdp_description_t *dsc, unsigned int index)
unsigned int fsdp_get_period_repeats_count (const fsdp_description_t *dsc, unsigned int index)
unsigned long int fsdp_get_period_repeat_interval (const fsdp_description_t *dsc, unsigned int index, unsigned int rindex)
unsigned long int fsdp_get_period_repeat_duration (const fsdp_description_t *dsc, unsigned int index, unsigned int rindex)
unsigned long int fsdp_get_period_repeat_offsets_count (const fsdp_description_t *dsc, unsigned int index, unsigned int rindex)
unsigned long int fsdp_get_period_repeat_offsets (const fsdp_description_t *dsc, unsigned int index, unsigned int rindex, unsigned int oindex)
fsdp_encryption_method_t fsdp_get_encryption_method (const fsdp_description_t *dsc)
const char * fsdp_get_encryption_content (const fsdp_description_t *dsc)
const char * fsdp_get_timezone_adj (const fsdp_description_t *dsc)
unsigned int fsdp_get_unidentified_attributes_count (const fsdp_description_t *dsc)
const char * fsdp_get_unidentified_attribute (const fsdp_description_t *dsc, unsigned int index)
unsigned int fsdp_get_media_rtpmap_count (const fsdp_media_description_t *mdsc)
const char * fsdp_get_media_rtpmap_payload_type (const fsdp_media_description_t *mdsc, unsigned int index)
const char * fsdp_get_media_rtpmap_encoding_name (const fsdp_media_description_t *mdsc, unsigned int index)
unsigned int fsdp_get_media_rtpmap_clock_rate (const fsdp_media_description_t *mdsc, unsigned int index)
const char * fsdp_get_media_rtpmap_encoding_parameters (const fsdp_description_t *mdsc, unsigned int index)
const char * fsdp_get_str_att (const fsdp_description_t *dsc, fsdp_session_str_att_t att)
unsigned int fsdp_get_sdplang_count (const fsdp_description_t *dsc)
const char * fsdp_get_sdplang (const fsdp_description_t *dsc, unsigned int index)
fsdp_sendrecv_mode_t fsdp_get_sendrecv_mode (const fsdp_description_t *dsc)
fsdp_session_type_t fsdp_get_session_type (const fsdp_description_t *dsc)
unsigned int fsdp_get_media_count (const fsdp_description_t *dsc)
const fsdp_media_description_tfsdp_get_media (const fsdp_description_t *dsc, unsigned int index)
fsdp_media_t fsdp_get_media_type (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_port (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_ports_count (const fsdp_media_description_t *dsc)
fsdp_transport_protocol_t fsdp_get_media_transport_protocol (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_formats (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_title (const fsdp_media_description_t *dsc)
fsdp_network_type_t fsdp_get_media_network_type (const fsdp_media_description_t *dsc)
fsdp_address_type_t fsdp_get_media_address_type (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_address (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_address_ttl (const fsdp_media_description_t *mdsc)
unsigned int fsdp_get_media_addresses_count (const fsdp_media_description_t *mdsc)
fsdp_bw_modifier_type_t fsdp_get_media_bw_modifier_type (const fsdp_media_description_t *dsc, unsigned int index)
const char * fsdp_get_media_bw_modifier_type_unknown (const fsdp_media_description_t *dsc, unsigned int index)
unsigned long int fsdp_get_media_bw_value (const fsdp_media_description_t *dsc, unsigned int index)
fsdp_encryption_method_t fsdp_get_media_encryption_method (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_encryption_content (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_ptime (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_maxptime (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_fmtp_count (const fsdp_media_description_t *mdsc)
const char * fsdp_get_media_fmtp (const fsdp_media_description_t *mdsc, unsigned int index)
unsigned int fsdp_get_media_sdplang_count (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_sdplang (const fsdp_media_description_t *dsc, unsigned int index)
unsigned int fsdp_get_media_lang_count (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_lang (const fsdp_media_description_t *dsc, unsigned int index)
fsdp_orient_t fsdp_get_media_orient (const fsdp_media_description_t *dsc)
fsdp_sendrecv_mode_t fsdp_get_media_sendrecv (const fsdp_media_description_t *dsc)
float fsdp_get_media_framerate (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_quality (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_rtcp_port (const fsdp_media_description_t *dsc)
fsdp_network_type_t fsdp_get_media_rtcp_network_type (const fsdp_media_description_t *dsc)
fsdp_address_type_t fsdp_get_media_rtcp_address_type (const fsdp_media_description_t *dsc)
const char * fsdp_get_media_rtcp_address (const fsdp_media_description_t *dsc)
unsigned int fsdp_get_media_unidentified_attributes_count (const fsdp_media_description_t *mdsc)
const char * fsdp_get_media_unidentified_attribute (const fsdp_media_description_t *mdsc, unsigned int index)

Detailed Description

SDP descriptions parsing routines.

Function Documentation

const char* fsdp_get_announcement_version const fsdp_description_t dsc  ) 
 

Get the announcement version for the session description in dsc.

Parameters:
dsc SDP description object.
Returns:
announcement version string for this description.

Definition at line 956 of file parser.c.

References fsdp_description_t_s::o_announcement_version.

fsdp_bw_modifier_type_t fsdp_get_bw_modifier_type const fsdp_description_t dsc,
unsigned int  index
 

Get the bandwidth modifier type for the session.

Parameters:
dsc SDP description object.
index number of bandwidth modifier.
Returns:
global bandwidth modifier type.
Return values:
FSDP_BW_MOD_TYPE_UNDEFINED if no global bandwith modifier type is defined or invalid index.
FSDP_BW_MOD_TYPE_UNKNOWN if an unknown bandwith modifier is specified or an invalid index is provided. In this case fsdp_get_bw_modifer_type_unknown() can be called to get the modifier as a character string.

Definition at line 1092 of file parser.c.

References fsdp_bw_modifier_t::b_mod_type, fsdp_description_t_s::bw_modifiers, fsdp_description_t_s::bw_modifiers_count, and FSDP_BW_MOD_TYPE_UNDEFINED.

const char* fsdp_get_bw_modifier_type_unknown const fsdp_description_t dsc,
unsigned int  index
 

Get the textual bandwidth modifier type when it is unknown.

Parameters:
dsc SDP description object.
index number of bandwidth modifier.
Returns:
global bandwidth modifier type.
Return values:
empty string if the provided bandwidth type is not unknown, the provided index is invalid or or there was a parse error.

Definition at line 1100 of file parser.c.

References fsdp_bw_modifier_t::b_mod_type, fsdp_bw_modifier_t::b_unknown_bw_modt, fsdp_description_t_s::bw_modifiers, fsdp_description_t_s::bw_modifiers_count, and FSDP_BW_MOD_TYPE_UNKNOWN.

unsigned int fsdp_get_bw_modifiers_count const fsdp_description_t dsc  ) 
 

Get the number of bandwidth modifiers specified for this session.

Parameters:
dsc SDP description object.
Returns:
number of bandwidth modifiers.

Definition at line 1084 of file parser.c.

References fsdp_description_t_s::bw_modifiers_count.

unsigned long int fsdp_get_bw_value const fsdp_description_t dsc,
unsigned int  index
 

Get the value for the bandwidth modifier.

Parameters:
dsc SDP description object.
index number of bandwidth modifier.
Returns:
global bandwidth value.
Return values:
0 if no bandwidth is specified for this session or an invalid index has been provided.

Definition at line 1110 of file parser.c.

References fsdp_bw_modifier_t::b_value, fsdp_description_t_s::bw_modifiers, and fsdp_description_t_s::bw_modifiers_count.

const char* fsdp_get_email const fsdp_description_t dsc,
unsigned int  index
 

Get the n-th email specified for the session in the description dsc.

Parameters:
dsc SDP description object.
index number of URI. Note that this index follows the traditional C convention: from 0 to fsdp_get_emails_count() - 1.
Returns:
string containing an email about the session. NULL if there is no such index.

Definition at line 1020 of file parser.c.

References fsdp_description_t_s::emails, and fsdp_description_t_s::emails_count.

unsigned int fsdp_get_emails_count const fsdp_description_t dsc  ) 
 

Get the number of emails specified for the session in the description dsc.

Parameters:
dsc SDP description object.
Returns:
number of emails.

Definition at line 1012 of file parser.c.

References fsdp_description_t_s::emails_count.

const char* fsdp_get_encryption_content const fsdp_description_t dsc  ) 
 

Get the encryption key or a URI pointing to the encryption key for this session.

Parameters:
dsc SDP description object.
Returns:
encryption key unless FSDP_ENCRYPTION_METHOD_URI is specified, in which case a URI pointing to the key is returned. If the global encryption method is undefined, NULL is returned.

Definition at line 1224 of file parser.c.

References FSDP_ENCRYPTION_METHOD_UNDEFINED, fsdp_description_t_s::k_encryption_content, and fsdp_description_t_s::k_encryption_method.

fsdp_encryption_method_t fsdp_get_encryption_method const fsdp_description_t dsc  ) 
 

Get the encryption method defined for this session.

Parameters:
dsc SDP description object.
Returns:
encryption method. FSDP_ENCRYPTION_METHOD_UNDEFINED if no encryption method is specified.

Definition at line 1216 of file parser.c.

References FSDP_ENCRYPTION_METHOD_UNDEFINED, and fsdp_description_t_s::k_encryption_method.

const char* fsdp_get_global_conn_address const fsdp_description_t dsc  ) 
 

Get the the global address of the multimedia session connection.

Parameters:
dsc SDP description object.
Returns:
global address for this connection.

Definition at line 1060 of file parser.c.

References fsdp_connection_address_t_s::address, and fsdp_description_t_s::c_address.

unsigned int fsdp_get_global_conn_address_ttl const fsdp_description_t dsc  ) 
 

Definition at line 1068 of file parser.c.

References fsdp_connection_address_t_s::address_ttl, and fsdp_description_t_s::c_address.

fsdp_address_type_t fsdp_get_global_conn_address_type const fsdp_description_t dsc  ) 
 

Get the the global type of network address of the multimedia session connection.

Parameters:
dsc SDP description object.
Returns:
global network address type for this connection. FSDP_ADDRESS_TYPE_UNDEFINED if no global network address type is included in the description.

Definition at line 1052 of file parser.c.

References fsdp_description_t_s::c_address_type, and FSDP_ADDRESS_TYPE_UNDEFINED.

unsigned int fsdp_get_global_conn_addresses_count const fsdp_description_t dsc  ) 
 

Definition at line 1076 of file parser.c.

References fsdp_connection_address_t_s::address_count, and fsdp_description_t_s::c_address.

fsdp_network_type_t fsdp_get_global_conn_network_type const fsdp_description_t dsc  ) 
 

Get the the global type of network of the multimedia session connection.

Parameters:
dsc SDP description object.
Returns:
global network type for this connection. FSDP_NETWORK_TYPE_UNDEFINED if no global network address type is included in the description.

Definition at line 1044 of file parser.c.

References fsdp_description_t_s::c_network_type, and FSDP_NETWORK_TYPE_UNDEFINED.

const char* fsdp_get_information const fsdp_description_t dsc  ) 
 

Get the information about the session provided in the description dsc.

Parameters:
dsc SDP description object.
Returns:
information of this session.
Examples:
parsedemo.c.

Definition at line 996 of file parser.c.

References fsdp_description_t_s::i_information.

const fsdp_media_description_t* fsdp_get_media const fsdp_description_t dsc,
unsigned int  index
 

Examples:
parsedemo.c.

Definition at line 1344 of file parser.c.

References fsdp_description_t_s::media_announcements, and fsdp_description_t_s::media_announcements_count.

const char* fsdp_get_media_address const fsdp_media_description_t dsc  ) 
 

Definition at line 1424 of file parser.c.

References fsdp_connection_address_t_s::address, and fsdp_media_description_t_s::c_address.

unsigned int fsdp_get_media_address_ttl const fsdp_media_description_t mdsc  ) 
 

Definition at line 1432 of file parser.c.

References fsdp_connection_address_t_s::address_ttl, and fsdp_media_description_t_s::c_address.

fsdp_address_type_t fsdp_get_media_address_type const fsdp_media_description_t dsc  ) 
 

Definition at line 1416 of file parser.c.

References fsdp_media_description_t_s::c_address_type, and FSDP_ADDRESS_TYPE_UNDEFINED.

unsigned int fsdp_get_media_addresses_count const fsdp_media_description_t mdsc  ) 
 

Definition at line 1440 of file parser.c.

References fsdp_connection_address_t_s::address_count, and fsdp_media_description_t_s::c_address.

fsdp_bw_modifier_type_t fsdp_get_media_bw_modifier_type const fsdp_media_description_t dsc,
unsigned int  index
 

Definition at line 1448 of file parser.c.

References fsdp_bw_modifier_t::b_mod_type, fsdp_media_description_t_s::bw_modifiers, fsdp_media_description_t_s::bw_modifiers_count, and FSDP_BW_MOD_TYPE_UNDEFINED.

const char* fsdp_get_media_bw_modifier_type_unknown const fsdp_media_description_t dsc,
unsigned int  index
 

Definition at line 1457 of file parser.c.

References fsdp_bw_modifier_t::b_mod_type, fsdp_bw_modifier_t::b_unknown_bw_modt, fsdp_media_description_t_s::bw_modifiers, fsdp_media_description_t_s::bw_modifiers_count, and FSDP_BW_MOD_TYPE_UNKNOWN.

unsigned long int fsdp_get_media_bw_value const fsdp_media_description_t dsc,
unsigned int  index
 

Definition at line 1467 of file parser.c.

References fsdp_bw_modifier_t::b_value, fsdp_media_description_t_s::bw_modifiers, and fsdp_media_description_t_s::bw_modifiers_count.

unsigned int fsdp_get_media_count const fsdp_description_t dsc  ) 
 

Examples:
parsedemo.c.

Definition at line 1336 of file parser.c.

References fsdp_description_t_s::media_announcements_count.

const char* fsdp_get_media_encryption_content const fsdp_media_description_t dsc  ) 
 

Definition at line 1484 of file parser.c.

References fsdp_media_description_t_s::k_encryption_content.

fsdp_encryption_method_t fsdp_get_media_encryption_method const fsdp_media_description_t dsc  ) 
 

Definition at line 1476 of file parser.c.

References FSDP_ENCRYPTION_METHOD_UNDEFINED, and fsdp_media_description_t_s::k_encryption_method.

const char* fsdp_get_media_fmtp const fsdp_media_description_t mdsc,
unsigned int  index
 

Definition at line 1594 of file parser.c.

References fsdp_media_description_t_s::a_fmtps, and fsdp_media_description_t_s::a_fmtps_count.

unsigned int fsdp_get_media_fmtp_count const fsdp_media_description_t mdsc  ) 
 

Definition at line 1586 of file parser.c.

References fsdp_media_description_t_s::a_fmtps_count.

const char* fsdp_get_media_formats const fsdp_media_description_t dsc  ) 
 

float fsdp_get_media_framerate const fsdp_media_description_t dsc  ) 
 

Definition at line 1618 of file parser.c.

References fsdp_media_description_t_s::a_framerate.

const char* fsdp_get_media_lang const fsdp_media_description_t dsc,
unsigned int  index
 

Definition at line 1577 of file parser.c.

References fsdp_media_description_t_s::a_langs, and fsdp_media_description_t_s::a_langs_count.

unsigned int fsdp_get_media_lang_count const fsdp_media_description_t dsc  ) 
 

Definition at line 1569 of file parser.c.

References fsdp_media_description_t_s::a_langs_count.

unsigned int fsdp_get_media_maxptime const fsdp_media_description_t dsc  ) 
 

Definition at line 1500 of file parser.c.

References fsdp_media_description_t_s::a_maxptime.

fsdp_network_type_t fsdp_get_media_network_type const fsdp_media_description_t dsc  ) 
 

Definition at line 1408 of file parser.c.

References fsdp_media_description_t_s::c_network_type, and FSDP_NETWORK_TYPE_UNDEFINED.

fsdp_orient_t fsdp_get_media_orient const fsdp_media_description_t dsc  ) 
 

Definition at line 1602 of file parser.c.

References fsdp_media_description_t_s::a_orient, and FSDP_ORIENT_UNDEFINED.

unsigned int fsdp_get_media_port const fsdp_media_description_t dsc  ) 
 

Definition at line 1360 of file parser.c.

References fsdp_media_description_t_s::port.

unsigned int fsdp_get_media_ports_count const fsdp_media_description_t dsc  ) 
 

Definition at line 1368 of file parser.c.

References fsdp_media_description_t_s::port_count.

unsigned int fsdp_get_media_ptime const fsdp_media_description_t dsc  ) 
 

Definition at line 1492 of file parser.c.

References fsdp_media_description_t_s::a_ptime.

unsigned int fsdp_get_media_quality const fsdp_media_description_t dsc  ) 
 

Definition at line 1626 of file parser.c.

References fsdp_media_description_t_s::a_quality.

const char* fsdp_get_media_rtcp_address const fsdp_media_description_t dsc  ) 
 

Definition at line 1658 of file parser.c.

References fsdp_media_description_t_s::a_rtcp_address.

fsdp_address_type_t fsdp_get_media_rtcp_address_type const fsdp_media_description_t dsc  ) 
 

Definition at line 1650 of file parser.c.

References fsdp_media_description_t_s::a_rtcp_address_type, and FSDP_ADDRESS_TYPE_UNDEFINED.

fsdp_network_type_t fsdp_get_media_rtcp_network_type const fsdp_media_description_t dsc  ) 
 

Definition at line 1642 of file parser.c.

References fsdp_media_description_t_s::a_rtcp_network_type, and FSDP_NETWORK_TYPE_UNDEFINED.

unsigned int fsdp_get_media_rtcp_port const fsdp_media_description_t dsc  ) 
 

Definition at line 1634 of file parser.c.

References fsdp_media_description_t_s::a_rtcp_port.

unsigned int fsdp_get_media_rtpmap_clock_rate const fsdp_media_description_t mdsc,
unsigned int  index
 

Definition at line 1534 of file parser.c.

References fsdp_media_description_t_s::a_rtpmaps, fsdp_media_description_t_s::a_rtpmaps_count, and fsdp_rtpmap_t::clock_rate.

unsigned int fsdp_get_media_rtpmap_count const fsdp_media_description_t mdsc  ) 
 

Examples:
parsedemo.c.

Definition at line 1508 of file parser.c.

References fsdp_media_description_t_s::a_rtpmaps_count.

const char* fsdp_get_media_rtpmap_encoding_name const fsdp_media_description_t mdsc,
unsigned int  index
 

Definition at line 1525 of file parser.c.

References fsdp_media_description_t_s::a_rtpmaps, fsdp_media_description_t_s::a_rtpmaps_count, and fsdp_rtpmap_t::encoding_name.

const char* fsdp_get_media_rtpmap_encoding_parameters const fsdp_description_t mdsc,
unsigned int  index
 

Definition at line 1543 of file parser.c.

References fsdp_description_t_s::a_rtpmaps, fsdp_description_t_s::a_rtpmaps_count, and fsdp_rtpmap_t::parameters.

const char* fsdp_get_media_rtpmap_payload_type const fsdp_media_description_t mdsc,
unsigned int  index
 

Definition at line 1516 of file parser.c.

References fsdp_media_description_t_s::a_rtpmaps, fsdp_media_description_t_s::a_rtpmaps_count, and fsdp_rtpmap_t::pt.

const char* fsdp_get_media_sdplang const fsdp_media_description_t dsc,
unsigned int  index
 

Definition at line 1560 of file parser.c.

References fsdp_media_description_t_s::a_sdplangs, and fsdp_media_description_t_s::a_sdplangs_count.

unsigned int fsdp_get_media_sdplang_count const fsdp_media_description_t dsc  ) 
 

Definition at line 1552 of file parser.c.

References fsdp_media_description_t_s::a_sdplangs_count.

fsdp_sendrecv_mode_t fsdp_get_media_sendrecv const fsdp_media_description_t dsc  ) 
 

Definition at line 1610 of file parser.c.

References fsdp_media_description_t_s::a_sendrecv_mode, and FSDP_SENDRECV_UNDEFINED.

const char* fsdp_get_media_title const fsdp_media_description_t dsc  ) 
 

Definition at line 1400 of file parser.c.

References fsdp_media_description_t_s::i_title.

fsdp_transport_protocol_t fsdp_get_media_transport_protocol const fsdp_media_description_t dsc  ) 
 

Definition at line 1376 of file parser.c.

References FSDP_TP_UNDEFINED, and fsdp_media_description_t_s::transport.

fsdp_media_t fsdp_get_media_type const fsdp_media_description_t dsc  ) 
 

Definition at line 1352 of file parser.c.

References FSDP_MEDIA_UNDEFINED, and fsdp_media_description_t_s::media_type.

const char* fsdp_get_media_unidentified_attribute const fsdp_media_description_t mdsc,
unsigned int  index
 

Definition at line 1675 of file parser.c.

References fsdp_media_description_t_s::unidentified_attributes, and fsdp_description_t_s::unidentified_attributes_count.

unsigned int fsdp_get_media_unidentified_attributes_count const fsdp_media_description_t mdsc  ) 
 

Definition at line 1666 of file parser.c.

References fsdp_media_description_t_s::unidentified_attributes_count.

const char* fsdp_get_name const fsdp_description_t dsc  ) 
 

Get the name of the session described in dsc.

Parameters:
dsc SDP description object.
Returns:
name of this session.
Examples:
parsedemo.c.

Definition at line 988 of file parser.c.

References fsdp_description_t_s::s_name.

const char* fsdp_get_owner_address const fsdp_description_t dsc  ) 
 

Get the network address of the owner of the session described in dsc.

Parameters:
dsc SDP description object.
Returns:
network address for the owner this session.

Definition at line 980 of file parser.c.

References fsdp_description_t_s::o_address.

fsdp_address_type_t fsdp_get_owner_address_type const fsdp_description_t dsc  ) 
 

Get the the type of address the owner of the session described in dsc is based on.

Parameters:
dsc SDP description object.
Returns:
network address type for the owner of this session.

Definition at line 972 of file parser.c.

References FSDP_ADDRESS_TYPE_UNDEFINED, and fsdp_description_t_s::o_address_type.

fsdp_network_type_t fsdp_get_owner_network_type const fsdp_description_t dsc  ) 
 

Get the the type of network the owner of the session described in dsc is based on.

Parameters:
dsc SDP description object.
Returns:
network type for the owner of this session.

Definition at line 964 of file parser.c.

References FSDP_NETWORK_TYPE_UNDEFINED, and fsdp_description_t_s::o_network_type.

const char* fsdp_get_owner_username const fsdp_description_t dsc  ) 
 

Get the username provided by the originator of the session.

Parameters:
dsc SDP description object.
Returns:
username of the session owner
Examples:
parsedemo.c.

Definition at line 940 of file parser.c.

References fsdp_description_t_s::o_username.

unsigned long int fsdp_get_period_repeat_duration const fsdp_description_t dsc,
unsigned int  index,
unsigned int  rindex
 

Get the duration of the repeat selected by rindex for the period selected by index.

Parameters:
dsc SDP description object.
index number of time period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
rindex number of repeat
Returns:
duration
Return values:
0 if an invalid index is provided.

Definition at line 1160 of file parser.c.

References fsdp_repeat_t::duration, fsdp_time_period_t::repeats, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

unsigned long int fsdp_get_period_repeat_interval const fsdp_description_t dsc,
unsigned int  index,
unsigned int  rindex
 

Get the interval time of the repeat selected by rindex for the period selected by index.

Parameters:
dsc SDP description object.
index number of time period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
rindex number of repeat
Returns:
interval time
Return values:
0 if an invalid index is provided.

Definition at line 1151 of file parser.c.

References fsdp_repeat_t::interval, fsdp_time_period_t::repeats, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

unsigned long int fsdp_get_period_repeat_offsets const fsdp_description_t dsc,
unsigned int  index,
unsigned int  rindex,
unsigned int  oindex
 

Get the offsets number oindex of the repeat selected by rindex for the period selected by index.

Parameters:
dsc SDP description object.
index number of time period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
rindex number of repeat
oindex number of offset
Returns:
offset value
Return values:
0 if an invalid index is provided.

Definition at line 1179 of file parser.c.

References fsdp_repeat_t::offsets, fsdp_repeat_t::offsets_count, fsdp_time_period_t::repeats, fsdp_time_period_t::repeats_count, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

unsigned long int fsdp_get_period_repeat_offsets_count const fsdp_description_t dsc,
unsigned int  index,
unsigned int  rindex
 

Get the number of offsets for the repeat selected by rindex and the period.selected by index.

Parameters:
dsc SDP description object.
index number of the period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
rindex number of the repeat.
Returns:
number of offsets
Return values:
0 if an invalid index is provided.

Definition at line 1169 of file parser.c.

References fsdp_repeat_t::offsets_count, fsdp_time_period_t::repeats, fsdp_time_period_t::repeats_count, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

unsigned int fsdp_get_period_repeats_count const fsdp_description_t dsc,
unsigned int  index
 

Get the number of repeats for the period selected by index.

Parameters:
dsc SDP description object.
index number of the period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
Returns:
number of repeats
Return values:
0 if an invalid index is provided.

Definition at line 1142 of file parser.c.

References fsdp_time_period_t::repeats_count, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

time_t fsdp_get_period_start const fsdp_description_t dsc,
unsigned int  index
 

Get the start time for the period selected by index.

Parameters:
dsc SDP description object.
index number of time period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
Returns:
start time
Return values:
0 if an invalid index is provided.

Definition at line 1126 of file parser.c.

References fsdp_time_period_t::start, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

time_t fsdp_get_period_stop const fsdp_description_t dsc,
unsigned int  index
 

Get the stop time for the period selected by index.

Parameters:
dsc SDP description object.
index number of time period. Note that this index follows the traditional C convention: from 0 to fsdp_get_period_count() - 1.
Returns:
stop time
Return values:
0 if an invalid index is provided.

Definition at line 1134 of file parser.c.

References fsdp_time_period_t::stop, fsdp_description_t_s::time_periods, and fsdp_description_t_s::time_periods_count.

unsigned long int fsdp_get_periods_count const fsdp_description_t dsc  ) 
 

Get the number of time periods specified for this session

Parameters:
dsc SDP description object.
Returns:
number of time periods

Definition at line 1118 of file parser.c.

References fsdp_description_t_s::time_periods_count.

const char* fsdp_get_phone const fsdp_description_t dsc,
unsigned int  index
 

Get the n-th phone specified for the session in the description dsc.

Parameters:
dsc SDP description object.
index number of URI. Note that this index follows the traditional C convention: from 0 to fsdp_get_phones_count() - 1.
Returns:
string containing a phone about the session. NULL if there is no such index.

Definition at line 1036 of file parser.c.

References fsdp_description_t_s::phones, and fsdp_description_t_s::phones_count.

unsigned int fsdp_get_phones_count const fsdp_description_t dsc  ) 
 

Get the number of phones specified for the session in the description dsc.

Parameters:
dsc SDP description object.
Returns:
number of phones.

Definition at line 1028 of file parser.c.

References fsdp_description_t_s::phones_count.

const char* fsdp_get_sdplang const fsdp_description_t dsc,
unsigned int  index
 

Definition at line 1296 of file parser.c.

References fsdp_description_t_s::a_sdplangs, and fsdp_description_t_s::a_sdplangs_count.

unsigned int fsdp_get_sdplang_count const fsdp_description_t dsc  ) 
 

Definition at line 1288 of file parser.c.

References fsdp_description_t_s::a_sdplangs_count.

fsdp_sendrecv_mode_t fsdp_get_sendrecv_mode const fsdp_description_t dsc  ) 
 

Get the mode of the conference, specified with attributes sendrecv, sendonly, recvonly and inactive.

Parameters:
dsc SDP description object.
Returns:
send/rec conference mode.
Return values:
FSDP_SENDRECV_UNDEFINED if conference mode not provided.

Definition at line 1320 of file parser.c.

References fsdp_description_t_s::a_sendrecv_mode, and FSDP_SENDRECV_UNDEFINED.

const char* fsdp_get_session_id const fsdp_description_t dsc  ) 
 

Get the id for the session described in dsc.

Parameters:
dsc SDP description object.
Returns:
id string for this session.

Definition at line 948 of file parser.c.

References fsdp_description_t_s::o_session_id.

fsdp_session_type_t fsdp_get_session_type const fsdp_description_t dsc  ) 
 

Get the type of conference, such as broadcast, meeting, moderated, test or H332.

Parameters:
dsc SDP description object.
Returns:
conference type.
Return values:
FSDP_SESSION_TYPE_UNDEFINED if conference type not provided.

Definition at line 1328 of file parser.c.

References fsdp_description_t_s::a_type, and FSDP_SESSION_TYPE_UNDEFINED.

const char* fsdp_get_str_att const fsdp_description_t dsc,
fsdp_session_str_att_t  att
 

Get the value of the session attribute specified in att. This function works for all the session attributes whose value is a character string. These attributes are defined in the session_string_attribute_t enumerated type.

Parameters:
dsc SDP description object.
att attribute to get.
Returns:
value of the attribute att.
Return values:
NULL if the attribute was not specified or there was a parse error or an invalid att is given.

Definition at line 1275 of file parser.c.

References fsdp_description_t_s::a_str_attributes, and FSDP_LAST_SESSION_STR_ATT.

const char* fsdp_get_timezone_adj const fsdp_description_t dsc  ) 
 

Get timezone adjustments.

Parameters:
dsc SDP description object.
Returns:
string with list of timezone adjustments
Return values:
NULL if no timezone adjustment list was specified or there was a parse error.

Definition at line 1191 of file parser.c.

References fsdp_description_t_s::timezone_adj.

const char* fsdp_get_unidentified_attribute const fsdp_description_t dsc,
unsigned int  index
 

Examples:
parsedemo.c.

Definition at line 1207 of file parser.c.

References fsdp_description_t_s::unidentified_attributes, and fsdp_description_t_s::unidentified_attributes_count.

unsigned int fsdp_get_unidentified_attributes_count const fsdp_description_t dsc  ) 
 

Examples:
parsedemo.c.

Definition at line 1199 of file parser.c.

References fsdp_description_t_s::unidentified_attributes_count.

const char* fsdp_get_uri const fsdp_description_t dsc  ) 
 

Get an URI about the session provided in the description dsc.

Parameters:
dsc SDP description object.
Returns:
string containing an URI about the session. NULL if the session uri is missing.

Definition at line 1004 of file parser.c.

References fsdp_description_t_s::u_uri.

unsigned int fsdp_get_version const fsdp_description_t dsc  ) 
 

Get the SDP protocol version of the description.

Returns:
SDP protocol version number.

Definition at line 932 of file parser.c.

References fsdp_description_t_s::version.

const char* fsdp_get_wrong_string const fsdp_description_t dsc  ) 
 

Get the the text that caused the first error when parsing this description.

Parameters:
dsc SDP description object.
Returns:
NULL if fsdp_parse returned FSDPE_OK for this description. Otherwise, a pointer as close as possible to the beginning of the text line or string that caused the parse error.

Definition at line 924 of file parser.c.

fsdp_error_t fsdp_parse const char *  description,
fsdp_description_t dsc
 

Parse a SDP description in description, extracting the session properties into dsc. These properties can be obtained individually later using the fsdp_get_xxxx functions.

Parameters:
description a multimedia session description formatted in SDP.
dsc pointer that is updated to point to a fsdp_description_t object. This fsdp_description_t object should have been previously allocated using fsdp_description_new(); to free it, fsdp_description_delete() should be used.
Returns:
FSDPE_OK when parsing completes successfully. Otherwise, another error code is returned.
Examples:
parsedemo.c.

Definition at line 60 of file parser.c.

References fsdp_description_t_s::emails, fsdp_description_t_s::emails_count, FSDP_ADDRESS_TYPE_IPV4, FSDP_ADDRESS_TYPE_IPV6, FSDP_NETWORK_TYPE_INET, FSDPE_EMPTY_NAME, FSDPE_INVALID_OWNER, FSDPE_INVALID_PARAMETER, FSDPE_INVALID_VERSION, FSDPE_MISSING_NAME, FSDPE_MISSING_OWNER, FSDPE_MISSING_VERSION, fsdp_description_t_s::i_information, MAXLONGFIELDLEN, MAXSHORTFIELDLEN, MLFLENS, MSFLENS, NEXT_LINE, fsdp_description_t_s::o_address, fsdp_description_t_s::o_address_type, fsdp_description_t_s::o_announcement_version, fsdp_description_t_s::o_network_type, fsdp_description_t_s::o_session_id, fsdp_description_t_s::o_username, fsdp_description_t_s::s_name, and fsdp_description_t_s::u_uri.


Generated on Wed May 3 13:49:06 2006 for FreeSDP by  doxygen 1.4.6