2 .\" Copyright (C) 2007-2009, 2013 Richard Kettlewell
4 .\" This program is free software: you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation, either version 3 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU General Public License for more details.
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
17 .TH disorder-playrtp 1
19 disorder-playrtp \- play DisOrder network broadcasts
27 \fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
30 If neither an address nor port are specified then the local DisOrder
31 configuration is consulted to find the server and the server is asked where the
34 If just a port is specified then the RTP stream is assumed to be unicast or
35 broadcast to that port.
37 If an address and a port are specified then the RTP stream is assumed to be
38 multicast to that group address and port.
46 will request a dedicated unicast stream from the server. The
48 may be followed by an optional port, or address/port pair, which will be the
49 local address/port to bind to and announce to the server.
52 .B \-\-api\fR, -\fB-A\fR \fIAPI\fR
53 Select the playback API.
54 The possibilities are, depending on platform and compilation options:
72 Pipe audio to a command.
75 The default is the first of the possibilities above that is supported.
77 .B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
78 Specifies the audio device to use.
81 below for more information.
83 .B \-\-command \fICOMMAND\fR, \fB-e \fICOMMAND\fR
84 Instead of sending to a physical audio device, invoke \fICOMMAND\fR using the
85 shell and write audio samples to its standard input.
86 Currently the input will be 44100KHz 16-bit signed stereo samples.
87 If \fICOMMAND\fR exits it is re-executed; any samples that had been written to
88 the pipe but not processed by the previous instance will be lost.
91 is redundant with this option, but you might want to set
95 .B "-e \(aqcat > dump\(aq"
96 would log audio data to a file for later processing.
97 You could convert it to another format with, for instance:
99 .B "sox -c2 -traw -r44100 -s -w dump dump.wav"
101 .B \-\-pause\-mode \fIMODE\fR, \fB-P \fIMODE
102 Set the pause mode for \fB\-\-command\fR to either \fBsilence\fR (the default), in
103 which pauses are represented by sending silent samples, or \fBsuspend\fR, in which
104 writes to the subprocess are suspended, requiring it to infer a pause from flow
107 .B \-\-config \fIPATH\fR, \fB\-C \fIPATH
108 Set the configuration file.
110 .IR pkgconfdir/config .
112 .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
113 Set the control socket.
114 Normally this would not be used manually.
116 .B \-\-help\fR, \fB\-h
117 Display a usage message.
119 .B \-\-version\fR, \fB\-V
120 Display version number.
121 .SS "Buffer Control Options"
122 You shouldn't need to use these options.
123 Their effects are subject to change between version without warning.
124 You should consult the source code for details of their effects.
126 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
127 Specifies the buffer low watermark in frames.
128 This also acts as the target buffer occupancy.
130 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
131 Specifies the maximum buffer size in frames.
132 If there are this many frames in the buffer then reading from the
133 network socket will be suspended.
134 The default is twice the \fB\-\-min\fR value.
136 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
137 Specifies socket receive buffer size.
138 The default is not to change the buffer size, i.e. you get whatever the
139 local operating system chooses.
140 The buffer size will not be reduced below the operating system's default.
142 .B \-\-monitor\fR, \fB\-M
143 Periodically report how close to the buffer low watermark the buffer is.
144 If you have trouble with poor playback quality, enable this option to see if
145 the buffer is emptying out (or overfilling, though there are measures to
146 prevent that from happening).
147 .SS "Deprecated Options"
148 These options may be removed in a future version.
149 Use \fB\-\-api\fR instead.
151 .B \-\-alsa\fR, \fB\-a
152 Use ALSA to play sound.
153 Only available on Linux.
155 .B \-\-oss\fR, \fB\-o
156 Use OSS to play sound.
157 Only available on Linux and FreeBSD.
159 .B \-\-core\-audio\fR, \fB\-c
160 Use Core Audio to play sound.
161 Only available on Macs.
165 option is used by Disobedience to control a background
168 The socket will be created as a UNIX domain stream socket.
169 When a connection is received a single line is read from it.
170 The following commands are known:
178 Causes the string "running" to be sent back.
181 Print the left and right volume levels,
182 as two decimal integers between 0 and 100,
183 separated by a space.
185 .BI "setvol " left " " right
186 Set the left and right volume levels to the given decimal values,
187 which should be between 0 and 100;
188 echo back the new values as for
192 Other commands are ignored.
193 After the first command the connection is closed.
194 Only one connection at a time will be serviced.
196 This protocol is not guaranteed to be stable.
199 On a Mac, the device name can either be the human-readable name of the desired
201 To get a list of the human-readable names, visit System Preferences -> Sound;
202 the Type column has the name you want.
204 For example, you might use "Built-in Output" for the built-in speaker
205 or "Built-in Line Output" if you have connected external speakers.
206 Remember to quote the name.
208 .BR disobedience (1),
209 .BR disorder_config (5),
~mdw / disorder / blob