ORML

orml (2) specification (1)
kavulix

ORML Version 1.2

Supported Elements
ORML
CHANNEL
FEED
ITEM
ROW
DESCRIPTION
BODY
POLICY
STREAM
IMAGE
SCRAPER
EXTENSION

OpenRokn Feeds
There are two types of ORML feeds supported by OpenRokn. All ORML feeds MUST begin with an orml element containing a version and namespace attribute. The second element can be either a "channel" or "feed" element. It is the second element that determines whether it will be a primary or secondary feed.

Primary feeds
Your Roku channel will typically only contain a single primary feed. The one exception is the search item which requires that search results be returned as a primary feed. All primary feeds MUST contain a channel element as the first child node of the orml element.

<orml version="1.2" xmlns="http://sourceforge.net/p/openrokn/home/ORML">
   <channel>
   </channel>
</orml>

Primary feeds are used when you need the initial screen to be either a poster or grid screen (e.g., when a channel first loads). The channel element tells the software to expect either a poster or grid as the first item. If neither a poster or grid item is detected then the channel will exit or in the case of search items it will alert the user that no results were found.

The first poster or grid item in a primary feed is slightly different from other poster/grid items in that you only need to provide a style and title attribute. Since the first item is never displayed on a poster screen you won't need to provide the sdposterurl, hdposterurl or shortdesc attributes. The title that you choose will be the first breadcrumb text displayed in the top right corner of the screen.

<orml version="1.2" xmlns="http://sourceforge.net/p/openrokn/home/ORML">
   <channel>
      <item type="poster" style="flat-category" title="Home">
      </item>
   </channel>
</orml>

Secondary feeds
A secondary feed is a feed that is used to populate a poster screen or a row on a grid screen and is used in combination with the feedurl attribute. All secondary feeds MUST contain a feed element as the first child node of the orml element. The first item element can be any of the supported types. It does not have to be a poster or grid item. Secondary feeds are described in more detail on the poster and grid pages. Below is a secondary feed example.

<orml version="1.2" xmlns="http://sourceforge.net/p/openrokn/home/ORML">
  <feed>
    <item type="document">
       <description>This is a document</description>
    </item>
    <item type="video">
       <description>This is a video</description>
    </item>
  </feed>
</orml>
MongoDB Logo MongoDB