Difference between revisions of "Dcerouter-qorbiter"

From LinuxMCE
Jump to: navigation, search
(→‎Properties)
m (Added categories)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
[[Category:QOrbiter Skin Api]]
 +
[[Category:QOrbiter]]
 +
[[Category: Programmer's Guide]]
 +
 
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.
 
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.
  
Line 30: Line 34:
 
  onMediaResponseChanged:console.log("Router Says: "+ mediaResponse)
 
  onMediaResponseChanged:console.log("Router Says: "+ mediaResponse)
 
|-
 
|-
−
| '''qs_storageDevice'''
+
| '''deviceResponse'''
 
| ''string''
 
| ''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''
 
| ''string''
−
| ''titleChanged''()
+
| ''eventResponseChanged''()
−
| The Media title of playing media, otherwise its file name
+
| Notification of events from the core.
 
|   
 
|   
 
|-
 
|-
−
| '''qs_mainTitle2'''
+
| '''commandResponse'''
 
| ''string''
 
| ''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'''
+
| '''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
+
 
|}
 
|}
 +
 +
=Signals=
 +
There are a '''lot''' of signals.

Latest revision as of 20:46, 23 November 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 eventResponseChanged() 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

Signals

There are a lot of signals.

Retrieved from "http://wiki.linuxmce.org/index.php?title=Dcerouter-qorbiter&oldid=33451"