grandMA3 User Manual Publication
SelectedTimecode()
grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » SelectedTimecode()
Version 2.0

Description

The SelectedTimecode Lua function returns the handle of the selected timecode object.

The selected timecode object is the Timecode show currently selected in the Timecodes pool. Learn more in the Timecodes topics.

Arguments

This function does not accept any arguments.

Return

  • Handle:
    The returned handle for the selected timecode object.

Example

This example prints all information about the selected timecode show in the Command Line History using the Dump() function:

Dump()

The Dump() function returns a string with information about the object, for instance, the name, class, path of the object, its properties, and children.

Learn more in the Dump() topic.

Lua
return function ()
-- The following prints the dump for the selected timecode object
local myTimecodeShow = SelectedTimecode()
if myTimecodeShow ~= nil then
Printf("=============== START OF DUMP ===============")
myTimecodeShow:Dump()
Printf("================ END OF DUMP ================")
end
end