sbIDeviceLibrary.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2011 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 "sbILibrary.idl"
#include "nsISupports.idl"

interface nsIArray;
interface sbIMediaItem;
interface sbIMediaList;
interface sbIPropertyArray;
interface nsIURI;
interface nsIFile;
interface sbIDeviceLibrarySyncSettings;

[scriptable, uuid(b97b4384-b3c6-4418-5fd5-7553859aad22)]
interface sbIDeviceLibraryListener : nsISupports
{
  void onBatchBegin(in sbIMediaList aMediaList);

  void onBatchEnd(in sbIMediaList aMediaList);

  boolean onItemAdded(in sbIMediaList aMediaList,
                      in sbIMediaItem aMediaItem,
                      in unsigned long aIndex);

  boolean onBeforeItemRemoved(in sbIMediaList aMediaList,
                              in sbIMediaItem aMediaItem,
                              in unsigned long aIndex);

  boolean onAfterItemRemoved(in sbIMediaList aMediaList,
                             in sbIMediaItem aMediaItem,
                             in unsigned long aIndex);

  boolean onBeforeListCleared(in sbIMediaList aMediaList,
                              in boolean      aExcludeLists);

  boolean onListCleared(in sbIMediaList aMediaList,
                        in boolean      aExcludeLists);

  boolean onItemUpdated(in sbIMediaList aMediaList,
                        in sbIMediaItem aMediaItem,
                        in sbIPropertyArray aProperties);

  boolean onItemMoved(in sbIMediaList aMediaList,
                      in unsigned long aFromIndex,
                      in unsigned long aToIndex);

  void onItemCopied(in sbIMediaItem aSourceItem,
                    in sbIMediaItem aDestItem);


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

  boolean onBeforeCreateMediaList(in AString aType,
                                  [optional] in sbIPropertyArray aProperties);

  boolean onBeforeAdd(in sbIMediaItem aMediaItem);

  boolean onBeforeAddAll(in sbIMediaList aMediaList);

  boolean onBeforeAddSome(in nsISimpleEnumerator aMediaItems);

  boolean onBeforeClear();
};

[scriptable, uuid(e40c58fa-5adf-434c-79a4-27c153101c9e)]
interface sbIDeviceLibrary : sbILibrary
{
  void initialize(in AString aLibraryId);

  void finalize();

  const unsigned long MGMT_PREF_UNINITIALIZED           = 0;
  const unsigned long MEDIATYPE_UNKNOWN                 = 0x0A;

  const unsigned long MEDIATYPE_AUDIO                   = 0x00;

  const unsigned long MEDIATYPE_VIDEO                   = 0x01;

  const unsigned long MEDIATYPE_IMAGE                   = 0x02;

  const unsigned long MEDIATYPE_COUNT                   = 0x03;

  attribute sbIDeviceLibrarySyncSettings syncSettings;

  /***************************************************************
   * Following functions are convenience functions for the UI
   * An alternative option would be to make this mainstream and
   * have syncSettings return a live object and make it read-only
   */

  nsIArray getSyncFolderListByType(in unsigned long aContentType);

  void setSyncFolderListByType(in unsigned long aContentType,
                               in nsIArray aFolderList);

  void sync();


  void addDeviceLibraryListener(in sbIDeviceLibraryListener aListener);

  void removeDeviceLibraryListener(in sbIDeviceLibraryListener aListener);
};