Contact Us
An instance path is a specific path used to access an instance within a system. In Pixera's API, the instance path is often used in various commands to identify specific objects or resources.
Usage
For example, the command Pixera.Timelines.Cue.getInst(“Timeline 1.Cue 1”) can be used to obtain an instance of a cue object, where “Timeline 1.Cue 1” is the specific instance path.
In addition, there are functions such as getHandleFromInstancePath and getInstancePath that allow you to obtain handles from instances or, conversely, retrieve the Instance Path from a given handle.
These concepts are important for interacting with the API and managing resources within the system.
Warning
Starting with 25.2 Layer Groups affect those Instance Paths!
For example, when searching for the instance path to a layer.
Without Layer Group
local layerName = Pixera.Timelines.Layer.getInst('Timeline.Layer 1').getName()
pixc.log(layerName)
With Layer Group
local layerName = Pixera.Timelines.Layer.getInst('Timeline.Layer Group.Layer 1').getName()
pixc.log(layerName)Tip
You can use the Blockbuilder to figure out the instace path:
PIXERA 25.3 INTER 44 | 10. November 2025 | J.B.