sbIPlayQueueService.idl

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.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"

interface nsISimpleEnumerator;
interface sbIMediaItem;
interface sbIMediaList;

[scriptable, uuid(abbeaac0-dc53-11df-937b-0800200c9a66)]
interface sbIPlayQueueServiceListener : nsISupports
{
  void onIndexUpdated(in unsigned long aToIndex);

  void onQueueOperationStarted();

  void onQueueOperationCompleted();
};

[scriptable, uuid(88849800-ddbe-11df-85ca-0800200c9a66)]
interface sbIPlayQueueService : nsISupports
{
  readonly attribute sbIMediaList mediaList;

  attribute unsigned long index;

  readonly attribute boolean operationInProgress;

  void queueNext(in sbIMediaItem aMediaItem);

  void queueLast(in sbIMediaItem aMediaItem);

  void queueSomeBefore(in unsigned long aIndex,
                       in nsISimpleEnumerator aMediaItems);

  void queueSomeNext(in nsISimpleEnumerator aMediaItems);

  void queueSomeLast(in nsISimpleEnumerator aMediaItems);

  void clearHistory();

  void clearAll();

  void addListener(in sbIPlayQueueServiceListener aListener);

  void removeListener(in sbIPlayQueueServiceListener aListener);
};