Songbird / Development / Songbird Add-Ons API Documentation

sbIRemotePlayer Interface Reference

This 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. More...

import "sbIRemotePlayer.idl";

List of all members.

Public Member Functions

void addListener (in AString aKey, in nsIObserver aObserver)
 Bind an observer to get called on changes to Songbird metadata/state.
void removeListener (in AString aKey, in nsIObserver aObserver)
 Remove an observer from the metadata key.
void downloadItem (in sbIMediaItem aItem)
 Download the item passed in.
void downloadList (in sbIRemoteMediaList aList)
 Download all items in a MediaList.
void downloadSelected (in sbIRemoteWebPlaylist aWebPlaylist)
 Download only the selected elements from a WebPlaylist.
void play ()
 Begin playback at the current location.
void playURL (in AString aURL)
 Play an media file by URL.
void stop ()
 Stop playback. Sets position to beginning.
void pause ()
 Stop playback, leaves position at current location.
void next ()
 Skip to the next track and begin playing.
void previous ()
 Skip to the previous track and begin playing.
nsIURI getSiteScope ()
 Get the site scope.
void fireEventToContent (in AString aClass, in AString aType)
 Fires the event to the webpage.
void fireMediaItemStatusEventToContent (in AString aClass, in AString aType, in sbIMediaItem aMediaItem, in long aStatus)
 Fires the media item status event to the webpage.
void onCommandsChanged ()
 Forces the webplaylist to rescan it's commands.
boolean hasAccess (in AString aRemotePermCataegory)
 Check if the code has access to a category.

Public Attributes

readonly attribute AString name
 The name of the player.
readonly attribute AString currentArtist
 The name of the artist for the currently playing media item.
readonly attribute AString currentAlbum
 The name of the album for the currently playing track.
readonly attribute AString currentTrack
 The name of the currently playing track.
readonly attribute boolean playing
 The playing state of the application.
readonly attribute boolean paused
 The paused state of the application.
readonly attribute long long repeat
 The repeat state for playback.
readonly attribute boolean shuffle
 Shuffle state for playback.
attribute long long position
 The location of playback within the current media, in milliseconds.
readonly attribute long long volume
 The volume on a range from 0 to 255.
readonly attribute boolean mute
 The mute state.
readonly attribute sbIRemoteCommands commands
 The collection of commands associated with the current page.
readonly attribute sbIRemoteWebPlaylist webPlaylist
 The current web playlist.
readonly attribute sbIRemoteLibrary mainLibrary
readonly attribute sbIRemoteLibrary webLibrary
readonly attribute sbIRemoteLibrary siteLibrary
readonly attribute sbIRemoteMediaList downloadMediaList


Detailed Description

This 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.

Definition at line 117 of file sbIRemotePlayer.idl.


Member Data Documentation

readonly attribute boolean sbIRemotePlayer::playing

The playing state of the application.

Returns:
false if the application is stopped

true if the application is playing or paused

Definition at line 197 of file sbIRemotePlayer.idl.

readonly attribute boolean sbIRemotePlayer::paused

The paused state of the application.

Returns:
false if the application is not paused

true if the application is paused

Definition at line 216 of file sbIRemotePlayer.idl.

readonly attribute long long sbIRemotePlayer::repeat

The repeat state for playback.

The repeat state for playback. This can be one of three values: 0 - no repeat 1 - repeat the current track forever 2 - repeat the current playlist forever

Definition at line 238 of file sbIRemotePlayer.idl.

readonly attribute boolean sbIRemotePlayer::shuffle

Shuffle state for playback.

This will be true if shuffle is enabled, false if not.

Definition at line 255 of file sbIRemotePlayer.idl.

readonly attribute boolean sbIRemotePlayer::mute

The mute state.

True if muted or the volume is set to 0, false otherwise

Definition at line 299 of file sbIRemotePlayer.idl.


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