Add an announcement option to music-on-hold - plays sound when put on hold/between...
[asterisk/asterisk.git] / configs / musiconhold.conf.sample
1 ;
2 ; Music on Hold -- Sample Configuration
3 ;
4 [general]
5 ;cachertclasses=yes ; use 1 instance of moh class for all users who are using it,
6                     ; decrease consumable cpu cycles and memory
7                     ; disabled by default
8
9
10 ; valid mode options:
11 ; files         -- read files from a directory in any Asterisk supported
12 ;                  media format
13 ; quietmp3      -- default
14 ; mp3           -- loud
15 ; mp3nb         -- unbuffered
16 ; quietmp3nb    -- quiet unbuffered
17 ; custom        -- run a custom application (See examples below)
18
19 ; =========
20 ; File-based (native) music on hold
21 ; =========
22 ;
23 ; This plays files directly from the specified directory, no external
24 ; processes are required. Files are played in normal sorting order
25 ; (same as a sorted directory listing), and no volume or other
26 ; sound adjustments are available. If the file is available in
27 ; the same format as the channel's codec, then it will be played
28 ; without transcoding (same as Playback would do in the dialplan).
29 ; Files can be present in as many formats as you wish, and the
30 ; 'best' format will be chosen at playback time.
31 ;
32 ; The path specified can be either an absolute path (starts with '/'),
33 ; or a relative path; relative paths are interpreted as being relative
34 ; to the 'astdatalibdir' in asterisk.conf, which defaults to
35 ; /var/lib/asterisk.
36 ;
37 ; NOTE:
38 ; If you are not using "autoload" in modules.conf, then you
39 ; must ensure that the format modules for any formats you wish
40 ; to use are loaded _before_ res_musiconhold. If you do not do
41 ; this, res_musiconhold will skip the files it is not able to
42 ; understand when it loads.
43 ;
44
45 [default]
46 mode=files
47 directory=moh
48 ;
49 ;[native-random]
50 ;mode=files
51 ;directory=moh
52 ;digit=#        ; If this option is set for a class, then when callers are
53 ;               ; listening to music on hold, they can press this digit, and
54 ;               ; they will switch to listening to this music class.
55 ;announcement=queue-thankyou    ;If this option is set for a class, then
56 ;               ; when callers get put on hold, the specified sound will be
57 ;               ; be played to them. Also, if using modes that Asterisk
58 ;               ; controls the playlist for (files, mp3, etc), the same
59 ;               ; sound will also be played between MOH songs.
60 ;sort=random    ; Sort the files in random order
61
62 ;[native-alphabetical]
63 ;mode=files
64 ;directory=moh
65 ;sort=alpha     ; Sort the files in alphabetical order.  If this option is
66 ;               ; not specified, the sort order is undefined.
67
68 ; =========
69 ; Other (non-native) playback methods
70 ; =========
71
72 ;[manual]
73 ;mode=custom
74 ; Note that with mode=custom, a directory is not required, such as when reading
75 ; from a stream.
76 ;directory=/var/lib/asterisk/mohmp3
77 ;application=/usr/bin/mpg123 -q -r 8000 -f 8192 -b 2048 --mono -s
78
79 ;[ulawstream]
80 ;mode=custom
81 ;application=/usr/bin/streamplayer 192.168.100.52 888
82 ;format=ulaw
83
84 ; mpg123 on Solaris does not always exit properly; madplay may be a better
85 ; choice
86 ;[solaris]
87 ;mode=custom
88 ;directory=/var/lib/asterisk/mohmp3
89 ;application=/site/sw/bin/madplay -Q -o raw:- --mono -R 8000 -a -12