sbIDevice.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://www.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 nsIInputStream;
interface nsIPropertyBag2;
interface nsIURI;
interface nsIVariant;

interface sbIDeviceCapabilities;
interface sbIDeviceContent;
interface sbIDeviceLibrary;
interface sbIDeviceProperties;
interface sbIDeviceParameters;
interface sbIDeviceStatus;
interface sbILibrary;
interface sbILibraryChangeset;
interface sbIMediaItem;

%{C++

#include <nsError.h>

// Device related errors
#define SB_ERROR_MEDIA_TYPE_NOT_SUPPORTED \
  NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_GENERAL, 1 )
#define SB_ERROR_DOWNLOAD_SIZE_UNAVAILABLE \
  NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_GENERAL, 2 )
#define SB_ERROR_DEVICE_DRM_FAILURE \
  NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_GENERAL, 3 )
#define SB_ERROR_DEVICE_DRM_CERT_FAIL \
  NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_GENERAL, 4 )

%}

[scriptable, function, uuid(cf163566-24b2-4ecd-4b9f-2a69725e22ad)]
interface sbIDeviceSupportsItemCallback : nsISupports
{
  void onSupportsMediaItem(in sbIMediaItem aMediaItem, in boolean aIsSupported);
};

[scriptable, uuid(fd0d4015-20e1-45b1-bd8a-a8f81d2bdfd2)]
interface sbIDevice : nsISupports
{
  readonly attribute AString name;

  readonly attribute AString productName;

  readonly attribute nsIDPtr controllerId;

  readonly attribute nsIDPtr id;

  void connect();

  void disconnect();

  readonly attribute boolean connected;

  readonly attribute boolean threaded;

  nsIVariant getPreference(in AString aPrefName);

  void setPreference(in AString aPrefName,
                     in nsIVariant aPrefValue);

  readonly attribute sbIDeviceCapabilities capabilities;

  readonly attribute sbIDeviceContent content;

  attribute sbIDeviceLibrary defaultLibrary;

  readonly attribute sbIDeviceLibrary primaryLibrary;

  readonly attribute nsIPropertyBag2 parameters;

  readonly attribute sbIDeviceProperties properties;

  readonly attribute boolean isDirectTranscoding;

  readonly attribute boolean isBusy;

  readonly attribute boolean canDisconnect;

  readonly attribute sbIDeviceStatus currentStatus;

  readonly attribute boolean supportsReformat;

  attribute unsigned long state;
  readonly attribute unsigned long previousState;

  const unsigned long STATE_IDLE            = 0;  // Not doing anything
  const unsigned long STATE_SYNCING         = 1;  // Performing a sync
  // These are not related to syncing (used for manual mode)
  const unsigned long STATE_COPYING         = 2;  // Copying a single file
  const unsigned long STATE_DELETING        = 3;  // Deleting a single file
  const unsigned long STATE_UPDATING        = 4;  // Updating a single file
  const unsigned long STATE_MOUNTING        = 5;  // (un)Mounting the device
  const unsigned long STATE_DOWNLOADING     = 6;
  const unsigned long STATE_UPLOADING       = 7;
  const unsigned long STATE_DOWNLOAD_PAUSED = 8;
  const unsigned long STATE_UPLOAD_PAUSED   = 9;
  const unsigned long STATE_DISCONNECTED    = 10; // Device is disconnected
  const unsigned long STATE_BUSY            = 11; // Busy with unspecified
                                                  // operation
  const unsigned long STATE_CANCEL          = 12; // In process of canceling operation
  const unsigned long STATE_TRANSCODE       = 13; // Transcoding a file.
  const unsigned long STATE_FORMATTING      = 14; // Formatting the device.
  const unsigned long STATE_SYNC_PREPARING  = 15; // Preparing to sync
  const unsigned long STATE_SYNC_PLAYLIST   = 16; // Sync playlist
  const unsigned long STATE_COPY_PREPARING  = 17; // Preparing to copy
  const unsigned long STATE_SYNCING_TYPE    = 18; // Syncing types
  const unsigned long STATE_COPYING_MUSIC   = 19; // Copying music
  const unsigned long STATE_COPYING_VIDEO   = 20; // Copying video
  const unsigned long STATE_IMAGESYNC_PREPARING  = 21; // Preparing to sync
  const unsigned long STATE_COPYING_IMAGE        = 22; // Copying image

  const unsigned long STATE_USER            = 0x20000000;

  const unsigned long REQUEST_FLAG_USER  = 0x80000000;
  const unsigned long REQUEST_FLAG_WRITE = 0x40000000;
  const unsigned long REQUEST_FLAG_READ  = 0x20000000;

  /* read requests */
  const unsigned long REQUEST_MOUNT        = REQUEST_FLAG_READ + 1;
  const unsigned long REQUEST_READ         = REQUEST_FLAG_READ + 2;
  const unsigned long REQUEST_EJECT        = REQUEST_FLAG_READ + 3;
  const unsigned long REQUEST_SUSPEND      = REQUEST_FLAG_READ + 4;

  /* write requests */
  const unsigned long REQUEST_WRITE         = REQUEST_FLAG_WRITE + 1;
  const unsigned long REQUEST_DELETE        = REQUEST_FLAG_WRITE + 2;
  const unsigned long REQUEST_SYNC          = REQUEST_FLAG_WRITE + 3;
  /* delete all files on the device */
  const unsigned long REQUEST_WIPE          = REQUEST_FLAG_WRITE + 4;
  /* move an item inside one playlist */
  const unsigned long REQUEST_MOVE          = REQUEST_FLAG_WRITE + 5;
  const unsigned long REQUEST_UPDATE        = REQUEST_FLAG_WRITE + 6;
  const unsigned long REQUEST_NEW_PLAYLIST  = REQUEST_FLAG_WRITE + 7;

  /* reset the device to its factory state */
  const unsigned long REQUEST_FACTORY_RESET = REQUEST_FLAG_WRITE + 8;

  /* format the device media */
  const unsigned long REQUEST_FORMAT        = REQUEST_FLAG_WRITE + 9;

  /* perform image sync */
  const unsigned long REQUEST_IMAGESYNC     = REQUEST_FLAG_WRITE + 10;

  /* update raw files on the device */
  const unsigned long REQUEST_WRITE_FILE    = REQUEST_FLAG_WRITE + 11;
  const unsigned long REQUEST_DELETE_FILE   = REQUEST_FLAG_WRITE + 12;

  /* Request indicating that a sync request has completed */
  const unsigned long REQUEST_SYNC_COMPLETE = REQUEST_FLAG_WRITE + 13;

  void submitRequest(in unsigned long aRequest, in nsIPropertyBag2 aRequestParameters);
  void cancelRequests();

  void syncLibraries();

  void supportsMediaItem(in sbIMediaItem aMediaItem,
                         in sbIDeviceSupportsItemCallback aCallback);

  void eject();

  void format();

  /* Set the enabled state on a named warning dialog */
  void setWarningDialogEnabled(in AString aWarning, in boolean aEnabled);
  /* Get the enabled state on a named warning dialog */
  boolean getWarningDialogEnabled(in AString aWarning);
  /* Reset the enabled state of all warning dialogs */
  void resetWarningDialogs();

  nsIInputStream openInputStream(in nsIURI aURI);

  void importFromDevice(in sbILibrary aImportToLibrary,
                        in sbILibraryChangeset aImportChangeset);

  void exportToDevice(in sbIDeviceLibrary aDevLibrary,
                      in sbILibraryChangeset aExportChangeset);

};