Revision as of 14:43, 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)
qs_storageDevice	string	storageDeviceChanged()	The LinuxMCE storage device the media is stored on
qs_mainTitle	string	titleChanged()	The Media title of playing media, otherwise its file name
qs_mainTitle2	string	titleChanged2()	Sometimes additional title params are sent, this is where they are deposited.
qs_subTitle	String	titleChanged()	Secondary text relating to media titles
genre	string	genreChanged()	Genre's seperated by a vertical slash
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 10: / Line 10: @@
 ! Example
 |-
-| '''b_mediaPlaying'''
+| '''dceIP'''
-| ''bool''
+| ''string''
-| ''mediaStatusChanged()''
+| ''dceIPChanged()''
-| True if media is playing in this EA, false if other wise
+|contains the '''current''' ip address of the active connection to the core.
-| EX: hiding an element based on media playing state
+|
-    Rectangle{
-                anchors.centerIn: parent
-                width:  parent.width*.90
-                height: parent.height*.91
-                radius: 6
-               '''visible: dcenowplaying.b_mediaPlaying ? true : false'''
-                color: "transparent"
-                Image{ // Album art here
-                    id: nowPlayingArt
-                    anchors.fill: parent
-                    source: "image://listprovider/updateobject/"+securityvideo.timestamp
-                    fillMode:  Image.PreserveAspectFit
-                    smooth:  true
-                }
-                MouseArea {
-                    anchors.fill: parent
-                    onClicked:gotoQScreen(dcenowplaying.qs_screen)
-                }
-            }
-        }
 |-
-| '''path'''
+| '''DCEHost'''
 | ''string''
-| ''pathChanged()''
+| ''DCEHostChanged()''
-| Provides the path of the current playing media
+| The '''hostname''' of the current active connection to the core.
 |
 |-
-| '''filepath'''
+| '''mediaResponse'''
 | ''string''
-| ''filepathChanged()''
+| ''mediaResponseChanged()''
-| Provides the '''full''' path of the current playing media
+| This is a server message that comes with requests relating to media.
-|
+|EX:
+ onMediaResponseChanged:console.log("Router Says: "+ mediaResponse)
 |-
 | '''qs_storageDevice'''