State
• State
____◦ General
________▪ DXMode STRING
________DirectX version to use. 11 or 12.
________▪ EditorStartupOptions MAP
________Additional options to use when launching Pixotope Engine.
________Refer to Unreal Engine documentation for more info.
element
____________• Enabled BOOLEAN
____________• Label STRING
____________• Arguments STRING
________▪ CompositingColorSpace STRING
________Internal compositing color space. Video or Linear.
________▪ MultimachineSyncing STRING
________▪ CameraSwitchingEnabled BOOLEAN
________▪ AllowNegativeBuffer BOOLEAN
________▪ AllowSubFrameDelay BOOLEAN
________▪ AllowSetExtensionDelay BOOLEAN
____◦ Experimental
________▪ FileInput BOOLEAN
________▪ ExperimentalVideoIOOutput BOOLEAN
________▪ VideoIODebugTools BOOLEAN
____◦ ActiveCameras STRING ARRAY
____◦ Defaults
________▪ Units STRING
________Default tracking units. CM or Inches.
________▪ VideoFormat
____________• FrameRate STRING
____________• Resolution STRING
________▪ Type STRING
________Default video input type. AJA File BMD or NDI.
________▪ ColorProfile STRING
________▪ ColorSpace STRING
________▪ Delays
____________• Tracking NUMBER
____________• ExecutionTime NUMBER
____________• Video NUMBER
____________• Audio NUMBER
____◦ Machines MAP
element
________▪ Timecode
____________• Selection
________________◦ 1 STRING
________________◦ 2 STRING
________________◦ 3 STRING
________________◦ 4 STRING
____________• Enabled BOOLEAN
________▪ Trackers MAP
____________• Map element:
________________◦ FrameMatchingMethod STRING
________________◦ Delay NUMBER
________▪ ExecutionTimeOffset NUMBER
________▪ GenlockUnsyncedReceiving BOOLEAN
________▪ UnsyncedDelayInFrames NUMBER
________▪ UnsyncedDelayInMilliseconds NUMBER
________▪ Routing MAP
____________• Map element:
________________◦ IOType STRING
________________◦ Name STRING
________________◦ Camera STRING
________________cameraID or undefined if media input
________________◦ UsedForCalibration BOOLEAN
________________◦ VideoFormat
____________________▪ FrameRate STRING
____________________▪ Resolution STRING
________________◦ ColorProfile STRING
________________◦ ColorSpace STRING
________________◦ SMPTEColorRange BOOLEAN
________________◦ Format STRING
________________◦ InputType STRING
________________◦ Type STRING
________________◦ Parent STRING
________________◦ Audio
____________________▪ Enabled BOOLEAN
____________________▪ Delay NUMBER
________________◦ Network
____________________▪ Video
________________________• Codec STRING
________________________• BitrateScale NUMBER
________________________• SRTLatency NUMBER
________________________• Profile STRING
________________________• Threads NUMBER
________________________• TransportFormat STRING
________________________• PixelFormat STRING
________________________• GOPSize NUMBER
________________________• PassPhrase STRING
________________________• Mode STRING
____________________▪ Tracking
________________________• OverrideTargetIP STRING NULL
________________________• OverridePlatformIP STRING NULL
________________________• TargetPort NUMBER
________________________• PlatformPort NUMBER
________________________• ProtocolIn STRING
________________________• ProtocolOut STRING
________________◦ Delay NUMBER
________________◦ Sharpen
____________________▪ Enabled BOOLEAN
____________________▪ Amplitude NUMBER
____________________▪ Profile NUMBER
________________◦ Video STRING
________________this correspnds to how the videoio is routed in pixotope SDI1 or File or etc
________________◦ Visualizer
____________________▪ Enabled BOOLEAN
____________________▪ Active BOOLEAN
____________________▪ HistogramEnabled BOOLEAN
____________________▪ VectorScopeEnabled BOOLEAN
____________________▪ WaveformEnabled BOOLEAN
____________________▪ ShowLogs BOOLEAN
____________________▪ ShowStatus BOOLEAN
____________________▪ ShowTimecode BOOLEAN
____________________▪ DebugTimers BOOLEAN
________________◦ BPE
____________________▪ Enabled BOOLEAN
____________________▪ Active BOOLEAN
____________________▪ ShowSkeleton BOOLEAN
____________________▪ CameraFocalLength NUMBER
____________________▪ DrawLines BOOLEAN
____________________▪ SendDH2 BOOLEAN
________▪ LocalChains MAP
____◦ CameraSets MAP
____◦ ColorMatching
________▪ ARLUT STRING
________▪ ARMachines STRING ARRAY
________▪ XRMachines STRING ARRAY
________▪ Samples NUMBER
________▪ IsCalibrateLEDWall BOOLEAN
________▪ IsColorMatchARtoLEDWall BOOLEAN
________▪ CalibrationMachines STRING ARRAY
____◦ Cameras MAP
element
________▪ Name STRING
________▪ Ancillary
____________• Fingerprint STRING
____________• CameraType STRING NULL
____________TODO REMOVE
____________• AssignedGroup STRING
________▪ Input
____________• TrackingProtocol STRING
____________• CameraSpecific
____________null only when object
________________◦ FilmbackWidth NUMBER
________________◦ FilmbackHeight NUMBER
________________◦ Aperture NUMBER
________________◦ EnableDOF BOOLEAN
________________◦ DistortionModel STRING
________________◦ EnableFilmback BOOLEAN
________________◦ EnableAperture BOOLEAN
____________• LengthUnits STRING
____________• AngleUnits STRING
____________• AxisPositives
________________◦ X STRING
________________◦ Y STRING
________________◦ Z STRING
____________• RotationPositives
________________◦ Pan STRING
________________◦ Tilt STRING
________________◦ Roll STRING
________▪ PositionOffsets
____________• Type STRING
____________• Value
________________◦ GlobalPosition
____________________▪ X NUMBER
____________________▪ Y NUMBER
____________________▪ Z NUMBER
________________◦ GlobalRotation
____________________▪ X NUMBER
____________________▪ Y NUMBER
____________________▪ Z NUMBER
________________◦ CameraRotation
____________________▪ Pan NUMBER
____________________▪ Tilt NUMBER
____________________▪ Roll NUMBER
________________◦ MountedPosition
____________________▪ X NUMBER
____________________▪ Y NUMBER
____________________▪ Z NUMBER
________________◦ Height NUMBER
________________◦ MainArmLength NUMBER
________________◦ ExtenderLength NUMBER
________________◦ DropLength NUMBER
________________◦ SwingOffset NUMBER
________________◦ ElevateOffset NUMBER
________________◦ InvertSwing BOOLEAN
________________◦ InvertElevate BOOLEAN
________▪ LensOffsets
____________• FieldOfView NUMBER
____________• FocusDistance NUMBER
____________• Aperture NUMBER
____________• CX NUMBER
____________• CY NUMBER
____________• NodalX NUMBER
____________• ShowCrosshair BOOLEAN
____________• K1 NUMBER
____________• K2 NUMBER
________▪ LensFileConfig
____________• UseLensFile BOOLEAN
____________• LensFilePath STRING
____________• ZoomEncoderOut NUMBER
____________• ZoomEncoderIn NUMBER
____________• FocusEncoderNear NUMBER
____________• FocusEncoderFar NUMBER
____________• EnableDOF BOOLEAN
____________• EnableDistortion BOOLEAN
____________• EnableNodal BOOLEAN
____________• EnableFOV BOOLEAN
____________• EnableCenterOffset BOOLEAN
____◦ Chromakeys MAP
element
________▪ Enabled BOOLEAN
________▪ OutputKey BOOLEAN
________▪ OutputKeyVisualizeExtremes BOOLEAN
________▪ KeyerModel STRING
________▪ ShaderParams
____________• BackgroundPicks [NUMBER,NUMBER,NUMBER] ARRAY
____________• ForegroundPicks [NUMBER,NUMBER,NUMBER] ARRAY
____________• EnableCleanPlate BOOLEAN
____________• ForegroundThreshold NUMBER
____________• BackgroundThreshold NUMBER
____________• ShadowStrength NUMBER
____________• ShadowContrast NUMBER
____________• DespillLuma NUMBER
____________• DespillChroma NUMBER
____________• DespillCutoff NUMBER
____________• EnableAutoDespill BOOLEAN
____________• DespillHue NUMBER
____________• MaskGamma NUMBER
____________• MaskGain NUMBER
____________• LumaKeyIntensity NUMBER
____________• ErodeSize NUMBER
____________• ColorKeyIntensityR NUMBER
____________• ColorKeyIntensityG NUMBER
____________• ColorKeyIntensityB NUMBER
____________• ColorKeyStrength NUMBER
____________• DetailEnhancement NUMBER
____________• Denoise NUMBER
____________• Respill NUMBER
____________• RespillUseCustomColor BOOLEAN
____________• RespillCustomColor [NUMBER,NUMBER,NUMBER]
____________• MultiplyFillWithKey BOOLEAN
____◦ Projects STRING ARRAY
____◦ Version STRING
____◦ Sync
________▪ CommonSyncDelay NUMBER
________▪ ProjectionDelay NUMBER
________▪ EnableExtrapolation BOOLEAN
________▪ AlignmentMethod STRING
____◦ MachineGroupings
________▪ Default
____________• AR STRING ARRAY
____________• XR STRING ARRAY
________▪ Custom MAP
____◦ FeatureFlags
________▪ ShowCameraTypes CAMERATYPES
________▪ Diagnostics
____________• NetworkCheck
________________◦ Latest
____________________▪ Individual INDIVIDUALMACHINERES
____________________▪ Total
________________________• AverageResponseTime NUMBER
________________________• MaxResponseTime NUMBER
________________________• MinResponseTime NUMBER
________________________• MaxDiffOverAverage NUMBER
________________________• TotalRating
____________________________◦ Value NUMBER
____________________________◦ Description STRING
________________________• LastUpdated NUMBER
________▪ Presets
____________• VideoKeyer PANELPRESETS(CHROMAKEY)
________▪ TrackMen
Non-state values
• ConnectedClients
Returns an array with all currently connected services (services that currently respond to heartbeats).
Value example: "[{"Name":"Machine1-CTS", "Role":"CTS"},…]"
• Shows
Returns an array of all shows available on this store (reads the files available on disk).
Value example: ["DefaultShow",…]
• CurrentShow
Returns the name of the currently open show.
Value example: "DefaultShow"
• CameraTypes
Returns the list of all camera types, default plus show specific
Value example: "[{"id":0, "label":"2/3inch - 16:9","camera_name":"2/3inch - 16:9","width":"9.59","height":"5.39"},…]"
• DefaultKeyerParameters
• DefaultSharpenParameters
• CompositingColorSpaceOptions
