Difference between revisions of "NowPlaying"

From LinuxMCE
Jump to: navigation, search
(Created page with "The Now playing contect object provides all of the information about the currently playing media available. The only thing it does not provide is timecode. This is done by anothe...")
 
m (Added categories)
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
[[Category:QOrbiter Skin Api]]
 +
[[Category:QOrbiter]]
 +
[[Category: Programmer's Guide]]
 
The Now playing contect object provides all of the information about the currently playing media available. The only thing it does not provide is timecode. This is done by another object'
 
The Now playing contect object provides all of the information about the currently playing media available. The only thing it does not provide is timecode. This is done by another object'
−
 
+
=Properties=
 
{| class="wikitable"
 
{| class="wikitable"
 
|+ Properties are accessed by: dcenowplaying.propertyname
 
|+ Properties are accessed by: dcenowplaying.propertyname
Line 9: Line 12:
 
! Example
 
! Example
 
|-
 
|-
−
| b_mediaPlaying
+
| '''b_mediaPlaying'''
−
| bool
+
| ''bool''
−
| totalTimeChanged()
+
| ''mediaStatusChanged()''
−
| the total time, in milliseconds of the current media
+
−
| Here i use the total time to calculate the time when dragging the seek bar back and forth
+
−
  property int slidertimer: (scroll_tab.x / scroller_transit.width) * dceTimecode.tcTotalTime
+
−
|-
+
−
| tcCurrentTime
+
−
| int
+
−
| mediaStatusChanged()
+
 
| True if media is playing in this EA, false if other wise
 
| 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
 
|  
 
|  
 
|-
 
|-
−
| runningTimer
+
| '''filepath'''
−
| double
+
| ''string''
−
| positionChanged()
+
| ''filepathChanged()''
−
| Used to constantly update the position of the seek bar as media advances
+
| Provides the '''full''' path of the current playing media
−
| By setting the x property to do a little math, I get the seek bar to advance across the transit  as the media plays
+
|  
−
x: ( dceTimecode.runningTimer / dceTimecode.tcTotalTime) * scroller.width
+
 
|-
 
|-
−
| dragTime
+
| '''qs_storageDevice'''
−
| String
+
| ''string''
−
| dragTimeChanged()
+
| ''storageDeviceChanged()''
−
| the time that the slider if implemented has been dragged to.
+
| The LinuxMCE storage device the media is stored on
−
| Here, it is utilized in a popup that shows when a user drags the seek bar
+
|  
−
Text {
+
−
            id: drag_label
+
−
            text: dceTimecode.dragTime
+
−
            anchors.centerIn: parent
+
−
        }
+
 
|-
 
|-
−
| qsTotalTime
+
| '''qs_mainTitle'''
−
| String
+
| ''string''
−
| totalStringTimeChanged()
+
| ''titleChanged''()
−
| Total time of media, formatted in HH::MM::SS - updated every second
+
| The Media title of playing media, otherwise its file name
 +
| 
 
|-
 
|-
−
| qsCurrentTime
+
| '''qs_mainTitle2'''
−
| String
+
| ''string''
−
| stringTimeChanged()
+
| ''titleChanged2''()
−
| The current position of the media in HH:MM::SS - updated every second
+
| Sometimes additional title params are sent, this is where they are deposited.
 +
| 
 
|-
 
|-
−
| stringPlaybackSpeed
+
| '''qs_subTitle'''
−
| string
+
| ''String''
−
|sPlaybackSpeedChanged()
+
| ''titleChanged''()
−
| Playback speed in string format
+
| Secondary text relating to media titles
 
|-
 
|-
−
| playbackSpeed
+
| '''genre'''
−
| int
+
| ''string''
−
| playbackSpeedChanged()
+
|''genreChanged''()
−
| Playback Speed in integer format
+
| 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
 
|}
 
|}
 +
 +
=Signals=
 +
No signals beyond signals associated with properties.
 +
 +
=Functions=
 +
This class does not have an accessible external functions

Latest revision as of 20:47, 23 November 2012

The Now playing contect object provides all of the information about the currently playing media available. The only thing it does not provide is timecode. This is done by another object'

Properties

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

Signals

No signals beyond signals associated with properties.

Functions

This class does not have an accessible external functions

Retrieved from "http://wiki.linuxmce.org/index.php?title=NowPlaying&oldid=33453"