sbIDirectoryImportService.idl
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2008 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25 */
26 
27 #include "nsISupports.idl"
28 
29 interface sbIMediaItem;
30 interface sbIMediaList;
31 interface nsIArray;
32 interface nsISimpleEnumerator;
33 interface sbIJobProgress;
34 interface sbIMediacoreTypeSniffer;
35 interface sbIFileMetadataService;
36 
44 [scriptable, uuid(395adc1c-64a3-45e4-8b00-893e7f76419c)]
46 {
52  readonly attribute unsigned long totalAddedToMediaList;
53 
57  readonly attribute unsigned long totalAddedToLibrary;
58 
62  readonly attribute unsigned long totalDuplicates;
63 
69 
73  readonly attribute sbIMediaList targetMediaList;
74 
78  readonly attribute unsigned long targetIndex;
79 };
80 
81 
87 [scriptable, uuid(13ab5520-449e-11dd-ae16-0800200c9a66)]
89 {
90 
101  sbIDirectoryImportJob import(in nsIArray aDirectories,
102  [optional] in sbIMediaList aTargetMediaList,
103  [optional] in PRInt32 aTargetIndex);
104 
118  in sbIMediacoreTypeSniffer aSniffer,
119  in sbIFileMetadataService aMetadataScanner,
120  [optional] in sbIMediaList aTargetMediaList,
121  [optional] in PRInt32 aTargetIndex);
122 };
123 
124 
sbIDirectoryImportJob importWithCustomSnifferAndMetadataScanner(in nsIArray aDirectories, in sbIMediacoreTypeSniffer aSniffer, in sbIFileMetadataService aMetadataScanner, [optional] in sbIMediaList aTargetMediaList, [optional] in PRInt32 aTargetIndex)
Recursively import from the given directories into the specified media list.
Generic interface for exposing long running jobs to the UI.
var uuid
A brief description of the contents of this interface.
readonly attribute unsigned long totalDuplicates
Number of items that already existed in the target library.
readonly attribute unsigned long totalAddedToLibrary
Number of new (unknown) items that were added to the library.
readonly attribute sbIMediaList targetMediaList
Media list receiving found items.
Handles finding media files in directories and adding them to a library or list.
Represents a recursive directory import operation. Use sbIDirectoryImportService to start a new impor...
readonly attribute unsigned long targetIndex
Index into targetMediaList where found items are inserted.
Interface that defines a single item of media in the system.
nsISimpleEnumerator enumerateAllItems()
Enumerator for sbIMediaItems that were found during this job.
readonly attribute unsigned long totalAddedToMediaList
Number of items that were added to the target media list (Note that items may already existed in the ...