SHOUTcast Calendar Event XML File Specification - Revision history

DrO at 23:01, 28 October 2014

2014-10-28T23:01:38Z

DrO: Removed deprecated attribute

2012-09-14T09:35:38Z

Removed deprecated attribute

DrO: Add main playlist event level

2012-01-10T22:57:50Z

Add main playlist event level

DrO: Added more information about event priorities + added missing priority element on the DJ event

2012-01-10T22:48:57Z

Added more information about event priorities + added missing priority element on the DJ event

DrO: Protected "SHOUTcast Calendar Event XML File Specification" [edit=sysop:move=sysop]

2011-08-22T22:43:03Z

Protected "SHOUTcast Calendar Event XML File Specification" [edit=sysop:move=sysop]

DrO: Change options base from _0 to _1 as per new Transcoder build

2011-07-07T14:50:02Z

Change options base from _0 to _1 as per new Transcoder build

DrO at 09:46, 22 June 2011

2011-06-22T09:46:08Z

DrO at 17:50, 18 January 2011

2011-01-18T17:50:48Z

DrO at 16:42, 6 January 2011

2011-01-06T16:42:47Z

DrO: /* Introduction */

2011-01-06T12:12:32Z

‎Introduction

← Older revision		Revision as of 23:01, 28 October 2014
Line 1:		Line 1:
		+	{{Template:NavBarSC}}
		+
		+
	==Introduction==		==Introduction==

@@ Line 50: / Line 50: @@
 The ''''startdate'''' and ''''enddate'''' attributes indicate the date range the event is valid for otherwise the event will be ignored. Either value can be left out and if so then the event will be unbounded in that direction i.e. specifying no ''''startdate'''' is the way to indicate the event takes effect when sc_trans starts.
-The ''''starttime'''' and ''''endtime'''' attributes work in a similar manner to the date ones for the event but are used when the associated ''''startdate'''' is met. So if no ''''starttime'''' is indicated then the event starts immediately on ''''startdate''''. So as you can see this could be left out along with ''''startdate'''' to make events start always when sc_trans is started.
+The ''''starttime'''' attribute works in a similar manner to the date ones for the event but are used when the associated ''''startdate'''' is met. So if no ''''starttime'''' is indicated then the event starts immediately on ''''startdate''''. So as you can see this could be left out along with ''''startdate'''' to make events start always when sc_trans is started.
 The ''''duration'''' attribute is the length of the scheduled event and if this is not specified then the event will end when ''''enddate'''' (if specified) is reached.

← Older revision		Revision as of 22:57, 10 January 2012
Line 98:		Line 98:
	DJ2 connects when DJ1 is already connected, DJ1 is dropped and DJ2 can connect.		DJ2 connects when DJ1 is already connected, DJ1 is dropped and DJ2 can connect.
	DJ1 connects when DJ2 is already connected, DJ2 stays connected and DJ1 is blocked.		DJ1 connects when DJ2 is already connected, DJ2 stays connected and DJ1 is blocked.
		+
		+	In all cases, if an event is valid and can be activated then it will be used instead of the specified main playlist, which has a priority of zero to keep it below all events.

@@ Line 25: / Line 25: @@
      <!-------------  dj type  ------------->
-     <dj archive="1|0|inherit">djname</dj>
+     <dj archive="1|0|inherit" priority="#">djname</dj>
      <!------------------------------------->
      <!-----------  relay type  ------------>
-     <relay url="" priority="#"/>
+     <relay url="xxx" priority="#"/>
      <!------------------------------------->
@@ Line 82: / Line 82: @@
 ''''Important Note:'''' If you use this on a playlist event then the event will be activated at the specified time period after the last event successfully occurred but the required file(s) will not be played until the currently playing file has completed playing as playlist events add to the main playback queue and do not act as an instant event as the relay and DJ events do.
@@ Line 108: / Line 124: @@
 - No
             inherit - Use value set for ''''djcapture'''' in the configuration file.
 e.g. This would enable archiving of the show made by the DJ identified as 'Bob'
-     <dj archive="1">Bob</dj>
+     <dj archive="1" priority="1">Bob</dj>
@@ Line 141: / Line 159: @@
             inherit - Use value set for ''''shuffle'''' in the configuration file.
-  priority : Specify the priority of the playlist when a playlist event overlaps with that of another playlist event. The result in this case is that the playlist event with the highest priority will become active.
+  priority : Specify the priority of the playlist when a playlist event overlaps with that of another event.
-Note: Supported priority values are 1 (default) and higher.
 e.g. This would specify the playlist known as 'evening' to loop if needed and to not be shuffled when played
