sbIPlaylistReader.idl

Go to the documentation of this file.

/*
 //
// 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
//
 */

#include "nsISupports.idl"
#include "nsIWebProgressListener.idl"

interface nsIObserver;
interface nsIFile;
interface sbIMediaList;
interface sbIPlaylistFormatType;

[scriptable, uuid(a1fd4697-6459-473f-a660-1915f91cd469)]
interface sbIPlaylistReaderListener : nsIWebProgressListener
{
  attribute nsIURI originalURI;

  attribute nsIURI destinationURI;

  attribute sbIMediaList mediaList;

  attribute boolean addDistinctOnly;

  attribute boolean playWhenLoaded;

  attribute nsIObserver observer;

  attribute boolean mediaMimetypesOnly;

  attribute AString state;
};

[scriptable, uuid(be2cd0d9-eed3-47f4-8a6e-c1e5b2bf508a)]
interface sbIPlaylistReader : nsISupports
{
  attribute nsIURI originalURI;

  void read(in nsIFile aFile,
            in sbIMediaList aMediaList,
            in PRBool aReplace,
            [optional] in sbIPlaylistFormatType aPlaylistFormatType);

  long vote(in AString aURL);

  AString name();

  AString description();

  void supportedMIMETypes(out unsigned long aMIMECount,
    [array, size_is (aMIMECount), retval] out wstring aMIMETypes);

  void supportedFileExtensions(out unsigned long aExtCount,
    [array, size_is (aExtCount), retval] out wstring aExts);
};

[scriptable, uuid(dee1ccec-b3d1-47cf-bbf0-c20222f84398)]
interface sbIPlaylistReaderManager : nsISupports
{
  attribute nsIURI originalURI;

  long loadPlaylist(in nsIURI aURL,
                    in sbIMediaList aMediaList,
                    in AString aContentType,
                    in boolean aAddDistinctOnly,
                    in sbIPlaylistReaderListener aPlaylistReaderListener);

  void read(in nsIFile aFile,
            in sbIMediaList aMediaList,
            in AString aContentType,
            in PRBool aAddDistinctOnly,
            [optional] in sbIPlaylistFormatType aPlaylistFormatType);

  void supportedMIMETypes(out PRUint32 aMIMECount,
    [array, size_is (aMIMECount), retval] out wstring aMIMETypes);

  void supportedFileExtensions(out PRUint32 aExtCount,
    [array, size_is (aExtCount), retval] out wstring aExts);
};