ORML

ORML Version 1.1

---

There are a total of 8 item types/screens supported by OpenRokn. All Roku screens supported by OpenRokn are considered items. Each screen is represented by an item element in orml feeds. When you want to add a new screen or new media object to your feed you simply add a new item tag. The screen type is then specified with the type attribute.

Item types: poster, grid,
audio,
video,
slideshow,
document,
settings,
search

---

All ORML feeds MUST begin with an orml element containing a version and namespace attribute.

Primary feeds
Your Roku channel will typically contain only a single primary feed. The one exception is the search screen. The primary feed contains the main layout for your channel and its url should be embedded within the settings.brs file. All primary feeds MUST contain a channel element as the first child node of the orml element.

---

<orml version="1.1" 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 notifies 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. Therefore it is important that the type attribute of the first item in your primary feed contains the poster or grid value. 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.

---

<orml version="1.1" 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 typically 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 screen. Secondary feeds are described in more detail on the poster and grid pages. Below is a secondary feed example.

---

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