sbIMetadataLookupData.idl

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2009 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#include "nsISupports.idl"
#include "sbIJobProgress.idl"

interface nsISimpleEnumerator;
interface nsIArray;
interface sbIMutablePropertyArray;

[scriptable, uuid(5ae0b558-1dd2-11b2-8046-b8cfcbe7f3a9)]
interface sbIMetadataAlbumDetail : nsISupports
{
  // properties of the album itself, e.g. artist name, album name, genre,
  // etc.  These are standard SBProperties.* as well as provider-specific
  // ones which should be namespaced to the provider, e.g.
  // http://freedb.org/#discId
  readonly attribute sbIMutablePropertyArray properties;

  // an nsIArray of sbIMutablePropertyArray items to hold the track properties
  readonly attribute nsIArray tracks;
};

[scriptable, uuid(d2f510f2-1dd1-11b2-ad78-991e90cdfe90)]
interface sbIMetadataLookupJob : sbIJobProgress
{
  const unsigned short JOB_DISC_LOOKUP         = 1;
  const unsigned short JOB_ALBUM_DETAIL_LOOKUP = 2;
  // Not yet implemented
  // const unsigned short JOB_DISC_SUBMIT      = 3;

  // One of the above JOB_* types
  readonly attribute unsigned short mlJobType;

  // The # of results found if any
  readonly attribute unsigned short mlNumResults;
  
  void init(in unsigned short jobType, in unsigned short status);

  void appendResult(in sbIMetadataAlbumDetail aAlbum);

  void changeStatus(in unsigned short status);

  nsISimpleEnumerator getMetadataResults();
};