Browse Source

rtpengine: docs for ping_mode parameter

Daniel-Constantin Mierla 1 year ago
parent
commit
faaad7e0e6
1 changed files with 22 additions and 0 deletions
  1. 22 0
      src/modules/rtpengine/doc/rtpengine_admin.xml

+ 22 - 0
src/modules/rtpengine/doc/rtpengine_admin.xml

@@ -2348,6 +2348,28 @@ modparam("rtpengine", "dtmf_events_sock", "127.0.0.1:2223")
 		</example>
 	</section>
 
+	<section id="rtpengine.p.ping_mode">
+		<title><varname>ping_mode</varname> (integer)</title>
+		<para>
+		Specify if the RTPEngine instances have to be pinged at startup to
+		detect if they are active. Set it to 0 to disable pinging and to 1
+		to activate pinging.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>1</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>ping_mode</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("rtpengine", "ping_mode", 0)
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>