Songbird / Development / Songbird Add-Ons API Documentation

Songbird Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
nsIHttpRequestHandlerAn interface that handles HTTP requests
nsIHttpRequestMetadataAn interface that represents the data included in an HTTP request
nsIHttpResponseAn interface that represents an HTTP response, as described in RFC 2616, section 6
nsIHttpServerAn interface that represents an HTTP server. Currently only used by the testharness. (HINT HINT!!!!)
sbIAddOnBundleUpdateServiceInterface for the add-on bundle update service
sbIAlbumArtFetcherInterface for an album art fetcher. Instantiate as a component instance
sbIAlbumArtFetcherSetInterface for an album art fetcher set. Instantiate as a component instance
sbIAlbumArtListenerA component which is interested in the result of an album art fetch request
sbIAlbumArtScannerInterface for an album art scanner. Instantiate as a component instance. It also implements the sbIJobProgress so the progress can be monitored externally
sbIAlbumArtScannerListenerInterface for an album art scanner listener. This is used for callbacks for progress of the scanning
sbIAlbumArtServiceInterface for the album art service. Instantiate as a component service
sbIApplicationControllerGlobal root controller for the Songbird application
sbIBatchCreateMediaItemsListenerCallback for batch media create items
sbIBookmarksDefinition of the sbIBookmarks interface
sbIBooleanPropertyInfoThe property information specific to boolean properties
sbIBundleSongbird Bundle Interface This is the main bundle management interface, used to get the bundle data, perform and observe the download process, list the bundle content and install bundled extensions
sbIBundleDataListenerSongbird Bundle Data Listener Interface
sbIBundleInstallListenerSongbird Bundle Installation Listener Interface
sbIButtonPropertyInfoThe property information specific to button properties
sbICallWithWindowCallbackA callback interface that is called with a window
sbICascadeFilterSetCascade filter management for a media list
sbICascadeFilterSetListenerListener interface for sbICascadeFilterSet
sbIChangeOperation
sbIClickablePropertyInfoThe property information specific to clickable properties
sbIClipboardHelper
sbICommandLineFlagHandlerSongbird Command line flag handler Interface
sbICommandLineItemHandlerSongbird Command line item handler Interface
sbICommandLineManagerSongbird Command line manager interface
sbIContentTypeFormat
sbICreateMediaListCallback
sbIDatabaseEngine[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbIDatabasePreparedStatementA prepared database statement
sbIDatabaseQueryAn object responsible for executing SQL queries on the database
sbIDatabaseQueryCallbackA more complex callback object that can be used to read each row of the results in turn
sbIDatabaseResultAn object containing the results of a database SELECT query
sbIDatabaseSimpleQueryCallbackA callback object used to inform client code that a query has completed
sbIDataRemoteAn interface for accessing, and binding to, stored data
sbIDatetimePropertyInfoThe property information specific to date/time fields
sbIDevice
sbIDeviceBase[SOON TO BE DEPRECATED AFTER 0.3] Base interface for all supported devices
sbIDeviceBaseCallback[SOON TO BE DEPRECATED AFTER 0.3] The callback class for sbIDeviceBase
sbIDeviceCapabilities[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceCompatibility[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceContent[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceController[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceControllerRegistrar[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceDeviceTesterBase
sbIDeviceDeviceTesterUtils
sbIDeviceErrorMonitorThis service monitors devices for errors and stores them for easy access later
sbIDeviceEvent
sbIDeviceEventListener
sbIDeviceEventTarget
sbIDeviceHelper
sbIDeviceIdentification[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceLibrary
sbIDeviceLibraryListenerInterface used to listen to changes to a device library
sbIDeviceManager
sbIDeviceManager2
sbIDeviceMarshall
sbIDeviceProperties
sbIDeviceRegistrar[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIDeviceServicePaneServiceProvides information about devices needed by the service pane
sbIDeviceStatus
sbIDirectoryImportJobRepresents a recursive directory import operation. Use sbIDirectoryImportService to start a new import job. Use sbIJobProgress to track job status and wait for completion
sbIDirectoryImportServiceHandles finding media files in directories and adding them to a library or list
sbIDisplayPaneContentInfoInformation needed for a display pane to be instantiated
sbIDisplayPaneInstantiator
sbIDisplayPaneListener
sbIDisplayPaneManagerSongbird Display Panes Interface This is the main display panes management interface, used to register and list panes and instantiators. Display panes are blocks within the main user interface which can be used to load arbitary sub-documents for display to the user with full chrome privileges
sbIDndSourceTrackerHelper service for transferring internal objects using drag and drop
sbIDOMEventWrapper
sbIDownloadButtonPropertyBuilder
sbIDownloadDeviceSongbird DownloadDevice Interface
sbIDownloadDeviceHelper
sbIDummyPropertyInfoAn interface used to recognize a dummy metadata property
sbIDurationPropertyInfoThe property information specific to date/time fields
sbIFaceplateManagerManages the panes that are displayed in faceplate widgets
sbIFaceplateManagerListenerCallback interface for faceplate event notification
sbIFaceplatePaneInterface used to communicate with faceplate pane binding instances
sbIFeathersManagerControls the appearance of the application
sbIFeathersManagerListenerCallback interface used to listen to Feathers Manager changes
sbIFileDownloader
sbIFileDownloaderListener
sbIFileMetadataService
sbIFileScanThe engine in which to execute sbIFileScanQuery objects
sbIFileScanCallbackThe callback to the sbIFileScanQuery interface
sbIFileScanQueryAn object to scan through the files of a folder (and optionally subfolders)
sbIFileSystemListener
sbIFileSystemWatcher
sbIFilterableMediaListViewControl the filter settings on a media list
sbIGlobalHotkeyCallbackGlobal hotkeys callback interface This interface is used by callback objects to receive a notification when a registered hotkey is pressed anywhere in the system (not just when the application is focused)
sbIGlobalHotkeysGlobal hotkey registration/unregistration interface This interface is used to register or unregister hotkey callbacks
sbIGStreamerInspectHandler
sbIGStreamerMediacore
sbIGStreamerService
sbIHotkeyActionBundleSongbird hotkey action bundle interface This interface describes a bundle of hotkey actions and provides a callback function that is triggered when one of the actions is triggered
sbIHotkeyActionsSongbird Hotkey Actions Interface This is the interface used to register hotkey action objects
sbIImageLinkPropertyInfoThe property information specific to image link properties
sbIImagePropertyBuilder
sbIIndexedMediaItemA container for a media item and its index
sbIJobCancelable
sbIJobProgressGeneric interface for exposing long running jobs to the UI
sbIJobProgressListenerImplemented to receive notifications from sbIJobProgress interfaces
sbIJobProgressServiceThe beginnings of a service to track all background tasks
sbIJobProgressUIInterface to control UI aspects of sbIJobProgress
sbILastFmWebServices
sbILastFmWebServicesResponse
sbILayoutDescriptionStruct describing the properties of a XUL window layout
sbILeakCanary
sbILibraryMedia library abstraction
sbILibraryChange
sbILibraryChangeset
sbILibraryConstraint
sbILibraryConstraintBuilder
sbILibraryConstraintGroup
sbILibraryDiffingServiceLibrary and media list diffing service
sbILibraryFactoryFactory for new library instances
sbILibraryImporterInterface for importing external libraries
sbILibraryImporterListenerInterface for listening to library importer events
sbILibraryImporterManager
sbILibraryLoader[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILibraryLoggingServiceLibrary and media list logging service
sbILibraryManagerManages the lifecycle of libraries in the system
sbILibraryManagerListenerManages the lifecycle of libraries in the system
sbILibraryResourceGeneral interface to data resources
sbILibraryServicePaneServiceProvides information about libraries and medialists needed by the service pane
sbILibrarySortA sort that can be applied to a media list view
sbILibraryStatisticsExtract statistics from a media library
sbILibraryTransferContextA base interface for the various library transfer contexts
sbILibraryUtilsSet of library utilities
sbILocalDatabaseAsyncGUIDArray[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseAsyncGUIDArrayListener[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseDynamicPlaylistService
sbILocalDatabaseGUIDArray[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseGUIDArrayListener[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseLibrary[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseLibraryCopyListenerInterface used to listen for items being copied _from_ a library
sbILocalDatabaseMediaItem[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseMediaListCopyListener[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseMigrationHandler
sbILocalDatabaseMigrationHelper
sbILocalDatabasePropertyCache[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseResourceProperty[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseResourcePropertyBag[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseSimpleMediaList[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseSmartMediaList[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseSmartMediaListCondition[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbILocalDatabaseSmartMediaListListener
sbILocalDatabaseTreeView[USER CODE SHOULD NOT REFERENCE THIS CLASS]
sbIMediacore
sbIMediacoreBalanceControl
sbIMediacoreCapabilities
sbIMediacoreError
sbIMediacoreEventDefinition of the sbIMediacoreEvent interface
sbIMediacoreEventListener
sbIMediacoreEventTarget
sbIMediacoreFactory
sbIMediacoreFactoryRegistrar
sbIMediacoreManager
sbIMediacorePlaybackControl
sbIMediacoreSequenceGenerator
sbIMediacoreSequencer
sbIMediacoreSimpleEqualizer
sbIMediacoreStatus
sbIMediacoreTranscodeControl
sbIMediacoreTypeSniffer
sbIMediacoreVideoWindow
sbIMediacoreVolumeControl
sbIMediacoreVoting
sbIMediacoreVotingChain
sbIMediacoreVotingParticipant
sbIMediaItemInterface that defines a single item of media in the system
sbIMediaItemListenerInterface for media item listeners
sbIMediaItemStatusEventInterface to maintain information about the last event that occurred
sbIMediaItemsTransferContextThis interface represents a transfer of a collection of media items and/or media lists
sbIMediaItemWatcherInterface for the media item watcher. The media item watcher may be used to watch for changes to a specific media item. Instantiate as a component instance
sbIMediaListA brief description of the contents of this interface
sbIMediaListBatchCallback
sbIMediaListEnumerationListenerInterface used to enumerate the items in a media list
sbIMediaListFactoryFactory for new media list instances
sbIMediaListListenerInterface used to listen to changes to a media list
sbIMediaListMatchThis interface is used to provide a generic test on medialists. Note that instead of providing an object with this interface to a method that requires it, you may instead give a raw javascript function. eg:
sbIMediaListTransferContextThis interface represents a transfer of a single media list
sbIMediaListViewA distinct view on a given media list
sbIMediaListViewListenerSaved state of a media list view
sbIMediaListViewMapA mapping from nsISupports objects to save sbIMediaListView states
sbIMediaListViewSelectionManage the selection of items within a view. This interface is a subset of nsITreeViewSelection. Note that if you are part of the user interface, you probably want to be calling nsITreeView.selection instead - otherwise things can get subtly out of sync
sbIMediaListViewSelectionListenerListener interface that gets notified on selection changes
sbIMediaListViewStateSaved state of a media list view
sbIMediaListViewTreeViewA tree view that views a media list view
sbIMediaListViewTreeViewObserverObserver to implement the nsITreeView methods that a sbIMediaListViewTreeView does not
sbIMediaPageA generic interface for UI that renders a media list view
sbIMediaPageInfoThis interface is used to describe a medialist page
sbIMediaPageManagerThe medialist page manager, used to register, unregister, enumerate, set and retrieve page/medialists associations
sbIMetadataChannelA wrapper for an nsIChannel that buffers the incoming data
sbIMetadataHandlerAn object capable of manipulating the metadata tags for a media file
sbIMetadataManagerThe manager from which to request a metadata handler
sbIMetricsMetrics service interface This is an interface to the songbird metrics service, used to phone home and send metrics gathered since the last report was sent
sbIMockDevice
sbIMutablePropertyArrayAn interface to carry around arrays of nsIProperty instances Note that implementations of the interface should also provide nsIMutableArray. QI to nsIMutableArray to access add/remove/clear methods
sbIMutableRemoteSecurityEvent
sbINativeWindowManagerInterface to the operating system's window manager This Interfaces to allows JavaScript to talk to the native operating system window manager in a somewhat cross-platform way. This interface is inspired by some of the GtkWindow interface
sbINumberPropertyInfoThe property information specific to numeric fields
sbIOrderableMediaListMedia lists that implement this interface support custom ordering
sbIPlaybackHistoryEntry
sbIPlaybackHistoryListener
sbIPlaybackHistoryService
sbIPlaylistClickEventInterface to maintain information about the last event that occurred
sbIPlaylistCommandsAn interface that represents the set of command buttons and context menu items available on a displayed playlist
sbIPlaylistCommandsBuilderA helper used to construct sbIPlaylistCommands interfaces
sbIPlaylistCommandsBuilderContextThe interface for giving context to playlist builder callbacks
sbIPlaylistCommandsBuilderGetBoolCallbackAn interface used to receive callbacks from an sbIPlaylistCommandsBuilder object when a boolean value should be returned
sbIPlaylistCommandsBuilderGetStringCallbackAn interface used to receive callbacks from an sbIPlaylistCommandsBuilder object when a string value should be returned
sbIPlaylistCommandsBuilderInstantiationCallbackA callback interface used to instantiate a custom command DOM element for sbIPlaylistCommandsBuilder objects
sbIPlaylistCommandsBuilderPCCallbackA callback interface used to receive callbacks from an sbIPlaylistCommandsBuilder object relating to an entire set of playlistcommands
sbIPlaylistCommandsBuilderRefreshCallbackA callback interface used to refresh a custom command DOM element for sbIPlaylistCommandsBuilder objects
sbIPlaylistCommandsBuilderSetValueCallbackA callback interface used to receive a string value from an sbIPlaylistCommandsBuilder object
sbIPlaylistCommandsBuilderSimpleCallbackAn interface used to receive generic callbacks from an sbIPlaylistCommandsBuilder object
sbIPlaylistCommandsContextThe interface for giving context to a playlistcommands object
sbIPlaylistCommandsManagerThe service used to register, unregister, and list playlist commands for a particular playlist guid or type
sbIPlaylistReaderA subclass from which one may derive instances to read specific playlist types
sbIPlaylistReaderListenerA listener interface for use with sbIPlaylistReader interfaces
sbIPlaylistReaderManagerAn interface to be used to read playlists. It will try to find the proper sbIPlaylistReader subclass and use it
sbIPlaylistWidget
sbIPlaylistWriter[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIPlaylistWriterListener[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIPlaylistWriterManager[UNIMPLEMENTED UNTIL AFTER 0.3]
sbIProgressPropertyInfoThe property information specific to progressmeters
sbIPrompter
sbIProperty
sbIPropertyArrayAn interface to carry around arrays of nsIProperty instances. Users of this interface should only QI it to a sbIMutablePropertyArray if they are the owners of the instance
sbIPropertyBuilder
sbIPropertyChange
sbIPropertyFactoryAn interface to create sbIProperty instances
sbIPropertyInfoAn interface used to describe a metadata property for use by the UI and other sbILibrary interfaces (smartplaylists, etc)
sbIPropertyManagerManager for system wide metadata properties
sbIPropertyOperatorAn interface to represent an operator that may act upon a property
sbIPropertyUnitProperty unit interface This interface describes a property unit
sbIPropertyUnitConverterProperty unit converter interface This is an interface songbird property converter, used to convert a property value between its various units representations
sbIProxiedServices
sbIRatingPropertyBuilder
sbIRemoteAPIService
sbIRemoteCommandsAn interface to specify playlist commands from remote web pages
sbIRemoteLibraryAn interface to control a media library from remote web pages
sbIRemoteMediaListAn interface to control a media list from remote web pages
sbIRemotePlayerThis interface is a composition of many of our other interfaces with the goal of exposing a more web-friendly interface to web sites. This defines our "Remote API" the websites can call to get information about and interact with Songbird
sbIRemotePlayerFactory
sbIRemoteSecurityEventAn interface to maintain information about the last security event that occurred
sbIRemoteSiteLibraryAn interface for a sandbox library created by the website
sbIRemoteWebPlaylistAn interface to control a media list from remote web pages
sbIRUIImportListener
sbIScriptableFilterResultThe result of a filtering expression in a library
sbISearchableMediaListViewControl the search settings on a media list
sbISecurityAggregatorA marker interface for objects that aggregate the security mixin
sbISecurityMixinAn interface for setting up nsISecurityCheckedComponent security checks
sbISeekableChannelA seekable wrapper for an nsIChannel
sbISeekableChannelListenerA listener interface for sbISeekableChannel
sbIServicePaneListenerListen for changes on service pane nodes
sbIServicePaneModuleThe interface exposed by the service pane backends
sbIServicePaneNodeThe interface to interact with a particular node in the service pane
sbIServicePaneNodeInternalThis is for internal use by sbServicePaneService
sbIServicePaneServiceThe interface exposed by the service pane service
sbISimpleButtonPropertyBuilder
sbISkinDescriptionStruct describing the properties of a skin
sbISmartPlaylistProperty
sbISmartPlaylistPropertyRegistrarRegistrar for smart playlists properties
sbISortableMediaListViewControl the sort settings on a media list
sbISQLBuilderBase interface for SQL building components
sbISQLBuilderCriterionInterface for SQL critera. This interface has no public methods as it is used only as a return type for the critera creation methods
sbISQLBuilderCriterionInInterface for "in" SQL critera
sbISQLDeleteBuilderInterface for building DELETE statements
sbISQLInsertBuilderInterface for building INSERT statements
sbISQLSelectBuilderInterface for building SELECT statements
sbISQLUpdateBuilderInterface for building UPDATE statements
sbISQLWhereBuilderInterface for building WHERE expressions
sbIStringBundleServiceInterface for the Songbird string bundle service. Instantiate as a component service
sbIStringTransform
sbITabBrowser
See also:
sbITabBrowserTab
sbITabBrowserTab
See also:
sbITabBrowser
sbITagLibChannelFileIOManagerA service for providing sbISeekableChannel file IO support in TagLib
sbITemporaryFileService
sbITestHarnessAn interface for launching unit tests from XULRunner apps
sbITestMediacoreEventCreator
sbITextPropertyInfoThe property information specific to text fields
sbITimingServiceAn interface for running simple, time based, profiling
sbITimingServiceTimer
sbITreeViewPropertyInfo
sbIURIImportService
sbIURIPropertyInfoThe property information specific to URL/URI fields
sbIURLFormatter
sbIWatchFolderService
sbIWFMoveRenameHelper9000A hackish service that helps the watch folder component gracefully handle moved or renamed files. Since the watch folders are only notified of added and removed paths, we have to make educated guesses when files are moved or renamed. If we don't we delete and then re-add media items, b breaking existing playlists and lose information like ratings
sbIWindowCloakWindow cloaking service interface This is an interface to the window cloaking service, used to hide a xul window without closing it, and to unhide it at a later time
sbIWindowLayerWindow layering service interface This is an interface to the window layering service, used to set the opacity of an entire window
sbIWindowMinMaxWindowMinMax service interface This is an interface to the WindowMinMax service, used to set and reset callbacks for querying the application for minimum and maximum dimensions
sbIWindowMinMaxCallbackWindowMinMax callback interface This interface describes a callback for the WindowMinMax service, used to query the application for minimum and maximum dimensions. The callback is also used to trap the closing of the window
sbIWindowRegionWindow region service interface This is an interface to the window region service, used to assign a region to a window at the OS level. This allows cutting out portions of a window without relying on mozilla's internal transparency management, which may interfere with the window content
sbIWindowResizeHookWindowResizeHook service interface This is an interface to the WindowResizeHook service, used to used to register callback notifications of window resizing events
sbIWindowResizeHookCallbackWindowResizeHook callback interface This interface describes a callback for the WindowResizeHook service, used to receive notifications of window resizing events
sbIWindowWatcher
sbIWMDeviceSongbird WMDevice Interface
sbPIBundleSongbird Private Bundle Interface This is a private interface for bundle management, used by the bundle download user interface
sbPIDataRemote2An additional interface for accessing dataremote values. Adds the ability to access values via methods rather than attributes. This is needed by the Remote API, which cannot access attributes on JavaScript XPCOM components due to Mozilla Bug 304048. In order to work around this problem we've replaced the old DataRemote class with a C++ wrapper that delegates to the old implementation using this interface
sbPIFileSystemTree
sbPIMediacoreManager

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