/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2001
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s): Shane Stephens, Michael Martin, Marcin Lubonski
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/* [scriptable, uuid(482e1890-1fe5-11d5-9cf8-0060b0fbd8ac)] */

#include "nsISupports.idl"

[scriptable, uuid(482e1890-1fe5-11d5-9cf8-0260b0fbd8ae)]
interface nsILibOggCallbackString : nsISupports {
  void call(in string arg);
};

[scriptable, uuid(482e1890-1fe5-11d5-9cf8-0260b0fbd8ad)]
interface nsILibOggCallbackNoArg : nsISupports {
  void call();
};

[scriptable, uuid(482e1890-1fe5-11d5-9cf8-0260b0fbd8ac)]
interface nsILibOggPlugin : nsISupports {

  const short apiVersionMajor = 1;
  const short apiVersionMinor = 0;

  string getVersionString();

  /* standard playback functions */
  void play();
  void pause();
  void restart();
  short getCurrentState();
  void setCurrentMovie(in string URL);
  string getCurrentMovie();
  boolean setPlayPosition(in long milliseconds);
  long getPlayPosition();
  void setVolume(in float volume);
  float getVolume();
  long getWindowWidth();
  long getWindowHeight();
  long getBufferedTime();
  long getMovieLength();
  boolean retrieveAnnotations(in nsILibOggCallbackString callback);
  void registerCMMLCallback(in nsILibOggCallbackString callback);
  void registerEndPlayCallback(in nsILibOggCallbackNoArg callback);
  void registerOnMouseClickCallback(in nsILibOggCallbackNoArg callback);

  /* playlist functions */
  void freezePlaylistProgression();
  void unfreezePlaylistProgression();
  long getPlaylistLength();
  long getCurrentPlaylistPosition();
  boolean playMovieAt(in long position);
  boolean playlistNext();
  boolean playlistPrev();
  string getMovieAt(in long position);
  boolean setMovieAt(in long position, in string url);
  void appendMovie(in string url);
  boolean insertMovieBefore(in long position, in string url);
  boolean removeMovieAt(in long position);
  boolean retrieveAnnotationsAt(in long position, 
                      in nsILibOggCallbackString callback);
  long getMovieLengthAt(in long position);
  void registerPlaylistCallback(in nsILibOggCallbackNoArg callback);
};