sbIDeviceBase.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 "nsISupports.idl"

interface nsIArray;
interface nsIStringEnumerator;
interface nsIURI;

interface sbILibrary;
interface sbIMediaItem;
interface sbIMediaList;

[scriptable, uuid(c52a5f0f-fd6e-4f41-a681-3ed88c9e5a9f)]
interface sbIDeviceBaseCallback : nsISupports
{
  void onDeviceConnect(in AString aDeviceIdentifier);

  void onDeviceDisconnect(in AString aDeviceIdentifier);

  void onTransferStart(in sbIMediaItem aMediaItem);

  void onTransferComplete(in sbIMediaItem aMediaItem,
                          in PRInt32 aStatus);

  void onStateChanged(in AString aDeviceIdentifier,
                      in unsigned long aState);
};


[scriptable, uuid(2964c3bf-18d6-4a72-8ccf-f08b732b4bab)]
interface sbIDeviceBase : nsISupports
{
  const PRUint32 FILE_FORMAT_UNDEFINED = 9999;
  const PRUint32 FILE_FORMAT_WAV       = 0;
  const PRUint32 FILE_FORMAT_MP3       = 1;
  const PRUint32 FILE_FORMAT_WMA       = 2;

  const PRUint32 STATE_IDLE            = 0;
  const PRUint32 STATE_BUSY            = 1;
  const PRUint32 STATE_DOWNLOADING     = 2;
  const PRUint32 STATE_UPLOADING       = 3;
  const PRUint32 STATE_DOWNLOAD_PAUSED = 4;
  const PRUint32 STATE_UPLOAD_PAUSED   = 5;
  const PRUint32 STATE_DELETING        = 6;

  const unsigned long OP_UPLOAD    = 1;
  const unsigned long OP_DOWNLOAD  = 2;
  const unsigned long OP_MOVE      = 3;
  
    attribute AString name;

  void initialize();

  void finalize();

  void addCallback(in sbIDeviceBaseCallback aCallback);

  void removeCallback(in sbIDeviceBaseCallback aCallback);

    readonly attribute AString deviceCategory;

    readonly attribute nsIStringEnumerator deviceIdentifiers;

    readonly attribute unsigned long deviceCount;

  sbILibrary getLibrary(in AString aDeviceIdentifier);

  unsigned long getDeviceState(in AString aDeviceIdentifier);

  nsIURI getTransferLocation(in AString aDeviceIdentifier,
                             in sbIMediaItem aMediaItem);

  unsigned long transferItems(in AString aDeviceIdentifier,
                              in nsIArray aMediaItems, 
                              in nsIURI aDestionationPath, 
                              in unsigned long aDeviceOperation,
                              in boolean aBeginTransferNow,
                              in sbILibrary aDestinationLibrary);

  unsigned long updateItems(in AString aDeviceIdentifier,
                            in nsIArray aMediaItems);

  unsigned long deleteItems(in AString aDeviceIdentifier,
                            in nsIArray aMediaItems);

  unsigned long deleteAllItems(in AString aDeviceIdentifier);

  unsigned long createPlaylists(in AString aDeviceIdentifier,
                                in nsIArray aMediaLists);

  unsigned long deletePlaylists(in AString aDeviceIdentifier,
                                in nsIArray aMediaLists);

  unsigned long addToPlaylist(in AString aDeviceIdentifier,
                              in sbIMediaList aMediaList,
                              in nsIArray aMediaItems,
                              in unsigned long aBeforeIndex);
                              
  unsigned long removeFromPlaylist(in AString aDeviceIdentifier,
                                   in sbIMediaList aMediaList,
                                   in sbIMediaItem aMediaItem,
                                   in unsigned long aIndex);

  unsigned long movePlaylistItem(in AString aDeviceIdentifier,
                                 in sbIMediaList aMediaList,
                                 in unsigned long aFromIndex,
                                 in unsigned long aToIndex);

  unsigned long clearPlaylist(in AString aDeviceIdentifier,
                              in sbIMediaList aMediaList);
  sbIMediaItem beginTransfer(in AString aDeviceIdentifier);

  unsigned long cancelTransfer(in AString aDeviceIdentifier,
                               in nsIArray aMediaItems);

  unsigned long suspendTransfer(in AString aDeviceIdentifier);

  unsigned long resumeTransfer(in AString aDeviceIdentifier);

  long long getUsedSpace(in AString aDeviceIdentifier);

    long long getAvailableSpace(in AString aDeviceIdentifier);

    nsIArray getSupportedFormats(in AString aDeviceIdentifier);

    boolean isDownloadSupported(in AString aDeviceIdentifier);

    boolean isUploadSupported(in AString aDeviceIdentifier);

    boolean isDeleteSupported(in AString aDeviceIdentifier);

    boolean isUpdateSupported(in AString aDeviceIdentifier);

    boolean isEjectSupported(in AString aDeviceIdentifier);

  boolean ejectDevice(in AString aDeviceIdentifier);
};

// XXXben These are left here for the time being so the world doesn't break
// XXXmig When these are left at the top, doxygen breaks.
%{ C++
// File format constants
#define kSB_DEVICE_FILE_FORMAT_UNDEFINED  -1
#define kSB_DEVICE_FILE_FORMAT_WAV        0
#define kSB_DEVICE_FILE_FORMAT_MP3        1
#define kSB_DEVICE_FILE_FORMAT_WMA        2

// Device State constants
#define kSB_DEVICE_STATE_IDLE             0
#define kSB_DEVICE_STATE_BUSY             1
#define kSB_DEVICE_STATE_DOWNLOADING      2
#define kSB_DEVICE_STATE_UPLOADING        3
#define kSB_DEVICE_STATE_DOWNLOAD_PAUSED  4
#define kSB_DEVICE_STATE_UPLOAD_PAUSED    5
#define kSB_DEVICE_STATE_DELETING         6
%}