1 #########################
2 section "General options"
3 #########################
6 These options are identical to their counterparts in para_server
7 and are discussed in detail there.
19 "where to write log output"
20 string typestr="filename"
25 "run as background daemon"
31 "run as the given user"
38 string typestr="group"
41 ########################
42 section "Audiod options"
43 ########################
50 If this flag is not given, para_audiod refuses to start if the
51 well-known socket file (see the --socket option) already exists
52 because this usually means that para_audiod is already running
53 and listening on that socket. After a crash or if para_audiod
54 received a SIGKILL signal, a stale socket file might remain and
55 you have to use --force once to force startup of para_audiod.
65 Para_audiod supports three modes of operation: On, off and
66 standby (sb). This option selects the mode that should be
67 used on startup. If para_audiod operates in \"on\" mode, it
68 will connect to para_server in order to receive its status
69 information. If para_server announces the availability of an
70 audio stream, para_audiod will automatically download, decode
71 and play the audio stream according to the given stream I/O
74 In \"standby\" mode, para_audiod will only receive the
75 status information from para_server but will not download
78 In \"off\" mode, para_audiod does not connect para_server at
79 all, but still listens on the local socket for connections.
85 string typestr="filename"
88 Para_audiod uses a \"well-known\" socket to listen
89 on for connections from para_audioc. This socket is a
90 special file in the file system; its location defaults to
91 /var/paraslash/audiod_sock.<host_name>.
93 para_audioc, the client program used to connect to para_audiod,
94 opens this socket in order to talk to para_audiod. If the
95 default value for para_audiod is changed, para_audioc must be
96 instructed to use also \"filename\" for connecting para_audiod.
100 #~~~~~~~~~~~~~~~~~~~~
107 Allow the user identified by \"uid\" to connect to para_audiod.
108 May be specified multiple times. If not specified at all,
109 all users are allowed to connect.
111 This feature requires unix socket credentials and is currently
112 only supported on Linux systems. On other operating systems,
113 the option is silently ignored and all local users are allowed
114 to connect to para_audiod.
117 option "clock_diff_count" -
118 #~~~~~~~~~~~~~~~~~~~~~~~~~~
119 "sync clock on startup"
124 Check the clock difference between the host running para_server
125 and the local host running para_audiod that many times before
126 starting any stream I/0. Set this to non-zero for non-local
127 setups if the clocks of these two hosts are not syncronized
131 #############################
132 section "Stream I/O options"
133 #############################
138 string typestr="receiver_spec"
143 This option may be given multiple times, once for each
144 supported audio format. The \"receiver_spec\" consists of
145 an audio format and the receiver name, separated by a colon,
146 and any options for that receiver, seperated by whitespace.
147 If any receiver options are present, the whole receiver
148 argument must be quoted.
152 -r 'mp3:http -i my.host.org -p 8009'
156 option "no_default_filters" D
157 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
158 "Configure filters manually"
161 If (and only if) this option is set, the --filter options
162 (see below) take effect. Otherwise, the compiled-in default
163 filters mp3dec, oggdec and aacdec are activated for mp3, ogg,
164 aac streams respectively.
169 "Use non-default filters"
170 string typestr="filter_spec"
173 dependon="no_default_filters"
175 This option may be given multiple times. The \"filter_spec\"
176 consists of an audio format, the name of the filter, and any
177 options for that filter. Mote that order matters.
181 --filter 'mp3:mp3dec'
183 --filter 'mp3:compress --inertia 5 --damp 2'
189 "Specify stream writer."
190 string typestr="writer_spec"
194 May be given multiple times, even multiple times for the same
195 audio format. Default value is \"alsa\" for all supported
196 audio formats. Example:
202 option "stream_delay" -
203 #~~~~~~~~~~~~~~~~~~~~~~
204 "time for client sync"
205 int typestr="milliseconds"
209 Add the given amount of milliseconds to the stream start time
210 announced by para_server and do not send data to the writer
211 before that time (modulo clock difference).
213 This is useful mainly for syncronizing the audio output of