sbIAlbumArtFetcher.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 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
 */

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Interface description for the album art fetcher interface.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

#include "nsISupports.idl"


interface nsIArray;
interface nsIDOMWindow;
interface sbIAlbumArtListener;
interface sbIMediaItem;

[scriptable, uuid(3792b0e2-1dd2-11b2-bdc8-cf5bc3f7931c)]
interface sbIAlbumArtFetcher : nsISupports
{
  readonly attribute AString shortName;

  readonly attribute AString name;

  readonly attribute AString description;

  readonly attribute boolean isLocal;

  attribute boolean isEnabled;
  
  attribute PRInt32 priority;

  attribute nsIArray albumArtSourceList;

  readonly attribute boolean isFetching;

  void fetchAlbumArtForAlbum(in nsIArray            aMediaItems,
                             in sbIAlbumArtListener aListener);


  void fetchAlbumArtForTrack(in sbIMediaItem         aMediaItem,
                             in sbIAlbumArtListener  aListener);
  
  /* \brief shut down the fetcher
   */
  void shutdown();
};


//
// C++ defs.
//

%{C++
#define SB_ALBUM_ART_FETCHER_CATEGORY "songbird-album-art-fetcher"

#define SB_FILEALBUMARTFETCHER_CONTRACTID \
          "@songbirdnest.com/Songbird/album-art/file-fetcher;1"

#define SB_METADATAALBUMARTFETCHER_CONTRACTID \
          "@songbirdnest.com/Songbird/album-art/metadata-fetcher;1"
%}C++