Songbird / Development / Songbird Add-Ons API Documentation

components/mediaimport/playlist/public/sbIPlaylistReader.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 
00034 #include "nsISupports.idl"
00035 #include "nsIWebProgressListener.idl"
00036 
00037 interface nsIObserver;
00038 interface nsIFile;
00039 interface sbIMediaList;
00040 
00047 [scriptable, uuid(a1fd4697-6459-473f-a660-1915f91cd469)]
00048 interface sbIPlaylistReaderListener : nsIWebProgressListener
00049 {
00055   attribute nsIURI originalURI;
00056 
00062   attribute nsIURI destinationURI;
00063 
00069   attribute sbIMediaList mediaList;
00070 
00076   attribute boolean addDistinctOnly;
00077 
00083   attribute boolean playWhenLoaded;
00084 
00089   attribute nsIObserver observer;
00090 
00094   attribute boolean mediaMimetypesOnly;
00095 
00099   attribute AString state;
00100 };
00101 
00108 [scriptable, uuid(8be3a732-f081-47e8-ac21-4d97d769260f)]
00109 interface sbIPlaylistReader : nsISupports
00110 {
00116   attribute nsIURI originalURI;
00117 
00123   void read(in nsIFile aFile,
00124             in sbIMediaList aMediaList,
00125             in PRBool aReplace);
00126 
00132   long vote(in AString aURL);
00133 
00139   AString name();
00140 
00146   AString description();
00147 
00153   void supportedMIMETypes(out unsigned long aMIMECount,
00154     [array, size_is (aMIMECount), retval] out wstring aMIMETypes);
00155 
00161   void supportedFileExtensions(out unsigned long aExtCount,
00162     [array, size_is (aExtCount), retval] out wstring aExts);
00163 };
00164 
00172 [scriptable, uuid(127d0f73-295b-4270-9c64-941c20d444e5)]
00173 interface sbIPlaylistReaderManager : nsISupports
00174 {
00180   attribute nsIURI originalURI;
00181 
00187   long loadPlaylist(in nsIURI aURL,
00188                     in sbIMediaList aMediaList,
00189                     in AString aContentType,
00190                     in boolean aAddDistinctOnly,
00191                     in sbIPlaylistReaderListener aPlaylistReaderListener);
00192 
00198   void read(in nsIFile aFile,
00199             in sbIMediaList aMediaList,
00200             in AString aContentType,
00201             in PRBool aAddDistinctOnly);
00202 
00208   void supportedMIMETypes(out PRUint32 aMIMECount,
00209     [array, size_is (aMIMECount), retval] out wstring aMIMETypes);
00210 
00216   void supportedFileExtensions(out PRUint32 aExtCount,
00217     [array, size_is (aExtCount), retval] out wstring aExts);
00218 };
00219 
00220 

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