about summary refs log tree commit homepage
path: root/Documentation/dtas-player_sink_examples.txt
blob: e9d28a9182f97beb779979f138fbe2a6a572c552 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
% dtas-player_sink_examples(7) dtas user manual

# NAME

dtas-player_sink_examples - sink examples for dtas-player

# SYNOPSIS

dtas-ctl sink ed SINKNAME command='...'
dtas-sinkedit SINKNAME

# EXAMPLES



## Streaming Ogg-Vorbis to Icecast

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.

    # set HOST/PORT/PASS via env or directly in the command
    ---
    name: oggfwd
    command: sox $SOXFMT - -t ogg - | oggfwd $HOST $PORT $PASS /dtas.ogg

## Stream to a remote host via ssh

Alternatively, if you have play(1) installed on any remote host and
a slow connection using Ogg-Vorbis:

    # 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.

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.

    ---
    name: ssh-remote
    command: ssh $HOST env AUDIODEV=... play -q $SOXFMT -

## Dump audio to a file during playback

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).

    $ dtas-ctl sink ed dumper command='sox $SOXFMT - /tmp/dump.sox'

Non-"default" sinks are not active by default, but may be made active.

    $ dtas-ctl sink ed dumper active=true

Changing it again to "active=false" will deactivate the sink.

## Apply a short delay to low frequencies to improve time-alignment

See dtas-xdelay(1).

# CONTACT

All feedback welcome via plain-text mail to: <dtas-all@nongnu.org>\
Mailing list archives available at <http://80x24.org/dtas-all/> and
<ftp://lists.gnu.org/dtas-all/>\
No subscription is necessary to post to the mailing list.

# COPYRIGHT

Copyright 2013-2015 all contributors <dtas-all@nongnu.org>.\
License: GPL-3.0+ <http://www.gnu.org/licenses/gpl-3.0.txt>

# SEE ALSO

dtas-ctl(1), dtas-sinkedit(1), dtas-xdelay(1),
sox(1), play(1), oggfwd(1), ssh(1), ssh_config(5), env(1)