sbRemoteMediaListBase Class Referenceabstract

#include <sbRemoteMediaListBase.h>

Inheritance diagram for sbRemoteMediaListBase:
[legend]
Collaboration diagram for sbRemoteMediaListBase:
[legend]

Public Member Functions

NS_IMETHOD GetClassName (char **aClassName)
 
NS_IMETHOD GetScriptableFlags (PRUint32 *aScriptableFlags)
 
NS_IMETHOD NewResolve (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, PRUint32 flags, JSObject **objp, PRBool *_retval)
 
NS_IMETHOD GetItemByGuid (const nsAString &aGuid, sbIMediaItem **_retval)
 
NS_IMETHOD GetItemByIndex (PRUint32 aIndex, sbIMediaItem **_retval)
 
NS_IMETHOD GetItemCountByProperty (const nsAString &aPropertyID, const nsAString &aPropertyValue, PRUint32 *_retval)
 
NS_IMETHOD GetListContentType (PRUint16 *_retval)
 
NS_IMETHOD EnumerateAllItems (sbIMediaListEnumerationListener *aEnumerationListener, PRUint16 aEnumerationType)
 
NS_IMETHOD EnumerateItemsByProperty (const nsAString &aPropertyID, const nsAString &aPropertyValue, sbIMediaListEnumerationListener *aEnumerationListener, PRUint16 aEnumerationType)
 
NS_IMETHOD IndexOf (sbIMediaItem *aMediaItem, PRUint32 aStartFrom, PRUint32 *_retval)
 
NS_IMETHOD LastIndexOf (sbIMediaItem *aMediaItem, PRUint32 aStartFrom, PRUint32 *_retval)
 
NS_IMETHOD Contains (sbIMediaItem *aMediaItem, PRBool *_retval)
 
NS_IMETHOD Add (sbIMediaItem *aMediaItem)
 
NS_IMETHOD AddItem (sbIMediaItem *aMediaItem, sbIMediaItem **aNewItem)
 
NS_IMETHOD AddAll (sbIMediaList *aMediaList)
 
NS_IMETHOD AddSome (nsISimpleEnumerator *aMediaItems)
 
NS_IMETHOD AddMediaItems (nsISimpleEnumerator *aMediaItems, sbIAddMediaItemsListener *aListener, PRBool aAsync)
 
NS_IMETHOD Remove (sbIMediaItem *aMediaItem)
 
NS_IMETHOD GetDistinctValuesForProperty (const nsAString &aPropertyID, nsIStringEnumerator **_retval)
 
virtual already_AddRefed
< sbIMediaItem
GetMediaItem ()
 
virtual already_AddRefed
< sbIMediaList
GetMediaList ()
 
 sbRemoteMediaListBase (sbRemotePlayer *aRemotePlayer, sbIMediaList *aMediaList, sbIMediaListView *aMediaListView)
 
virtual nsresult Init ()=0
 
- Public Member Functions inherited from sbIMediaList
sbIMediaItem getItemByGuid (in AString aGuid)
 Get a media item in the list by guid. More...
 
sbIMediaItem getItemByIndex (in unsigned long aIndex)
 Get a media item in the list by index. More...
 
unsigned short getListContentType ()
 Get the content type of the media list. More...
 
void enumerateAllItems (in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType)
 Enumerate all items in the list. More...
 
void enumerateItemsByProperty (in AString aPropertyID, in AString aPropertyValue, in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType)
 Enumerate the media items in the list that match a given property ID and value. More...
 
void enumerateItemsByProperties (in sbIPropertyArray aProperties, in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType)
 Enumerate the media items that match a list of property IDs and values. More...
 
nsIArray getItemsByProperty (in AString aPropertyID, in AString aPropertyValue)
 
PRUint32 getItemCountByProperty (in AString aPropertyID, in AString aPropertyValue)
 
nsIArray getItemsByProperties (in sbIPropertyArray aProperties)
 
