PCM6SHOUT.CONF(5) Manual Page


NAME

pcm6shout.conf - configuration file for pcm6shout(1)

SYNOPSIS

The configuration file is the only way to pass options and settings to pcm6shout(1). This man page describes all the available options and where applicable, their default values. The configuration file maybe be located anywhere on the file system and the filename does not need to be pcm6shout.conf.

FILE FORMAT

The format of the pcm6shout configuration file is very simple. There is one configuration option per line in the file. Each option is formatted as option's name, followed by a space, followed by the option's value.

Blank lines and lines beginning with a hash (#) are ignored. The maximum length of a single line is 255 characters. Each configuration option should only appear once.

OPTIONS

multicast_ip

The address of the IPv6 multicast group to receive packets on. There is no default value for this option.

multicast_port

The port to receive packets on. Should be an even number. RTCP reports are sent on one port higher. Port numbers above 1024 are usually used. There is no default value for this option.

multicast_ttl

The TTL for RTCP report packets. Default value is 127.

multicast_timeout

The time in seconds to wait for a packet. Set to 0 to disable timeouts. Default is to wait 10 seconds.

multicast_ssrc

Only accept packets from this SSRC, expressed as a hexadecimal number. Default is to accept packets from the SSRC of the first packet received.

audio_format

Either "MP3" or "Vorbis". Chooses the format that the audio is encoded to. Default format is MP3.

mp3_bitrate

The bitrate of the encoded MP3 in kbps. Default bitrate is 128. See lame --longhelp for a list of valid bitrates.

mp3_mode

Either "Mono", "Joint" or "Stereo". Joint will encode the difference between the two channels, which will result in better quality audio if the two channels are similar. Default mode is Joint.

mp3_quality

True quality is determined by the bitrate but this variable will effect quality by selecting expensive or cheap algorithms. Quality is an integer between 0 and 9. Default quality is 3.

vorbis_quality

The quality of the Ogg Vorbis stream is chosen using a floating point number between 0 and 10.

vorbis_downmix

True or False. Downmix a stereo source stream to mono before encoding to Ogg Vorbis. Default is to not downmix.

shout_host

The IP address or hostname of the Icecast/Shoutcast server to connect to. Default host is localhost.

shout_port

The port of the Icecast/Shoutcast server. Default is port 8000.

shout_protocol

The protocol to use for communicating with the server. Use "http" for an Icecast 2 Server, "shoutcast" for a Shoutcast server, or "audiocast" for an Icecast 1 Server. Default protocol is http.

shout_password

The source password for connecting to the server. There is no default password.

shout_username

Optional username for the server. Default username is "source".

shoutispublic

True or False. Should this stream be advertised on public directories ? Default is not to be public.

shout_name

The name of the stream. Default is "Unconfigured pcm6shout stream".

shout_genre

The audio genre of the stream. Default is no genre.

shout_url

A URL for users to find out more information about the stream. Default is no URL.

shout_description

A textual description about the content of the stream. Default is no description.

shout_mount

Mountpoint for Icecast servers. This allows you to server more than one audio stream with a streaming server. For example "/stream_low.ogg". Default is to use the default mount (/).

shout_dumpfile

The filename for archives of the stream to be recorded remotely on the server. Default is not to have a dump file.

AUTHOR

Written by Nicholas J Humfrey, <njh@ecs.soton.ac.uk>

RESOURCES

Main web site: http://www.ecs.soton.ac.uk/~njh/pcm6cast/

SEE ALSO

pcm6shout(1), pcm6client(1), pcm6cast(1)

COPYING

Copyright © 2003,2004 University of Southampton. Free use of this software is granted under the terms of the GNU Lesser General Public License (LGPL)


Version 0.1
Last updated 19-May-2004 10:57:49 BST