chiark - git - mdw - disorder/blob - doc/disorder-playrtp.1.in

   1 .\"
   2 .\" Copyright (C) 2007-2009, 2013 Richard Kettlewell
   3 .\"
   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.
   8 .\"
   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.
  13 .\"
  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/>.
  16 .\"
  17 .TH disorder-playrtp 1
  18 .SH NAME
  19 disorder-playrtp \- play DisOrder network broadcasts
  20 .SH SYNOPSIS
  21 .B disorder\-playrtp
  22 .RI [ OPTIONS ]
  23 .RB [ \-\- ]
  24 .RI [[ ADDRESS ]
  25 .IR PORT ]
  26 .SH DESCRIPTION
  27 \fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
  28 address.
  29 .PP
  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
  32 RTP stream is.
  33 .PP
  34 If just a port is specified then the RTP stream is assumed to be unicast or
  35 broadcast to that port.
  36 .PP
  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.
  39 .SH OPTIONS
  40 .TP
  41 .B \-\-api\fR, -\fB-A\fR \fIAPI\fR
  42 Select the playback API.
  43 The possibilities are, depending on platform and compilation options:
  44 .RS 8
  45 .TP
  46 .B pulseaudio
  47 PulseAudio.
  48 .TP
  49 .B alsa
  50 ALSA.
  51 Linux only.
  52 .TP
  53 .B oss
  54 OSS.
  55 .TP
  56 .B coreaudio
  57 Core Audio.
  58 OS X only.
  59 .TP
  60 .B command
  61 Pipe audio to a command.
  62 .RE
  63 .IP
  64 The default is the first of the possibilities above that is supported.
  65 .TP
  66 .B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
  67 Specifies the audio device to use.
  68 See
  69 .B "DEVICE NAMES"
  70 below for more information.
  71 .TP
  72 .B \-\-command \fICOMMAND\fR, \fB-e \fICOMMAND\fR
  73 Instead of sending to a physical audio device, invoke \fICOMMAND\fR using the
  74 shell and write audio samples to its standard input.
  75 Currently the input will be 44100KHz 16-bit signed stereo samples.
  76 If \fICOMMAND\fR exits it is re-executed; any samples that had been written to
  77 the pipe but not processed by the previous instance will be lost.
  78 .IP
  79 .B \-\-device
  80 is redundant with this option, but you might want to set
  81 .BR \-\-pause\-mode .
  82 .IP
  83 As an example,
  84 .B "-e \(aqcat > dump\(aq"
  85 would log audio data to a file for later processing.
  86 You could convert it to another format with, for instance:
  87 .IP
  88 .B "sox -c2 -traw -r44100 -s -w dump dump.wav"
  89 .TP
  90 .B \-\-pause\-mode \fIMODE\fR, \fB-P \fIMODE
  91 Set the pause mode for \fB\-\-command\fR to either \fBsilence\fR (the default), in
  92 which pauses are represented by sending silent samples, or \fBsuspend\fR, in which
  93 writes to  the subprocess are suspended, requiring it to infer a pause from flow
  94 control.
  95 .TP
  96 .B \-\-config \fIPATH\fR, \fB\-C \fIPATH
  97 Set the configuration file.
  98 The default is
  99 .IR pkgconfdir/config .
 100 .TP
 101 .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
 102 Set the control socket.
 103 Normally this would not be used manually.
 104 .TP
 105 .B \-\-help\fR, \fB\-h
 106 Display a usage message.
 107 .TP
 108 .B \-\-version\fR, \fB\-V
 109 Display version number.
 110 .SS "Buffer Control Options"
 111 You shouldn't need to use these options.
 112 Their effects are subject to change between version without warning.
 113 You should consult the source code for details of their effects.
 114 .TP
 115 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
 116 Specifies the buffer low watermark in frames.
 117 This also acts as the target buffer occupancy.
 118 .TP
 119 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
 120 Specifies the maximum buffer size in frames.
 121 If there are this many frames in the buffer then reading from the
 122 network socket will be suspended.
 123 The default is twice the \fB\-\-min\fR value.
 124 .TP
 125 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
 126 Specifies socket receive buffer size.
 127 The default is not to change the buffer size, i.e. you get whatever the
 128 local operating system chooses.
 129 The buffer size will not be reduced below the operating system's default.
 130 .TP
 131 .B \-\-monitor\fR, \fB\-M
 132 Periodically report how close to the buffer low watermark the buffer is.
 133 If you have trouble with poor playback quality, enable this option to see if
 134 the buffer is emptying out (or overfilling, though there are measures to
 135 prevent that from happening).
 136 .SS "Deprecated Options"
 137 These options may be removed in a future version.
 138 Use \fB\-\-api\fR instead.
 139 .TP
 140 .B \-\-alsa\fR, \fB\-a
 141 Use ALSA to play sound.
 142 Only available on Linux.
 143 .TP
 144 .B \-\-oss\fR, \fB\-o
 145 Use OSS to play sound.
 146 Only available on Linux and FreeBSD.
 147 .TP
 148 .B \-\-core\-audio\fR, \fB\-c
 149 Use Core Audio to play sound.
 150 Only available on Macs.
 151 .SH "REMOTE CONTROL"
 152 The
 153 .B \-\-socket
 154 option is used by Disobedience to control a background
 155 .B disorder\-playrtp
 156 daemon.
 157 The socket will be created as a UNIX domain stream socket.
 158 When a connection is received a single line is read from it.
 159 The following commands are known:
 160 .TP
 161 .B stop
 162 Causes
 163 .B disorder\-playrtp
 164 to terminate.
 165 .TP
 166 .B query
 167 Causes the string "running" to be sent back.
 168 .TP
 169 .B getvol
 170 Print the left and right volume levels,
 171 as two decimal integers between 0 and 100,
 172 separated by a space.
 173 .TP
 174 .BI "setvol " left " " right
 175 Set the left and right volume levels to the given decimal values,
 176 which should be between 0 and 100;
 177 echo back the new values as for
 178 .B getvol
 179 above.
 180 .PP
 181 Other commands are ignored.
 182 After the first command the connection is closed.
 183 Only one connection at a time will be serviced.
 184 .PP
 185 This protocol is not guaranteed to be stable.
 186 .SH "DEVICE NAMES"
 187 .SS "Core Audio"
 188 On a Mac, the device name can either be the human-readable name of the desired
 189 output or its UID.
 190 To get a list of the human-readable names, visit System Preferences -> Sound;
 191 the Type column has the name you want.
 192 .PP
 193 For example, you might use "Built-in Output" for the built-in speaker
 194 or "Built-in Line Output" if you have connected external speakers.
 195 Remember to quote the name.
 196 .SH "SEE ALSO"
 197 .BR disobedience (1),
 198 .BR disorder_config (5),
 199 .BR disorderd (8)
 200 .\" Local Variables:
 201 .\" mode:nroff
 202 .\" fill-column:79
 203 .\" End: