sbIMediacoreSequencer.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 nsIArray;
interface nsIURI;

interface sbIMediacore;
interface sbIMediacoreSequence;
interface sbIMediacoreSequenceGenerator;
interface sbIMediaItem;
interface sbIMediaListView;

[scriptable, uuid(ddce2b50-d69d-11df-937b-0800200c9a66)]
interface sbIMediacoreSequencer : nsISupports
{
  const unsigned long MODE_FORWARD    = 0;
  const unsigned long MODE_REVERSE    = 1;
  const unsigned long MODE_SHUFFLE    = 1 << 1;

  const unsigned long MODE_CUSTOM     = 1 << 16;

  attribute unsigned long mode;

  const unsigned long MODE_REPEAT_NONE = 0;
  const unsigned long MODE_REPEAT_ONE  = 1;
  const unsigned long MODE_REPEAT_ALL  = 1 << 1;

  attribute unsigned long repeatMode;

  attribute sbIMediaListView view;

  readonly attribute unsigned long viewPosition;

  readonly attribute sbIMediaItem currentItem;

  readonly attribute sbIMediaItem nextItem;

  readonly attribute nsIArray currentSequence;

  attribute unsigned long sequencePosition;

  void playView(in sbIMediaListView aView,
                [optional] in long long aItemIndex,
                [optional] in boolean aNotFromUserAction);

  const long AUTO_PICK_INDEX = -1;

  void playURL(in nsIURI aURI);

  void play();

  void stop([optional] in boolean aNotFromUserAction);

  void next([optional] in boolean aNotFromUserAction);

  void previous([optional] in boolean aNotFromUserAction);

  void requestHandleNextItem(in sbIMediacore aMediacore);

  void abort();

  // When in custom mode, this generator is used to generate the sequence.
  attribute sbIMediacoreSequenceGenerator customGenerator;
};