Songbird / Development / Songbird Add-Ons API Documentation

sbIDeviceStatus Interface Reference

import "sbIDeviceStatus.idl";

List of all members.

Public Member Functions

void init (in AString aDeviceID)
 Initialize the DeviceStatus component for a device.

Public Attributes

attribute unsigned long currentState
 The current overall state of the device.
attribute unsigned long currentSubState
 The current sub state of the device, copying could be a sub state of the syncing state.
attribute AString stateMessage
attribute AString currentOperation
attribute double progress
attribute PRInt64 workItemProgress
attribute PRInt64 workItemProgressEndCount
attribute sbIMediaItem mediaItem
attribute sbIMediaList mediaList


Detailed Description

Note:
Implementations of this interface must be threadsafe.
Holds the current status of a device, idle, syncing, etc with all the relevent information.

Definition at line 44 of file sbIDeviceStatus.idl.


Member Data Documentation

attribute unsigned long sbIDeviceStatus::currentState

The current overall state of the device.

See also:
sbIDevice::STATE_*

Definition at line 49 of file sbIDeviceStatus.idl.

attribute unsigned long sbIDeviceStatus::currentSubState

The current sub state of the device, copying could be a sub state of the syncing state.

See also:
sbIDevice::STATE_*

Definition at line 56 of file sbIDeviceStatus.idl.

attribute AString sbIDeviceStatus::stateMessage

Sets the state message

Definition at line 61 of file sbIDeviceStatus.idl.

attribute AString sbIDeviceStatus::currentOperation

Sets the current operation

Definition at line 66 of file sbIDeviceStatus.idl.

attribute double sbIDeviceStatus::progress

Sets the current progress as a percent. Done is 100.0.

Definition at line 71 of file sbIDeviceStatus.idl.

attribute PRInt64 sbIDeviceStatus::workItemProgress

Sets the current work item # for example processing multiple files

Definition at line 76 of file sbIDeviceStatus.idl.

attribute PRInt64 sbIDeviceStatus::workItemProgressEndCount

Sets the end count for processing multiple items

Definition at line 81 of file sbIDeviceStatus.idl.

attribute sbIMediaItem sbIDeviceStatus::mediaItem

Current Item being processed

Definition at line 86 of file sbIDeviceStatus.idl.

attribute sbIMediaList sbIDeviceStatus::mediaList

Current List being processed

Definition at line 91 of file sbIDeviceStatus.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