sbIAlbumArtService.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-2008 POTI, Inc.
// http://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 service interface.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

#include "nsISupports.idl"

interface nsIArray;
interface nsIURI;


[scriptable, uuid(dcb6dd07-36a2-44e6-9ee2-8b22577204bf)]
interface sbIAlbumArtService : nsISupports
{
  nsIArray getFetcherList(in unsigned long type,
                          [optional] in boolean includeDisabled);


  boolean imageIsValidAlbumArt
            (in AUTF8String                             aMimeType,
             [const, array, size_is(aDataLen)] in octet aData,
             in unsigned long                           aDataLen);


  nsIURI cacheImage(in AUTF8String                             aMimeType,
                    [const, array, size_is(aDataLen)] in octet aData,
                    in unsigned long                           aDataLen);

  
  void cacheTemporaryData(in AString aKey, in nsISupports aData);


  nsISupports retrieveTemporaryData(in AString aKey);
};


//
// C++ defs.
//

%{C++
#define SB_ALBUMARTSERVICE_CONTRACTID \
          "@songbirdnest.com/Songbird/album-art-service;1"
%}C++