chiark / gitweb /
DisOrder 3.0
[disorder] / doc / disorder-playrtp.1.in
... / ...
CommitLineData
1.\"
2.\" Copyright (C) 2007, 2008 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 2 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, but
10.\" WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12.\" 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, write to the Free Software
16.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
17.\" USA
18.\"
19.TH disorder-playrtp 1
20.SH NAME
21disorder-playrtp \- play DisOrder network broadcasts
22.SH SYNOPSIS
23.B disorder\-playrtp
24.RI [ OPTIONS ]
25.RB [ \-\- ]
26.RI [[ GROUP ]
27.IR PORT ]
28.SH DESCRIPTION
29\fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
30address.
31.PP
32If neither a group nor port are specified then the local DisOrder
33configuration is consulted to find the server and the server is asked where the
34RTP stream is.
35.PP
36If just a port is specified then the RTP stream is assumed to be unicast or
37broadcast to that port.
38.PP
39If a group and a port are specified then the RTP stream is assumed to be
40multicast to that group and port.
41.SH OPTIONS
42The default sound API is the first of the ones listed below that are available.
43Usually this implies ALSA under Linux and Core Audio under OS X.
44.TP
45.B \-\-alsa\fR, \fB-\a
46Use ALSA to play sound.
47.TP
48.B \-\-oss\fR, \fB\-o
49Use OSS to play sound.
50.TP
51.B \-\-core\-audio\fR, \fB\-c
52Use Core Audio to play sound.
53.TP
54.B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
55Specifies the audio device to use.
56The exact meaning of this is platform-dependent; on Linux it is the
57ALSA device name.
58.TP
59.B \-\-config \fIPATH\fR, \fB\-C \fIPATH
60Set the configuration file.
61The default is
62.IR pkgconfdir/config .
63.TP
64.B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
65Set the control socket.
66Normally this would not be used manually.
67.TP
68.B \-\-help\fR, \fB\-h
69Display a usage message.
70.TP
71.B \-\-version\fR, \fB\-V
72Display version number.
73.SS "Buffer Control Options"
74You shouldn't need to use these options.
75.TP
76.B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
77Specifies the buffer low watermark in frames.
78If the number of frames falls below this value then playing will be
79stopped until the buffer fills up.
80.TP
81.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
82Specifies the buffer high watermark in frames.
83Once there are this many frames in the buffer, playing will be (re-)started.
84.TP
85.B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
86Specifies the maximum buffer size in frames.
87If there are this many frames in the buffer then reading from the
88network socket will be suspended.
89The default is four times the \fB\-\-buffer\fR value.
90.TP
91.B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
92Specifies socket receive buffer size.
93The default is 131072 (128Kbytes).
94The buffer size will not be reduced below the operating system's default.
95.SH "REMOTE CONTROL"
96The
97.B \-\-socket
98option is used by Disobedience to control a background
99.B disorder\-playrtp
100daemon.
101The socket will be created as a UNIX domain stream socket.
102When a connection is received a single line is read from it.
103The following commands are known:
104.TP
105.B stop
106Causes
107.B disorder\-playrtp
108to terminate.
109.TP
110.B query
111Causes the string "running" to be sent back.
112.PP
113Other commands are ignored.
114After the first command the connection is closed.
115Only one connection at a time will be serviced.
116.PP
117This protocol is not guaranteed to be stable.
118.SH "SEE ALSO"
119.BR disobedience (1),
120.BR disorder_config (5),
121.BR disorderd (8)
122.\" Local Variables:
123.\" mode:nroff
124.\" fill-column:79
125.\" End: