.SH CONFIGURATION FILE SETTINGS
You should use the configuration file for setting up shairport-sync. This file is normally \fI/etc/shairport-sync.conf\f1. You may need to have root privileges to modify it.
-Settings are organised into groups, for example, there is a "general" group of standard settings, and there is an "alsa" group with settings that pertain to the ALSA back end.
+Settings are organised into groups, for example, there is a "general" group of standard settings, and there is an "alsa" group with settings that pertain to the ALSA back end. Here is an example of a typical configuration file:
-Most of the settings have sensible default values, so most users will only need to set (1) the service name, (2) a password (if desired) and (3) the output device. If the output device has a hardware mixer that can be used for volume control, then (4) the fact that the output mixer is hardware and (5) the output device mixer's volume-control name should be specificed. It is highly desirable to use the hardware mixer for volume control, if available -- response time is reduced to zero and the processor load is reduced.
+\fBgeneral = {\f1
-A sample configuration file, with all settings commented out and with some usage notes, is installed at \fI/etc/shairport-sync.conf.sample\f1.
+\fBname = "Mike's Boombox";\f1
+
+\fBinterpolation = "soxr";\f1
+
+\fBpassword = "secret";\f1
+
+\fB};\f1
+
+\fB\f1
+
+\fBalsa = {\f1
+
+\fBoutput_device = "hw:0";\f1
+
+\fBmixer_type = "hardware";\f1
+
+\fBmixer_control_name = "PCM";\f1
+
+\fB};\f1
+
+Most settings have sensible default values, so -- as in the example above -- users generally only need to set (1) the service name, (2) a password (if desired) and (3) the output device. If the output device has a hardware mixer that can be used for volume control, then (4) the fact that the output mixer is hardware and (5) the output device mixer's volume-control name should be specificed. It is highly desirable to use the hardware mixer for volume control, if available -- response time is reduced to zero and the processor load is reduced. In the example above, "soxr" interpolation was also enabled.
+
+A sample configuration file with all possible settings, but with all of them commented out, is installed at \fI/etc/shairport-sync.conf.sample\f1.
To retain backwards compatability with previous versions of shairport-sync you can use still use command line options, but any new features, etc. will be available only via configuration file settings.
This is the \fIlatency\f1, in frames, used when the source is unrecognised. Default is 88,200.
.TP
\fB"METADATA" SETTINGS\f1
-These are the settings available within the \fBmetadata\f1 group:
+Shairport Sync can process metadata provided by the source, such as Track Number, Album Name, cover art, etc. and can provide additional metadata such as volume level, pause/resume, etc. It provides the metadata to a pipe, by default \fI/tmp/shairport-sync-metadata\f1. To process metadata, Shairport Sync must have been compiled with metadata support included. The \fBmetadata\f1 group of settings allow you to enable metadata handling and to control certain aspects of it. These are the settings available within the \fBmetadata\f1 group:
.TP
-\fBenabled=\f1\fI"no"\f1\fB;\f1
+\fBenabled=\f1\fI"choice"\f1\fB;\f1
Comment Here
.TP
\fBinclude_cover_art=\f1\fI"no"\f1\fB;\f1
<p>Settings are organised into <i>groups</i>, for example, there is a "general" group of
standard settings, and there is an "alsa" group with settings that pertain to the ALSA
- back end.</p>
+ back end. Here is an example of a typical configuration file:</p>
- <p>Most of the settings have sensible default values, so most users will only need to set (1) the service name, (2) a password (if desired) and
- (3) the output device. If the output device has a hardware mixer that can be used for volume control, then (4) the fact that the output mixer is hardware and (5) the output device mixer's volume-control name should be specificed. It is highly desirable to use the hardware mixer for volume control, if available -- response time is reduced to zero and the processor load is reduced.</p>
+ <p><opt>general = {</opt></p>
+ <p><p><opt>name = "Mike's Boombox";</opt></p></p>
+ <p><p><opt>interpolation = "soxr";</opt></p></p>
+ <p><p><opt>password = "secret";</opt></p></p>
+ <p><opt>};</opt></p>
+ <p><opt></opt></p>
+ <p><opt>alsa = {</opt></p>
+ <p><p><opt>output_device = "hw:0";</opt></p></p>
+ <p><p><opt>mixer_type = "hardware";</opt></p></p>
+ <p><p><opt>mixer_control_name = "PCM";</opt></p></p>
+ <p><opt>};</opt></p>
- <p>A sample configuration file, with all settings commented out and with some usage notes,
- is installed at <file>/etc/shairport-sync.conf.sample</file>.</p>
+ <p>Most settings have sensible default values, so -- as in the example above -- users generally only need to set (1) the service name, (2) a password (if desired) and
+ (3) the output device. If the output device has a hardware mixer that can be used for volume control, then (4) the fact that the output mixer is hardware and (5) the output device mixer's volume-control name should be specificed. It is highly desirable to use the hardware mixer for volume control, if available -- response time is reduced to zero and the processor load is reduced. In the example above, "soxr" interpolation was also enabled.</p>
+
+ <p>A sample configuration file with all possible settings, but with all of them commented out, is installed at <file>/etc/shairport-sync.conf.sample</file>.</p>
<p>To retain backwards compatability with previous versions of shairport-sync
you can use still use command line options, but any new features, etc. will
</option>
<option><p><opt>"METADATA" SETTINGS</opt></p></option>
- <p>These are the settings available within the <opt>metadata</opt> group:</p>
+ <p>Shairport Sync can process metadata provided by the source, such as Track Number, Album Name, cover art, etc. and can provide additional metadata such as volume level, pause/resume, etc. It provides the metadata to a pipe, by default <file>/tmp/shairport-sync-metadata</file>. To process metadata, Shairport Sync must have been compiled with metadata support included. The <opt>metadata</opt> group of settings allow you to enable metadata handling and to control certain aspects of it. These are the settings available within the <opt>metadata</opt> group:</p>
<option>
- <p><opt>enabled=</opt><arg>"no"</arg><opt>;</opt></p>
+ <p><opt>enabled=</opt><arg>"choice"</arg><opt>;</opt></p>
<optdesc>Comment Here</optdesc>
</option>
<option>
<p>Settings are organised into groups, for example, there is a "general" group of
standard settings, and there is an "alsa" group with settings that pertain to the ALSA
- back end.</p>
+ back end. Here is an example of a typical configuration file:</p>
- <p>Most of the settings have sensible default values, so most users will only need to set (1) the service name, (2) a password (if desired) and
- (3) the output device. If the output device has a hardware mixer that can be used for volume control, then (4) the fact that the output mixer is hardware and (5) the output device mixer's volume-control name should be specificed. It is highly desirable to use the hardware mixer for volume control, if available -- response time is reduced to zero and the processor load is reduced.</p>
+ <p><b>general = {</b></p>
+ <p><p><b>name = "Mike's Boombox";</b></p></p>
+ <p><p><b>interpolation = "soxr";</b></p></p>
+ <p><p><b>password = "secret";</b></p></p>
+ <p><b>};</b></p>
+ <p><b></b></p>
+ <p><b>alsa = {</b></p>
+ <p><p><b>output_device = "hw:0";</b></p></p>
+ <p><p><b>mixer_type = "hardware";</b></p></p>
+ <p><p><b>mixer_control_name = "PCM";</b></p></p>
+ <p><b>};</b></p>
- <p>A sample configuration file, with all settings commented out and with some usage notes,
- is installed at <em>/etc/shairport-sync.conf.sample</em>.</p>
+ <p>Most settings have sensible default values, so -- as in the example above -- users generally only need to set (1) the service name, (2) a password (if desired) and
+ (3) the output device. If the output device has a hardware mixer that can be used for volume control, then (4) the fact that the output mixer is hardware and (5) the output device mixer's volume-control name should be specificed. It is highly desirable to use the hardware mixer for volume control, if available -- response time is reduced to zero and the processor load is reduced. In the example above, "soxr" interpolation was also enabled.</p>
+
+ <p>A sample configuration file with all possible settings, but with all of them commented out, is installed at <em>/etc/shairport-sync.conf.sample</em>.</p>
<p>To retain backwards compatability with previous versions of shairport-sync
you can use still use command line options, but any new features, etc. will
<p><b>"METADATA" SETTINGS</b></p>
- <p>These are the settings available within the <b>metadata</b> group:</p>
+ <p>Shairport Sync can process metadata provided by the source, such as Track Number, Album Name, cover art, etc. and can provide additional metadata such as volume level, pause/resume, etc. It provides the metadata to a pipe, by default <em>/tmp/shairport-sync-metadata</em>. To process metadata, Shairport Sync must have been compiled with metadata support included. The <b>metadata</b> group of settings allow you to enable metadata handling and to control certain aspects of it. These are the settings available within the <b>metadata</b> group:</p>
- <p><b>enabled=</b><em>"no"</em><b>;</b></p>
+ <p><b>enabled=</b><em>"choice"</em><b>;</b></p>
Comment Here
projects / thirdparty / shairport-sync.git / commitdiff