unsigned long indexOf (in sbIMediaItem aMediaItem, [optional] in unsigned long aStartFrom)
 Get the first index of a media item in the list. More...
 
unsigned long lastIndexOf (in sbIMediaItem aMediaItem, in unsigned long aStartFrom)
 Get the last index of a media item int he list. More...
 
boolean contains (in sbIMediaItem aMediaItem)
 Check if the list contains a media item. More...
 
void add (in sbIMediaItem aMediaItem)
 Add a media item to this list. More...
 
sbIMediaItem addItem (in sbIMediaItem aMediaItem)
 addItem a media item to this list More...
 
void addAll (in sbIMediaList aMediaList)
 Add the contents of a media list to this list. More...
 
void addSome (in nsISimpleEnumerator aMediaItems)
 Adds media items suppled by the provided enumerator NOTE: This method is now deprecated. More...
 
void addMediaItems (in nsISimpleEnumerator aMediaItems, in sbIAddMediaItemsListener aListener, in boolean aAsync)
 Adds media items suppled by the provided enumerator. More...
 
void remove (in sbIMediaItem aMediaItem)
 Remove the first occurrence of the given media item from the list. More...
 
void removeByIndex (in unsigned long aIndex)
 Remove a media item from the list by index. More...
 
void removeSome (in nsISimpleEnumerator aMediaItems)
 Removed media items suppled by the provided enumerator. More...
 
void clear ()
 Clear the list. More...
 
void addListener (in sbIMediaListListener aListener, [optional] in boolean aOwnsWeak, [optional] in unsigned long aFlags, [optional] in sbIPropertyArray aPropertyFilter)
 Add a listener to this media list. More...
 
void removeListener (in sbIMediaListListener aListener)
 Remove a listener from this media list. More...
 
sbIMediaListView createView ([optional] in sbIMediaListViewState aState)
 Create a new, raw view for this list. This is generally not the function that you want to use for making views as it will create a completely raw view, for example lacking any filterConstraint. Please consider using sbLibraryUtils.createStandardMediaListView and proceed carefully if you use this method instead. More...
 
void runInBatchMode (in sbIMediaListBatchCallback aCallback, [optional] in nsISupports aUserData)
 Runs the given callback with the given user data in batch mode. More...
 
nsIStringEnumerator getDistinctValuesForProperty (in AString aPropertyID)
 
- Public Member Functions inherited from sbIMediaItem
void testIsURIAvailable (in nsIObserver aObserver)
 Test if this media item is available for playback. More...
 
nsIChannel openInputStreamAsync (in nsIStreamListener aListener, in nsISupports aContext)
 Asynchronously get an input stream to the content of the media item. More...
 
nsIInputStream openInputStream ()
 Synchronously get an input stream to the content of the media item. More...
 
nsIOutputStream openOutputStream ()
 Get an output stream to the content of the media item. More...
 
AString toString ()
 Get a string representation of the media item, useful for debugging. More...
 
- Public Member Functions inherited from sbILibraryResource
AString getProperty (in AString aID)
 Get the value of a property of this resource. More...
 
void setProperty (in AString aID, in AString aValue)
 Set the value of a property on this resource. More...
 
sbIPropertyArray getProperties ([optional] in sbIPropertyArray aPropertyIDs)
 Get properties from this resource in a property array. More...
 
void setProperties (in sbIPropertyArray aProperties)
 Sets the properties and values in the supplied property array to this resource. This works as if you called setProperty on each property in the array. More...
 
boolean equals (in sbILibraryResource aOtherLibraryResource)
 Tests the equality of two library resources. More...
 
- Public Member Functions inherited from sbIRemoteMediaList
sbIMediaListView getView ()
 
- Public Member Functions inherited from sbXPCScriptableStub
virtual ~sbXPCScriptableStub ()
 
NS_IMETHOD PreCreate (nsISupports *nativeObj, JSContext *cx, JSObject *globalObj, JSObject **parentObj)
 
NS_IMETHOD Create (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj)
 
