Server/Spec - Revision history

Dave at 18:27, 1 November 2023

2023-11-01T18:27:37Z

← Older revision		Revision as of 18:27, 1 November 2023
Line 67:		Line 67:
	kPushNotifyEvent_ROTATION_CHANGED, // insert, remove, reorder, new singer up		kPushNotifyEvent_ROTATION_CHANGED, // insert, remove, reorder, new singer up
	kPushNotifyEvent_SONG_SKIPPED, // for when a song is missing		kPushNotifyEvent_SONG_SKIPPED, // for when a song is missing

			kPushNotifyEvent_PLAY_MODE_CHANGED,
			kPushNotifyEvent_VOLUME_CHANGED,
			kPushNotifyEvent_KEY_CHANGED,
			kPushNotifyEvent_TIME_CHANGED,

	kPushNotifyEvent_NUMTYPES		kPushNotifyEvent_NUMTYPES

Dave at 16:58, 8 September 2023

2023-09-08T16:58:02Z

← Older revision		Revision as of 16:58, 8 September 2023
Line 113:		Line 113:
	'''CWS_Path_NEW_PLAYLIST''': required: kPostData_SUBMIT (empty string), kPostData_NAME, kPostData_ADMIN_PASSWORD		'''CWS_Path_NEW_PLAYLIST''': required: kPostData_SUBMIT (empty string), kPostData_NAME, kPostData_ADMIN_PASSWORD

	'''CWS_Path_CMD''': required data: kPostData_CMD_ID, which is any of the [[Scripting]] commands, eg: http://localhost/command?cmd_id=# where # is the number of the scripting command		'''CWS_Path_CMD''': required data: kPostData_CMD_ID ("cmd_id"), which is any of the [[Scripting]] commands, and optionally kPostData_CMD_VAR ("cmd_var"), a floating point number, eg: http://localhost/command?cmd_id=<cmd>&cmd_var=<fpnum> where <cmd> is the number of the scripting command, and <fpnum> is a floating point number

	'''CWS_Path_NOTIFY_REGISTER''' and '''CWS_Path_NOTIFY_UNREGISTER''': register (or not) your OWN server for notifications from kJams. Note you must "percent escape" the URL that you're registering or un-registering. Note you must also specify the port number. eg:		'''CWS_Path_NOTIFY_REGISTER''' and '''CWS_Path_NOTIFY_UNREGISTER''': register (or not) your OWN server for notifications from kJams. Note you must "percent escape" the URL that you're registering or un-registering. Note you must also specify the port number. eg:

Dave: /* Doc */

2017-10-26T23:12:49Z

Doc

← Older revision		Revision as of 23:12, 26 October 2017
Line 75:		Line 75:
	You may use Bonjour to discover the web server and port. Everything is URL Encoded except for the search strings.		You may use Bonjour to discover the web server and port. Everything is URL Encoded except for the search strings.

	If you search for "\*" (no quotes) you'll get the entire library. If you append an "F" on the end, it'll come in JSON format.		If you search for "\*" (no quotes) you'll get the entire library. If you append a "J" on the end, it'll come in JSON format.

	send a '''CWS_Path_PING''' periodically so the session does not time out (the app let's the KJ set a timeout to whatever they want, so 30 seconds is probably a good period)		send a '''CWS_Path_PING''' periodically so the session does not time out (the app let's the KJ set a timeout to whatever they want, so 30 seconds is probably a good period)

Dave: /* Types */

2016-09-28T03:32:24Z

Types

← Older revision		Revision as of 03:32, 28 September 2016
Line 66:		Line 66:
	kPushNotifyEvent_DATABASE_CHANGED,		kPushNotifyEvent_DATABASE_CHANGED,
	kPushNotifyEvent_ROTATION_CHANGED, // insert, remove, reorder, new singer up		kPushNotifyEvent_ROTATION_CHANGED, // insert, remove, reorder, new singer up
			kPushNotifyEvent_SONG_SKIPPED, // for when a song is missing

	kPushNotifyEvent_NUMTYPES		kPushNotifyEvent_NUMTYPES

Dave: /* Doc */

2016-09-16T03:19:52Z

Doc

← Older revision		Revision as of 03:19, 16 September 2016
Line 94:		Line 94:
	'''CWS_Path_PLAYLISTS''': only works if a singer is logged in, it returns the list of playlists that are owned by the singer. currently there are three ("Tonight", "History" and "Favorites") but be prepared to show a variable number.		'''CWS_Path_PLAYLISTS''': only works if a singer is logged in, it returns the list of playlists that are owned by the singer. currently there are three ("Tonight", "History" and "Favorites") but be prepared to show a variable number.

	'''CWS_Path_SONGS''': singer must be logged in, requires params: kPostData_PLAYLIST (~~name~~), kPostData_ORDER_BY (CWS_OrderByType value) (optional), kPostData_SEARCH (search string (NOT URL ENCODED!)). returns a plist containing the songs in the playlist. also pings~~. must send some search string to get a list of songs~~.		'''CWS_Path_SONGS''': singer must be logged in, requires params: kPostData_PLAYLIST (playlist ID), kPostData_ORDER_BY (CWS_OrderByType value) (optional), kPostData_SEARCH (search string (NOT URL ENCODED!)) (optional). returns a plist containing the songs in the playlist. also pings.

	'''CWS_Path_SEARCH''':, singer must be logged in, requires param: kPostData_SEARCH (search string (NOT URL ENCODED!)), searches main Library playlist		'''CWS_Path_SEARCH''':, singer must be logged in, requires param: kPostData_SEARCH (search string (NOT URL ENCODED!)), searches main Library playlist

Dave: /* Doc */

2016-09-15T22:04:39Z

Doc

← Older revision		Revision as of 22:04, 15 September 2016
Line 102:		Line 102:
	'''CWS_Path_REORDER''': changes order of playlist. singer must be logged in, requires parms: kPostData_PLAYLIST, kPostData_INDEX_OLD, kPostData_INDEX. These are playlist indexes, as determined when sorted by "#"		'''CWS_Path_REORDER''': changes order of playlist. singer must be logged in, requires parms: kPostData_PLAYLIST, kPostData_INDEX_OLD, kPostData_INDEX. These are playlist indexes, as determined when sorted by "#"

	'''CWS_Path_REMOVE''': removes a song from a playlist. singer must be logged in. required params: kPostData_PLAYLIST, kPostData_PLI (playlist item ID of playlist). alternately summarily deletes a singer, no chance to save, no undo, no warning. for PLAYLIST pass the "Playlist ID" you got when you inquired for SINGERS, for PLI, pass the "siID" of the singer in question. this requires the kPostData_ADMIN_PASSWORD, which can be inquired via Python, or have the admin add it to your app in a location not viewable by users.		'''CWS_Path_REMOVE''': removes a song from a playlist. singer must be logged in. required params: kPostData_PLAYLIST (Playlist ID), kPostData_PLI (playlist item ID of playlist). alternately summarily deletes a singer, no chance to save, no undo, no warning. for PLAYLIST pass the "Playlist ID" you got when you inquired for SINGERS, for PLI, pass the "siID" of the singer in question. this requires the kPostData_ADMIN_PASSWORD, which can be inquired via Python, or have the admin add it to your app in a location not viewable by users.

	'''CWS_Path_PITCH''': changes pitch of a song. singer must be logged in. required params: kPostData_SONG (song ID), kPostData_PITCH (integer value [-6..+6])		'''CWS_Path_PITCH''': changes pitch of a song. singer must be logged in. required params: kPostData_SONG (song ID), kPostData_PITCH (integer value [-6..+6])

Dave at 16:39, 31 August 2016

2016-08-31T16:39:03Z

← Older revision		Revision as of 16:39, 31 August 2016
Line 117:		Line 117:
	http://localhost/notify_register?url=http%3A%2F%2Flocalhost%3A12345.		http://localhost/notify_register?url=http%3A%2F%2Flocalhost%3A12345.
	kJams will then send notifications to this URL when "events" happen, like this:		kJams will then send notifications to this URL when "events" happen, like this:
	http://localhost:12345?event=#		http://localhost:12345/post?event=#
	where # above is replaced by a number corresponding to a value taken from '''PushNotifyEventType''' above		where # above is replaced by a number corresponding to a value taken from '''PushNotifyEventType''' above

Dave: /* Doc */

2016-08-31T05:33:49Z

Doc

← Older revision		Revision as of 05:33, 31 August 2016
Line 118:		Line 118:
	kJams will then send notifications to this URL when "events" happen, like this:		kJams will then send notifications to this URL when "events" happen, like this:
	http://localhost:12345?event=#		http://localhost:12345?event=#
	where # above is replaced by a number~~, out of these values:~~		where # above is replaced by a number corresponding to a value taken from '''PushNotifyEventType''' above

Dave at 05:33, 31 August 2016

2016-08-31T05:33:03Z

@@ Line 56: / Line 56: @@
 	CWS_OrderBy_NUMTYPES
 } CWS_OrderByType;
 </pre>
@@ Line 101: / Line 114: @@
 '''CWS_Path_CMD''': required data: kPostData_CMD_ID, which is any of the [[Scripting]] commands, eg: http://localhost/command?cmd_id=# where # is the number of the scripting command
-'''CWS_Path_NOTIFY_REGISTER''' and '''CWS_Path_NOTIFY_UNREGISTER''': register (or not) your OWN server for notifications from kJams.  Note you must "percent escape" the URL that you're registering or un-registering.  Note you must also specify the port number.  eg: http://localhost/notify_register?url=http%3A%2F%2Flocalhost%3A12345.  kJams will then send notifications to this URL when "events" happen, like this:
+'''CWS_Path_NOTIFY_REGISTER''' and '''CWS_Path_NOTIFY_UNREGISTER''': register (or not) your OWN server for notifications from kJams.  Note you must "percent escape" the URL that you're registering or un-registering.  Note you must also specify the port number.  eg:
   http://localhost:12345?event=#
 where # above is replaced by a number, out of these values:

Dave: //

2016-08-31T05:31:49Z

@@ Line 16: / Line 16: @@
 #define		kPostData_PLI				"piIx"		// Play List Item index
 #define		kPostData_ERROR				"error"
 CWS_StringTable		g_CWS_StringTable[] = {
@@ Line 40: / Line 41: @@
 	{	CWS_Path_NEW_PLAYLIST,		"new_playlist"			},
 	{	CWS_Path_CMD,			"command"			},
 };
@@ Line 97: / Line 100: @@
 '''CWS_Path_CMD''': required data: kPostData_CMD_ID, which is any of the [[Scripting]] commands, eg: http://localhost/command?cmd_id=# where # is the number of the scripting command