Instant TV Channel MRSS Elements

The following special XML elements are understood by the Instant TV Channel MRSS parser. If present, these elements override any equivalent Content Editor parameters.

A note about MRSS XML Optimization Due to the manner in which Instant TV Channel optimizes the parsing of MRSS XML, if your MRSS items do not all contain the same tags, then the first item in your MRSS feed must contain all tags used in the rest of the items in the feed. If necessary, create a "template" 1st item with a true irc:donotdisplay tag along with all other tags from the feed. Tags present in the 2nd and subsequent items in the MRSS feed that are not also present in the 1st item are ignored.
  • irc:actors - Up to 3 comma-separated actor names. Displayed in bold text above the description on the Springboard/Detail screen
  • irc:album - The album for an audio item. Appears on Audio/MP3 Springboard/Detail screens.
  • irc:artist - The artist of an audio item. Appears on Audio/MP3 Springboard/Detail screens, and as the ShortDescriptionLine2 parameter for the parent List if the irc:ShortDescriptionLine2 element is not present.
  • irc:audioformat - If set to "dolby-digital", then the "5.1 ))" icon will be displayed between the HD flag and Director fields on the Springboard/Detail screen. Does not determine actual audio format.
  • irc:categories - Category, genre, or keyword for the content item. May be two comma-separated words or short phrases. Appears on the Springboard/Detail screen beneath the Length field.
  • irc:deeplinkid - A unique ID to be used along with the MRSS item's own DeepLinkId when constructing a combined Roku deep linking contentId string.
  • irc:description - The description of the content item. Appears on the Springboard/Detail screen.
  • irc:director - The director's name. Appears on the lower right of the Springboard/Detail screen beneath the description, after the HD and Dolby flags.
  • irc:donotdisplay - If "true" then this item will not be displayed. This might be used if this item is a trailer video, or if this item is a template for the feed.
  • irc:fhdbif - The URL for the optional FHD BIF file.
  • irc:gridrowtitle - The Row title, if the MRSS file is used as a complete Grid Row. Has no effect if not used as a Grid Row.
  • irc:hdbif - The URL for the HD BIF file.
  • irc:hdbranded - If set to "false", then "HD" will not be displayed to the right of the Rating on the Springboard/Detail screen for HD streams. Does not determine actual video quality.
  • irc:hdbufferpictureurl - The URL for an HD (1280x720) fullscreen image to be displayed while the video stream is buffering.
  • irc:hdlistposter - The URL for an HD poster image or thumbnail for the content item. Appears in the parent List or Grid. The ListDisplayMode parameter determines how the image is scaled for display in the parent List or Grid. If this element is missing, the irc:poster element is used instead.
  • irc:hdposter - The URL for an HD poster image or thumbnail for the content item. Appears in the Springboard/Detail screen. The DisplayMode parameter determines how the image is scaled for display in the Springboard/Detail screen. If this element is missing, the irc:poster element is used instead.
  • irc:length - The length in seconds of the content item. Appears on the lower left of the Springboard/Detail screen beneath the description, before the Release Date field. Affects display of Springboard play, resume, and play again buttons. Can be represented as a number of seconds or in hh:mm:ss format.
  • irc:live - If set to "true", then the "play from beginning" button will be removed from the Springboard/Detail screen.
  • irc:midroll - The position in seconds within a video stream at which a midroll video advertisement may appear. Values less than 1 are ignored. Must be contained within an irc:midrolls element.
  • irc:midrolls - A container element for the video advertisement midroll postion irc:midroll sub-element.
  • irc:password - If this element is present, then the content item will be password protected.
  • irc:passwordeverytime - If set to "true", then the password must be entered every time the item is accessed.
  • irc:passwordsetsecuretext - If set to "false", then the password will be displayed as it is entered on the screen.
  • irc:playallbutton - If set to "false", then the "play all" button will be removed from the Series Springboard/Detail screen.
  • irc:playduration - The maximum playback duration. Limits the playback duration to less than the actual content length. Includes PlayStart time. If not present or zero, plays the content through to the end. Can be represented as a number of seconds or in hh:mm:ss format.
  • irc:playstart - The playback start offset. If not present or zero, then playback starts at the beginning of the content. Can be represented as a number of seconds or in hh:mm:ss format.
  • irc:poster - The URL for an image or thumbnail for the content item, used for HD and SD displays. Appears on the Springboard/Detail screen and in the parent List or Grid. The DisplayMode and ListDisplayMode parameters determine how the image is scaled for display on the Springboard/Detail screen and in the parent List or Grid. This element is ignored if the more specific irc:hdposter, irc:sdposter, irc:hdlistposter and irc:sdlistposter elements are provided.
  • irc:rating - Usually the MPAA or TV rating, but may be any text. Appears between the Release Date field and the HD flag on the Springboard/Detail screen.
  • irc:releasedate - Usually the release date of the content item, but may be any text. Appears between the Length and Rating fields on the Springboard/Detail screen.
  • irc:sdbif - The URL for the optional SD BIF file.
  • irc:shortdescriptionline1 - The 1st line of text that appears beneath the selected poster on the parent Horizontal List or in Grid "top" descriptions.
  • irc:shortdescriptionline2 - The 2nd line of text that appears beneath the selected poster on the parent Horizontal List or in Grid "top" descriptions.
  • irc:srt - The URL for an optional SRT subtitle file.
  • irc:streamformat - The format of the stream. Currently supported values are: "mp4", "wma", "mp3", "hls", and "ism".
  • irc:stream - A sub-element for the irc:streams element used for ABR (Adaptive Bit Rate) streams. Must be contained within an irc:streams element. By convention, multiple irc:stream elements are ordered from lowest bitrate to highest bitrate. Has the following attributes:
    • url - The URL of the content item. Must point to a Roku-compatible video or audio stream matching the format specified by the irc:streamformat element, or the Content Editor's StreamFormat parameter if the irc:streamformat element is not present.
    • bitrate - The average bitrate in Kbps of the content item pointed to by the url attribute.
    • contentid - A unique content ID for this stream element. Must be unique. If not provided then one is generated automatically. The content ID from the first stream element in a video is included in Google Analytics reports.
    • quality - Set to "hd", "fhd", or "uhd" for 1280x720, 1920x1080, or 3840x2160 resolutions respectively. Otherwise set to "sd".
    • stickyredirects - Set to "true" if the HTTP endpoint should be sticky and not subject to change on subsequent requests.

    If only using a single stream, consider using irc:url instead of irc:streams and irc:stream.
  • irc:streams - A container element for the ABR (Adaptive Bit Rate) irc:stream element. This element and any sub-elements are ignored if the irc:url element is present.
  • irc:subtitle - A sub-element for the irc:subtitles element used for streams that require multiple language subtitles. Must be contained within an irc:subtitles element. Has the following attributes:
    • trackId - The subtitle URL or track source/id. For example "http://domain.com/subtitle.srt" or "eia608/1".
    • trackDescription - The track description to be shown in the closed caption configuration dialog.
    • trackLanguage - The 2 or 3 character ISO 639 language code, for example "en".

    If only using a single SRT file, consider using irc:srt instead of irc:subtitles and irc:subtitle.
  • irc:subtitles - A container element for the irc:subtitles element used for streams that require multiple language subtitles. This element and any sub-elements are ignored if the irc:srt element is present.
  • irc:title - The title of the content item. Appears at the top of the Springboard/Detail screen and as the ShortDescriptionLine1 parameter for the parent List if the irc:ShortDescriptionLine1 element is not present.
  • irc:titleseries - The series title of the content item. If present, is displayed on the Springboard/Detail screen in place of the Title.
  • irc:trackidsubtitle - The subtitle streaming format followed by the name of the corresponding stream index. For example: "eia608/1" or "ism/textstream_eng". Not used for SRT caption files.
  • irc:trailerbackgroundurl - The URL for a Trailer background image displayed beneath the Trailer video, or in place of the Trailer video if none has been provided. Typically this image is a screenshot from the main video. This image is scaled to fit full screen.
  • irc:traileroverlayurl - The URL for a partially transparent image which is overlayed onto this item's Springboard, parent List, or parent Grid when the item is focused or highlighted. Typically this image contains text or logo artwork related to the main video item. This image is scaled to fit full screen.
  • irc:traileruid - The 36-character Content UID or the DeepLinkId of a trailer video.
  • irc:url - The URL of the content item. Must point to a Roku-compatible video or audio stream matching the format specified by the irc:streamformat element, or the Content Editor's StreamFormat parameter if the irc:streamformat element is not present.


Example MRSS Feed Fragment

Example Adaptive Bitrate MRSS Feed Fragment

Example Multiple Subtitle Feed Fragment

Information about using MRSS feeds within Instant TV Channel can be found here.

Questions or comments concerning Instant TV Channel can be emailed to .

Instant TV Channel is a cloud-based tool for Roku developers and content providers that shortens development time and eases maintenance after deployment.


Subtitles

If you are considering subtitles for your Roku video content, our sister-site InstantSubtitles.com provides an easy-to-use and inexpensive solution. Click here for more information.




Access Code: ID1
Check out Instant TV Channel by adding our latest demonstration channel to your Roku player.



Instant TV Channel is not affiliated with nor endorsed by Roku Inc.