[Asterisk-code-review] res musiconhold: Document the 'format' option (asterisk[14])

[Joshua Colp]

Joshua Colp has submitted this change and it was merged. ( https://gerrit.asterisk.org/5329 )

Change subject: res_musiconhold: Document the 'format' option
......................................................................


res_musiconhold: Document the 'format' option

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

Change-Id: I6aab666c0bf01fd0c64d7a5bcb22fa7f5d41335e
---
M configs/samples/musiconhold.conf.sample
1 file changed, 5 insertions(+), 1 deletion(-)

Approvals:
  Anonymous Coward #1000019: Verified
  Joshua Colp: Looks good to me, approved
  Corey Farrell: Looks good to me, but someone else must approve



diff --git a/configs/samples/musiconhold.conf.sample b/configs/samples/musiconhold.conf.sample
index 3df29bf..b2980fc 100644
--- a/configs/samples/musiconhold.conf.sample
+++ b/configs/samples/musiconhold.conf.sample
@@ -85,7 +85,11 @@
 ;[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

-- 
To view, visit https://gerrit.asterisk.org/5329
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I6aab666c0bf01fd0c64d7a5bcb22fa7f5d41335e
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: 14
Gerrit-Owner: Sean Bright <sean.bright at gmail.com>
Gerrit-Reviewer: Anonymous Coward #1000019
Gerrit-Reviewer: Corey Farrell <git at cfware.com>
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>