Introduction

Here are some notes on how to hook into the eMusic Remote interface and backend components.

Currently, Remote has support for tabbrowsing, toolbars, statusbar and sidebar as well as all the toolkit specific interfaces: error console, add-ons manager, etc.

Most generic Extensions will be able to just add entries in the install.rdf and chrome.manifest to get things to work (information below).

For a list of official and unofficially supported extensions click here.

Here are some additional notes to help with creating extensions.

Window Mediator

When referring to "navigator.window" in your window mediator/iterator please add a check for "emusic:window" and that will give you the main eMusic window.

install.rdf:

    <em:targetApplication>
    <Description>
      <em:id>dlm@emusic.com</em:id>
      <em:minVersion>1.0</em:minVersion>
      <em:maxVersion>1.0.0.*</em:maxVersion>
    </Description>
   </em:targetApplication>

chrome.manifest:

overlay chrome://emusic/content/startup.xul chrome://YOURNAMESPACE/content/YOUROVERLAY.xul

contents.rdf:

  <RDF:Seq about="urn:mozilla:overlays">
    <RDF:li resource="chrome://emusic/content/startup.xul"/>
  </RDF:Seq>
    
  <!-- eMusic overlays -->
  <RDF:Seq about="chrome://emusic/content/startup.xul">
    <RDF:li>chrome://YOURNAMESPACE/content/YOUROVERLAY.xul</RDF:li>
  </RDF:Seq>

Common Firefox Features

The following objects/calls are available natively or as a wrapper with the 1.0 release. Note, some objects may not be fully implemented:

• objects: gBrowser, gURLBar, appcontent, appCore
• functions: BrowserStartup, getWebNavigation, getBrowserURL, toErrorConsole, toJavaScriptConsole, toOpenWindowByType, toAddons, openAddonsMgr, openExternal, gPrefService, loadURI, openUILinkIn, openUILink, getBrowser, BrowserOpenTab, BrowserFullScreen

Common GUI objects/id's:

• stringbundleset id="brandStrings" & id="bundle_brand"
• broadcasterset id="mainBroadcasterSet"
• commandset id="mainCommandSet"
• keyset id="mainKeyset"
• popupset id="mainPopupSet"
• toolbox id="navigator-toolbox"
• popup id="contentAreaContextMenu"
• vbox id="sidebar-box"
• tabbrowser id="content"
• statusbar id="status-bar"
• All menus share Firefox naming schema: File, Edit, View, Tools, Window & Help (Edit is currently only used on Linux platforms)

• support for gContextMenu is planned but is currently not available

Additional toolbar boxes

• toolbox id="download-toolbox": track view toolbar
• toolbox id="download-album-toolbox": album view toolbar
• toolbox id="audiobooks-toolbox": audibooks view toolbar