Songbird / Development / Songbird Add-Ons API Documentation

sbIDeviceManager2 Interface Reference

List of all members.

Public Member Functions

sbIDeviceMarshall getMarshallByID (in nsIDPtr aIDPtr)
void updateDevices ()
sbIDeviceEvent createEvent (in unsigned long aType,[optional] in nsIVariant aData,[optional] in nsISupports aOrigin)
sbIDevice getDeviceForItem (in sbIMediaItem aItem)

Public Attributes

readonly attribute nsIArray marshalls
readonly attribute boolean canDisconnect

Detailed Description

Definition at line 48 of file sbIDeviceManager.idl.


Member Function Documentation

sbIDeviceMarshall sbIDeviceManager2::getMarshallByID ( in nsIDPtr  aIDPtr  ) 

Get a device marshall by ID.

void sbIDeviceManager2::updateDevices (  ) 

Simply calls updateDevices on all loaded controllers.

sbIDeviceEvent sbIDeviceManager2::createEvent ( in unsigned long  aType,
[optional] in nsIVariant  aData,
[optional] in nsISupports  aOrigin 
)

Create a new event

Parameters:
aType The type of the event; should be one of the COMMAND_* or EVENT_* constants on this interface.
aData (Optional) The data to pass to any listeners that would receive this event.
aOrigin (Optional) Some indication of the source of the event.
See also:
sbIDeviceEvent

sbIDeviceEventTarget

sbIDeviceEventListener

sbIDevice sbIDeviceManager2::getDeviceForItem ( in sbIMediaItem  aItem  ) 

Return the device to which the media item specified by aItem belongs. If the media item does not belong to any device, return null.

Parameters:
aItem Media item for which to get device.
Returns:
Device to which media item belongs.


Member Data Documentation

readonly attribute nsIArray sbIDeviceManager2::marshalls

List of marshalls that are currently instantiated. Order is undefined and may change between reads.

Definition at line 54 of file sbIDeviceManager.idl.

readonly attribute boolean sbIDeviceManager2::canDisconnect

Can all devices be disconnected?

Definition at line 99 of file sbIDeviceManager.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2