[sr-dev] git:master: sdpops: added note about dtmf and telepheone-event to docs of spd_keep_codecs_by_name ()

Module: sip-router Branch: master Commit: a80a8b2366282f967263507be47727aa3417d67d URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a80a8b2… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue May 20 08:46:04 2014 +0200 sdpops: added note about dtmf and telepheone-event to docs of spd_keep_codecs_by_name() --- modules/sdpops/README | 41 ++++++++++++++++++---------------- modules/sdpops/doc/sdpops_admin.xml | 4 +++ 2 files changed, 26 insertions(+), 19 deletions(-) diff --git a/modules/sdpops/README b/modules/sdpops/README index ebad4bd..74b049d 100644 --- a/modules/sdpops/README +++ b/modules/sdpops/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; - Copyright (c) 2011 asipto.com + Copyright � 2011 asipto.com __________________________________________________________________ Table of Contents @@ -149,7 +149,7 @@ Chapter 1. Admin Guide 4.17. sdp_with_ice() 4.18. sdp_get_line_startswith(avpvar, string) -4.1. sdp_remove_codecs_by_id(list) +4.1. sdp_remove_codecs_by_id(list) Remove the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one item or @@ -166,7 +166,7 @@ sdp_remove_codecs_by_id("0"); sdp_remove_codecs_by_id("0,8,3"); ... -4.2. sdp_remove_codecs_by_name(list) +4.2. sdp_remove_codecs_by_name(list) Remove the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one item or @@ -183,7 +183,7 @@ sdp_remove_codecs_by_name("PCMU"); sdp_remove_codecs_by_name("PCMU,PCMA,GSM"); ... -4.3. sdp_remove_line_by_prefix(string) +4.3. sdp_remove_line_by_prefix(string) Remove all SDP attribute lines beginning with 'string' in all media streams. @@ -202,7 +202,7 @@ if ($si == "2001:DB8::8:800:200C:417A" ... -4.4. sdp_keep_codecs_by_id(list [, mtype]) +4.4. sdp_keep_codecs_by_id(list [, mtype]) Keep only the codecs provided in the parameter 'list' from all media streams found in SDP payload. The parameter 'list' must be one item or @@ -222,13 +222,16 @@ sdp_keep_codecs_by_id("0"); sdp_keep_codecs_by_id("0,8,3", "audio"); ... -4.5. sdp_keep_codecs_by_name(list [, mtype]) +4.5. sdp_keep_codecs_by_name(list [, mtype]) 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. + Note that you have to explicitely keep 'telephone-event' in the list of + names if you want to keep DTMF attributes. + Optional parameter mtype can be provided to apply the operations only to the streams matching m=mtype. @@ -242,7 +245,7 @@ sdp_keep_codecs_by_name("PCMU"); sdp_keep_codecs_by_name("PCMU,PCMA,GSM"); ... -4.6. sdp_with_media(type) +4.6. sdp_with_media(type) 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 @@ -259,7 +262,7 @@ if(sdp_with_media("video")) } ... -4.7. sdp_remove_media(type) +4.7. sdp_remove_media(type) Remove the streams that match on 'm=type ...' line. The parameter can be static string or variable holding the media type. @@ -272,7 +275,7 @@ if(sdp_with_media("video")) sdp_remove_media("video"); ... -4.8. sdp_with_transport(type) +4.8. sdp_with_transport(type) Return true of the SDP has 'media=media port type ...' line. Useful to check the transport of the RTP sessions, such as 'RTP/AVP', 'RTP/SAVP' @@ -290,7 +293,7 @@ if(sdp_with_transport("RTP/SAVP")) } ... -4.9. sdp_with_transport_like(string) +4.9. sdp_with_transport_like(string) Returns true if the SDP has 'media=media port type ...' line, where type contains string. The parameter can be static string or variable @@ -307,7 +310,7 @@ if(sdp_with_transport_like("SAVPF")) } ... -4.10. sdp_transport(pv) +4.10. sdp_transport(pv) Assigns common media transport (if any) of 'm' lines to pv argument. Returns 1 if common media transport was found, -2 if there was no @@ -320,7 +323,7 @@ if(sdp_with_transport_like("SAVPF")) sdp_transport("$avp(caller_rtp_transport)"); ... -4.11. sdp_remove_transport(type) +4.11. sdp_remove_transport(type) Remove the streams that match on 'm=media port type ...' line. The parameter can be static string or variable holding the transport type. @@ -333,7 +336,7 @@ sdp_transport("$avp(caller_rtp_transport)"); sdp_remove_transport("RTP/AVP"); ... -4.12. sdp_with_codecs_by_id(list) +4.12. sdp_with_codecs_by_id(list) 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 @@ -350,7 +353,7 @@ if(sdp_with_codecs_by_id("0")) { ... } if(sdp_with_codecs_by_id("0,8,3")) { ... } ... -4.13. sdp_with_codecs_by_name(list) +4.13. sdp_with_codecs_by_name(list) 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 @@ -367,7 +370,7 @@ if(sdp_with_codecs_by_name("PCMU")) { ... } if(sdp_with_codecs_by_name("PCMU,PCMA,GSM")) { ... } ... -4.14. sdp_print(level) +4.14. sdp_print(level) Print the SDP internal structure to log 'level'. The parameter can be static integer or variable holding the integer value of the log level. @@ -380,7 +383,7 @@ if(sdp_with_codecs_by_name("PCMU,PCMA,GSM")) { ... } sdp_print("1"); ... -4.15. sdp_get(avpvar) +4.15. sdp_get(avpvar) 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. @@ -392,7 +395,7 @@ sdp_print("1"); sdp_get("$avp(sdp)"); ... -4.16. sdp_content() +4.16. sdp_content() Return true if the SIP message has SDP body or a SDP part in body. @@ -405,7 +408,7 @@ if(sdp_content()) { } ... -4.17. sdp_with_ice() +4.17. sdp_with_ice() Return true if the SIP message has SDP body that contains ICE candidate attribute(s). @@ -419,7 +422,7 @@ if(sdp_with_ice()) { } ... -4.18. sdp_get_line_startswith(avpvar, string) +4.18. sdp_get_line_startswith(avpvar, string) Store the search part of SDP body message with line beginning with 'string' in an AVP. Return 1 if 'string' is found in SDP, -1 on error diff --git a/modules/sdpops/doc/sdpops_admin.xml b/modules/sdpops/doc/sdpops_admin.xml index 7373b0b..bf15ded 100644 --- a/modules/sdpops/doc/sdpops_admin.xml +++ b/modules/sdpops/doc/sdpops_admin.xml @@ -187,6 +187,10 @@ sdp_keep_codecs_by_id("0,8,3", "audio"); list of codec names. </para> <para> + Note that you have to explicitely keep 'telephone-event' in the list + of names if you want to keep DTMF attributes. + </para> + <para> Optional parameter mtype can be provided to apply the operations only to the streams matching m=mtype. </para>