View source - Amarok Wiki

From Amarok Wiki

You do not have permission to do that, for the following reason:
The action you have requested is limited to users in the group user.
You can view and copy the source of this page:
If you are looking for some hints for using your portable player with amaroK, then look [[Media Devices|here]].
= Writing a MediaDevice =

This page contains a small HOW-TO for developers who wish to write an interface to an portable media device for amaroK.

Developers should refer to [[DeviceManager]] to be aware of signals that may be caught to aid them.

== Understanding ==
We provide a fairly wholesome and easy way to interface to the Media Device browser.  Please look at mediabrowser.cpp to understand the layouts and the way which the browser interacts with the device.  The important class to look at is '''MediaDevice'''.

Before you start to hack on amaroK, please read the HACKING file for style and code guidelines.

== What do you need to do? ==
At a minimum, all the pure virtual functions must be implemented by a media device, all items are stored in a hierarchy of MediaItems, and when items are manipulated the MediaItems must be updated accordingly.

A MediaItem is an subclass of KListViewItem, which exists in the mediadevicelist (the contents of the device).  The following functions '''''must''''' be implemented:



=== public methods ===

<pre>
virtual bool       isConnected() = 0;
</pre>
'''Returns'''
: true if the device is connected
<br>
<pre>
virtual void       addToPlaylist(MediaItem *playlist, MediaItem *after, QPtrList<MediaItem> items) = 0;
</pre>
Adds particular tracks to a playlist<br>
'''Parameters'''
: ''playlist'' parent playlist for tracks to be added to
: ''after'' insert following this item
: ''items'' tracks to add to playlist
<br>
<pre>
virtual MediaItem *newPlaylist(const QString &name, MediaItem *parent, QPtrList<MediaItem> items) = 0;
</pre>
Create a new playlist<br>
'''Parameters'''
: ''name'' playlist title
: ''parent'' parent MediaItem of the new playlist
: ''items'' tracks to add to the new playlist
'''Returns'''
: the newly created playlist
<br>
<pre>
virtual void       addToDirectory( MediaItem *directory, QPtrList<MediaItem> items ) = 0;<br>
</pre>
Move items to a directory<br>
'''Parameters'''
: ''directory'' new parent of dropped items
: ''items'' tracks to add to the directory
<br>
<pre>
virtual MediaItem *newDirectory( const QString &name, MediaItem *parent ) = 0;<br>
</pre>
Create a new directory<br>
'''Parameters'''
: ''name'' directory name
: ''parent'' parent MediaItem of the new directory
: ''items'' tracks to add to the new directory
'''Returns'''
: the newly created directory
<br>

=== private methods ===

<pre>
virtual MediaItem *trackExists( const MetaBundle& bundle ) = 0;<br>
</pre>
Find a particular track. This may not be worth implementing for non database driven devices, as it could be slow<br>
'''Parameters'''
: ''bundle'' The metabundle of the requested media item
'''Returns'''
: The MediaItem of the item if found, otherwise 0
<br>

=== protected methods ===
<pre>
virtual bool getCapacity( unsigned long *total, unsigned long *available ) = 0;
</pre>
Get the capacity and freespace available on the device, in KB<br>
'''Returns'''
: ''true'' if successful
<br>
<pre>
virtual void lockDevice( bool ) = 0;
</pre>
Lock device for exclusive access if possible
<br><br>
<pre>
virtual void unlockDevice() = 0;
</pre>
Unlock device
<br><br>
<pre>
virtual bool openDevice( bool silent=false ) = 0;
</pre>
Connect to device, and populate m_listview with MediaItems<br>
'''Parameters'''
: ''silent'' if true, suppress error dialogs
'''Returns'''
: ''true'' if successful
<br>
<pre>
virtual bool closeDevice() = 0;
</pre>
Wrap up any loose ends and close the device<br>
'''Returns'''
: ''true'' if successful
<br>
<pre>
virtual void synchronizeDevice() = 0;
</pre>
Write any pending changes to the device, such as database changes
<br><br>
<pre>
virtual MediaItem *copyTrackToDevice(const MetaBundle& bundle, const PodcastInfo *info) = 0;
</pre>
Copy a track to the device<br>
'''Parameters'''
: ''bundle'' The MetaBundle of the item to transfer. Will move the item specified by bundle().url().path()
: ''info'' additional podcast metadata, if present, item is assumed to be a podcast
'''Returns'''
: If successful, the created MediaItem in the media device view, else 0
<br>
<pre>
virtual int  deleteItemFromDevice( MediaItem *item, bool onlyPlayed=false ) = 0;
</pre>
Recursively remove MediaItem from the tracklist and the device<br>
'''Parameters'''
: ''item'' MediaItem to remove
: ''onlyPlayed'' True if item should be deleted only if it has been played
'''Returns'''
: -1 on failure, number of files deleted otherwise

<br>
<pre>
virtual void cancelTransfer() = 0;
</pre>
Abort the currently active track transfer
<br>
<br>


[[Category:Development]]
Return to Media Device.
Retrieved from "http://amarok.kde.org/wiki/Media_Device"
Amarok Website

Navigation

Views

Toolbox

From Amarok Wiki

Amarok Website

Related

Navigation

Views

Toolbox

From Amarok Wiki