@@ Line 159: / Line 176: @@
   url : Specify the url of the source to be relayed.
-−
-  priority : Specify the priority of the source when a relay event overlaps with that of another relay event. The result in this case is that the relay event with the highest priority will become active.
+  priority : Specify the priority of the source when a relay event overlaps with that of another event.
-Note: Supported priority values are 1 (default) and higher.
 e.g. This would enable the relaying of the stream on 'my_site' on port 9000

@@ Line 122: / Line 122: @@
 In the sc_trans configuration file:
-     playlistfilename_0=morning
+     playlistfilename_1=morning
-     playlistfilename_1=daytime
+     playlistfilename_2=daytime
-     playlistfilename_2=evening
+     playlistfilename_3=evening
 In the calendar xml file:

← Older revision	Revision as of 22:43, 22 August 2011
(No difference)

@@ Line 20: / Line 20: @@
      <!----------  playlist type  ---------->
      <playlist loopatend="1|0" shuffle="1|0|inherit" priority="#">
-       foo.lst
+       playlistname
      </playlist>
      <!------------------------------------->

@@ Line 165: / Line 165: @@
 e.g. This would enable the relaying of the stream on 'my_site' on port 9000
-     <relay url="http://my_site:9000" priority="1"/>
+     <nowiki><relay url="http://my_site:9000" priority="1"/></nowiki>
 Note: It may be necessary to append ''''/;'''' onto the end of the url as in some cases the wrong mime type will be returned from the server and so causes the relay url fail to be recognised by sc_trans. This depends on the server.

@@ Line 6: / Line 6: @@
 If you use the AJAX api (see [[SHOUTcast_Transcoder_AJAX_api_Specification|sc_trans_ajax_api.txt]] and [[SHOUTcast_Transcoder_AJAX_api_Specification#AddEvent|Sections 2.14]] to [[SHOUTcast_Transcoder_AJAX_api_Specification#AbortEvent|2.16]]) then you can make changes to the calendar file whilst sc_trans is running but you will need to make sure to have ''''calendarrewrite=1'''' in your sc_trans configuration file so that any live changes made will be saved back into your calender file.
 ==File Layout==
@@ Line 99: / Line 100: @@
 The purpose of a DJ event is to control the access a DJ has to the instance of sc_trans for the duration of the specified event. This makes it simple to setup scheduling of access of different DJs at different times of the day or week.
-This is enabled in combination with the settings in the sc_trans configuration file for controlling DJ access. So for this to work you will also need to make sure you enable ''''djport / djport2'''' (depending on you using SHOUTcast 1 or SHOUTcast 2 features) and to set any passwords and names in the sc_trans config file to match the event. See sc_trans.txt - section 3.0.3 for more information setting up DJ support.
+This is enabled in combination with the settings in the sc_trans configuration file for controlling DJ access. So for this to work you will also need to make sure you enable ''''djport / djport2'''' (depending on you using SHOUTcast 1 or SHOUTcast 2 features) and to set any passwords and names in the sc_trans config file to match the event. See [[SHOUTcast_DNAS_Transcoder_2#DJ_Support|sc_trans.txt - section 3.0.3]] for more information setting up DJ support.
 The parameters supported for this event type are:

@@ Line 5: / Line 5: @@
 An important thing to note is that sc_trans will only read the settings from your calendar xml file when it is loaded. So if you do change anything in the file externally whilst sc_trans is running then you will need to restart your sc_trans instance for the new values to be read in.
-If you use the AJAX api (see sc_trans_ajax_api.txt and Sections 2.14 to 2.16) then you can make changes to the calendar file whilst sc_trans is running but you will need to make sure to have ''''calendarrewrite=1'''' in your sc_trans configuration file so that any live changes made will be saved back into your calender file.
+If you use the AJAX api (see [[SHOUTcast_Transcoder_AJAX_api_Specification|sc_trans_ajax_api.txt]] and [[SHOUTcast_Transcoder_AJAX_api_Specification#AddEvent|Sections 2.14]] to [[SHOUTcast_Transcoder_AJAX_api_Specification#AbortEvent|2.16]]) then you can make changes to the calendar file whilst sc_trans is running but you will need to make sure to have ''''calendarrewrite=1'''' in your sc_trans configuration file so that any live changes made will be saved back into your calender file.
-−
 ==File Layout==