NS_IMETHOD PostCreate (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj)
 
NS_IMETHOD AddProperty (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, jsval *vp, PRBool *_retval)
 
NS_IMETHOD DelProperty (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, jsval *vp, PRBool *_retval)
 
NS_IMETHOD GetProperty (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, jsval *vp, PRBool *_retval)
 
NS_IMETHOD SetProperty (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, jsval *vp, PRBool *_retval)
 
NS_IMETHOD Enumerate (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, PRBool *_retval)
 
NS_IMETHOD NewEnumerate (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, PRUint32 enum_op, jsval *statep, jsid *idp, PRBool *_retval)
 
NS_IMETHOD NewResolve (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, PRUint32 flags, JSObject **objp, PRBool *_retval)
 
NS_IMETHOD Convert (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, PRUint32 type, jsval *vp, PRBool *_retval)
 
NS_IMETHOD Finalize (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj)
 
NS_IMETHOD CheckAccess (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval id, PRUint32 mode, jsval *vp, PRBool *_retval)
 
NS_IMETHOD Call (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, PRUint32 argc, jsval *argv, jsval *vp, PRBool *_retval)
 
NS_IMETHOD Construct (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, PRUint32 argc, jsval *argv, jsval *vp, PRBool *_retval)
 
NS_IMETHOD HasInstance (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval val, PRBool *bp, PRBool *_retval)
 
NS_IMETHOD Trace (nsIXPConnectWrappedNative *wrapper, JSTracer *trc, JSObject *obj)
 
NS_IMETHOD Equality (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, jsval val, PRBool *_retval)
 
NS_IMETHOD OuterObject (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, JSObject **_retval)
 
NS_IMETHOD InnerObject (nsIXPConnectWrappedNative *wrapper, JSContext *cx, JSObject *obj, JSObject **_retval)
 
NS_IMETHOD PostCreatePrototype (JSContext *cx, JSObject *proto)
 

Protected Member Functions

virtual ~sbRemoteMediaListBase ()
 

Static Protected Member Functions

static nsresult ThrowJSException (JSContext *cx, const nsACString &aExceptionMsg)
 
