about summary refs log tree commit homepage
path: root/Documentation/dtas-ctl.pod
blob: 25a8b3f67e61b33e6e2dd9933baa6a752064682c (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
% dtas-ctl(1) dtas user manual

=head1 NAME

dtas-ctl - low-level client for dtas-player

=head1 SYNOPSYS

dtas-ctl [ARGS...]

=head1 DESCRIPTION

dtas-ctl passes command-line arguments as-is to dtas-player.  It is mainly
useful for simple commands such as ("current", "play_pause", "pause", "play",
"rg RGARGS", "seek HH:MM:SS", "skip").

See L<dtas-player_protocol(7)> for a detailed description of the protocol.

=head1 EXAMPLES

display the currently playing track

        $ dtas-ctl current

enqueue a file for playback (L<dtas-enq(1)> is easier to use, here)

        $ dtas-ctl enq /absolute/path/to/file

toggle the play/pause state of the player

        $ dtas-ctl play_pause

change the ReplayGain mode

        $ dtas-ctl rg mode=album_gain
        # "track_gain", "off" may be used, too

seek 5 seconds forward

        $ dtas-ctl seek +5

seek to an absolute position

        $ dtas-ctl seek 1:00

skip to the next track

        $ dtas-ctl skip

To play the output of an arbitrary command (note the quotes) and usage
of $SOXFMT (see L<dtas-player_protocol(7)>).

	$ dtas-ctl enq-cmd 'sox -n $SOXFMT - synth 3 pluck'

=head1 ENVIRONMENT

DTAS_PLAYER_SOCK - the path to the dtas-player control socket.
This defaults to ~/.dtas/player.sock

=head1 CONTACT

All feedback welcome via plain-text mail to: L<mailto:dtas-all@nongnu.org>

Mailing list archives available at L<https://80x24.org/dtas-all/>
and L<https://lists.gnu.org/archive/html/dtas-all/>

No subscription is necessary to post to the mailing list.

=head1 COPYRIGHT

Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>

License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>

=head1 SEE ALSO

L<dtas-player(1)>, L<dtas-player_protocol(7)>, L<dtas-enq(1)>,
L<dtas-sinkedit(1)>, L<dtas-sourceedit(1)>