X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/419893d77041c006cb22eeaa189f9797773fbdc1..d4170ca70fd4f87f77fa2213219eb30f89d3d0d0:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index e2f1ab0..d033258 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -1,5 +1,5 @@ .\" -.\" Copyright (C) 2004-2008 Richard Kettlewell +.\" Copyright (C) 2004-2009 Richard Kettlewell .\" .\" This program is free software: you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by @@ -276,12 +276,14 @@ This is the default if .B speaker_command is specified, or if no native is available. .TP -.B network +.B rtp Transmit audio over the network. This is the default if \fBbroadcast\fR is specified. You can use .BR disorder-playrtp (1) to receive and play the resulting stream on Linux and OS X. +.B network +is a deprecated synonym for this API. .RE .TP .B authorization_algorithm \fIALGORITHM\fR @@ -293,7 +295,7 @@ for more details. .TP .B broadcast \fIADDRESS\fR \fIPORT\fR Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR. -This implies \fBapi network\fR. +This implies \fBapi rtp\fR. .IP See also \fBmulticast_loop\fR and \fBmulticast_ttl\fR. .TP @@ -386,7 +388,12 @@ will be tried. .IP For \fBapi alsa\fR this is the device name to use. .IP -For \fBapi coreaudio\fR this is currently ignored. +For \fBapi coreaudio\fR this can be either the UID or the human-readable +name of the desired device. +For a list of names, visit System Preferences -> Sound and look at the Type column. +For example, you might use "Built-in Output" for the built-in speaker +or "Built-in Line Output" if you have connected external speakers. +Remember to quote the name. .IP The default is \fBdefault\fR, which is intended to map to whatever the system's default is. @@ -430,12 +437,12 @@ For \fBapi coreaudio\fR, volume setting is not currently supported. .B multicast_loop yes\fR|\fBno Determines whether multicast packets are loop backed to the sending host. The default is \fByes\fR. -This only applies if \fBapi\fR is set to \fBnetwork\fR and \fBbroadcast\fR +This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR is actually a multicast address. .TP .B multicast_ttl \fIHOPS\fR Set the maximum number of hops to send multicast packets. -This only applies if \fBapi\fR is set to \fBnetwork\fR and +This only applies if \fBapi\fR is set to \fBrtp\fR and \fBbroadcast\fR is actually a multicast address. The default is 1. .TP @@ -623,7 +630,7 @@ The default is .BR 16/44100/2 . .PP With the -.B network +.B rtp backend the sample format is forced to .B 16b/44100/2 and with the