From XMTuner

[edit] The XMTuner Web Interface

XMTuner provides a Web Application UI in addition to the desktop UI when the XMTuner server is running. (If using the XMTuner Service, this is the only UI available.)

To access the Web Interface, open your favorite browser (Firefox, Internet Explorer, Safari, Google Chrome, etc) and point it at

http://localhost:19081/

(you can also use your computer's IP address or hostname instead of localhost, that's left as an exercise for the reader)

[edit] What's On

This is the default page of the XMTuner Web Interface. (Introduced in XMTuner 0.2).

It features the Channel Guide, as well as a Now Playing space.

[edit] Now Playing

The Now Playing area will show what channel is currently playing (when using the built-in player) or presumed to be currently playing (i.e. last channel played) when you're using another media player or portable device. This allows you to get the current channel information and currently playing song (or program) on the go from any PC or device on your network. Also available is the History of Recently Played songs (up to 25).

Note: When using an external media player, XMTuner has no way to know when you start and stop a stream, it is normal for the web interface to appear that you're still on the last channel played. Additionally (for advanced multi-user setups), if another device (or the built-in player) plays a different channel, your last channel information will be replaced.

[edit] Channel Guide

This is the full XM (or Sirius) channel lineup. Each channel line shows the Channel's Name, Description (when hovering over the channel name), and the currently playing song information. XMTuner also supports the XM Radio Program Guide so the currently playing program will be shown. (For additional program guide details (times, next program): hover over the program name). Additionally, the channel's logo is provided, linked to the SiriusXM channel page for each channel, and the play link with the stream URL.

[edit] Feeds

The most useful and common feature of the Web UI, is its RSS (Podcast) feed, which is used by TVersity and other applications to easily get the full list of the Sirius|XM lineup. The default feed is linked from the upper-right corner of the channel guide.

The feed is directly available at the URL: http://localhost:19081/feeds/

Browsers that support RSS feeds natively, such as Firefox, will present an option to "Subscribe..." to this feed with a link to it. They'll also give a preview view of the feed.

[edit] Playlists

Starting in XMTuner 0.4, a new type of output was added. Playlists. Intended for desktop media players and some devices which desire them, this is best compared to the feed type.

The Playlist URL is: http://localhost:19081/playlists/

The default playlist type is PLS, though ASX and M3U are also supported.

To change the playlist type, use the type= option.

Valid values are:

pls
asx
m3u

Example: http://localhost:19081/playlists/?type=m3u (for the m3u playlist)

Also accepted is the bitrate option (see Options for use in What's On and Feed URLs below for details of this option.)

Note: The protocol types cannot be controlled in the playlist output using the type option like in feeds and what's on. This is because each playlist format expects a specific URL type in the output. The XMTuner options, where they can apply are used when building the URLs in the playlists.

[edit] Streams

All the channels have a stream URL, used for playing the stream, the channel guide and feeds provide these URLs for you, but in the interest of completeness, the format of these URLs is documented here.

This information is only useful if you're bulding the stream URLs yourself, the XMTuner does all the work for you in normal use.

The base stream URL for a channel is as follows:

http://<XMTuner IP>:<XMTuner Port>/streams/<channel number>

Or in more readable terms:

http://localhost:19081/streams/2

There are 2 optional components, <bandwidth> and <streamtype> (In XMTuner 0.6, there are now 3 optional components with the addition of <format>

The valid values for bandwidth are low and high, when omitted the preference for "Default to High Bandwidth stream" is used.

Examples:
http://localhost:19081/streams/2/high (for the 128k stream)
http://localhost:19081/streams/2/low (for the 32k stream)

Streamtype (added in XMTuner 0.3) is used to indicate to XMTuner that it needs to ask TVersity to transcode the stream from Windows Media to a type your player can handle. (Currently, as of XMTuner 0.3-0.5.1, the only supported stream type is mp3, XMTuner 0.6 adds support for wav). If omitted, no transcoding is done.

Valid values are nothing, mp3 (XMTuner 0.3 and higher) and wav (XMTuner 0.6+).

Example:
http://localhost:19081/streams/2/high/mp3 (Sirius XM Hits 1 on XM, 128k stream, as mp3)

Format controls whether the stream is automatically redirected to or if XMTuner generates a playlist of one of the <format> types. This feature is available starting in XMTuner 0.6, the valid playlist types are asx and m3u.

So, putting it all together, the full format of the stream URL is:

http://<xmtuner's computer ip>:<xmtuner port>/streams/<channel number>[/<bandwidth>][/<streamtype>][/<format>]

Brackets [ ] mean optional, so those components can be left out.

[edit] Options for Use in What's On and Feed URLs

The normal option-less URLs for the What's On page and Feeds use the XMTuner options to construct their URLs. This is the preferred design, as it makes things as simple as possible. (In early versions of XMTuner <0.3 this was the primary way to work with its URLs)

XMTuner never needs these options to be specified manually to function normally, these are for advanced users only.

Though there are cases where you want to temporarily or for a specific purpose, break from your normal routine. For this reason, XMTuner supports options to control the output of the URLs for these pages.

It should be noted that purpose for these options controls is to control the stream URLs presented on the What's On page and the links in the feed.

The options belong in the query string part of the URL.. The query string is the portion of the URL after the page that begins with a ? and has name, value pairs, seperated by an &)

http://example.com/somepage/?option1=value1&option2=value2

[edit] Options

type:

This controls the protocol of the resulting generated URLs. Valid values are:
http (default when use mms is unchecked)
mms (default when use mms is checked)
rtsp (default when tversity asks for a feed url automatically)
mp3 (http protocol + add the mp3 streamtype to the URL
New in XMTuner 0.6 are the following types:
wav (http protocol + wav streamtype for wav transcoding)
asx (streams should be contained in an asx playlist)
m3u (streams should be contained in an m3u playlist)

bitrate:

Low (32k)
High (128k - Default, may require a premium online subscription)

format (new in XMTuner 0.6):

This controls whether the stream URL is redirected automatically (default) or a playlist is generated for the channel. Supported playlists are ASX and M3U. This parameter is used for extending the type versions of these playlists, for example, combining an mp3 transcoded feed with an m3u playlist type. (?type=mp3&format=m3u)

m3u (MP3 playlist)
asx (Windows Media playlist)

streamtype (XMTuner 0.3+)

Expliticly define the transcoded type, default is null (no transcoding). Where possible use the type option above, this exists for overriding the automatic protocol selection that XMTuner does based on streamtype. Valid values:
mp3
wav (XMTuner 0.6+)

Examples:

http://localhost:19081/?type=mms  (What's On page with the Play links generated as mms:// links)

http://localhost:19081/?bitrate=low (What's On page with 32k stream links)

http://localhost:19081/?type=mms&bitrate=low (both the above combined: 32k mms:// stream links)

The same applies to the feed URL, so only one example:

http://localhost:19081/feeds/?type=mms (Feed with MMS links, used with Orb...)