codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / 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 ;preferchannelclass=yes ; Prefer the musicclass as defined by CHANNEL(musicclass),
10                         ; over a class set by an application (e.g. a musicclass set on a queue).
11                         ; Defaults to yes.
12
13 ; valid mode options:
14 ; files         -- read files from a directory in any Asterisk supported
15 ;                  media format
16 ; quietmp3      -- default
17 ; mp3           -- loud
18 ; mp3nb         -- unbuffered
19 ; quietmp3nb    -- quiet unbuffered
20 ; custom        -- run a custom application (See examples below)
21
22 ; =========
23 ; File-based (native) music on hold
24 ; =========
25 ;
26 ; This plays files directly from the specified directory, no external
27 ; processes are required. Files are played in normal sorting order
28 ; (same as a sorted directory listing), and no volume or other
29 ; sound adjustments are available. If the file is available in
30 ; the same format as the channel's codec, then it will be played
31 ; without transcoding (same as Playback would do in the dialplan).
32 ; Files can be present in as many formats as you wish, and the
33 ; 'best' format will be chosen at playback time.
34 ;
35 ; The path specified can be either an absolute path (starts with '/'),
36 ; or a relative path; relative paths are interpreted as being relative
37 ; to the 'astdatalibdir' in asterisk.conf, which defaults to
38 ; /var/lib/asterisk.
39 ;
40 ; NOTE:
41 ; If you are not using "autoload" in modules.conf, then you
42 ; must ensure that the format modules for any formats you wish
43 ; to use are loaded _before_ res_musiconhold. If you do not do
44 ; this, res_musiconhold will skip the files it is not able to
45 ; understand when it loads.
46 ;
47
48 [default]
49 mode=files
50 directory=moh
51 ;
52 ;[native-random]
53 ;mode=files
54 ;directory=moh
55 ;digit=#        ; If this option is set for a class, then when callers are
56 ;               ; listening to music on hold, they can press this digit, and
57 ;               ; they will switch to listening to this music class.
58 ;announcement=queue-thankyou    ;If this option is set for a class, then
59 ;               ; when callers get put on hold, the specified sound will be
60 ;               ; be played to them. Also, if using modes that Asterisk
61 ;               ; controls the playlist for (files, mp3, etc), the same
62 ;               ; sound will also be played between MOH songs.
63 ;sort=random    ; Sort the files in random order. Other sort options are:
64 ;               ; 'alpha' and 'randstart'. If 'alpha', the files are sorted
65 ;               ; in alphabetical order. If 'randstart', the files are sorted
66 ;               ; in alphabetical order as well, but the first file is chosen
67 ;               ; at random. If unspecified, the sort order is undefined.
68
69 ;[native-alphabetical]
70 ;mode=files
71 ;directory=moh
72 ;sort=alpha     ; Sort the files in alphabetical order.
73
74 ; =========
75 ; Other (non-native) playback methods
76 ; =========
77
78 ;[manual]
79 ;mode=custom
80 ; Note that with mode=custom, a directory is not required, such as when reading
81 ; from a stream.
82 ;directory=/var/lib/asterisk/mohmp3
83 ;application=/usr/bin/mpg123 -q -r 8000 -f 8192 -b 2048 --mono -s
84
85 ;[ulawstream]
86 ;mode=custom
87 ;application=/usr/bin/streamplayer 192.168.100.52 888
88 ;format=ulaw    ; The 'format' option specifies the audio format that the
89 ;               ; 'application' will provide to Asterisk. In this example,
90 ;               ; streamplayer will output ulaw samples so we need to set the
91 ;               ; format to ulaw so that Asterisk knows how to interpret the
92 ;               ; incoming audio.
93
94 ; mpg123 on Solaris does not always exit properly; madplay may be a better
95 ; choice
96 ;[solaris]
97 ;mode=custom
98 ;directory=/var/lib/asterisk/mohmp3
99 ;application=/site/sw/bin/madplay -Q -o raw:- --mono -R 8000 -a -12
100
101 ; By default, when res_musiconhold reloads or unloads, it sends a HUP signal
102 ; to custom applications (and all descendants), waits 100ms, then sends a
103 ; TERM signal, waits 100ms, then finally sends a KILL signal.  An application
104 ; which is interacting with an external device and/or spawns children of its
105 ; own may not be able to exit cleanly in the default times, expecially if sent
106 ; a KILL signal, or if it's children are getting signals directly from
107 ; res_musiconhoild.  To allow extra time, the 'kill_escalation_delay'
108 ; class option can be used to set the number of milliseconds res_musiconhold
109 ; waits before escalating kill signals, with the default being the current
110 ; 100ms.  To control to whom the signals are sent, the "kill_method"
111 ; class option can be set to "process_group" (the default, existing behavior),
112 ; which sends signals to the application and its descendants directly, or
113 ; "process" which sends signals only to the application itself.
114
115 ;[sox_from_device]
116 ;mode=custom
117 ;directory=/var/lib/asterisk/mohmp3
118 ;application=/usr/bin/sox -q -t alsa -c 2 -r 48000 hw:1 -c 1 -r 8000 -t raw -s -
119 ; Wait 500ms before escalating kill signals
120 ;kill_escalation_delay=500
121 ; Send signals to just the child process instead of all descendants
122 ;kill_method=process