sbIMetadataHandler.idl

Go to the documentation of this file.

/*
//
// 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
//
*/

#include "nsISupports.idl"
#include "nsIChannel.idl"
#include "sbIPropertyArray.idl"

[scriptable, uuid(068500d6-0678-46f5-b69d-49dc02453a40)]
interface sbIMetadataHandler : nsISupports
{
  const PRUint32 METADATA_IMAGE_TYPE_OTHER              = 0x00;
  const PRUint32 METADATA_IMAGE_TYPE_FILEICON           = 0x01;
  const PRUint32 METADATA_IMAGE_TYPE_OTHERFILEICON      = 0x02;
  const PRUint32 METADATA_IMAGE_TYPE_FRONTCOVER         = 0x03;
  const PRUint32 METADATA_IMAGE_TYPE_BACKCOVER          = 0x04;
  const PRUint32 METADATA_IMAGE_TYPE_LEAFLETPAGE        = 0x05;
  const PRUint32 METADATA_IMAGE_TYPE_MEDIA              = 0x06;
  const PRUint32 METADATA_IMAGE_TYPE_LEADARTIST         = 0x07;
  const PRUint32 METADATA_IMAGE_TYPE_ARTIST             = 0x08;
  const PRUint32 METADATA_IMAGE_TYPE_CONDUCTOR          = 0x09;
  const PRUint32 METADATA_IMAGE_TYPE_BAND               = 0x0A;
  const PRUint32 METADATA_IMAGE_TYPE_COMPOSER           = 0x0B;
  const PRUint32 METADATA_IMAGE_TYPE_LYRICIST           = 0x0C;
  const PRUint32 METADATA_IMAGE_TYPE_RECORDINGLOCATION  = 0x0D;
  const PRUint32 METADATA_IMAGE_TYPE_DURINGRECORDING    = 0x0E;
  const PRUint32 METADATA_IMAGE_TYPE_DURINGPERFORMANCE  = 0x0F;
  const PRUint32 METADATA_IMAGE_TYPE_MOVIESCREENCAPTURE = 0x10;
  const PRUint32 METADATA_IMAGE_TYPE_COLOUREDFISH       = 0x11;
  const PRUint32 METADATA_IMAGE_TYPE_ILLUSTRATION       = 0x12;
  const PRUint32 METADATA_IMAGE_TYPE_BANDLOGO           = 0x13;
  const PRUint32 METADATA_IMAGE_TYPE_PUBLISHERLOGO      = 0x14;
  
  readonly attribute ACString contractID;

  attribute sbIMutablePropertyArray props;

  readonly attribute PRBool completed;
  
  readonly attribute PRBool requiresMainThread;

  attribute nsIChannel channel;

  PRInt32 vote( in AString aUrl );

  PRInt32 read();

  PRInt32 write();

  void getImageData(in PRInt32 aType,
                    out AUTF8String aMimeType,
                    out unsigned long aDataLen,
                    [array,retval,size_is(aDataLen)] out octet aData);

  void setImageData(in PRInt32 aType, in AString aUrl);

  void onChannelData( in nsISupports aChannel );

  void close();
};