slackbuilds/audio/jack-tools/man/jack-play.1

75 lines
3.1 KiB
Groff

'\" t
.\" Title: jack-play
.\" Author: Rohan Drape <rd@slavepianos.org>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 06/16/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "JACK\-PLAY" "1" "06/16/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
jack-play \- JACK Sound File Player
.SH "SYNOPSIS"
.sp
jack\-play [options] sound\-file\&...
.SH "OPTIONS"
.sp
\fB\-b\fR : Set the disk buffer size in frames (default=4096)\&. This value must be a power of two\&. If the JACK period size at any time exceeds this value the player will halt\&.
.sp
\fB\-c\fR : Set the sample rate conversion algorithm (default=2)\&. Values are: SRC_SINC_BEST_QUALITY = 0, SRC_SINC_MEDIUM_QUALITY = 1, SRC_SINC_FASTEST = 2, SRC_ZERO_ORDER_HOLD = 3 and SRC_LINEAR = 4\&.
.sp
\fB\-d\fR : Set the destination port pattern, overrides environment variable\&.
.sp
\fB\-i\fR : Set the initial disk seek in frames (default=0)\&.
.sp
\fB\-m\fR : Set the minimal disk transfer size in frames (default=32)\&. This is an optimization switch\&.
.sp
\fB\-l\fR : Loop input file indefinitely\&.
.sp
\fB\-n\fR : Set the client name (default=jack\-play)\&.
.sp
\fB\-q\fR : Set the frame size to request data from the ringbuffer (default=64)\&. This is an optimization switch\&.
.sp
\fB\-r\fR : Set the resampling ratio multiplier (default=1\&.0)\&.
.sp
\fB\-t\fR : Run in JACK transport aware mode\&.
.sp
\fB\-u\fR : Do not make client name unique by appending process identifier\&.
.SH "DESCRIPTION"
.sp
jack\-play is a light\-weight JACK sound file player\&. It creates as many output ports as there are channels in the input file\&. It will connect to ports mentioned at \fB\-p\fR or in the environment variable JACK_PLAY_CONNECT_TO which must include a %d pattern to indicate port number, otherwise it implements no connection logic, use jack\-plumbing(1) instead\&.
.sp
jack\-play will read files in any format supported by libsndfile, and will resample to match the server sample rate using libsamplerate\&.
.SH "AUTHOR"
.sp
Written by Rohan Drape http://rd\&.slavepianos\&.org/
.SH "SEE ALSO"
.sp
jackd(1), libsndfile(3) http://mega\-nerd\&.com/libsndfile/, libsamplerate(3) http://mega\-nerd\&.com/SRC/
.SH "AUTHOR"
.PP
\fBRohan Drape\fR <\&rd@slavepianos\&.org\&>
.RS 4
Author.
.RE