AIM Standard Playout Formats

In this article, you will find the essential information you need for understanding the AIM playout formats in Rapid.

AIM Rapid (XML) Format

The AIM Rapid (XML) format can contain information for the currently playing track and up to seven items that are queued to be played.

An example XML is given as follows:

<playoutFeedExport>
    <playoutItem time="2023-02-26T15:08:10+00:00" duration="02:00" title="Lullaby" artist="The Cure" album="Galore" cart="12345" type="song" status="playing" imageUrl="https://www.thisisaim.com/exampleimage1.jpg" label="Dorian" labelNumber="90704" />
    <playoutItem time="2023-02-26T15:10:10+00:00" duration="02:00" title="The News" artist="" album="" type="other" status="queued" />
    <playoutItem time="2023-02-26T15:12:10+00:00" duration="03:37" title="Jump" artist="Madonna" album="Jump" cart="67890" type="song" status="queued" imageUrl="https://www.thisisaim.com/exampleimage2.jpg" label="London/Decca" labelNumber="4850020" />
</playoutFeedExport>

The following elements and attributes are contained within the XML:

playoutFeedExport (mandatory): A container for all elements and attributes within this XML. There is one playoutFeedExport per XML file.
playoutItem (mandatory): A container for all elements and attributes relating to a particular playout item. A single XML file can contain multiple playoutItem elements.
- time (optional): The start time for this playout item. The time should be supplied in ISO 8601 with a timezone offset, e.g., 2023-02-26T15:08:10+00:00. If the start time is omitted then the start time in Rapid is set to the time the item is imported into Rapid for the current item. Queued items are not supported if the time is not supplied.
- duration (optional): The expected duration of the item. If it is not provided then a default duration of four minutes is used for this playout source. It should be provided in HH:MM:SS format.
- cart (optional): The cart number for this playout item
- title (mandatory): The title for this playout item
- artist (optional): The artist for this playout item
- album (optional): The album (if it is a music track) for this playout item
- type (optional): The type of playout item. Accepted values are: song, speech, spot, link, other. If this value is not provided, then the type defaults to song.
- status (mandatory): Whether this track is the currently playing item or queued. Accepted values are: playing, queued. A maximum of one item with the status set to playing is allowed per XML file
- label (optional): The record label (if it is a music track)
- labelNumber (optional): The label/catalog number (if it is a music track)
- imageUrl (optional): A link to the image. The image must be square and a minimum size of 450 pixels by 450 pixels. Rapid will download the image from the URL included within this element.
imageLink (optional): A link to the image. Rapid will download the image from the URL included within this element.
THIS FIELD HAS BEEN DEPRECATED PLEASE USE IMAGEURL

AIM Rapid (Text) Format

The AIM Rapid (Text) format contains information for the currently playing track.

An example Text is given as follows:

now.cart=444
now.title=This Is What You Came For
now.artist=Calvin Harris & Rihanna
now.album=This Is What You Came For (Single)
now.time=2023-02-26T15:08:10+00:00
now.duration=221
now.imageUrl=https://www.thisisaim.com/exampleimage1.jpg
now.label=Dorian
now.labelNumber=90704
now.type=song
next.cart=555
next.title=Jump
next.artist=Madonna
next.album=Confessions on a Dance Floor
next.time=2023-02-26T15:12:02+00:00
next.duration=202
next.type=song
next.imageUrl=https://www.thisisaim.com/exampleimage2.jpg
next.label=London/Decca
next.labelNumber=4850020

Each field should be on a new line.

The following fields are contained within the text. Those entries with a prefix "now." refer to the current item. Those entries with a prefix "next." refer to the next item to play:

cart (optional): The cart number for this playout item
title (mandatory): The title for this playout item
artist (optional): The artist for this playout item
album (optional): The album (if it is a music track) for this playout item
time (optional): The start time for this playout item. The time should be supplied in ISO 8601 with a timezone offset, e.g., 2023-02-26T15:08:10+00:00. If the start time is omitted then the start time in Rapid is set to the time the item is imported into Rapid for the current item. Queued items are not supported if the time is not supplied.
duration (optional): The expected duration of the item. If it is not provided then a default duration of four minutes is used for this playout source. It should be provided in one of three formats:
- 00:01:30 (hours:minutes:seconds),
- 01:30 (minutes:seconds), or
- 90 (seconds only).
type (optional): The type of playout item. Accepted values are: song, speech, spot, link, other. If this value is not provided, then the type defaults to song.
label (optional): The record label (if it is a music track)
labelNumber (optional): The label/catalog number (if it is a music track)
imageUrl (optional): A link to the image. The image must be square and a minimum size of 450 pixels by 450 pixels. Rapid will download the image from the URL included within this element.

AIM Rapid (JSON) Format

The AIM Rapid (JSON, JavaScript Object Notation) format contains information for tracks.

An example is given as follows:

{
    "nowPlaying": [
       {
                       "album": "",
                       "artist": "Asino",
                       "duration": "00:03:40",
                       "imageUrl": "https://www.thisisaim.com/exampleimage1.jpg",
                       "status": "playing",
                       "cart": "12345",
                       "time": "2023-02-26T15:08:10+00:00",
                       "title": "Need Someone",
                       "label": "Dorian", 
                       "labelNumber": "90704",
                       "type": "song"
               },
               {
                       "album": "",
                       "artist": "CamelPhat & Elderbrook",
                       "duration": "00:03:24",
                       "imageUrl": "https://www.thisisaim.com/exampleimage2.jpg",
                       "status": "queued",
                       "cart": "67890",
                       "time": "2023-02-26T15:10:10+00:00",
                       "title": "Cola (Craig Knight Remix)",
                       "label": "London/Decca", 
                       "labelNumber": "4850020",
                       "type": "song"
               }
        ]
}

The following attributes are contained within the JSON:

time (optional): The start time for this playout item. The time should be supplied in ISO 8601 with a timezone offset, e.g., 2023-02-26T15:08:10+00:00. If the start time is omitted then the start time in Rapid is set to the time the item is imported into Rapid for the current item. Queued items are not supported if the time is not supplied.
duration (optional): The expected duration of the item. If it is not provided then a default duration of four minutes is used for this playout source. It should be provided in HH:MM:SS format.
cart (optional): The cart number for this playout item
title (mandatory): The title for this playout item
artist (optional): The artist for this playout item
album (optional): The album (if it is a music track) for this playout item
type (optional): The type of playout item. Accepted values are: song, speech, spot, link, other. If this value is not provided, then the type defaults to song.
status (mandatory): Whether this track is the currently playing item or queued. Accepted values are: playing, queued. A maximum of one item with the status set to playing is allowed per JSON file.
label (optional): The record label (if it is a music track)
labelNumber (optional): The label/catalog number (if it is a music track)
imageUrl (optional): A link to the image. The image must be square and a minimum size of 450 pixels by 450 pixels. Rapid will download the image from the URL included within this element.

v490/1

AIM Standard Playout Formats ​

AIM Rapid (XML) Format ​

AIM Rapid (Text) Format ​

AIM Rapid (JSON) Format ​

AIM Standard Playout Formats

AIM Rapid (XML) Format

AIM Rapid (Text) Format

AIM Rapid (JSON) Format