layout.md

Layout

• Overview
• Properties
  • orientation
  • scroll
  • error
• Styling
• Events
  • onlaunch
  • onvolumedown
  • onvolumeup
  • onresume
  • onpause

Overview

The layout file describes the visual components of a remote.

Properties

orientation

Lock the orientation of the layout using portrait or landscape.

<layout orientation="portrait">

</layout>

scroll

Set the scroll mode using none, vertical, horizontal, and both.

<layout scroll="veritcal">

</layout>

error

Display an error message instead of a proper layout.

<layout error="Could not find required data.">

</layout>

Styling

See the styling page for more details.

Events

onlaunch

Occurs when the "launch" button is pressed in a remote.

<layout onlaunch="launch">

</layout>

actions.launch = function ()
    ...
end

onvolumedown

Occurs when the "volume down" button is pressed on the client device.

<layout onvolumedown="volume_down">

</layout>

actions.volume_down = function ()
    ...
end

onvolumeup

Occurs when the "volume up" button is pressed on the client device.

<layout onvolumeup="volume_up">

</layout>

actions.volume_up = function ()
    ...
end

onpause

Occurs when the client device wishes to pause (for example phone call received).

<layout onpause="pause">

</layout>

actions.pause = function ()
    ...
end

onresume

Occurs when the client device wishes to resume (for example phone call finished).

<layout onresume="resume">

</layout>

actions.resume = function ()
    ...
end