Dcerouter-qorbiter - Revision history

Marie.o: Added categories

2012-11-23T19:46:23Z

Added categories

←Older revision		Revision as of 19:46, 23 November 2012
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 99:		Line 103:
	\|If monitor mode is available		\|If monitor mode is available
	\|}		\|}
	~~[[Category:QOrbiter Skin Api]]~~

	=Signals=		=Signals=
	There are a '''lot''' of signals.		There are a '''lot''' of signals.

Langstonius: /* Properties */

2012-10-06T00:23:26Z

Properties

←Older revision		Revision as of 00:23, 6 October 2012
Line 39:		Line 39:
	\| '''eventResponse'''		\| '''eventResponse'''
	\| ''string''		\| ''string''
	\| ''~~evenResponseChanged~~''()		\| ''eventResponseChanged''()
	\| Notification of events from the core.		\| Notification of events from the core.
	\|		\|

Langstonius: /* Properties */

2012-10-02T15:09:22Z

Properties

←Older revision		Revision as of 15:09, 2 October 2012
Line 99:		Line 99:
	\|If monitor mode is available		\|If monitor mode is available
	\|}		\|}
			[[Category:QOrbiter Skin Api]]

	=Signals=		=Signals=
	There are a '''lot''' of signals.		There are a '''lot''' of signals.

Langstonius: /* Properties */

2012-10-02T15:05:39Z

Properties

←Older revision		Revision as of 15:05, 2 October 2012
Line 99:		Line 99:
	\|If monitor mode is available		\|If monitor mode is available
	\|}		\|}

			=Signals=
			There are a '''lot''' of signals.

Langstonius: /* Properties */

2012-10-02T14:59:06Z

Properties

←Older revision		Revision as of 14:59, 2 October 2012
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)		\| 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~~
	\|}		\|}

Langstonius: /* Properties */

2012-10-02T14:49:38Z

Properties

←Older revision		Revision as of 14:49, 2 October 2012
Line 30:		Line 30:
	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~~''()		\| ''evenResponseChanged''()
	\| ~~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'''		\| '''tvProgram'''

Langstonius: /* Properties */

2012-10-02T14:43:30Z

Properties

←Older revision		Revision as of 14:43, 2 October 2012
Line 10:		Line 10:
	! Example		! 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''		\| ''string''
	\| ''~~pathChanged~~()''		\| ''DCEHostChanged()''
	\| ~~Provides the path~~ of the current ~~playing media~~		\| The '''hostname''' of the current active connection to the core.
	\|		\|
	\|-		\|-
	\| '''~~filepath~~'''		\| '''mediaResponse'''
	\| ''string''		\| ''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'''		\| '''qs_storageDevice'''

Langstonius: Created page with "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 wit..."

2012-10-02T14:40:19Z

Created page with "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 wit..."

New page

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=
{| class="wikitable"
|+ Properties are accessed by: dcenowplaying.propertyname
! Property Name
! Property Type
! Signal
! Description
! Example
|-
| '''b_mediaPlaying'''
| ''bool''
| ''mediaStatusChanged()''
| True if media is playing in this EA, false if other wise
| 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'''
| ''string''
| ''pathChanged()''
| Provides the path of the current playing media
|
|-
| '''filepath'''
| ''string''
| ''filepathChanged()''
| Provides the '''full''' path of the current playing media
|
|-
| '''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
|}