import"sbIDeviceLibrary.idl";
Public Member Functions | |
| void | initialize (in AString aLibraryId) |
| Initialize the device library. More... | |
| void | finalize () |
| Finalize the device library. More... | |
| nsIArray | getSyncFolderListByType (in unsigned long aContentType) |
| Return the list of folders with content type aContentType the user wants to sync from his disk to the device. More... | |
| void | setSyncFolderListByType (in unsigned long aContentType, in nsIArray aFolderList) |
| Set the list of folders with content type aContentType the user wants to sync from his disk to the device. More... | |
| void | sync () |
| Initiates a sync operation on this library. More... | |
| void | addDeviceLibraryListener (in sbIDeviceLibraryListener aListener) |
| Add a listener to this device library. More... | |
| void | removeDeviceLibraryListener (in sbIDeviceLibraryListener aListener) |
| Remove a listener from this device library. More... | |
 Public Member Functions inherited from sbILibrary | |
| boolean | containsItemWithSameIdentity (in sbIMediaItem aMediaItem) |
| Checks if another mediaitem with the same identity as aMediaItem is already present in the library. This function can be called on the parent library of aMediaItem and it will only return true if a mediaitem other than the param aMediaItem has the same identity as aMediaItem. More... | |
| nsIArray | getItemsWithSameIdentity (in sbIMediaItem aMediaItem) |
| Find mediaitems in the library that have the same identity as aMediaItem. Returns an empty array if none are found. This function can be called on the parent library of aMediaItem and it will only return a mediaitem other than the param aMediaItem. More... | |
| nsIChannel | resolve (in nsIURI aUri) |
| Resolves a songbird schemed URL to a channel. Throws an exception if the item referenced in the URL is not found. More... | |
| sbIMediaItem | createMediaItem (in nsIURI aContentUri, [optional] in sbIPropertyArray aProperties, [optional] in boolean aAllowDuplicates) |
| Creates a new media item aContentUri The URI pointing to the content of the new media item. Use sbILibraryUtils.getContentURI or getFileContentURI to produce library content URI's. More... | |
| boolean | createMediaItemIfNotExist (in nsIURI aContentUri, [optional] in sbIPropertyArray aProperties, [optional] out sbIMediaItem aResultItem) |
| Create a new media item, disallowing duplicates, and return if it did. More... | |
| sbIMediaList | createMediaList (in AString aType, [optional] in sbIPropertyArray aProperties) |
| Creates a new media list. More... | |
| sbIMediaList | copyMediaList (in AString aType, in sbIMediaList aSource, in boolean aDontCopyContent) |
| Creates a new media list. More... | |
| sbIMediaItem | getMediaItem (in AString aGuid) |
| Get a media item. More... | |
| sbIMediaItem | getDuplicate (in sbIMediaItem aMediaItem) |
| Search for and return a duplicate of the media item specified by aMediaItem. More... | |
| void | clearItems () |
| Clear all media items (excluding medialists) from the library. More... | |
| void | clearItemsByType (in AString aContentType) |
| Clear items of a certain CONTENT_TYPE (see sbStandardProperties.h). More... | |
| void | registerMediaListFactory (in sbIMediaListFactory aFactory) |
| Register a new media list type at run time. More... | |
| void | optimize ([optional] in boolean aAnalyzeOnly) |
| Called when the library should remove unsupported media list types, unknown property types, temporary items, or otherwise optimize its performance or size. More... | |
| void | flush () |
| Called when the library should save any cached data to disk. More... | |
| nsIArray | batchCreateMediaItems (in nsIArray aURIArray, [optional] in nsIArray aPropertyArrayArray, [optional] in boolean aAllowDuplicates) |
| Create many media items from a list of URIs, and notify their addition. More... | |
| nsIArray | batchCreateMediaItemsIfNotExist (in nsIArray aURIArray, [optional] in nsIArray aPropertyArrayArray, [optional] out nsIArray aResultItemArray) |
| Create many media items from a list of URIs, disallowing duplicates, and return which items were created. More... | |
| void | batchCreateMediaItemsAsync (in sbIBatchCreateMediaItemsListener aListener, in nsIArray aURIArray, [optional] in nsIArray aPropertyArrayArray, [optional] in boolean aAllowDuplicates) |
| Asychronously create many media items from a list of URIs. More... | |
| Public Member Functions inherited from sbIMediaList | |
| sbIMediaItem | getItemByGuid (in AString aGuid) |
| Get a media item in the list by guid. More... | |
| sbIMediaItem | getItemByIndex (in unsigned long aIndex) |
| Get a media item in the list by index. More... | |
| unsigned short | getListContentType () |
| Get the content type of the media list. More... | |
| void | enumerateAllItems (in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType) |
| Enumerate all items in the list. More... | |
| void | enumerateItemsByProperty (in AString aPropertyID, in AString aPropertyValue, in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType) |
| Enumerate the media items in the list that match a given property ID and value. More... | |
| void | enumerateItemsByProperties (in sbIPropertyArray aProperties, in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType) |
| Enumerate the media items that match a list of property IDs and values. More... | |
| nsIArray | getItemsByProperty (in AString aPropertyID, in AString aPropertyValue) |
| PRUint32 | getItemCountByProperty (in AString aPropertyID, in AString aPropertyValue) |
| nsIArray | getItemsByProperties (in sbIPropertyArray aProperties) |
| unsigned long | indexOf (in sbIMediaItem aMediaItem, [optional] in unsigned long aStartFrom) |
| Get the first index of a media item in the list. More... | |
| unsigned long | lastIndexOf (in sbIMediaItem aMediaItem, in unsigned long aStartFrom) |
| Get the last index of a media item int he list. More... | |
| boolean | contains (in sbIMediaItem aMediaItem) |
| Check if the list contains a media item. More... | |
| void | add (in sbIMediaItem aMediaItem) |
| Add a media item to this list. More... | |
| sbIMediaItem | addItem (in sbIMediaItem aMediaItem) |
| addItem a media item to this list More... | |
| void | addAll (in sbIMediaList aMediaList) |
| Add the contents of a media list to this list. More... | |
| void | addSome (in nsISimpleEnumerator aMediaItems) |
| Adds media items suppled by the provided enumerator NOTE: This method is now deprecated. More... | |
| void | addMediaItems (in nsISimpleEnumerator aMediaItems, in sbIAddMediaItemsListener aListener, in boolean aAsync) |
| Adds media items suppled by the provided enumerator. More... | |
| void | remove (in sbIMediaItem aMediaItem) |
| Remove the first occurrence of the given media item from the list. More... | |
| void | removeByIndex (in unsigned long aIndex) |
| Remove a media item from the list by index. More... | |
| void | removeSome (in nsISimpleEnumerator aMediaItems) |
| Removed media items suppled by the provided enumerator. More... | |
| void | clear () |
| Clear the list. More... | |
| void | addListener (in sbIMediaListListener aListener, [optional] in boolean aOwnsWeak, [optional] in unsigned long aFlags, [optional] in sbIPropertyArray aPropertyFilter) |
| Add a listener to this media list. More... | |
| void | removeListener (in sbIMediaListListener aListener) |
| Remove a listener from this media list. More... | |
| sbIMediaListView | createView ([optional] in sbIMediaListViewState aState) |
| Create a new, raw view for this list. This is generally not the function that you want to use for making views as it will create a completely raw view, for example lacking any filterConstraint. Please consider using sbLibraryUtils.createStandardMediaListView and proceed carefully if you use this method instead. More... | |
| void | runInBatchMode (in sbIMediaListBatchCallback aCallback, [optional] in nsISupports aUserData) |
| Runs the given callback with the given user data in batch mode. More... | |
| nsIStringEnumerator | getDistinctValuesForProperty (in AString aPropertyID) |
| Public Member Functions inherited from sbIMediaItem | |
| void | testIsURIAvailable (in nsIObserver aObserver) |
| Test if this media item is available for playback. More... | |
| nsIChannel | openInputStreamAsync (in nsIStreamListener aListener, in nsISupports aContext) |
| Asynchronously get an input stream to the content of the media item. More... | |
| nsIInputStream | openInputStream () |
| Synchronously get an input stream to the content of the media item. More... | |
| nsIOutputStream | openOutputStream () |
| Get an output stream to the content of the media item. More... | |
| AString | toString () |
| Get a string representation of the media item, useful for debugging. More... | |
| Public Member Functions inherited from sbILibraryResource | |
| AString | getProperty (in AString aID) |
| Get the value of a property of this resource. More... | |
| void | setProperty (in AString aID, in AString aValue) |
| Set the value of a property on this resource. More... | |
| sbIPropertyArray | getProperties ([optional] in sbIPropertyArray aPropertyIDs) |
| Get properties from this resource in a property array. More... | |
| void | setProperties (in sbIPropertyArray aProperties) |
| Sets the properties and values in the supplied property array to this resource. This works as if you called setProperty on each property in the array. More... | |
| boolean | equals (in sbILibraryResource aOtherLibraryResource) |
| Tests the equality of two library resources. More... | |
Public Attributes | |
| 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 |
| Public Attributes inherited from sbILibrary | |
| readonly attribute sbIDevice | device |
| Reference to the device that this library is stored on. More... | |
| readonly attribute boolean | supportsForeignMediaItems |
| Declares if this library will host foreign media items. More... | |
| readonly attribute nsIPropertyBag2 | creationParameters |
| Holds the parameters with which this library was created. More... | |
| readonly attribute sbILibraryFactory | factory |
| Holds the factory that created this library. More... | |
| readonly attribute nsIStringEnumerator | mediaListTypes |
| A list of available media list types. More... | |
| Public Attributes inherited from sbIMediaList | |
| const unsigned short | ENUMERATIONTYPE_SNAPSHOT = 0 |
| This flag means that the list being enumerated is a copy that may become out of date. More... | |
| const unsigned short | ENUMERATIONTYPE_LOCKING = 1 |
| This flag means that the list is protected from changes by other threads during the enumeration. More... | |
| const unsigned short | CONTENTTYPE_NONE = 0 |
| These flags specify the contentType of the media list. More... | |
| const unsigned short | CONTENTTYPE_AUDIO = 1 |
| const unsigned short | CONTENTTYPE_VIDEO = 2 |
| const unsigned short | CONTENTTYPE_MIX = 3 |
| attribute AString | name |
| The name of the media list. More... | |
| readonly attribute AString | type |
| The type of media list (eg "simple") More... | |
| readonly attribute unsigned long | length |
| Returns the length of the list. More... | |
| readonly attribute boolean | isEmpty |
| Is the list empty? More... | |
| readonly attribute boolean | userEditableContent |
| True if the user should be allowed to edit the content of this media list. More... | |
| const unsigned long | LISTENER_FLAGS_ITEMADDED = 1 << 0 |
| const unsigned long | LISTENER_FLAGS_BEFOREITEMREMOVED = 1 << 1 |
| const unsigned long | LISTENER_FLAGS_AFTERITEMREMOVED = 1 << 2 |
| const unsigned long | LISTENER_FLAGS_ITEMUPDATED = 1 << 3 |
| const unsigned long | LISTENER_FLAGS_BEFORELISTCLEARED = 1 << 4 |
| const unsigned long | LISTENER_FLAGS_LISTCLEARED = 1 << 5 |
| const unsigned long | LISTENER_FLAGS_BATCHBEGIN = 1 << 6 |
| const unsigned long | LISTENER_FLAGS_BATCHEND = 1 << 7 |
| const unsigned long | LISTENER_FLAGS_ITEMMOVED = 1 << 8 |
| const unsigned long | LISTENER_FLAGS_ALL = 0xffffffff |
| Public Attributes inherited from sbIMediaItem | |
| readonly attribute sbILibrary | library |
| The library that this media item is contained in. More... | |
| readonly attribute boolean | isMutable |
| Can the media item be changed? More... | |
| readonly attribute sbIMediaItemController | itemController |
| An interface to the media item controller (if any) that determines this item's availability for playback. More... | |
| attribute long long | mediaCreated |
| Creation time of the media item as a unix timestamp. More... | |
| attribute long long | mediaUpdated |
| Last modification time of the media item as a unix timestamp. More... | |
| attribute nsIURI | contentSrc |
| A nsIURI that resolves to the content of the media item. More... | |
| attribute long long | contentLength |
| Size (in bytes) of the content of the media item. More... | |
| attribute AString | contentType |
| Content type of the content of the media item, typically a mime type (should this be renamed?) More... | |
| Public Attributes inherited from sbILibraryResource | |
| readonly attribute AString | guid |
| The guid of this resource. More... | |
| readonly attribute long long | created |
| The creation time of this resource as a unix timestamp. More... | |
| readonly attribute long long | updated |
| The last update time of this resource as a unix timestamp. More... | |
| readonly attribute nsIStringEnumerator | propertyIDs |
| Returns a string enumerator of the IDs of all the properties set on this resource. More... | |
| readonly attribute boolean | userEditable |
| True if users should be allowed to modify the resource. More... | |
Definition at line 225 of file sbIDeviceLibrary.idl.
| void sbIDeviceLibrary::addDeviceLibraryListener | ( | in sbIDeviceLibraryListener | aListener | ) |
Add a listener to this device library.
| sbIDeviceLibraryListener | aListener listener to add. |
| void sbIDeviceLibrary::finalize | ( | ) |
Finalize the device library.
| nsIArray sbIDeviceLibrary::getSyncFolderListByType | ( | in unsigned long | aContentType | ) |
Return the list of folders with content type aContentType the user wants to sync from his disk to the device.
| aContentType | Content type to be synced |
| void sbIDeviceLibrary::initialize | ( | in AString | aLibraryId | ) |
Initialize the device library.
| aLibraryId | Device library identifier. |
| void sbIDeviceLibrary::removeDeviceLibraryListener | ( | in sbIDeviceLibraryListener | aListener | ) |
Remove a listener from this device library.
| sbIDeviceLibraryListener | aListener listener to remove. |
| void sbIDeviceLibrary::setSyncFolderListByType | ( | in unsigned long | aContentType, |
| in nsIArray | aFolderList | ||
| ) |
Set the list of folders with content type aContentType the user wants to sync from his disk to the device.
| aContentType | Content type to be synced |
| aFolderList | List of nsIFIle that represent the folders to sync. |
| void sbIDeviceLibrary::sync | ( | ) |
Initiates a sync operation on this library.
This is a no-op if this library is in manual management mode.
| const unsigned long sbIDeviceLibrary::MEDIATYPE_AUDIO = 0x00 |
Definition at line 249 of file sbIDeviceLibrary.idl.
| const unsigned long sbIDeviceLibrary::MEDIATYPE_COUNT = 0x03 |
Definition at line 255 of file sbIDeviceLibrary.idl.
| const unsigned long sbIDeviceLibrary::MEDIATYPE_IMAGE = 0x02 |
Definition at line 253 of file sbIDeviceLibrary.idl.
| const unsigned long sbIDeviceLibrary::MEDIATYPE_UNKNOWN = 0x0A |
Media type for management type and playlist list.
Definition at line 247 of file sbIDeviceLibrary.idl.
| const unsigned long sbIDeviceLibrary::MEDIATYPE_VIDEO = 0x01 |
Definition at line 251 of file sbIDeviceLibrary.idl.
| const unsigned long sbIDeviceLibrary::MGMT_PREF_UNINITIALIZED = 0 |
Syncronization settings
Definition at line 242 of file sbIDeviceLibrary.idl.
| attribute sbIDeviceLibrarySyncSettings sbIDeviceLibrary::syncSettings |
Gets/Sets the current sync mode of the device. The object returned by the getter is a temporary transient object. Changes are not made until you call setter.
Definition at line 262 of file sbIDeviceLibrary.idl.
