Below is a sample XML response for a typical successful request.
<?xml version="1.0" encoding="UTF-8"?>
<live_stream_config version="1.10" xmlns="https://provisioning.streamtheworld.com/player/livestream-1.10">
<mountpoints>
<mountpoint tags="td-lowdelay">
<status>
<status-code>200</status-code>
<status-message>OK</status-message>
</status>
<transports>
<transport>http</transport>
<transport mountSuffix="_SC">shoutcast</transport>
<transport mountSuffix="HLS/playlist.m3u8">hls</transport>
<transport mountSuffix="/HLSTS/playlist.m3u8">hlsts</transport>
</transports>
<metadata>
<shoutcast-v1 enabled="true" mountSuffix="_SC"/>
<shoutcast-v2 enabled="true" mountSuffix="_SC"/>
<sse-sideband enabled="true" mountSuffix="_SBM"/>
</metadata>
<servers>
<server sid="1681">
<ip>1681.live.streamtheworld.com</ip>
<ports>
<port type="http">80</port>
<port type="http">3690</port>
<port type="http">443</port>
</ports>
</server>
<server sid="2310">
<ip>2310.live.streamtheworld.com</ip>
<ports>
<port type="http">80</port>
<port type="http">443</port>
</ports>
</server>
</servers>
<metrics>
<listener-tracking url="https://test-prod.webcastmetrics.com/lt" wcm-station-id="35892" />
<tag name="uuid"/>
</metrics>
<mount>WXYZFM</mount>
<format>FLV</format>
<audio>96000</audio>
<media-format container="flv" cuepoints="stwcue" trackScheme="audio">
<audio index="0" samplerate="44100" codec="heaacv2" bitrate="32000" channels="2" tags="low-bw"/>
</media-format>
<authentication>0</authentication>
<timeout>0</timeout>
<send-page-url>1</send-page-url>
<!-- Optional Section -->
<side-channels>
<station name="WXYZ_SIDECHAN1"/>
<station name="WXYZ_SIDECHAN2"/>
</side-channels>
</mountpoint>
<!-- Other mount points may be present if request was by station name -->
<mountpoint .../>
</mountpoints>
</live_stream_config>
The corresponding XML schema is available at the following URL:
https://playerservices.streamtheworld.com/schema/livestream-1.10.xsd
Additional comments for important tags
Name | Value |
---|---|
<live_stream_config> | The version attribute represents the version of the configuration file format. Versions 1, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, and 1.10 are currently supported. The value of this attribute matches the version number passed in the initial request. We highly recommended you use the most recent version (1.10). |
<status-code> | The mount status, in the form of a three-digit integer. See Mount Status Codes for details. |
<status-message> | A textual description of the mount’s status. This message is always in English, and can be used for display to the user. However, it is recommended that the client application implement its own string dictionary to display friendlier messages to the user, based on the status code. In that case, this message can be used as a fallback if the client does not know the status code. |
<transport> | This element can appear multiple times and indicates which transport(s) is (are) supported for this mount. The mountSuffix attribute indicates a suffix that needs to be appended to the mount name when requesting the stream. When the timeshift="true" property is added to a HLSRW transport, it means that the HLS URL available is capable of Timeshift Radio. |
<shoutcast-v1> | Specifies that Shoutcast v1 metadata is available for this mount (enabled="true"), and what suffix (via mountSuffix="<suffix>") to append to the stream URL when connecting. Note: for Shoutcast V1, the metadata is multiplexed into the stream, so the mount suffix is identical to the stream itself – there is no need to establish a second connection to obtain metadata. |
<shoutcast-v2> | Specifies whether Shoutcast v2 metadata is available for this mount (when enabled="true"), and what suffix (via mountSuffix="<suffix>") to append to the stream URL when connecting. Note: for Shoutcast V2, the metadata is multiplexed into the stream, so the mount suffix is identical to the stream itself – there is no need to establish a second connection to obtain metadata. |
<sse-sideband> | Specifies whether Sideband Metadata is available for this mount (when enabled="true"), and what suffix (via mountSuffix="<suffix>") used by players to build the mount’s metadata URL if using SBM. See Sideband Metadata for details. |
<server> | This element can appear multiple times when a mount’s stream is hosted on multiple servers. The sid attribute indicates the ID of the server. |
<ip> | IP address of the server. |
<port> | This element can appear multiple times; it indicates the port(s) the server is listening on. The type attribute indicates, for each port, what kind of connection the port supports:
|
<metrics> | The <metrics> tag is part of the provisioning information to inform the player about the URL needed to call the Triton Listener Tracking (LT) API. For more information about LT and the risks of duplicate measurement, please speak to your Triton Digital representative. |
<mount> | The name of the mount (same as the mount parameter in the request) |
<format> | The format of the stream. The currently allowed formats and codecs are: FLV: Audio: MP3, AAC. Video: On2 VP6, H.264 MP3: MPEG Layer III Audio Deprecated – use the <media-format> element instead. |
<bitrate> | The bitrate of the stream, in bits per second. Deprecated – use the <audio> element instead. |
<media-format> | Defines the media format for this mount. These attributes are defined:
This element will contain a single <audio> element. |
<audio> | Defines the format of an audio track contained in the stream. These attributes are defined:
|
<authentication> | This feature is now deprecated, and the value is always set to 0. |
<timeout> | This feature is now deprecated, and the value is always set to 0. |
<send-page-url> | Boolean (0 or 1) indicating if the player is required to send the address of the page where it is embedded. When required, the URL of the page should be base64 encoded and sent as the value of the pageurl query parameter. |
<side-channels> | If the station/mount has side-channels, they will be listed here using nested <station name="..."/> elements. Separate calls to the Player Provisioning API are necessary to obtain information about the side-channel stations. |