Songbird / Development / Songbird Add-Ons API Documentation

components/mediacore/metadata/manager/public/sbIMetadataHandler.idl

Go to the documentation of this file.
00001 /*
00002 //
00003 // BEGIN SONGBIRD GPL
00004 // 
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright(c) 2005-2008 POTI, Inc.
00008 // http://songbirdnest.com
00009 // 
00010 // This file may be licensed under the terms of of the
00011 // GNU General Public License Version 2 (the "GPL").
00012 // 
00013 // Software distributed under the License is distributed 
00014 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
00015 // express or implied. See the GPL for the specific language 
00016 // governing rights and limitations.
00017 //
00018 // You should have received a copy of the GPL along with this 
00019 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00020 // or write to the Free Software Foundation, Inc., 
00021 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00022 // 
00023 // END SONGBIRD GPL
00024 //
00025 */
00026 
00031 #include "nsISupports.idl"
00032 #include "nsIChannel.idl"
00033 #include "sbIPropertyArray.idl"
00034 
00044 [scriptable, uuid(4a858410-52e7-11dd-ae16-0800200c9a66)]
00045 interface sbIMetadataHandler : nsISupports
00046 {
00051   const PRUint32 METADATA_IMAGE_TYPE_OTHER              = 0x00;
00052   const PRUint32 METADATA_IMAGE_TYPE_FILEICON           = 0x01;
00053   const PRUint32 METADATA_IMAGE_TYPE_OTHERFILEICON      = 0x02;
00054   const PRUint32 METADATA_IMAGE_TYPE_FRONTCOVER         = 0x03;
00055   const PRUint32 METADATA_IMAGE_TYPE_BACKCOVER          = 0x04;
00056   const PRUint32 METADATA_IMAGE_TYPE_LEAFLETPAGE        = 0x05;
00057   const PRUint32 METADATA_IMAGE_TYPE_MEDIA              = 0x06;
00058   const PRUint32 METADATA_IMAGE_TYPE_LEADARTIST         = 0x07;
00059   const PRUint32 METADATA_IMAGE_TYPE_ARTIST             = 0x08;
00060   const PRUint32 METADATA_IMAGE_TYPE_CONDUCTOR          = 0x09;
00061   const PRUint32 METADATA_IMAGE_TYPE_BAND               = 0x0A;
00062   const PRUint32 METADATA_IMAGE_TYPE_COMPOSER           = 0x0B;
00063   const PRUint32 METADATA_IMAGE_TYPE_LYRICIST           = 0x0C;
00064   const PRUint32 METADATA_IMAGE_TYPE_RECORDINGLOCATION  = 0x0D;
00065   const PRUint32 METADATA_IMAGE_TYPE_DURINGRECORDING    = 0x0E;
00066   const PRUint32 METADATA_IMAGE_TYPE_DURINGPERFORMANCE  = 0x0F;
00067   const PRUint32 METADATA_IMAGE_TYPE_MOVIESCREENCAPTURE = 0x10;
00068   const PRUint32 METADATA_IMAGE_TYPE_COLOUREDFISH       = 0x11;
00069   const PRUint32 METADATA_IMAGE_TYPE_ILLUSTRATION       = 0x12;
00070   const PRUint32 METADATA_IMAGE_TYPE_BANDLOGO           = 0x13;
00071   const PRUint32 METADATA_IMAGE_TYPE_PUBLISHERLOGO      = 0x14;
00072   
00081   attribute sbIMutablePropertyArray props;
00082 
00092   readonly attribute PRBool completed;
00093   
00100   readonly attribute PRBool requiresMainThread;
00101 
00115   attribute nsIChannel channel;
00116 
00133   PRInt32 vote( in AString aUrl );
00134 
00144   PRInt32 read();
00145 
00160   PRInt32 write();
00161 
00179   void getImageData(in PRInt32 aType,
00180                     out AUTF8String aMimeType,
00181                     out unsigned long aDataLen,
00182                     [array,retval,size_is(aDataLen)] out octet aData);
00183 
00197   void setImageData(in PRInt32 aType, in AString aUrl);
00198 
00210   void onChannelData( in nsISupports aChannel );
00211 
00215   void close();
00216 };

Generated on Tue Mar 10 14:28:55 2009 for Songbird by  doxygen 1.5.2