Configuration:AutoDJ

From ShoutIRC RadioBot Wiki
Jump to: navigation, search
Configuration Sections vde

ircbot.conf Format
RadioBot Sections
Base
Example
IRC
Example
SS
Example
Timer Plugin
Most Popular Plugin Sections
AutoDJ SAM
Example
SimpleDJ DCC
Example
TTS
Example
Welcome
Other Plugin Sections
Auto_Identify Centovacast
Example
ChanAdmin
Example
ChannelLinking Forum Jabber
Hangman LastFM Logging LevelEmul Mumble
Example
phpBB
Example
Pidgin PublicVote SC_Proxy ShowSchedule Skype SMS
SS_Admin TeamSpeak3
Example
Telnet Trivia TuneIN
Example
Twitter
Example
Uno Users_MySQL
Example
Users_Shared


These options control the AutoDJ plugin.

Contents

AutoDJ

AutoDJ/Server

This section sets the main information for your stream.

Password			server_stream_pass
Password			SourceUser:SourcePass
Mandatory
Sets the streaming password for your server. (Shoutcast note: this is your streaming password, not admin password)
For Steamcast, you can put in just a password if you are using ShoutCast compatibility, or SourceUser:SourcePass for a mount.
Name				Name for your Stream
Mandatory
Sets the name AutoDJ will use for your stream
Description			Description for your stream
Mandatory
Sets the description AutoDJ will use for your stream
Genre				Various
Mandatory
Sets the genre AutoDJ will use for your stream
URL				http://www.example.com
Optional
Sets the URL AutoDJ will send for your stream
ICQ				123456789
Optional
Sets the ICQ # AutoDJ will send for your stream
AIM				aim_username
Optional
Sets the AIM nick AutoDJ will send for your stream
IRC				#channel, or irc://irc.server.com/channel
Optional
Sets the IRC server/channel AutoDJ will send for your stream
Public				1
Optional
Sets the public flag AutoDJ will send for your stream
Reset				1
Optional
Sets whether icy-reset: 1 is sent in your connection headers (shoutcast only) (default: 0)
Encoder                        mp3
Encoder                        aac
Encoder                        winamp
Optional
Sets which Encoder you would like to use (default: mp3)
Bitrate				64
Mandatory
Sets the bitrate the Encoder will use when encoding your stream (in kbps)
Sample				44100
Mandatory
Sets the samplerate the Encoder will use when encoding your stream
Channels			2
Mandatory
Sets the channels the Encoder will use when encoding your stream.
For the MP3 Encoder plugin, 1 = Mono, 2 = Joint Stereo (if available), 3 = Stereo
For others, it is typically 1 = Mono, 2 = Stereo
Mount				/
Optional
Sets the mountpoint for your stream (Icecast2 and Steamcast only)
MimeOverride			audio/aac
Optional
Forces the feeder to report this mime type to the sound server instead of the one given to it by the Encoder
Content			c:\path\mp3 (Win32)
Content			/some/path/mp3 (Absolute Path in Linux)
Content			./mp3 (Relative Path in Linux)
Mandatory
Sets the folder your music is in. You can also use multiple paths by using a ; to seperate them, for example: c:\path\mp3\;d:\path\mp3\
Promo				c:\path\promos (Win32)
Promo				/some/path/promos (Absolute Path in Linux)
Promo				./promos (Relative Path in Linux)
Optional
Sets the folder your promo files are in
SourceIP			127.0.0.1
Optional
Sets an alternate sound server IP to feed to instead of the default from SS/Server0. (default: empty/blank)
This setting is mainly for if you have different SrcIP and DestIP settings in your shoutcast configuration.
SourcePort			8001
Optional
Sets an alternate sound server port to feed instead of the default from SS/Server0. (default: empty/blank)
This setting is mainly for if you want to feed a different server than you pull stream titles from.

AutoDJ/Options

This section holds various AutoDJ options.

