[asterisk-commits] mmichelson: branch mmichelson/issue13538 r161906 - /team/mmichelson/issue1353...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Mon Dec  8 16:20:42 2008
New Revision: 161906

URL: http://svn.digium.com/view/asterisk?view=rev&rev=161906
Log:
Add an example scenario to the documentation to hopefully
better explain the use of the AUDIOHOOK_INHERIT function


Modified:
    team/mmichelson/issue13538/funcs/func_audiohookinherit.c

Modified: team/mmichelson/issue13538/funcs/func_audiohookinherit.c
URL: http://svn.digium.com/view/asterisk/team/mmichelson/issue13538/funcs/func_audiohookinherit.c?view=diff&rev=161906&r1=161905&r2=161906
==============================================================================
--- team/mmichelson/issue13538/funcs/func_audiohookinherit.c (original)
+++ team/mmichelson/issue13538/funcs/func_audiohookinherit.c Mon Dec  8 16:20:42 2008
@@ -58,7 +58,32 @@
 			<para>By enabling audiohook inheritance on the channel, you are giving
 			permission for an audiohook to be inherited by a descendent channel. By
 			disabling audiohook inheritance on the channel, you are denying permission
-			for an audiohook to be inherited from a parent channel.</para>
+			for an audiohook to be inherited from a parent channel.
+
+			Example scenario:
+			exten => 2000,1,MixMonitor(blah.wav)
+			exten => 2000,n,Set(AUDIOHOOK_INHERIT(MixMonitor)=yes)
+			exten => 2000,n,Dial(SIP/2000)
+
+			exten => 3000,1,Set(AUDIOHOOK_INHERIT(MixMonitor)=no)
+			exten => 3000,n,Dial(SIP/3000)
+
+			exten => 4000,1,Dial(SIP/4000)
+
+			In this basic dialplan scenario, let's consider three sample calls
+			Call 1: Caller dials 2000. The person who answers then executes an attended
+					transfer to 4000.
+			Result: Since extension 2000 set MixMonitor to be inheritable, after the
+					transfer to 4000 has completed, the call will continue to be recorded
+					to blah.wav
+			
+			Call 2: Caller dials 2000. The person who answers then executes an attended
+					transfer to 3000.
+			Result: Since extension 2000 set MixMonitor to be inheritable, after the transfer
+					to 3000 has completed, we will attempt to continue the MixMonitor recording.
+					However, since extension 3000 has specifically requested not to inherit
+					MixMonitor from a parent channel, MixMonitor recording will stop once the
+					transfer has completed.</para>
 		</description>
 	</function>
  ***/