Breadcrumbs

Store API - State

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