Songbird / Development / Songbird Add-Ons API Documentation

sbIFileMetadataService Interface Reference

List of all members.

Public Member Functions

sbIJobProgress read (in nsIArray aMediaItemArray)
 Start a processing job to read metadata from the files associated with the given media items.
sbIJobProgress write (in nsIArray aMediaItemArray, in nsIStringEnumerator aRequiredProperties)
 Start a processing job to write metadata from the given media items back to their associated files.

Detailed Description

Definition at line 57 of file sbIFileMetadataService.idl.


Member Function Documentation

sbIJobProgress sbIFileMetadataService::read ( in nsIArray  aMediaItemArray  ) 

Start a processing job to read metadata from the files associated with the given media items.

Note that all the media items must be from the same library. This restriction is due to the fact that library batching can only be done on a per library basis.

If called off of the main thread, will proxy to complete job startup. Be aware that proxy events may be processed on the calling thread while waiting. Also note that the sbIJobProgress token returned should NOT be accessed off of the main thread.

Parameters:
aMediaItemsArray An array filled with media items to be scanned.
Returns:
An interface for monitoring the status of the request

sbIJobProgress sbIFileMetadataService::write ( in nsIArray  aMediaItemArray,
in nsIStringEnumerator  aRequiredProperties 
)

Start a processing job to write metadata from the given media items back to their associated files.

Note that all the media items must be from the same library. This restriction is due to the fact that library batching can only be done on a per library basis.

Also note that if a property is found in a file but does not exist in the associated sbIMediaItem, it will be removed from the file on write.

Also note that for each item all the properties in the list of aRequiredProperties will be written even if they have not changed.

If called off of the main thread, will proxy to complete job startup. Be aware that proxy events may be processed on the calling thread while waiting. Also note that the sbIJobProgress token returned should NOT be accessed off of the main thread.

Parameters:
aMediaItemsArray An array filled with media items to be scanned.
aRequiredProperties A String Enumertor filled with property ids that we wish to write.
Returns:
An interface for monitoring the status of the request


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2