%docentities; ]> &adminguide;
Overview This module provides function for checking and managing the SDP payloads of SIP messages. Examples of what this module offers: remove codecs from SDP, check the media stream types, return attributes of SDP document. For the full least of the features provided by this module and the implementation state, read further to the list of exported functions.
Dependencies
&kamailio; Modules The following modules must be loaded before this module: none.
External Libraries or Applications The following libraries or applications must be installed before running &kamailio; with this module loaded: None
Parameters The module does not export any config parameter yet.
Functions
<function moreinfo="none">sdp_remove_codecs_by_id(list)</function> Remove the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one or a comma separated list of numeric codec IDs. The parameter can be a static string or a variable holding the list of numeric codec IDs. This function can be used from ANY_ROUTE. <function>sdp_remove_codecs_by_id</function> usage ... # remove PCMU sdp_remove_codecs_by_id("0"); # remove PCMU, PCMA and GSM sdp_remove_codecs_by_id("0,8,3"); ...
<function moreinfo="none">sdp_remove_codecs_by_name(list)</function> Remove the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one or a comma separated list of codec names. The parameter can be a static string or a variable holding the list of codec names. This function can be used from ANY_ROUTE. <function>sdp_remove_codecs_by_name</function> usage ... # remove PCMU sdp_remove_codecs_by_name("PCMU"); # remove PCMU, PCMA and GSM sdp_remove_codecs_by_name("PCMU,PCMA,GSM"); ...
<function moreinfo="none">sdp_keep_codecs_by_id(list [, mtype])</function> Keep only the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one or a comma separated list of numeric codec IDs. The parameter can be a static string or a variable holding the list of numeric codec IDs. Optional parameter mtype can be provided to apply the operations only to the streams matching m=mtype. This function can be used from ANY_ROUTE. <function>sdp_keep_codecs_by_id</function> usage ... # keep only PCMU sdp_keep_codecs_by_id("0"); # keep PCMU, PCMA and GSM in audio stream sdp_keep_codecs_by_id("0,8,3", "audio"); ...
<function moreinfo="none">sdp_keep_codecs_by_name(list [, mtype])</function> Keep only the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one or a comma separated list of codec names. The parameter can be a static string or a variable holding the list of codec names. Optional parameter mtype can be provided to apply the operations only to the streams matching m=mtype. This function can be used from ANY_ROUTE. <function>sdp_keep_codecs_by_name</function> usage ... # keep only PCMU sdp_keep_codecs_by_name("PCMU"); # keep PCMU, PCMA and GSM sdp_keep_codecs_by_name("PCMU,PCMA,GSM"); ...
<function moreinfo="none">sdp_with_media(type)</function> Return true of the SDP has 'media=type ...' line. Useful to check the content of the RTP sessions, such as 'audio' or 'video'. The parameter can be static string or variable holding the media type. This function can be used from ANY_ROUTE. <function>sdp_with_media</function> usage ... # check for video stream if(sdp_with_media("video")) { # the session has a video stream } ...
<function moreinfo="none">sdp_remove_media(type)</function> Remove the streams that match on 'm=type ...' line. The parameter can be static string or variable holding the media type. This function can be used from ANY_ROUTE. <function>sdp_remove_media</function> usage ... # remove video stream sdp_remove_media("video"); ...
<function moreinfo="none">sdp_with_codecs_by_id(list)</function> Returns true if any of the codecs provided in the parameter 'list' from all media streams is found in SDP payload. The parameter 'list' must be one or a comma separated list of numeric codec IDs. The parameter can be a static string or a variable holding the list of numeric codec IDs. This function can be used from ANY_ROUTE. <function>sdp_with_codecs_by_id</function> usage ... # test for PCMU if(sdp_with_codecs_by_id("0")) { ... } # test for PCMU, PCMA or GSM if(sdp_with_codecs_by_id("0,8,3")) { ... } ...
<function moreinfo="none">sdp_with_codecs_by_name(list)</function> Returns true if any of the codecs provided in the parameter 'list' from all media streams is found in SDP payload. The parameter 'list' must be one or a comma separated list of codec names. The parameter can be a static string or a variable holding the list of codec names. This function can be used from ANY_ROUTE. <function>sdp_with_codecs_by_name</function> usage ... # test for PCMU if(sdp_with_codecs_by_id("PCMU")) { ... } # test for PCMU, PCMA or GSM if(sdp_with_codecs_by_id("PCMU,PCMA,GSM")) { ... } ...
<function moreinfo="none">sdp_print(level)</function> Print the SDP internal structure to log 'level'. The parameter can be static integer or variable holding the integer value of the log level. This function can be used from ANY_ROUTE. <function>sdp_print</function> usage ... # print the SDP sdp_print("1"); ...
<function moreinfo="none">sdp_get(avpvar)</function> Store the SDP part of message body in an AVP. Return 1 if SDP is found, -1 on error and -2 if there is no SDP part in the message body. This function can be used from ANY_ROUTE. <function>sdp_get</function> usage ... sdp_get("$avp(sdp)"); ...