sbILibraryImporter.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://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
//
*/

/* *****************************************************************************
 *******************************************************************************
 *
 * Interface description for the library importer interface.
 *
 *******************************************************************************
 ******************************************************************************/

#include "nsISupports.idl"


[scriptable, uuid(D2CC37F4-A5DB-4226-966F-C51A9AE5686F)]
interface sbILibraryImporterListener : nsISupports
{
    void onLibraryChanged(
        in AString                  aLibFilePath,
        in AString                  aGUID);


    void onImportError();


    void onNonExistentMedia(
        in unsigned long            aNonExistentMediaCount,
        in unsigned long            aTrackCount);


    void onUnsupportedMedia();


    AString onDirtyPlaylist(
        in AString                  aPlaylistName,
        out boolean                 aApplyAll);
};


interface sbIJobProgress;

[scriptable, uuid(04E3F8E9-70F4-4129-9A74-CEC88A8AEE93)]
interface sbILibraryImporter : nsISupports
{
    /*
     * Attributes.
     *
     * libraryType              Library type.
     * libraryReadableType      Readable library type.
     * libraryDefaultFileName   Default library file name.
     * libraryDefaultFilePath   Default library file path.
     * libraryFileExtensionList Comma separated list of library file extensions.
     * libraryPreviouslyImported
     *                          True if a library has previously been imported.
     * libraryPreviousImportPath
     *                          File path of previously imported library.
     */

    readonly attribute AString  libraryType;
    readonly attribute AString  libraryReadableType;
    readonly attribute AString  libraryDefaultFileName;
    readonly attribute AString  libraryDefaultFilePath;
    readonly attribute AString  libraryFileExtensionList;
    readonly attribute boolean  libraryPreviouslyImported;
    readonly attribute AString  libraryPreviousImportPath;


    void initialize();


    void finalize();


    sbIJobProgress import(
        in AString                  aLibFilePath,
        in AString                  aGUID,
        in boolean                  aCheckForChanges);


    void setListener(
        in sbILibraryImporterListener   aListener);
};


[scriptable, uuid(81c027cd-1c4d-42d7-8b70-134cba5175a1)]
interface sbILibraryImporterManager : nsISupports
{
  attribute sbILibraryImporter defaultLibraryImporter;
};