sbIPlaybackHistoryEntry.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"

interface sbIMediaItem;
interface sbIPropertyArray;

[scriptable, uuid(3e2733de-9e30-4bde-99f0-274bacdd0b20)]
interface sbIPlaybackHistoryEntry : nsISupports
{
  readonly attribute long long entryId;

  readonly attribute sbIMediaItem item;
  
  readonly attribute long long timestamp;

  readonly attribute long long duration;

  readonly attribute sbIPropertyArray annotations;

  AString getAnnotation(in AString aAnnotationId);

  boolean hasAnnotation(in AString aAnnotationId);

  void setAnnotation(in AString aAnnotationId, 
                     in AString aAnnotationValue);

  void removeAnnotation(in AString aAnnotationId);

  void init(in sbIMediaItem aItem, 
            in long long aTimestamp,
            in long long aDuration,
            in sbIPropertyArray aAnnotations);

  [notxpcom] void setEntryId(in long long aEntryId);
};

%{C++

#define SB_PLAYBACKHISTORYENTRY_DESCRIPTION    \
  "Songbird Playback History Entry"
#define SB_PLAYBACKHISTORYENTRY_CONTRACTID     \
  "@songbirdnest.com/Songbird/PlaybackHistoryEntry;1"
#define SB_PLAYBACKHISTORYENTRY_CLASSNAME      \
  "sbPlaybackHistoryEntry"
#define SB_PLAYBACKHISTORYENTRY_CID            \
{ /* 64abdd62-3481-4ce9-89c6-e02398a4aa5c */   \
  0x64abdd62,                                  \
  0x3481,                                      \
  0x4ce9,                                      \
  { 0x89, 0xc6, 0xe0, 0x23, 0x98, 0xa4, 0xaa, 0x5c }  \
}

%}