audio_item

Item type: audio
Roku component: roSpringboardScreen + roVideoScreen

---

Example

<item type="audio"
      title="My audio title"
      url="http://yoursite.com/audio.mp3"
      streamformat="mp3"
      sdposterurl="http://yoursite.com/audio_sd.jpg"
      hdposterurl="http://yoursite.com/audio_hd.jpg"
      contentid="the_id_of_my_song"
      length="240"
      bitrate="256"/>

---

Supported Attributes

Name: title
Type: string
Supported values
any string of text

Name: shortdesc
Type: string
Supported values
any string of text

Name: sdposterurl
Type: string
Supported values
any url pointing to a jpg, png or gif image

Name: hdposterurl
Type: string
Supported values
any url pointing to a jpg, png or gif image

Name: enableextensions
Type: boolean
Supported values
true|false

Name: enablescrapers
Type: boolean
Supported values
true|false

Name: live
Type: boolean
Supported values
true|false
Notes
If true then the length will be removed from the audio player and a live logo will be displayed instead.

Name: streamformat
Type: string
Supported values
mp3|mp4|wma
Notes
Use mp4 for m4a. Max audio bitrate is 256kbps.

Name: contentid
Type: string
Supported values
any string of text

Name: rbsurl
Type: string
Supported values
any url pointing to a "report broken stream" script
Notes
If this attribute is not included on an audio item then the global rbsurl pref will be used instead. This attribute is useful if you need to add a unique parameter to the rbsurl for each item. For example, you could add a different category parameter to each rbsurl attribute. rbsurl="http://yoursite.com/rbs.php?category=podcast"

Name: eiurl
Type: string
Supported values
any url pointing to an "email information" script
Notes
If this attribute is not included on an audio item then the global eiurl pref will be used instead. This attribute is useful if you need to add a unique parameter to the eiurl for each item.

Name: length
Type: integer
Supported values
the length of the audio item in seconds

Name: stickyredirects
Type: boolean
Supported values
true|false
Notes
Determines whether the http endpoint should be sticky and not subject to change on subsequent requests. This attribute is optional and if omitted the default value of false will be used.

Name: url
Type: string
Supported values
any url pointing to a compatible audio stream

Name: bitrate
Type: integer
Supported values
the bitrate of the audio item in kbps

Name: album
Type: string
Supported values
any string of text
Notes
If the album and/or artist attributes are included then they will be displayed as the short description on episodic poster screens and they will replace the full description on springboard screens. If both the album and artist are omitted then the shortdesc attribute will be displayed on episodic poster screens instead.

Name: artist
Type: string
Supported values
any string of text
Notes
If the album and/or artist attributes are included then they will be displayed as the short description on episodic poster screens and they will replace the full description on springboard screens. If both the album and artist are omitted then the shortdesc attribute will be displayed on episodic poster screens instead.

Name: releasedate
Type: string
Supported values
any string of text
Notes
There is no specific format for the date string. You can use "November 10, 2012" or "11/10/12" or "Sat Nov 10" or any other date format.

Name: starrating
Type: integer
Supported values
any integer between 1-100

Name: disableresumebtn
Type: boolean
Supported values
true|false
Notes
If this attribute is omitted the resume button will be displayed by default.

Name: disableplaybtn
Type: boolean
Supported values
true|false
Notes
If this attribute is omitted the play button will be displayed by default.

Name: disabledescriptionbtn
Type: boolean
Supported values
true|false
Notes
If this attribute is omitted the "view full description" button will be displayed by default.

Name: enablereportstreambtn
Type: boolean
Supported values
true|false

Name: enableemailmebtn
Type: boolean
Supported values
true|false

Name: enableemailfriendbtn
Type: boolean
Supported values
true|false

---

Supported Child Nodes

description

extension

scraper