Cue Point Format

Prev Next

A cue point is an XML message containing metadata for a stream. The information it contains is logically split into two categories: attributes and custom keys. The example cue point below includes the following six attributes:

  • cue_title

  • cue_time_duration

  • program_id

  • track_artist_name

  • track_album_name

  • track_album_publisher 

<?xml version="1.0" encoding="utf-8"?>
<stwcue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" version="1" xmlns="http://www.streamtheworld.com/metadata/stwcue-1.0">
    <mount>Test Mount</mount>
    <cuepoint type="track" timestamp="1406569181652" cache="true">
        <attributes>
            <attribute name="cue_title">Summertime Sadness</attribute>
            <attribute name="cue_time_duration">234000</attribute>
            <attribute name="program_id">Test</attribute>
            <attribute name="track_artist_name">Lana Del Rey</attribute>
            <attribute name="track_album_name">Summertime Sadness</attribute>
            <attribute name="track_album_publisher">EMI Music</attribute>
        </attributes>
    </cuepoint>
</stwcue>

The custom keys in the above example are: mount (mount name), type, timestamp, and cache. They are mapped from the corresponding STWCue custom keys described here.

In order to map the parsed value into the cue point attribute, use the attribute name as-is in the key. For example, in the first processor in the tutorial, the cue_title key is mapped to the {title} variable. That is, it will appear in the attributes of the cue point.