Revision as of 14:49, 2 October 2012

This page describes the rather large dcerouter api for qorbiter. 'dcerouter' is provided as a context object, meaning it can be accessed by that name so that you can interact with the core like sending commands, requesting data, etc. This is a work in progress and if you note any problems, please notify Langston Ball.

Properties

Properties are accessed by: dcenowplaying.propertyname
Property Name	Property Type	Signal	Description	Example
dceIP	string	dceIPChanged()	contains the current ip address of the active connection to the core.
DCEHost	string	DCEHostChanged()	The hostname of the current active connection to the core.
mediaResponse	string	mediaResponseChanged()	This is a server message that comes with requests relating to media.	EX: onMediaResponseChanged:console.log("Router Says: "+ mediaResponse)
deviceResponse	string	deviceResponseChanged()	The response from any commands issued to devices.	EX: onDeviceResponseChanged:console.log("Device 32 Says: "+ deviceResponse)
eventResponse	string	evenResponseChanged()	Notification of events from the core.
commandResponse	string	commandResponseChanged()	Response from commands issue to the core.
media_pageSeperator	int	newPageSeperator()	This property changes the amount of cells returned by a datagrid request. It can be changed at any time, and the media grid will recalculate.
media_currentPage	int	mediaPageChanged()	The current 'page' of the total cells requesting in the datagrid divided by the allowed amount of cells per page (media_pageSeperator)
tvProgram	string	programChanged()	The title of the tv program, otherwise blank
channel	string	channelChanged()	Current tv channel number
channelID	string	chanIDchanged()	The Current channel ID for mythtv
network	string	networkChanged()	The name of the TV network, i.e. HBO
episode	string	episodeChanged()	The name of the episode currently being viewed if available.
album	string	albumChanged()	The title of the album playing
track	string	trackChanged()	The current playing audio track
performerList	string	performersChanged()	A list of vertical slash seperated performers
synop	string	synopChanged()	Synopsis
director	string	directorChanged()	The director(s)
releaseDate	string	rlsChanged()	Release Date of the media

@@ Line 30: / Line 30: @@
   onMediaResponseChanged:console.log("Router Says: "+ mediaResponse)
 |-
-| '''qs_storageDevice'''
+| '''deviceResponse'''
 | ''string''
-| ''storageDeviceChanged()''
+| ''deviceResponseChanged()''
-| The LinuxMCE storage device the media is stored on
+| The response from any commands issued to devices.
-|
+|EX:
+ onDeviceResponseChanged:console.log("Device 32 Says: "+ deviceResponse)
 |-
-| '''qs_mainTitle'''
+| '''eventResponse'''
 | ''string''
-| ''titleChanged''()
+| ''evenResponseChanged''()
-| The Media title of playing media, otherwise its file name
+| Notification of events from the core.
 |
 |-
-| '''qs_mainTitle2'''
+| '''commandResponse'''
 | ''string''
-| ''titleChanged2''()
+| ''commandResponseChanged''()
-| Sometimes additional title params are sent, this is where they are deposited.
+| Response from commands issue to the core.
 |
 |-
-| '''qs_subTitle'''
+| '''media_pageSeperator'''
-| ''String''
+| ''int''
-| ''titleChanged''()
+| ''newPageSeperator''()
-| Secondary text relating to media titles
+| This property changes the amount of cells returned by a datagrid request. It can be changed at any time, and the media grid will recalculate.
 |-
-| '''genre'''
+| '''media_currentPage'''
-| ''string''
+| ''int''
-|''genreChanged''()
+|''mediaPageChanged''()
-| Genre's seperated by a vertical slash
+| The current 'page' of the total cells requesting in the datagrid divided by the allowed amount of cells per page (media_pageSeperator)
 |-
 | '''tvProgram'''