State
• State
____◦ Compositing
________▪ VideoOutputColorSpacePassthrough boolean
________▪ OCIOConfigPath string
________▪ MachineInfoVisualizer
____________• Enabled boolean
____________• ShowMachineName boolean
____________• ShowResolution boolean
____________• ShowColorSpace boolean
____________• ShowRoutingName boolean
____________• ShowTimecode boolean
____________• ShowGenlock boolean
____________• ShowPerformance boolean
____________• ShowRenderGroup boolean
________▪ XR
____________• DOFEnable boolean
____________• DOFGain number
____________• DisplayMode string
____________• Mode "InnerFrustumOnly" "FrameEverythingInSingleFrustum" "SeparateInnerAndOuterFrustum"
____________• SampleOutsideFrustumColor Color
____________• RenderOutsideType string
____________• UpdateFrequencyOfOutsideCameraView number
____________• Overscan number
____________• DisableMotionBlur boolean
____◦ General
________▪ FrameRate number
________▪ EnableFilmicTonemapper boolean
________▪ MultimachineSyncing string
________▪ CameraSwitchingEnabled boolean
________▪ AllowNegativeBuffer boolean
________▪ AllowSubFrameDelay boolean
________▪ AllowSetExtensionDelay boolean
________▪ AllowAdvancedOptions boolean
____◦ Experimental
________▪ ExperimentalVideoIOOutput boolean
________▪ VideoIODebugTools boolean
____◦ ActiveCameras string array
____◦ Defaults
________▪ Units string
________Default tracking units. CM or Inches.
________▪ EditorOptions map
________Additional options to use when launching Pixotope Engine.
________Refer to Unreal Engine documentation for more info.[data-colorid=m8k6zw95un]{color:#97a0af} html[data-color-mode=dark] [data-colorid=m8k6zw95un]{color:#505968}[data-colorid=i6docsckq4]{color:#97a0af} html[data-color-mode=dark] [data-colorid=i6docsckq4]{color:#505968}[data-colorid=ub8djjia7z]{color:#97a0af} html[data-color-mode=dark] [data-colorid=ub8djjia7z]{color:#505968}[data-colorid=singuv635e]{color:#97a0af} html[data-color-mode=dark] [data-colorid=singuv635e]{color:#505968}element____________• Enabled BOOLEAN____________• Label STRING____________• Arguments STRING____________• Editor BOOLEAN____________• Live BOOLEAN________▪ VideoIOOptions map
________Additional options to use when launching Pixotope Pipeline.element____________• Enabled BOOLEAN____________• Label STRING____________• Arguments STRING________▪ VideoFormat
____________• Resolution string
____________• CustomResolutionWidth number
____________• CustomResolutionHeight number
________▪ Type string
________Default video input type. AJA File BMD or NDI.
________▪ ColorSpace string
________▪ Delays
____________• Tracking number
____________• ExecutionTime number
____________• Video number
____________• Audio number
____◦ Machines map element________▪ Refsource STRING________▪ Timecode____________• Config________________◦ 1 TIMECODESELECTIONOPTIONS________________◦ 2 TIMECODESELECTIONOPTIONS________________◦ 3 TIMECODESELECTIONOPTIONS________________◦ 4 TIMECODESELECTIONOPTIONS____________• Enabled BOOLEAN________▪ PixelStreaming____________• Enabled BOOLEAN________▪ Trackers MAP____________• Map element:________________◦ FrameMatchingMethod STRING________________◦ Delay NUMBER________________◦ UseLensDelay BOOLEAN________________◦ LensDelay NUMBER________▪ UseGlobalExecutionTimeOffset BOOLEAN________▪ ExecutionTimeOffset NUMBER________▪ Routing MAP____________• Map element:________________◦ IOType STRING________________◦ Name STRING________________◦ Camera STRING________________cameraID or empty if media input________________◦ VideoFormat____________________▪ Resolution STRING____________________▪ CustomResolutionWidth NUMBER____________________▪ CustomResolutionHeight NUMBER________________◦ ColorSpace STRING________________◦ SMPTEColorRange BOOLEAN________________◦ SBColorRange BOOLEAN________________◦ Format STRING________________◦ InputType STRING________________◦ Type STRING________________◦ Parent STRING________________◦ Source VIDEOIOSOURCETYPE________________◦ Audio____________________▪ Delay NUMBER____________________▪ EmbedAudioEngine STRING____________________▪ PassThroughAudio STRING________________◦ Network____________________▪ Video________________________• Codec STRING________________________• BitrateScale NUMBER________________________• SRTLatency NUMBER________________________• Profile STRING________________________• Threads NUMBER________________________• TransportFormat STRING________________________• PixelFormat STRING________________________• GOPSize NUMBER________________________• PassPhrase STRING________________________• Mode STRING____________________▪ SMPTE2110 SMPTE2110________________◦ Delay NUMBER________________◦ File____________________▪ Folder STRING____________________▪ Running BOOLEAN____________________▪ Stopped BOOLEAN____________________▪ LoopbackEnabled BOOLEAN________________◦ Sharpen____________________▪ Enabled BOOLEAN____________________▪ Amplitude NUMBER____________________▪ Profile NUMBER________________◦ NormalGeneration____________________▪ Enabled BOOLEAN________________◦ DepthGeneration____________________▪ Enabled BOOLEAN________________◦ XRCSC STRING________________◦ Video STRING________________this is the "address" so SDI1 for example when using AJA or filename when using file________________◦ Device NUMBER________________◦ 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________________◦ ExtractTracking____________________▪ Enabled BOOLEAN____________________▪ Channel NUMBER____________________▪ AudioPacketID NUMBER________________◦ AvalancheChannelIndex NUMBER________________◦ XRMapping? STRING________▪ LocalChains MAP________▪ InputUsedForCalibration STRING________▪ RefsourceData STRING________▪ RefsourceResolution STRING____◦ CameraSets map
____◦ ColorMatching
________▪ ARLUT string
________▪ ARMachine string
________▪ Samples number
________▪ IsCalibrateLEDWall boolean
________▪ IsColorMatchARtoLEDWall boolean
________▪ CalibrationMachines string array
________▪ ShouldAbortEarly boolean
________this is a hacky
________▪ EnableCalibrationMachines boolean
________▪ CalibrationLatencyLeniency number
________give people a recourse if the auto latency should be wrong for some reason (but if so thats a bug and also needs to be fixed)
____◦ 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________▪ KeyerMode STRING________▪ OutputKey BOOLEAN________▪ OutputKeyVisualizeExtremes BOOLEAN________▪ ShaderParams____________• BackgroundPicks [NUMBER,NUMBER,NUMBER] ARRAY____________• ForegroundPicks [NUMBER,NUMBER,NUMBER] ARRAY____________• ShadowPicks [NUMBER,NUMBER,NUMBER] ARRAY____________• EnableCleanPlate BOOLEAN____________• Erode NUMBER____________• ForegroundThreshold NUMBER____________• BackgroundThreshold NUMBER____________• ShadowContrast NUMBER____________• ShadowDarkening NUMBER____________• ShadowCompositingInEngine BOOLEAN____________• DespillLuma NUMBER____________• DespillChroma NUMBER____________• DespillCutoff NUMBER____________• DespillHue NUMBER____________• DespillContrastCompensate BOOLEAN____________• MaskGamma NUMBER____________• MaskGain NUMBER____________• LumaKeyIntensity NUMBER____________• DetailEnhancement NUMBER____________• Respill NUMBER____________• RespillEdges NUMBER____________• RespillUseCustomColor BOOLEAN____________• RespillCustomColor [NUMBER,NUMBER,NUMBER]____________• EdgeCorrection NUMBER____________• ErodeSize NUMBER____________• DepthTreshold NUMBER____◦ ChromakeysMeta map
____◦ Projects string array
____◦ Version string
____◦ Sync
________▪ CommonSyncDelay number
________▪ ProjectionDelay number
________▪ EnableExtrapolation boolean
________▪ TimecodeType string
________▪ SyntheticTimecodeProvider string
____◦ MachineGroupings
________▪ Default
____________• AR string array
____________• VS string array
____________• ARVS string array
____________• XR string array
________▪ Custom map
________▪ Features
____________• NoDelay string array
____________• MultiCameraPreview string array
____________• MOTION string array
____◦ 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
____________• DataMapper
________________◦ State DataMapperState
________________◦ Data DataMapperData
____________• RenderBackup
________________◦ ParameterThresholds map element____________________▪ warning NUMBER____________________▪ critical NUMBER
____________• VidehubAutoConnect boolean
____________• CriticalFailover boolean
____________• AutomaticFailover boolean
____________• VidehubConnection
________________◦ IPAddress string
________________◦ Port? number
____________• MachineGroups map element________________◦ Name STRING________________◦ Main____________________▪ Routings________________________• Source NUMBER________________________• Destination NUMBER)____________________▪ Active BOOLEAN____________• Backup
________________◦ Routings
____________________▪ Destination number)
________________◦ Active boolean
________________◦ MainMachineName string
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