sbIMediaItem.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 "sbILibraryResource.idl"

interface nsIObserver;
interface nsIURI;
interface nsIChannel;
interface nsIStreamListener;
interface nsIInputStream;
interface nsIOutputStream;
interface sbILibrary;
interface sbIMediaItemController;

[scriptable, uuid(64aa9b34-00e0-480e-b919-2322496175cb)]
interface sbIMediaItem : sbILibraryResource
{
  /*
  Group: MediaItem Properties
  */

  readonly attribute sbILibrary library;

  /*
   * \brief The library that this media item is linked from.  This is to aid
   * in support of foreign media items
  readonly attribute sbILibrary originLibrary;
   */

  readonly attribute boolean isMutable;

  readonly attribute sbIMediaItemController itemController;

// Convenience Attributes (these should thunk directly to the sbILibraryResource::G/SetProperty calls)

  /*
  Prop: mediaCreated

  A timestamp representing the date and time at which this <MediaItem> was created.

  Type:
    Number
  */
  attribute long long mediaCreated;

  /*
  Prop: mediaUpdated

  A timestamp representing the date and time at which this <MediaItem> was last updated.

  Type:
    Number
  */
  attribute long long mediaUpdated;

  /*
  Prop: contentSrc

  The URI representing the location of the <MediaItem>.  If the URI is a URL, it
  may be QI'ed to an nsIURL.

  Type:
    Number, in bytes.
  */
  attribute nsIURI contentSrc;

  /*
  Prop: contentLength

  The size (in bytes) of the content of the <MediaItem>. If this <MediaItem>
  is also a <MediaList>, the contentLength will always be 0. 

  The contentLength may not be available for streams

  Type:
    Number, in bytes.
  */
  attribute long long contentLength;

  /*
  Prop: contentType

  The content type, also called mime type, of the <MediaItem>.

  Type:
    String

  Note:
    This property is never filled currently.
  */
  attribute AString contentType;

  void testIsURIAvailable(in nsIObserver aObserver);

  nsIChannel openInputStreamAsync(in nsIStreamListener aListener, in nsISupports aContext);

  nsIInputStream openInputStream();

  nsIOutputStream openOutputStream();

  AString toString();
};

[scriptable, uuid(691f4342-4dcb-471f-a0f4-c4ac94cbd805)]
interface sbIIndexedMediaItem : nsISupports
{
  readonly attribute unsigned long index;
  readonly attribute sbIMediaItem mediaItem;
};