[sr-dev] git:master: modules_k/textops: update docs for is_audio_on_hold()

[Ovidiu Sas]

Module: sip-router
Branch: master
Commit: e6201dd5b6d49183567cbd6df47564f65b3d435c
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e6201dd5b6d49183567cbd6df47564f65b3d435c

Author: Ovidiu Sas <osas at voipembedded.com>
Committer: Ovidiu Sas <osas at voipembedded.com>
Date:   Sun Jan 23 12:51:07 2011 -0500

modules_k/textops: update docs for is_audio_on_hold()

---

 modules_k/textops/doc/textops_admin.xml |   25 +++++++++++++++++++++++++
 1 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/modules_k/textops/doc/textops_admin.xml b/modules_k/textops/doc/textops_admin.xml
index 0c8ea28..b978f36 100644
--- a/modules_k/textops/doc/textops_admin.xml
+++ b/modules_k/textops/doc/textops_admin.xml
@@ -1131,6 +1131,31 @@ if(has_body("application/sdp"))
 
 	<section>
 		<title>
+		<function moreinfo="none">is_audio_on_hold()</function>
+		</title>
+		<para>
+		The function returns <emphasis>true</emphasis> if the SIP message
+		has a body attached and at least one audio stream in on hold.
+		</para>
+		<para>
+		This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, 
+		FAILURE_ROUTE and BRANCH_ROUTE.
+		</para>
+		<example>
+		<title><function>is_audio_on_hold</function> usage</title>
+		<programlisting format="linespecific">
+...
+if(is_audio_on_hold())
+{
+    # do interesting stuff here
+}
+...
+</programlisting>
+		</example>
+	</section>
+
+	<section>
+		<title>
 		<function moreinfo="none">is_privacy(privacy_type)</function>
 		</title>
 		<para>