sbIMediaItemWatcher.idl
Go to the documentation of this file.
1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set sw=2 :miv */
3 /*
4 //
5 // BEGIN SONGBIRD GPL
6 //
7 // This file is part of the Songbird web player.
8 //
9 // Copyright(c) 2005-2008 POTI, Inc.
10 // http://songbirdnest.com
11 //
12 // This file may be licensed under the terms of of the
13 // GNU General Public License Version 2 (the "GPL").
14 //
15 // Software distributed under the License is distributed
16 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
17 // express or implied. See the GPL for the specific language
18 // governing rights and limitations.
19 //
20 // You should have received a copy of the GPL along with this
21 // program. If not, go to http://www.gnu.org/licenses/gpl.html
22 // or write to the Free Software Foundation, Inc.,
23 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 //
25 // END SONGBIRD GPL
26 //
27 */
28 
29 //------------------------------------------------------------------------------
30 //------------------------------------------------------------------------------
31 //
32 // Interface description for the media item watcher interface.
33 //
34 //------------------------------------------------------------------------------
35 //------------------------------------------------------------------------------
36 
37 #include "nsISupports.idl"
38 
39 
51 interface sbIMediaItem;
52 interface sbIMediaItemListener;
53 interface sbIPropertyArray;
54 
55 [scriptable, uuid(bac56d2b-0ea8-46b8-ac35-1051986fc3f4)]
57 {
58  /*XXXeps Should add watchSome to watch multiple media items. */
59 
71  void watch(in sbIMediaItem aMediaItem,
72  in sbIMediaItemListener aListener,
73  [optional] in sbIPropertyArray aPropertyIDs);
74 
78  void cancel();
79 };
80 
81 
82 //
83 // C++ defs.
84 //
85 
86 %{C++
87 #define SONGBIRD_MEDIAITEMWATCHER_CONTRACTID \
88  "@songbirdnest.com/Songbird/Library/MediaItemWatcher;1"
89 %}C++
90 
void cancel()
Cancel watcher.
void watch(in sbIMediaItem aMediaItem, in sbIMediaItemListener aListener, [optional] in sbIPropertyArray aPropertyIDs)
Watch for changes to the media item specified by aMediaItem and call the listener specified by aListe...
Interface for the media item watcher. The media item watcher may be used to watch for changes to a sp...
var uuid
function C(H)
Interface for media item listeners.
Interface that defines a single item of media in the system.
An interface to carry around arrays of nsIProperty instances. Users of this interface should only QI ...