static JSBool AddHelper (JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
 

Protected Attributes

nsCOMPtr
< nsISecurityCheckedComponent
mSecurityMixin
 
nsRefPtr< sbRemotePlayermRemotePlayer
 
nsCOMPtr< sbIMediaListmMediaList
 
nsCOMPtr< sbIMediaListViewmMediaListView
 
nsCOMPtr< sbIMediaItemmMediaItem
 
nsCOMPtr< sbILibrarymLibrary
 
nsCOMPtr< sbILibraryResourcemRemLibraryResource
 

Additional Inherited Members

- Public Attributes inherited from sbIMediaList
const unsigned short ENUMERATIONTYPE_SNAPSHOT = 0
 This flag means that the list being enumerated is a copy that may become out of date. More...
 
const unsigned short ENUMERATIONTYPE_LOCKING = 1
 This flag means that the list is protected from changes by other threads during the enumeration. More...
 
const unsigned short CONTENTTYPE_NONE = 0
 These flags specify the contentType of the media list. More...
 
const unsigned short CONTENTTYPE_AUDIO = 1
 
const unsigned short CONTENTTYPE_VIDEO = 2
 
const unsigned short CONTENTTYPE_MIX = 3
 
attribute AString name
 The name of the media list. More...
 
readonly attribute AString type
 The type of media list (eg "simple") More...
 
readonly attribute unsigned long length
 Returns the length of the list. More...
 
readonly attribute boolean isEmpty
 Is the list empty? More...
 
readonly attribute boolean userEditableContent
 True if the user should be allowed to edit the content of this media list. More...
 
const unsigned long LISTENER_FLAGS_ITEMADDED = 1 << 0
 
const unsigned long LISTENER_FLAGS_BEFOREITEMREMOVED = 1 << 1
 
const unsigned long LISTENER_FLAGS_AFTERITEMREMOVED = 1 << 2
 
const unsigned long LISTENER_FLAGS_ITEMUPDATED = 1 << 3
 
const unsigned long LISTENER_FLAGS_BEFORELISTCLEARED = 1 << 4
 
const unsigned long LISTENER_FLAGS_LISTCLEARED = 1 << 5
 
const unsigned long LISTENER_FLAGS_BATCHBEGIN = 1 << 6
 
const unsigned long LISTENER_FLAGS_BATCHEND = 1 << 7
 
const unsigned long LISTENER_FLAGS_ITEMMOVED = 1 << 8
 
const unsigned long LISTENER_FLAGS_ALL = 0xffffffff
 
- Public Attributes inherited from sbIMediaItem
readonly attribute sbILibrary library
 The library that this media item is contained in. More...
 
readonly attribute boolean isMutable
 Can the media item be changed? More...
 
readonly attribute
sbIMediaItemController 
itemController
 An interface to the media item controller (if any) that determines this item's availability for playback. More...
 
attribute long long mediaCreated
 Creation time of the media item as a unix timestamp. More...
 
attribute long long mediaUpdated
 Last modification time of the media item as a unix timestamp. More...
 
attribute nsIURI contentSrc
 A nsIURI that resolves to the content of the media item. More...
 
attribute long long contentLength
 Size (in bytes) of the content of the media item. More...
 
attribute AString contentType
 Content type of the content of the media item, typically a mime type (should this be renamed?) More...
 
- Public Attributes inherited from sbILibraryResource
readonly attribute AString guid
 The guid of this resource. More...
 
readonly attribute long long created
 The creation time of this resource as a unix timestamp. More...
 
readonly attribute long long updated
 The last update time of this resource as a unix timestamp. More...
 
readonly attribute
nsIStringEnumerator 
propertyIDs
 Returns a string enumerator of the IDs of all the properties set on this resource. More...
 
readonly attribute boolean userEditable
 True if users should be allowed to modify the resource. More...
 
- Public Attributes inherited from sbISecurityAggregator
readonly attribute sbIRemotePlayer remotePlayer
 

Detailed Description

Definition at line 60 of file sbRemoteMediaListBase.h.

Constructor & Destructor Documentation

sbRemoteMediaListBase::sbRemoteMediaListBase ( sbRemotePlayer aRemotePlayer,
sbIMediaList aMediaList,
sbIMediaListView aMediaListView 
)
sbRemoteMediaListBase::~sbRemoteMediaListBase ( )
protectedvirtual

Definition at line 113 of file sbRemoteMediaListBase.cpp.

Member Function Documentation

NS_IMETHODIMP sbRemoteMediaListBase::Add ( sbIMediaItem aMediaItem)

Definition at line 727 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::AddAll ( sbIMediaList aMediaList)

Definition at line 759 of file sbRemoteMediaListBase.cpp.

JSBool sbRemoteMediaListBase::AddHelper ( JSContext *  cx,
JSObject *  obj,
uintN  argc,
jsval *  argv,
jsval *  rval 
)
staticprotected

Definition at line 283 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::AddItem ( sbIMediaItem aMediaItem,
sbIMediaItem **  aNewItem 
)

Definition at line 733 of file sbRemoteMediaListBase.cpp.

Here is the caller graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::AddMediaItems ( nsISimpleEnumerator aMediaItems,
sbIAddMediaItemsListener aListener,
PRBool  aAsync 
)

Definition at line 788 of file sbRemoteMediaListBase.cpp.

Here is the caller graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::AddSome ( nsISimpleEnumerator aMediaItems)

Definition at line 782 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::Contains ( sbIMediaItem aMediaItem,
PRBool *  _retval 
)

Definition at line 712 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::EnumerateAllItems ( sbIMediaListEnumerationListener aEnumerationListener,
PRUint16  aEnumerationType 
)

Definition at line 641 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::EnumerateItemsByProperty ( const nsAString &  aPropertyID,
const nsAString &  aPropertyValue,
sbIMediaListEnumerationListener aEnumerationListener,
PRUint16  aEnumerationType 
)

Definition at line 657 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::GetClassName ( char **  aClassName)

Definition at line 175 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::GetDistinctValuesForProperty ( const nsAString &  aPropertyID,
nsIStringEnumerator **  _retval 
)

Definition at line 837 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::GetItemByGuid ( const nsAString &  aGuid,
sbIMediaItem **  _retval 
)

Definition at line 589 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::GetItemByIndex ( PRUint32  aIndex,
sbIMediaItem **  _retval 
)

Definition at line 608 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::GetItemCountByProperty ( const nsAString &  aPropertyID,
const nsAString &  aPropertyValue,
PRUint32 *  _retval 
)

Definition at line 627 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::GetListContentType ( PRUint16 *  _retval)

Definition at line 635 of file sbRemoteMediaListBase.cpp.

already_AddRefed< sbIMediaItem > sbRemoteMediaListBase::GetMediaItem ( )
virtual

Implements sbIWrappedMediaItem.

Definition at line 150 of file sbRemoteMediaListBase.cpp.

already_AddRefed< sbIMediaList > sbRemoteMediaListBase::GetMediaList ( )
virtual

Implements sbIWrappedMediaList.

Definition at line 161 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::GetScriptableFlags ( PRUint32 *  aScriptableFlags)

Definition at line 185 of file sbRemoteMediaListBase.cpp.

NS_IMETHODIMP sbRemoteMediaListBase::IndexOf ( sbIMediaItem aMediaItem,
PRUint32  aStartFrom,
PRUint32 *  _retval 
)

Definition at line 678 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

virtual nsresult sbRemoteMediaListBase::Init ( )
pure virtual
NS_IMETHODIMP sbRemoteMediaListBase::LastIndexOf ( sbIMediaItem aMediaItem,
PRUint32  aStartFrom,
PRUint32 *  _retval 
)

Definition at line 695 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::NewResolve ( nsIXPConnectWrappedNative *  wrapper,
JSContext *  cx,
JSObject *  obj,
jsval  id,
PRUint32  flags,
JSObject **  objp,
PRBool *  _retval 
)

Definition at line 198 of file sbRemoteMediaListBase.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbRemoteMediaListBase::Remove ( sbIMediaItem aMediaItem)

Definition at line 813 of file sbRemoteMediaListBase.cpp.

nsresult sbRemoteMediaListBase::ThrowJSException ( JSContext *  cx,
const nsACString &  aExceptionMsg 
)
staticprotected

Definition at line 238 of file sbRemoteMediaListBase.cpp.

Here is the caller graph for this function:

Member Data Documentation

nsCOMPtr<sbILibrary> sbRemoteMediaListBase::mLibrary
protected

Definition at line 151 of file sbRemoteMediaListBase.h.

nsCOMPtr<sbIMediaItem> sbRemoteMediaListBase::mMediaItem
protected

Definition at line 150 of file sbRemoteMediaListBase.h.

nsCOMPtr<sbIMediaList> sbRemoteMediaListBase::mMediaList
protected

Definition at line 148 of file sbRemoteMediaListBase.h.

nsCOMPtr<sbIMediaListView> sbRemoteMediaListBase::mMediaListView
protected

Definition at line 149 of file sbRemoteMediaListBase.h.

nsCOMPtr<sbILibraryResource> sbRemoteMediaListBase::mRemLibraryResource
protected

Definition at line 152 of file sbRemoteMediaListBase.h.

nsRefPtr<sbRemotePlayer> sbRemoteMediaListBase::mRemotePlayer
protected

Definition at line 147 of file sbRemoteMediaListBase.h.

nsCOMPtr<nsISecurityCheckedComponent> sbRemoteMediaListBase::mSecurityMixin
protected

Definition at line 145 of file sbRemoteMediaListBase.h.


The documentation for this class was generated from the following files: