ML Lua API

• Index

Contents

• Functions
• Fields
• Class lvinfo

Modules

• event
• battery
• camera
• console
• constants
• display
• dryos
• global
• interval
• key
• lens
• lv
• menu
• movie
• property
• task
• config
• keys
• logger

Examples

• api_test.lua
• calc.lua
• editor.lua
• copy2m.lua
• menutest.lua
• scrnshot.lua
• hello.lua
• config.lua
• keys.lua
• logger.lua
• strict.lua
• pong.lua
• recdelay.lua
• sokoban.lua

Module lv

LiveView functions

Info:

• Copyright: 2014
• License: GPL
• Author: Magic Lantern Team

Functions

start ()	Enter LiveView.
pause ()	Pause LiveView (but leave shutter open).
resume ()	Resume LiveView.
stop ()	Exit LiveView.
wait (num_frames)	Wait for N LiveView frames in LiveView.
info (definition)	Create a new LV info item

Fields

enabled	Whether or not LV is enabled (may be running or paused).
paused	Whether or not LV is paused (shutter open, but sensor inactive; useful for powersaving).
running	Whether or not LV is running (that is, enabled and not paused).
zoom	Get/set LiveView zoom factor (1, 5, 10).

Class lvinfo

lvinfo:update ()	Function called before displaying; can override strings, dimensions and so on
lvinfo.name	Get/Set the item name (for menu)
lvinfo.value	Get/Set the item value
lvinfo.background	Get/Set the item background color
lvinfo.foreground	Get/Set the item foreground color
lvinfo.custom_drawing	Get/Set if the item uses custom drawing
lvinfo.font	Get the item font assigned by the backend
lvinfo.height	Get/Set the item height
lvinfo.preferred_position	Get/Set the item's preferred position
lvinfo.priority	Get/Set the item priority: if there's not enough space, the items with low priority will disappear
lvinfo.bar	Get/Set the which bar the item appears on
lvinfo.width	Get/Set the item width; default: measured from value and fontspec; 0 = do not display this item at all
lvinfo.x	Get the item x position
lvinfo.y	Get the item y position

Functions

start ()

Enter LiveView.

pause ()

Pause LiveView (but leave shutter open).

resume ()

Resume LiveView.

stop ()

Exit LiveView.

wait (num_frames)

Wait for N LiveView frames in LiveView.

Parameters:

• num_frames int

info (definition)

Create a new LV info item

Parameters:

• definition table A table with the inital values for properties of the item

Returns:

lvinfo

Fields

enabled

Whether or not LV is enabled (may be running or paused).

• enabled bool

paused

Whether or not LV is paused (shutter open, but sensor inactive; useful for powersaving).

• paused bool

running

Whether or not LV is running (that is, enabled and not paused).

• running bool

zoom

Get/set LiveView zoom factor (1, 5, 10).

• zoom bool

Class lvinfo

Represents an info item that is displayed in the ML info bars in LiveView

lvinfo:update ()

Function called before displaying; can override strings, dimensions and so on

lvinfo.name

Get/Set the item name (for menu)

• name string

lvinfo.value

Get/Set the item value

• value string

lvinfo.background

Get/Set the item background color

• background int see constants.COLOR

lvinfo.foreground

Get/Set the item foreground color

• foreground int see constants.COLOR

lvinfo.custom_drawing

Get/Set if the item uses custom drawing

• custom_drawing bool

lvinfo.font

Get the item font assigned by the backend

• font int see constants.FONT

lvinfo.height

Get/Set the item height

• height int

lvinfo.preferred_position

Get/Set the item's preferred position

• preferred_position int

lvinfo.priority

Get/Set the item priority: if there's not enough space, the items with low priority will disappear

• priority int

lvinfo.bar

Get/Set the which bar the item appears on

• bar int

lvinfo.width

Get/Set the item width; default: measured from value and fontspec; 0 = do not display this item at all

• width int

lvinfo.x

Get the item x position

• x int

lvinfo.y

Get the item y position

• y int