sbIAlbumArtListener.idl
Go to the documentation of this file.
1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set sw=2 :miv */
3 /*
4 //
5 // BEGIN SONGBIRD GPL
6 //
7 // This file is part of the Songbird web player.
8 //
9 // Copyright(c) 2005-2008 POTI, Inc.
10 // http://songbirdnest.com
11 //
12 // This file may be licensed under the terms of of the
13 // GNU General Public License Version 2 (the "GPL").
14 //
15 // Software distributed under the License is distributed
16 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
17 // express or implied. See the GPL for the specific language
18 // governing rights and limitations.
19 //
20 // You should have received a copy of the GPL along with this
21 // program. If not, go to http://www.gnu.org/licenses/gpl.html
22 // or write to the Free Software Foundation, Inc.,
23 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 //
25 // END SONGBIRD GPL
26 //
27 */
28 
29 //------------------------------------------------------------------------------
30 //------------------------------------------------------------------------------
31 //
32 // Interface description for the album art listener interface.
33 //
34 //------------------------------------------------------------------------------
35 //------------------------------------------------------------------------------
36 
37 #include "nsISupports.idl"
38 
39 interface nsIURI;
40 interface sbIAlbumArtFetcher;
41 interface sbIMediaItem;
42 interface nsIArray;
43 
52 [scriptable, uuid(3683db2c-1796-4fe5-b2c2-a9b8466a4a47)]
54 {
61  void onChangeFetcher(in sbIAlbumArtFetcher aFetcher);
62 
71  void onTrackResult(in nsIURI aImageLocation,
72  in sbIMediaItem aMediaItem);
73 
82  void onAlbumResult(in nsIURI aImageLocation,
83  in nsIArray aMediaItems);
84 
90  void onSearchComplete(in nsIArray aMediaItems);
91 };
92 
void onChangeFetcher(in sbIAlbumArtFetcher aFetcher)
onChangeFetcher - Notifies the listener when the fetcher being used has changed. This is used from th...
void onSearchComplete(in nsIArray aMediaItems)
onSearchComplete - Notifies the listener that the search for artwork has been completed.
var uuid
void onAlbumResult(in nsIURI aImageLocation, in nsIArray aMediaItems)
onAlbumResult - Notifies the listener when either an image has or has not been found for a list of it...
A component which is interested in the result of an album art fetch request.
Interface that defines a single item of media in the system.
Interface for an album art fetcher. Instantiate as a component instance.
void onTrackResult(in nsIURI aImageLocation, in sbIMediaItem aMediaItem)
onTrackResult - Notifies the listener when either an image has or has not been found. aImageLocation will be null if the operation failed to get artwork.