ORML

kavulix
There is a newer version of this page. You can find it here.

ORML Version 1.2


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


OpenRokn Feeds
There are two types of xml feeds supported by OpenRokn, primary and secondary feeds. All ORML feeds MUST begin with an orml element containing a version and namespace attribute.

Primary feeds
Your Roku channel will typically only contain a single primary feed. The one exception is the search_item. The primary feed contains the main layout for your channel and determines which content is displayed when the channel first loads. 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. The first item in a primary feed is slightly different from other items in that you only need to provide a style and title attribute. Since the item isn't displayed as a poster you won't need to provide the sdposterurl or hdposterurl attributes.


<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_item and grid_item pages. Below is a secondary feed example.


<orml version="1.2" xmlns="http://sourceforge.net/p/openrokn/home/ORML">
  <feed>
    <item type="document">
    </item>
    <item type="video">
    </item>
  </feed>
</orml>

MongoDB Logo MongoDB