sbIMetadataLookupProvider.idl
Go to the documentation of this file.
1 /*
2  *=BEGIN SONGBIRD GPL
3  *
4  * This file is part of the Songbird web player.
5  *
6  * Copyright(c) 2005-2009 POTI, Inc.
7  * http://www.songbirdnest.com
8  *
9  * This file may be licensed under the terms of of the
10  * GNU General Public License Version 2 (the ``GPL'').
11  *
12  * Software distributed under the License is distributed
13  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
14  * express or implied. See the GPL for the specific language
15  * governing rights and limitations.
16  *
17  * You should have received a copy of the GPL along with this
18  * program. If not, go to http://www.gnu.org/licenses/gpl.html
19  * or write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  *=END SONGBIRD GPL
23  */
24 
30 #include "nsISupports.idl"
32 
33 interface sbICDTOC;
34 
39 [scriptable, uuid(6e85fb20-1dd2-11b2-a6ae-c297b88bb7ef)]
41 {
46  readonly attribute AString name;
47 
52  readonly attribute AString description;
53 
59  readonly attribute AString logoURL;
60 
61  /*
62  * \brief Currently unused. This can be null if no URL is provided.
63  */
64  readonly attribute AString infoURL;
65 
72  readonly attribute unsigned long weight;
73 
74  /*
75  ACString calculateIdFromTracks([array, size_is(numTracks)] in aTracks,
76  in unsigned long numTracks);
77  ACString calculateIdFromAlbum(in sbIMetadataAlbumDetail aAlbum);
78 
79  sbIMetadataLookupJob queryId(in AUTF8String aID);
80  sbIMetadataLookupJob submitID(in sbIMetadataAlbumDetail aAlbum);
81  */
82 
92 
99 };
readonly attribute AString name
The name this provider is identified by. Used by the metadata lookup manager's getProvider() method...
sbIMetadataLookupJob getAlbumDetail(in sbIMetadataAlbumDetail aAlbum)
Get follow-up album detailed information such as track listing, etc.
Defines the interface for metadata lookup jobs, and the album results.
var uuid
readonly attribute AString description
Used in the CD Rip preference pane to display descriptive text next to the provider drop down...
readonly attribute AString logoURL
Used during CD Lookup notification in the header to display which service we're currently looking up ...
A metadata lookup service provider.
readonly attribute unsigned long weight
A default weight that the sbIMetadataLookupManager uses to determine which provider to use by default...
sbIMetadataLookupJob queryDisc(in sbICDTOC aCDTOC)
Given a CD TOC (sbICDTOC), lookup the results for matching albums from this provider. Returns a metadata lookup job from which you can get sbIMetadataAlbumDetail objects. You must then call getAlbumDetail() to fill out the exact detail information for each album (such as track listings, etc.)
readonly attribute AString infoURL