Songbird / Development / Songbird Add-Ons API Documentation

sbILibraryImporterListener Interface Reference

Interface for listening to library importer events. More...

import "sbILibraryImporter.idl";

List of all members.

Public Member Functions

void onLibraryChanged (in AString aLibFilePath, in AString aGUID)
 Handle library changed events. These events occur when the contents of the import library change.
void onImportError ()
 Handle library import error events. These events occur whenever an error is encountered while importing a library.
void onNonExistentMedia (in unsigned long aNonExistentMediaCount, in unsigned long aTrackCount)
 Handle non-existent media events. These events occur whenever the media file for an imported track does not exist.
void onUnsupportedMedia ()
 Handle unsupported media events. These events occur whenever an attempt is made to import media that is not supported by Songbird.
AString onDirtyPlaylist (in AString aPlaylistName, out boolean aApplyAll)
 Handle dirty playlist events. These events occur when an imported library playlist has been modified in Songbird. This method returns the action to take, "keep" to keep the Songbird playlist unmodified, "merge" to merge the import library playlist into the Songbird playlist, and "replace" to replace the Songbird playlist. This method also returns whether to apply the action to all dirty playlists.


Detailed Description

Interface for listening to library importer events.

Implementors of this interface can listen to library importer events.

Definition at line 48 of file sbILibraryImporter.idl.


Member Function Documentation

void sbILibraryImporterListener::onLibraryChanged ( in AString  aLibFilePath,
in AString  aGUID 
)

Handle library changed events. These events occur when the contents of the import library change.

Parameters:
aLibFilePath File path to external library that changed.
aGUID GUID of Songbird library into which external library was imported.

void sbILibraryImporterListener::onNonExistentMedia ( in unsigned long  aNonExistentMediaCount,
in unsigned long  aTrackCount 
)

Handle non-existent media events. These events occur whenever the media file for an imported track does not exist.

Parameters:
aNonExistentMediaCount Count of the number of non-existent track media files.
aTrackCount Count of the number of tracks.

AString sbILibraryImporterListener::onDirtyPlaylist ( in AString  aPlaylistName,
out boolean  aApplyAll 
)

Handle dirty playlist events. These events occur when an imported library playlist has been modified in Songbird. This method returns the action to take, "keep" to keep the Songbird playlist unmodified, "merge" to merge the import library playlist into the Songbird playlist, and "replace" to replace the Songbird playlist. This method also returns whether to apply the action to all dirty playlists.

Parameters:
aPlaylistName Name of dirty playlist.
aApplyAll Apply action to all playlists.
Returns:
Import action.


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