sbILibrary.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 "sbIMediaList.idl"

interface nsIArray;
interface nsIChannel;
interface nsIPropertyBag2;
interface nsIStringEnumerator;
interface nsIURI;
interface sbIDevice;
interface sbILibraryFactory;
interface sbIMediaItem;
interface sbIMediaListFactory;

[scriptable, uuid(923514f0-0845-431f-86d4-3a073c6a0a98)]
interface sbIBatchCreateMediaItemsListener : nsISupports
{
  void onProgress(in unsigned long aIndex);

  void onComplete(in nsIArray aMediaItems,
                  in unsigned long aResult);
};

[scriptable, uuid(cf0b3ffd-bdc6-4319-a13a-1ad82560230a)]
interface sbILibrary : sbIMediaList
{
  readonly attribute sbIDevice device;

  readonly attribute boolean supportsForeignMediaItems;

  readonly attribute nsIPropertyBag2 creationParameters;

  readonly attribute sbILibraryFactory factory;

  boolean containsItemWithSameIdentity(in sbIMediaItem aMediaItem);

  nsIArray getItemsWithSameIdentity(in sbIMediaItem aMediaItem);

  nsIChannel resolve(in nsIURI aUri);

  sbIMediaItem createMediaItem(in nsIURI aContentUri,
                               [optional] in sbIPropertyArray aProperties,
                               [optional] in boolean aAllowDuplicates);

  boolean createMediaItemIfNotExist(in nsIURI aContentUri,
                                    [optional] in sbIPropertyArray aProperties,
                                    [optional] out sbIMediaItem aResultItem);

  sbIMediaList createMediaList(in AString aType,
                               [optional] in sbIPropertyArray aProperties);

  sbIMediaList copyMediaList(in AString aType,
                             in sbIMediaList aSource,
                             in boolean aDontCopyContent);

  sbIMediaItem getMediaItem(in AString aGuid);

  sbIMediaItem getDuplicate(in sbIMediaItem aMediaItem);

  void clearItems();

  void clearItemsByType(in AString aContentType);

  readonly attribute nsIStringEnumerator mediaListTypes;

  void registerMediaListFactory(in sbIMediaListFactory aFactory);

/*
  AString getPreferedAudioMimeType();
  AString getPreferedVideoMimeType();
*/

  void optimize([optional] in boolean aAnalyzeOnly);

  void flush();

  nsIArray batchCreateMediaItems(in nsIArray aURIArray,
                                 [optional] in nsIArray aPropertyArrayArray,
                                 [optional] in boolean aAllowDuplicates);

  nsIArray batchCreateMediaItemsIfNotExist
             (in nsIArray aURIArray,
              [optional] in nsIArray aPropertyArrayArray,
              [optional] out nsIArray aResultItemArray);

  void batchCreateMediaItemsAsync(in sbIBatchCreateMediaItemsListener aListener,
                                  in nsIArray aURIArray,
                                  [optional] in nsIArray aPropertyArrayArray,
                                  [optional] in boolean aAllowDuplicates);
};