From: Sean Bright <sean.bright@gmail.com>
Date: Mon, 27 Mar 2017 14:35:15 +0000 (-0400)
Subject: res_musiconhold: Document the 'format' option
X-Git-Tag: 13.16.0-rc1~79
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2c28f7a92253555afeeeb7c75f5ba3cbf5212c10;p=thirdparty%2Fasterisk.git

res_musiconhold: Document the 'format' option

ASTERISK-26086 #close
Reported by: Jens Bürger

Change-Id: I6aab666c0bf01fd0c64d7a5bcb22fa7f5d41335e
---

diff --git a/configs/samples/musiconhold.conf.sample b/configs/samples/musiconhold.conf.sample
index 1211c8a6da..8b2202de54 100644
--- a/configs/samples/musiconhold.conf.sample
+++ b/configs/samples/musiconhold.conf.sample
@@ -79,7 +79,11 @@ directory=moh
 ;[ulawstream]
 ;mode=custom
 ;application=/usr/bin/streamplayer 192.168.100.52 888
-;format=ulaw
+;format=ulaw    ; The 'format' option specifies the audio format that the
+;               ; 'application' will provide to Asterisk. In this example,
+;               ; streamplayer will output ulaw samples so we need to set the
+;               ; format to ulaw so that Asterisk knows how to interpret the
+;               ; incoming audio.
 
 ; mpg123 on Solaris does not always exit properly; madplay may be a better
 ; choice