QueuePlugin			.\plugins\adjq_memory.dll (Win32)
QueuePlugin			./plugins/adjq_memory.so (Linux)
Optional
Sets the queue plugin to use (default: adjq_memory)
DSPPlugin			.\plugins\dsp_volnorm.dll (Win32)
DSPPlugin			./plugins/dsp_volnorm.so (Linux)
Optional
Sets the DSP plugin to use (default: none)
Resampler			speex
Resampler			soxr
Resampler			libresample
Optional
Let's you choose between the 3 different resamplers AutoDJ supports. If you have clipping issues or anything trying one or the other might help. (default: speex)
ID3_Mode			1
Optional
Adjusts if ID3 tags are read: 0 = Don't read ID3 tags, 1 = Read ID3 tags (default: 1).
Turning off ID3 tags will speed up file scans drastically, but will have less accurate titles depending on your filenames.
EnableCrossfade		0 or 1
Optional
Lets you turn the crossfader on or off. This is not compatible with the AutoDJ voice and will be disabled automatically if EnableVoice is turned on.
CrossfadeMinDuration		30
Optional
Sets the minimum song duration in seconds to crossfade (default: 30)
CrossfadeLength			6000
Optional
Sets the crossfade length in milliseconds (default: 6000)
AutoStart			0 or 1
Optional
Specifies whether or not you want AutoDJ to start playing when the bot starts (default: 1)
AutoReload			300
Optional
Makes the bot reload your content directory (same as !autodj-reload) every X seconds automatically (default: 0/disabled)
AutoPlayIfNoSource		60
Optional
If the number is greater than 0, AutoDJ will start playing if your shoutcast server doesn't have a source for over X seconds (default: 0)
DJConnectTime			10
Optional
Sets the number of seconds to give DJs to connect to your sound server when they use !autodj-stop (default: 10)
EnableRequests			0 or 1
Optional
Specifies whether or not you want AutoDJ to accept requests (default: 1) (EnableRequestSystem must be on in the Base section as well for it to work)
EnableFind			0 or 1
Optional
Enables or disables the find command (@find) (EnableFind and EnableRequestSystem must be on in the Base section as well for it to work)
EnableYP			0 or 1
Optional
Specifies whether or not you want your stream added to the ShoutIRC.com stream list (default: 1)
EnableTitleUpdates		0 or 1
Optional
Specifies whether or not to send title updates to your sound server (default: 1)
StrictParse		0 or 1
Optional
Removes any dashes from artist/album/title in title updates for if you need to be able to parse the fields correctly. (default: 0)
IncludeAlbum		0 or 1
Optional
Specifies whether or not to include the album in title updates instead of just artist and title. (default: 0)
OnlyScanNewFiles		0 or 1
Optional
This option will make it so the bot will only read/update meta tags for new files. This could speed up scans over slow locations like NFS/FTPFS mounts. (default: 0)
MinReqTimePerSong              60
Optional
Sets the minimum number of seconds that must pass before a song is requested again. (default: 0/disabled)
MinReqTimePerArtist            60
Optional
Sets the minimum number of seconds that must pass before an artist is requested again. (default: 0/disabled)
Note: This relies on you having accurate & consistent meta data such as ID3 tags.
MinReqTimePerUser              60
Optional
Sets the minimum number of seconds that must pass before the same person can request another song. (default: 0/disabled)
MinReqTimePerUserMask          -1
Optional
If set to 0-3 it will use a wildcard mask to match the user instead of their username or nickname. (default: -1, user bot username if recognized or medium nickname otherwise)
0-3 correspond to the mask types in the Mask API function.
MaxRequests              20
Optional
Sets the maximum number of requested songs in the request queue. (default: 0/unlimited)
MaxSongDuration              60
Optional
Sets the maximum length of a song in seconds that will play during random playback. (default: 0/disabled)
Note: This relies on you having accurate meta data such as ID3 tags.
DoPromos			X
DoPromos			MIN:MAX
Optional
How often to do a set of promos, or 0 to disable. The number means a set of promos will play after X songs play. (1 == promos after every song, 2 == 2 songs, then a set of promos)
You can also use a value like 2:5 to use a random number between 2 and 5 for example. The lower # must come first or bad results may happen.
NumPromos			X
Optional
Sets how many promos to play in a set. Default/minimum is 1.
NoRepeat			X
Optional
Tells AutoDJ not to play any song more often than X seconds. (Unless done by !request or the scheduler)
NoRepeatArtist			X
Optional
Tells AutoDJ not to play 2 songs by the same artist more often than X seconds. (Unless done by !request or the scheduler)
Note: This relies on you having accurate & consistent meta data such as ID3 tags.
RequestDelay			3600
Optional
Tells AutoDJ do delay requested song playback by X seconds. This is mainly for stations that have to follow rules about requesting songs.
MoveDir			c:\path\moved (Win32)
MoveDir			/some/path/moved (Absolute Path in Linux)
MoveDir			./moved (Relative Path in Linux)
Optional
Sets the folder files are moved to when you use !move or !autodj-move (note: these commands won't work without a MoveDir set)
YouTubeDir			c:\path\youtube (Win32)
YouTubeDir			/some/path/youtube (Absolute Path in Linux)
YouTubeDir			./youtube (Relative Path in Linux)
Optional
Sets the folder YouTube audio files are stored in. (default: ./youtube)
NoPlayFilters			*badsong.mp3*,*/some/folder*
Optional
This sets filters to block songs from playing during normal rotation, while allowing them to be requested or queued by the AutoDJ Scheduler
Multiple filters can be specified be separating them with commas (,)
EnableVoice			0
EnableVoice			MIN:MAX
Optional
How often to do a voice announcement, or 0 to disable. The # means a voice announcement will play after X songs play. (1 == voice after every song, 2 == 2 songs, then voice announcement)
You can also use a value like 2:5 to use a random number between 2 and 5 for example. The lower # must come first or bad results may happen.
Also note the TTS Services plugin has to be loaded before AutoDJ for the voice to work.
VoiceArtist			Artist
VoiceTitle			The voice of AutoDJ
Optional
This sets the meta data (think ID3 tag) to use for the AutoDJ voice when it is talking.
EnableVoiceBroadcast		0 or 1
Optional
This makes AutoDJ also speak his voice message to your IRC channels and anything that responds to IB_BROADCAST_MSG (default: 1).
ScanThreads			-1
Optional
Set the number of threads to use when scanning your music for ID3 and other meta tags. (default: one thread for each CPU/core up to a max of 6)
ScanDebug			1
Optional
Prints out each file when scanning your music for ID3 and other meta tags, useful to find a corrupt file if it causes hangs/crashes.

AutoDJ/FileLister

These options control the internal playlist writer of your songs.

List				file.txt/html/whatever
Optional
This sets the filename the playlist will be written to
Header				header.txt
Optional
Sets a file that should be written to the top of your playlist before the songs, default is no header
Footer				footer.txt
Optional
Sets a file that should be written to the end of your playlist, default is no footer
NewChar			%char%
Optional
Sets text to be written when the writer detects a change in the first character of the filenames being written, default is nothing written on new chars
Line				%file%
Optional
Sets the text written for each file, default is %file%

AutoDJ/MP3_Encoder

See the MP3 Encoder page for configuration options.

AutoDJ/Queue_MySQL

These options control the MySQL Queue plugin.

Host				localhost
Required
Sets the hostname of your MySQL Server
User				mysql_username
Required
Sets the username to use to login to your MySQL Server
Pass				mysql_password
Optional
Sets the password to use to login to your MySQL Server. (comment out or remove line for no password)
DBName				database
Required
Sets which database to use. This database must already exist
DBTable				AutoDJ
Optional
Sets which database table to use. The plugin will attempt to create this table if it doesn't already exist. (default: AutoDJ)
KeepHistory				0
Optional
If # is greater than 0, the plugin will keep your request history for # days (default: 0)
FindSort				random
FindSort				filename
FindSort				title
Optional
Sets the sort field of @find and scheduler results. random = random order, filename = sort by filename, title = sort by meta/id3 title (default: no sort, return in table order)

AutoDJ/Winamp_Encoder

These options control the Winamp Encoder plugin. Note: AAC+/FLAC/WMA/MP3 have their mime type set automatically upon loading, for other plugins you will need to set MimeOverride in the AutoDJ/Server section.

Plugin				enc_aacplus.dll
Required (if you want to use the plugin)
This sets the filename the encoder plugin you want to load
FourCC				AACP
Optional
This sets the FourCC code of the encoder you want to use inside the encoder plugin. If this is not set, it defaults to the first (and usually only) encoder in the DLL

AutoDJ/FFmpeg_Encoder

These options control the FFmpeg Encoder plugin.

Format mp3
Optional
Sets the FFmpeg output format (container) (default: mp3)
Encoder whatever
Optional
Sets the FFmpeg encoder to use, default is the default encoder for your selected output format. This can be left out/blank most of the time.


RadioBot vde

RadioBot main pages
Main PageInstallationChangelogCommandsPluginsFAQConfigurationCreditsRemote ClientBuilt-In VariablesMulti Sound Server ModeUsername Character Restrictions
Auto DJ Pages
Auto DJ Main PageWebRequest SystemSchedulerMP3 EncoderVoice SupportMySQL Plugin
Personal tools