.TH dtas-player_sink_examples 7 "" "dtas user manual"
.SH NAME
.PP
dtas-player_sink_examples - sink examples for dtas-player
.SH SYNOPSIS
.PP
dtas-ctl sink ed SINKNAME command=\[aq]...\[aq] dtas-sinkedit SINKNAME
.SH EXAMPLES
.SS Streaming Ogg-Vorbis to Icecast
.PP
To use oggfwd(1) and Icecast, the following sink works.
Warning: the following example will likely expose your Icecast source
password to any local users on the system.
.IP
.nf
\f[C]
#\ set\ HOST/PORT/PASS\ via\ env\ or\ directly\ in\ the\ command
---
name:\ oggfwd
command:\ sox\ $SOXFMT\ -\ -t\ ogg\ -\ |\ oggfwd\ $HOST\ $PORT\ $PASS\ /dtas.ogg
\f[]
.fi
.SS Stream to a remote host via ssh
.PP
Alternatively, if you have play(1) installed on any remote host and a
slow connection using Ogg-Vorbis:
.IP
.nf
\f[C]
#\ Long\ lines\ in\ YAML\ can\ be\ broken\ up\ and\ the\ subsequent\ lines
#\ indented\ with\ by\ spaces
---
name:\ ssh-remote
command:\ sox\ $SOXFMT\ -\ -t\ ogg\ -\ |
\ \ ssh\ $HOST\ env\ AUDIODEV=...\ play\ -q\ -t\ ogg\ -

#\ Note\ the\ use\ of\ env(1),\ as\ the\ "env"\ parameter\ for\ the\ sink\ may\ not\ be
#\ passed\ via\ ssh\ to\ the\ remote\ $HOST\ depending\ on\ the\ ssh_config(5)
#\ configuration.
\f[]
.fi
.PP
If you have a fast connection, there is no need to encode using
Ogg-Vorbis.
Alternatively, you may also use "flac" instead of "ogg" in the above
Ogg-Vorbis example.
.IP
.nf
\f[C]
---
name:\ ssh-remote
command:\ ssh\ $HOST\ env\ AUDIODEV=...\ play\ -q\ $SOXFMT\ -
\f[]
.fi
.SS Dump audio to a file during playback
.PP
To configure a dumper sink (in addition to the "default" sink).
Note the use of $SOXFMT, this will be automatically expanded to match
the internal format of the player.
The internal format of the player is described in
dtas-player_protocol(7).
.IP
.nf
\f[C]
$\ dtas-ctl\ sink\ ed\ dumper\ command=\[aq]sox\ $SOXFMT\ -\ /tmp/dump.sox\[aq]
\f[]
.fi
.PP
Non-"default" sinks are not active by default, but may be made active.
.IP
.nf
\f[C]
$\ dtas-ctl\ sink\ ed\ dumper\ active=true
\f[]
.fi
.PP
Changing it again to "active=false" will deactivate the sink.
.SS Apply a short delay to low frequencies to improve time-alignment
.PP
See dtas-xdelay(1).
.SH CONTACT
.PP
All feedback welcome via plain-text mail to: <dtas-all@nongnu.org>
.PD 0
.P
.PD
Mailing list archives available at <http://80x24.org/dtas-all/> and
<ftp://lists.gnu.org/dtas-all/>
.PD 0
.P
.PD
No subscription is necessary to post to the mailing list.
.SH COPYRIGHT
.PP
Copyright 2013-2016 all contributors <dtas-all@nongnu.org>.
.PD 0
.P
.PD
License: GPL-3.0+ <http://www.gnu.org/licenses/gpl-3.0.txt>
.SH SEE ALSO
.PP
dtas-ctl(1), dtas-sinkedit(1), dtas-xdelay(1), sox(1), play(1),
oggfwd(1), ssh(1), ssh_config(5), env(1)