Rivendellaudio/conf/rlm_spinitron_plus.conf
Fred Gleason eb4f2dffac 2018-08-29 Fred Gleason <fredg@paravelsystems.com>
* Added support for the Spinitron v2 API in the 'spinitron_plus' RLM.
2018-08-29 16:33:51 +00:00

184 lines
4.6 KiB
Plaintext

; rlm_spinitron_plus.conf
;
; This is the sample configuration file for the 'rlm_spinitron_plus' module
; for Rivendell, which can be used log Now & Next data to the Spinitron
; online playlist service [http://www.spinitron.com].
;
; To enable this module, add it to the 'Loadable Modules' list in
; RDAdmin->ManageHosts->RDAirPlay->ConfigureNow&Next. The 'Argument'
; field should point to the location of this file.
;
; This module requires the curl(1) network transfer tool, included with most
; Linux distros. It is also available at http://curl.haxx.se/.
; Section Header
;
; One section per Spinitron account is configured, starting with
; 'Spinitron1' and working up consecutively
[Spinitron1]
; MajorVersion
;
; The major version of the Spinitron API to be used. Choices are '1'
; or '2'.
MajorVersion=1
; Station;
;
; The station to be used for the Spinitron account to which to log the
; play-out.
Station=wxyz
; Username
;
; Username for the Spinitron account to which to log the play-out.
Username=user@example.com
; Password
;
; The password of the Spinitron account to which to log the play-out.
Password=changeme
; APIKey
;
; API key for the Spinitron v2 account to which to log the play-out.
; (This setting is only needed for Spinitron major version 2).
APIKey=change_me_please
; PlaylistMode
;
; Set the Spinitron playlist mode to use when sending updates.
;
; (For a discussion of the implications of this setting on your
; Spinitron playlists, see Section 3.2 of the 'Spinitron Automation
; Integration' document, available from Spinitron).
;
; The following options are recognized:
;
; Full - Always use the Spinitron 'Full Automation' mode.
; Assist - Always use the Spinitron 'Live Assist' mode.
; Follow - Use the Spinitron 'Full Automation' mode when RDAirPlay
; is in Automatic, otherwise use the Spinitron 'Live Assist' mode.
PlaylistMode=Follow
; Title. The string to be sent as the 'Title' field for each update,
; including any wildcards as placeholders for metadata values.
; The following wildcards are available:
;
; Now Next Field
; ----------------------------------------------
; %n %N The Rivendell cart number
; %h %H Event length (in milliseconds)
; %g %G The Rivendell group name
; %t %T Title
; %a %A Artist
; %l %L Album
; %y %Y Year
; %b %B Record Label
; %c %C Client
; %e %E Agency
; %m %M Composer
; %p %P Publisher
; %r %R Conductor
; %s %S Song ID
; %u %U User Definied
; %o %O Outcue
; %i %I Description
Title=%t
; Artist. The string to be sent as the 'Artist' field for each update,
; including any wildcards as placeholders for metadata values.
; (See the 'Title' section above for a list of available wildcards).
Artist=%a
; Album. The string to be sent as the 'Album' field for each update,
; including any wildcards as placeholders for metadata values.
; (See the 'Title' section above for a list of available wildcards).
Album=%l
; Label. The string to be sent as the 'Label' field for each update,
; including any wildcards as placeholders for metadata values.
; (See the 'Title' section above for a list of available wildcards).
Label=%b
; Composer. The string to be sent as the 'Composer' field for each update,
; including any wildcards as placeholders for metadata values.
; (See the 'Title' section above for a list of available wildcards).
Composer=%m
; Notes. The string to be sent as the 'Notes' field for each update,
; including any wildcards as placeholders for metadata values.
; (See the 'Title' section above for a list of available wildcards).
Notes=%u
; Log Selection
;
; Set the status for each log to 'Yes', 'No' or 'Onair' to indicate whether
; state changes on that log should be output to this account. If set
; to 'Onair', then output will be generated only if RDAirPlays OnAir flag
; is active.
MasterLog=Yes
Aux1Log=Yes
Aux2Log=Yes
VLog101=No
VLog102=No
VLog103=No
VLog104=No
VLog105=No
VLog106=No
VLog107=No
VLog108=No
VLog109=No
VLog110=No
VLog111=No
VLog112=No
VLog113=No
VLog114=No
VLog115=No
VLog116=No
VLog117=No
VLog118=No
VLog119=No
VLog120=No
; Additional Spinitron instances can be configured by adding new
; sections...
;
;[Spinitron2]
;MajorVersion=2
;Station=abcd
;Username=metoo
;Password=letmein
;APIKey=some_different_key
;Title=%t
;Artist=%a
;Album=%l
;Label=%b
;Composer=%m
;Notes=%u
;MasterLog=Yes
;Aux1Log=No
;Aux2Log=Onair
;VLog101=No
;VLog102=No
;VLog103=No
;VLog104=No
;VLog105=No
;VLog106=No
;VLog107=No
;VLog108=No
;VLog109=No
;VLog110=No
;VLog111=No
;VLog112=No
;VLog113=No
;VLog114=No
;VLog115=No
;VLog116=No
;VLog117=No
;VLog118=No
;VLog119=No
;VLog120=No