Contact Us
This article discusses the API command string getPerformanceMonitoringValuesJsonEx, which provides a performance readout of all connected systems.
API Commands
Use
There is an API command that allows you to retrieve certain performance metrics from the connected clients.
getPerformanceMonitoringValuesJsonEx(string filter)
This command also offers filter options:
system, outputs, outputsIndividual, outputsTotal, unreal
Multiple filters can be used at once (see example down below)
This command will provide the same data as the performance monitoring values in the GUI itself.
Depending on whether the engine is open, engine values are also read; these values can be reset using the API command resetCumulativePerformanceMonitoringValues()
Alternatives
Performance Monitoring with getPerformanceMonitoringValuesJsonEx
Monitoring the status of a Live System with getStructureJson()
Examples
-- example code to read out all existing connected live systems
local systems = Pixera.LiveSystems.getLiveSystems()
for i,n in pairs(systems) do
pixc.log(n.getPerformanceMonitoringValuesJsonEx("system,outputsIndividual"))
end
PIXERA 26.2 | 23. July 2026 | J.B.