sbIPlaybackHistoryService.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 nsIArray;
interface nsISimpleEnumerator;

interface sbIMediaItem;
interface sbIPlaybackHistoryEntry;
interface sbIPlaybackHistoryListener;
interface sbIPropertyArray;

[scriptable, uuid(c818767c-7474-436c-8bec-a95ad08cf1e5)]
interface sbIPlaybackHistoryService : nsISupports
{
  readonly attribute nsISimpleEnumerator entries;

  readonly attribute unsigned long long entryCount;

  sbIPlaybackHistoryEntry createEntry(in sbIMediaItem aItem, 
                                      in long long aTimestamp,
                                      in long long aDuration,
                                      in sbIPropertyArray aAnnotations);

  void addEntry(in sbIPlaybackHistoryEntry aEntry);

  void addEntries(in nsIArray aEntries);

  sbIPlaybackHistoryEntry getEntryByIndex(in long long aIndex);

  nsIArray getEntriesByIndex(in long long aStartIndex, 
                             in unsigned long long aCount);

  nsIArray getEntriesByTimestamp(in long long aStartTimestamp, 
                                 in long long aEndTimestamp);

  void removeEntry(in sbIPlaybackHistoryEntry aEntry);

  void removeEntryByIndex(in long long aIndex);

  void removeEntriesByIndex(in long long aStartIndex, 
                            in unsigned long long aCount);

  void removeEntries(in nsIArray aEntries);

  nsIArray getEntriesByAnnotation(in AString aAnnotationId, 
                                  in AString aAnnotationValue,
                                  [optional] in unsigned long aCount);
  
  nsIArray getEntriesByAnnotations(in sbIPropertyArray aAnnotations,
                                   [optional] in unsigned long aCount);

  void clear();

  void addListener(in sbIPlaybackHistoryListener aListener);

  void removeListener(in sbIPlaybackHistoryListener aListener);

  [notxpcom] nsresult addOrUpdateAnnotation(in long long aEntryId,
                                            in AString aAnnotationId,
                                            in AString aAnnotationValue);

  [notxpcom] nsresult removeAnnotation(in long long aEntryId,
                                       in AString aAnnotationId);
};

%{C++

#define SB_PLAYBACKHISTORYSERVICE_DESCRIPTION    \
  "Songbird Playback History Service"
#define SB_PLAYBACKHISTORYSERVICE_CONTRACTID     \
  "@songbirdnest.com/Songbird/PlaybackHistoryService;1"
#define SB_PLAYBACKHISTORYSERVICE_CLASSNAME      \
  "sbPlaybackHistoryService"
#define SB_PLAYBACKHISTORYSERVICE_CID            \
{ /*{e4f7838e-9672-453e-818d-a0da84e64365}*/     \
  0xe4f7838e,                                    \
  0x9672,                                        \
  0x453e,                                        \
  { 0x81, 0x8d, 0xa0, 0xda, 0x84, 0xe6, 0x43, 0x65 }  \
}

%}