sbIDeviceLibrarySyncDiff Interface Reference

import"sbIDeviceLibrarySyncDiff.idl";

Inheritance diagram for sbIDeviceLibrarySyncDiff:
[legend]
Collaboration diagram for sbIDeviceLibrarySyncDiff:
[legend]

Public Member Functions

void generateSyncLists (in unsigned long aMediaTypesToExportAll, in unsigned long aMediaTypesToImportAll, in sbILibrary aSourceLibrary, in sbILibrary aDestLibrary, in nsIArray aSourceLists, out sbILibraryChangeset aExportChangeset, out sbILibraryChangeset aImportChangeset)
 
void generateDropLists (in sbILibrary aSourceLibrary, in sbILibrary aDestLibrary, in sbIMediaList aSourceList, in nsIArray aSourceItems, out nsIArray aDestItems, out sbILibraryChangeset aChangeset)
 

Public Attributes

const unsigned long SYNC_TYPE_AUDIO = 1<<0
 
const unsigned long SYNC_TYPE_VIDEO = 1<<1
 

Detailed Description

Definition at line 33 of file sbIDeviceLibrarySyncDiff.idl.

Member Function Documentation

void sbIDeviceLibrarySyncDiff::generateDropLists ( in sbILibrary  aSourceLibrary,
in sbILibrary  aDestLibrary,
in sbIMediaList  aSourceList,
in nsIArray  aSourceItems,
out nsIArray  aDestItems,
out sbILibraryChangeset  aChangeset 
)

Generate change set to apply to or from a device library during drag-and-drop operation.

Parameters
aSourceLibraryThe source library for the drop operation.
aDestLibraryThe destination library for the drop operation.
aSourceListA source playlist being copied to the destination library. May be null if aSourceItems is not.
aSourceItemsAn array of sbIMediaItems for the drop operation. May be null if aSourceList is not.
aDestItemsAn array of sbIMediaItems that can be added to an sbIMediaList corresponding to this drop operation. Only populated when aSourceItems is passed (will be empty otherwise).
aChangesetThe changes to apply to the destination library as a result of this drop operation.
void sbIDeviceLibrarySyncDiff::generateSyncLists ( in unsigned long  aMediaTypesToExportAll,
in unsigned long  aMediaTypesToImportAll,
in sbILibrary  aSourceLibrary,
in sbILibrary  aDestLibrary,
in nsIArray  aSourceLists,
out sbILibraryChangeset  aExportChangeset,
out sbILibraryChangeset  aImportChangeset 
)

Generate lists of items to sync in 2-way sync.

Parameters
aMediaTypesToExportAllThe media types (bit mask) to export all of to the destination library.
aMediaTypesToImportAllThe media types (bit mask) to import all of to the source library.
aSourceLibraryThe source library for the sync operation - usually the main library.
aDestLibraryThe destination library for the sync operation - usually a device library
aSourceListsArray of playlists to export to the destination library. Used when a media type is NOT passed in aMediaTypesToExportAll. May be null to indicate that no playlists are to be exported.
aExportChangesetThe changeset describing items to be exported to the destination (device) library. This will be non-null if SYNC_FLAG_EXPORT_ALL or SYNC_FLAG_EXPORT_PLAYLISTS is passed (though the changeset may still be empty in that case!) In this list, an ADDED item should be added to the destination library, and the corresponding file copied (or transcoded) to the target. A MODIFIED item should be modified in the target library (the target item will be given in the sbILibraryChange), and the target file overwritten.
aImportChangesetThe changeset describing items to be imported to the source (main) library. This will be non-null if SYNC_FLAG_IMPORT is passed (though the changeset may still be empty) Here, an ADDED item should be added to the source (main) library. A MODIFIED item will, likewise, modify an existing item (sbILibraryChange::destinationItem), but note that this MUST only ever occur for lists. Thus, there is no actual target file to overwrite. It would be an internal error for an sbILibraryChange in this list to have operation == MODIFIED, and isList false.

Member Data Documentation

const unsigned long sbIDeviceLibrarySyncDiff::SYNC_TYPE_AUDIO = 1<<0

Definition at line 36 of file sbIDeviceLibrarySyncDiff.idl.

const unsigned long sbIDeviceLibrarySyncDiff::SYNC_TYPE_VIDEO = 1<<1

Definition at line 37 of file sbIDeviceLibrarySyncDiff.idl.


The documentation for this interface was generated from the following file: