Revision as of 14:59, 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)
i_current_mediaType	int	mediaTypeChanged()	Current media type of the media in the data grid screen
m_dwPK_Device	int	deviceIdChanged()	QOrbiter's device id.
qMediaPlayerID	int	qMediaPlayerIDChanged()	The media player id for qMediaPlayer associated with this qOrbiter. it is required to start qMediaPlayer
discreteAudio	bool	discreteAudioChanged ()	True if discrete audio is avail
m_bContainsVideo	bool	containsVideo()	If the stream contains video or not.
usingLiveAv	bool	liveAvPath()	If the device is using live av path
m_bIsOSD	bool	isOsd()	If Qorbiter is an onscreen display. experimental
monitorAvailible	bool	monitorStatusChanged()	If monitor mode is available

@@ Line 59: / Line 59: @@
 | The current 'page' of the total cells requesting in the datagrid divided by the allowed amount of cells per page (media_pageSeperator)
 |-
-| '''tvProgram'''
+| '''i_current_mediaType'''
-| ''string''
+| ''int''
-| ''programChanged''()
+| ''mediaTypeChanged''()
-| The title of the tv program, otherwise blank
+| Current media type of the media in the data grid screen
 |-
-| '''channel'''
+| '''m_dwPK_Device'''
-| ''string''
+| ''int''
-| ''channelChanged''()
+| ''deviceIdChanged''()
-| Current tv channel number
+| QOrbiter's device id.
 |-
-| '''channelID'''
+| '''qMediaPlayerID'''
-| ''string''
+| ''int''
-| ''chanIDchanged''()
+| ''qMediaPlayerIDChanged''()
-| The Current channel ID for mythtv
+| The media player id for qMediaPlayer associated with this qOrbiter. it is required to start qMediaPlayer
 |-
-| '''network'''
+| '''discreteAudio '''
-| ''string''
+| ''bool''
-| ''networkChanged''()
+| ''discreteAudioChanged ''()
-| The name of the TV network, i.e. HBO
+|True if discrete audio is avail
 |-
-| '''episode'''
+| '''m_bContainsVideo '''
-| ''string''
+| ''bool''
-| ''episodeChanged''()
+| ''containsVideo''()
-| The name of the episode currently being viewed if available.
+| If the stream contains video or not.
 |-
-| '''album'''
+| '''usingLiveAv '''
-| ''string''
+| ''bool''
-| ''albumChanged''()
+| ''liveAvPath''()
-| The title of the album playing
+| If the device is using live av path
 |-
-| '''track'''
+| '''m_bIsOSD '''
-| ''string''
+| ''bool''
-| ''trackChanged''()
+| ''isOsd''()
-| The current playing audio track
+| If Qorbiter is an onscreen display. experimental
 |-
-| '''performerList'''
+| '''monitorAvailible '''
-| ''string''
+| ''bool''
-| ''performersChanged''()
+| ''monitorStatusChanged''()
-|A list of vertical slash seperated performers
+|If monitor mode is available
-|-
-| '''synop'''
-| ''string''
-| ''synopChanged''()
-|Synopsis
-|-
-| '''director'''
-| ''string''
-| ''directorChanged''()
-|The director(s)
-|-
-| '''releaseDate'''
-| ''string''
-| ''rlsChanged''()
-|Release Date of the media
 |}