sbIMetadataLookupProvider Interface Reference

A metadata lookup service provider. More...

import"sbIMetadataLookupProvider.idl";

Inheritance diagram for sbIMetadataLookupProvider:
[legend]
Collaboration diagram for sbIMetadataLookupProvider:
[legend]

Public Member Functions

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.) More...
 
sbIMetadataLookupJob getAlbumDetail (in sbIMetadataAlbumDetail aAlbum)
 Get follow-up album detailed information such as track listing, etc. More...
 

Public Attributes

readonly attribute AString name
 The name this provider is identified by. Used by the metadata lookup manager's getProvider() method. More...
 
readonly attribute AString description
 Used in the CD Rip preference pane to display descriptive text next to the provider drop down. More...
 
readonly attribute AString logoURL
 Used during CD Lookup notification in the header to display which service we're currently looking up data aginst. This can be null if no logo is provided. More...
 
readonly attribute AString infoURL
 
readonly attribute unsigned long weight
 A default weight that the sbIMetadataLookupManager uses to determine which provider to use by default if the user hasn't specified one. 0 is reserved for application bundled providers. Lower values have stronger weight. More...
 

Detailed Description

A metadata lookup service provider.

Definition at line 40 of file sbIMetadataLookupProvider.idl.

Member Function Documentation

sbIMetadataLookupJob sbIMetadataLookupProvider::getAlbumDetail ( in sbIMetadataAlbumDetail  aAlbum)

Get follow-up album detailed information such as track listing, etc.

Returns
sbIMetadataLookupJob
sbIMetadataLookupJob sbIMetadataLookupProvider::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.)

Returns
sbIMetadataLookupJob

Member Data Documentation

readonly attribute AString sbIMetadataLookupProvider::description

Used in the CD Rip preference pane to display descriptive text next to the provider drop down.

Definition at line 52 of file sbIMetadataLookupProvider.idl.

readonly attribute AString sbIMetadataLookupProvider::infoURL

Definition at line 64 of file sbIMetadataLookupProvider.idl.

readonly attribute AString sbIMetadataLookupProvider::logoURL

Used during CD Lookup notification in the header to display which service we're currently looking up data aginst. This can be null if no logo is provided.

Definition at line 59 of file sbIMetadataLookupProvider.idl.

readonly attribute AString sbIMetadataLookupProvider::name

The name this provider is identified by. Used by the metadata lookup manager's getProvider() method.

Definition at line 46 of file sbIMetadataLookupProvider.idl.

readonly attribute unsigned long sbIMetadataLookupProvider::weight

A default weight that the sbIMetadataLookupManager uses to determine which provider to use by default if the user hasn't specified one. 0 is reserved for application bundled providers. Lower values have stronger weight.

Definition at line 72 of file sbIMetadataLookupProvider.idl.


The documentation for this interface was generated from the following file: