sbIPlaylistWriter.idl
Go to the documentation of this file.
1 /*
2  *=BEGIN SONGBIRD GPL
3  *
4  * This file is part of the Songbird web player.
5  *
6  * Copyright(c) 2005-2009 POTI, Inc.
7  * http://www.songbirdnest.com
8  *
9  * This file may be licensed under the terms of of the
10  * GNU General Public License Version 2 (the ``GPL'').
11  *
12  * Software distributed under the License is distributed
13  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
14  * express or implied. See the GPL for the specific language
15  * governing rights and limitations.
16  *
17  * You should have received a copy of the GPL along with this
18  * program. If not, go to http://www.gnu.org/licenses/gpl.html
19  * or write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  *=END SONGBIRD GPL
23  */
24 
25 #include "nsISupports.idl"
26 
27 #include "nsIProgressEventSink.idl"
28 #include "nsIPrompt.idl"
29 #include "nsIAuthPrompt.idl"
30 
31 interface sbIMediaList;
32 interface sbIPlaylistFormatType;
33 interface nsIFile;
38 [scriptable, uuid(69140b92-1dd2-11b2-8028-8e852c70b55a)]
39 interface sbIPlaylistWriterListener : nsIProgressEventSink
40 {
41 };
42 
47 [scriptable, uuid(9e64107d-74ef-4e62-9d5c-a639c2a9bbe6)]
49 {
51 
58  void write(in nsIFile aFile,
59  in sbIMediaList aMediaList,
60  in AString aContentType,
61  [optional] in sbIPlaylistFormatType aPlaylistFormatType);
62 
69  AString name();
70 
77  AString description();
78 
85  void supportedMIMETypes(out PRUint32 aMIMECount,
86  [array, size_is (aMIMECount), retval] out wstring aMIMETypes);
87 
94  void supportedFileExtensions(out PRUint32 aExtCount,
95  [array, size_is (aExtCount), retval] out wstring aExts);
96 };
97 
104 [scriptable, uuid(ee2dabc8-0158-49d4-bda9-9ebb2cf20ab8)]
106 {
112  void write(in nsIFile aFile,
113  in sbIMediaList aMediaList,
114  in AString aContentType,
115  [optional] in sbIPlaylistFormatType aPlaylistFormatType);
116 
123  void supportedMIMETypes(out PRUint32 aMIMECount,
124  [array, size_is (aMIMECount), retval] out wstring aMIMETypes);
125 
132  void supportedFileExtensions(out PRUint32 aExtCount,
133  [array, size_is (aExtCount), retval] out wstring aExts);
134 };
135 
void write(in nsIFile aFile, in sbIMediaList aMediaList, in AString aContentType, [optional] in sbIPlaylistFormatType aPlaylistFormatType)
AString description()
A description of the type of playlists it outputs.
void supportedMIMETypes(out PRUint32 aMIMECount, [array, size_is(aMIMECount), retval] out wstring aMIMETypes)
attribute sbIPlaylistWriterListener writerListener
inArray array
Write a playlist file.
void supportedFileExtensions(out PRUint32 aExtCount, [array, size_is(aExtCount), retval] out wstring aExts)
File extensions recognized by this writer.
Write a file using an appropriate registered playlist writer. Playlist writers are registered by addi...
AString name()
A name for this playlist writer.
var uuid
A brief description of the contents of this interface.
void supportedMIMETypes(out PRUint32 aMIMECount, [array, size_is(aMIMECount), retval] out wstring aMIMETypes)
Mimetypes recognized by this writer.
void supportedFileExtensions(out PRUint32 aExtCount, [array, size_is(aExtCount), retval] out wstring aExts)
void write(in nsIFile aFile, in sbIMediaList aMediaList, in AString aContentType, [optional] in sbIPlaylistFormatType aPlaylistFormatType)
The function which actually outputs the file.
Implements playlist writing logic for a particular format.