Songbird / Development / Songbird Add-Ons API Documentation

components/mediacore/playback/history/public/sbIPlaybackHistoryEntry.idl

00001 /*
00002 //
00003 // BEGIN SONGBIRD GPL
00004 //
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright(c) 2005-2008 POTI, Inc.
00008 // http://songbirdnest.com
00009 //
00010 // This file may be licensed under the terms of of the
00011 // GNU General Public License Version 2 (the "GPL").
00012 //
00013 // Software distributed under the License is distributed
00014 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
00015 // express or implied. See the GPL for the specific language
00016 // governing rights and limitations.
00017 //
00018 // You should have received a copy of the GPL along with this
00019 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00020 // or write to the Free Software Foundation, Inc.,
00021 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00022 //
00023 // END SONGBIRD GPL
00024 //
00025 */
00026 
00027 #include "nsISupports.idl"
00028 
00029 interface sbIMediaItem;
00030 interface sbIPropertyArray;
00031 
00035 [scriptable, uuid(3e2733de-9e30-4bde-99f0-274bacdd0b20)]
00036 interface sbIPlaybackHistoryEntry : nsISupports
00037 {
00042   readonly attribute long long entryId;
00043 
00047   readonly attribute sbIMediaItem item;
00048   
00053   readonly attribute long long timestamp;
00054 
00059   readonly attribute long long duration;
00060 
00065   readonly attribute sbIPropertyArray annotations;
00066 
00073   AString getAnnotation(in AString aAnnotationId);
00074 
00081   boolean hasAnnotation(in AString aAnnotationId);
00082 
00088   void setAnnotation(in AString aAnnotationId, 
00089                      in AString aAnnotationValue);
00090 
00095   void removeAnnotation(in AString aAnnotationId);
00096 
00105   void init(in sbIMediaItem aItem, 
00106             in long long aTimestamp,
00107             in long long aDuration,
00108             in sbIPropertyArray aAnnotations);
00109 
00115   [notxpcom] void setEntryId(in long long aEntryId);
00116 };
00117 
00118 %{C++
00119 
00120 #define SB_PLAYBACKHISTORYENTRY_DESCRIPTION    \
00121   "Songbird Playback History Entry"
00122 #define SB_PLAYBACKHISTORYENTRY_CONTRACTID     \
00123   "@songbirdnest.com/Songbird/PlaybackHistoryEntry;1"
00124 #define SB_PLAYBACKHISTORYENTRY_CLASSNAME      \
00125   "sbPlaybackHistoryEntry"
00126 #define SB_PLAYBACKHISTORYENTRY_CID            \
00127 { /* 64abdd62-3481-4ce9-89c6-e02398a4aa5c */   \
00128   0x64abdd62,                                  \
00129   0x3481,                                      \
00130   0x4ce9,                                      \
00131   { 0x89, 0xc6, 0xe0, 0x23, 0x98, 0xa4, 0xaa, 0x5c }  \
00132 }
00133 
00134 %}

Generated on Tue Mar 10 14:28:55 2009 for Songbird by  doxygen 1.5.2