grandMA3 User Manual Publication
GetDMXUniverse(integer[, boolean])
|
grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » GetDMXUniverse(integer[, boolean])
|
Version 2.2
|
Description
The GetDMXUniverse Lua function returns a table with the DMX channels and their current value.
Arguments
- Integer:
The integer is the universe number. The valid range is 1 to 1024. - Boolean (optional):
The boolean indicates if the returned value is in percent or DMX value.- True:
The returned value is in percent. The range is 0 to 100. - False:
The returned value is in DMX value. The range is 0 to 255.
- True:
Return
- Table:
The returned table lists all the DMX addresses and the corresponding values.
-- OR --
- Nil:
Nil is returned if the universe is not granted or the input value is out of range.
Example
This example prints the table in a list for DMX universe 1 (if it is granted):
Lua |
return function() -- This gets a table for universe 1 with the returned value in percent. local tableDMXUniverse = GetDMXUniverse(1,true) -- Check the returned table and print information if nil. if tableDMXUniverse == nil then Printf("No value is returned. The univer is not granted or input is out of range") return end -- Prints the table if not nil. for addr, value in ipairs(tableDMXUniverse) do Printf("DMX Addr: %i - DMX value : %i", addr, value) end end |