Module lv
LiveView functions
Functions
start() | Enter LiveView. |
pause() | Pause LiveView (but leave shutter open). |
resume() | Resume LiveView. |
stop() | Exit LiveView. |
wait(num_frames) | Wait for N 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). |
overlays | Get the status of LiveView overlays (false = disabled, 1 = Canon, 2 = ML) |
vidmode | Get the name of current LiveView video mode. |
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 whether 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 horizontal position (signed integer, look up other struct lvinfo_item items in ML source code). |
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 (see enum lvinfo_bar in lvinfo.h). |
lvinfo.width | Get/Set the item width; default: measured from value and fontspec. |
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 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:
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
- overlays
-
Get the status of LiveView overlays (false = disabled, 1 = Canon, 2 = ML)
- overlays int
- vidmode
-
Get the name of current LiveView video mode.
Examples: MV-1080, MV-720, MVC-1080, REC-1080, ZOOM-X5, PH-LV, PH-QR, PLAY-PH, PLAY-MV...
- vidmode string
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 whether the item uses custom drawing.
- custom_drawing bool
- lvinfo.font
-
Get the item font assigned by the backend.
- font int readonly see constants.FONT
- lvinfo.height
-
Get/Set the item height.
- height int
- lvinfo.preferred_position
-
Get/Set the item's preferred horizontal position (signed integer, look up other
struct lvinfo_item
items in ML source code).- preferred_position int (default 0)
- lvinfo.priority
-
Get/Set the item priority: if there's not enough space, the items with low priority will disappear.
- priority int (default 0)
- lvinfo.bar
-
Get/Set the which bar the item appears on (see enum lvinfo_bar in lvinfo.h).
TODO: constants.
- bar int (default anywhere)
- 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 readonly
- lvinfo.y
-
Get the item y position.
- y int readonly