Difference between revisions of "Development/Tutorials/Plasma/JavaScript/NowPlaying"

Jump to: navigation, search
(Main script: Add a link to the QtScript documentation)
Line 10: Line 10:
 
Create a folder for your plasmoid, and create a <tt>metadata.desktop</tt> file with the following contents:
 
Create a folder for your plasmoid, and create a <tt>metadata.desktop</tt> file with the following contents:
  
<code>
+
<code ini>
 
[Desktop Entry]
 
[Desktop Entry]
 
Name=Simple Now Playing
 
Name=Simple Now Playing

Revision as of 21:28, 18 May 2009

Contents

Abstract

This will show you some slightly more advanced techniques for dealing with data engines, and give you a useful plasmoid at the end that you can easily edit to display custom information about what your favourite media player is playing (providing, of course, that your favourite media player is supported by the nowplaying data engine).

We assume you've read the QtScript data engine tutorial.


Metadata.desktop

Create a folder for your plasmoid, and create a metadata.desktop file with the following contents:

[Desktop Entry] Name=Simple Now Playing Comment=A simple text description of what is currently playing Icon=applications-multimedia

Type=Service X-KDE-ServiceTypes=Plasma/Applet

X-Plasma-API=javascript X-Plasma-MainScript=code/main.js X-Plasma-DefaultSize=200,100

X-KDE-PluginInfo-Author=<Your name here> X-KDE-PluginInfo-Email=<Your email here> X-KDE-PluginInfo-Name=simplenowplaying X-KDE-PluginInfo-Version=1.0 X-KDE-PluginInfo-Website=http://plasma.kde.org/ X-KDE-PluginInfo-Category=Multimedia X-KDE-PluginInfo-Depends= X-KDE-PluginInfo-License=GPL X-KDE-PluginInfo-EnabledByDefault=true


Main script

Create a contents/code/main.js file with the following contents:

layout = new LinearLayout(plasmoid); layout.setOrientation(QtVertical);

label = new Label(); layout.addItem(label); label.text = "No player found";

function firstSource() { var sources = plasmoid.dataEngine("nowplaying").sources; if (sources.length) { return sources[0]; } else { label.text = "No player found"; return ; } }

plasmoid.dataUpdate = function(name, data) { if (source == name) { label.text = 'Info:\n'; for (var key in data) { label.text += key + ': ' + data[key] + '\n'; } } }

source = firstSource();

npDataEngine = plasmoid.dataEngine("nowplaying");

npDataEngine.sourceRemoved.connect(function(name) { if (name == source) { source = firstSource(); if (source) { npDataEngine.connect(source, plasmoid, 500); } } });

npDataEngine.sourceAdded.connect(function(name) { if (!source) { source = name; npDataEngine.connect(source, plasmoid, 500); } });

if (source) { npDataEngine.connectSource(source, plasmoid, 500); }

It looks complicated, compared to the two previous tutorials, but there is really only one new thing, and that is that we're watching for sources appearing and disappearing.

The nowplaying data engine makes sources appear and disappear as media players come and go. This plasmoid is a little stupid and only ever watches the first source in the list, but that will be enough for us.

The magic is in listening to the sourceAdded and sourceRemoved signals of the data engine. These, unsuprisingly, are emitted when the sources property of the data engine, which lists all known sources, changes. Note that it may be possible to sensibly request sources that are not in the sources property of a data engine - for example, the twitter data engine has a theoretically infinite number of sources available, one for each possible twitter account, and these cannot possibly be listed in the sources property.

You can learn more about using signals and slots in QtScript in the QtScript documentation. Remember that any property, signal or slot and any method tagged with Q_INVOKABLE (see the Plasma API documentation for which methods this applies to) can be called from QtScript.

Challenge

Modify plasmoid.dataUpdate to display the information you care about, rather than all the information provided by the nowplaying data engine.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal