Breadcrumbs

Store API - State

State

• State
____◦ General
________▪ DXMode string
________DirectX version to use. 11 or 12.
________▪ EditorStartupOptions string
________Additional options to use when launching Pixotope Engine.
________Refer to Unreal Engine documentation for more info.
________▪ CompositingColorSpace string
________Internal compositing color space. Video or Linear.
________▪ SyncMode string
____◦ Experimental
________▪ FileInput boolean
________▪ ExperimentalVideoIOOutput boolean
________▪ VideoIODebugTools boolean
____◦ ActiveCameras string array
____◦ Defaults
________▪ Units string
________Default tracking units. CM or Inches.
________▪ VideoInputFormat string
________▪ VideoOutputFormat 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
____________• 1 string
____________• 2 string
____________• 3 string
____________• 4 string
________▪ Trackers map
________▪ ExecutionTimeOffset number
________▪ ProjectionDelay number
________▪ GenlockUnsyncedReceiving boolean
________▪ UnsyncedDelayInFrames number
________▪ UnsyncedDelayInMilliseconds number

____◦ CameraSets map
____◦ ColorMatching
________▪ ARLUT string
________▪ ARMachines string array
________▪ XRMachines string array
________▪ Samples number
________▪ IsCalibrateLEDWall boolean
________▪ IsColorMatchARtoLEDWall boolean
____◦ Cameras map

element

________▪ Name string
________▪ Ancillary
____________• Fingerprint string
____________• CameraType string null
____________TODO REMOVE
____________• AssignedCTS string
____________TODO REMOVE
____________• AssignedGroup string
____________• Delay number
________▪ Input
____________• TrackingProtocol string
____________• CameraSpecific
____________null only when object
________________◦ FilmbackWidth number
________________◦ FilmbackHeight number
________________◦ Aperture number
________________◦ EnableDOF boolean
________________◦ DistortionModel string
________________◦ EnableFilmback boolean
________________◦ EnableAperture boolean
____________• Source
________________◦ Type string
________________◦ Value
____________________▪ IP string
____________________▪ MulticastGroupIP string
____________________▪ Port number
____________• 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
________▪ Outputs map
____________• Map element:
________________◦ Name string
________________◦ IP string
________________◦ Port number
________________◦ TrackingProtocol string

____◦ ObjectTrackerGroups map

element

________▪ Name string
________▪ Ancillary
____________• Fingerprint string
____________• CameraType string null
____________TODO REMOVE
____________• AssignedCTS string
____________TODO REMOVE
____________• AssignedGroup string
____________• Delay number
________▪ Input
____________• TrackingProtocol string
____________• CameraSpecific
____________null only when object
________________◦ FilmbackWidth number
________________◦ FilmbackHeight number
________________◦ Aperture number
________________◦ EnableDOF boolean
________________◦ DistortionModel string
________________◦ EnableFilmback boolean
________________◦ EnableAperture boolean
____________• Source
________________◦ Type string
________________◦ Value
____________________▪ IP string
____________________▪ MulticastGroupIP string
____________________▪ Port number
____________• 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
________▪ Outputs map
____________• Map element:
________________◦ Name string
________________◦ IP string
________________◦ Port number
________________◦ TrackingProtocol string

____◦ ObjectTrackers map

element

________▪ Name string
________▪ Ancillary
____________• Fingerprint string
____________• CameraType string null
____________TODO REMOVE
____________• AssignedCTS string
____________TODO REMOVE
____________• AssignedGroup string
____________• Delay number
________▪ Input
____________• TrackingProtocol string
____________• CameraSpecific
____________null only when object
________________◦ FilmbackWidth number
________________◦ FilmbackHeight number
________________◦ Aperture number
________________◦ EnableDOF boolean
________________◦ DistortionModel string
________________◦ EnableFilmback boolean
________________◦ EnableAperture boolean
____________• Source
________________◦ Type string
________________◦ Value
____________________▪ IP string
____________________▪ MulticastGroupIP string
____________________▪ Port number
____________• 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
________▪ Outputs map
____________• Map element:
________________◦ Name string
________________◦ IP string
________________◦ Port number
________________◦ TrackingProtocol string

____◦ VideoIO map

element

________▪ Fingerprint string
________▪ IOType string
________▪ Name string
________▪ Camera string
________cameraID or undefined if media input
________▪ VideoFormat 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
____________• Tracking
________________◦ OverrideTargetIP string null
________________◦ OverridePlatformIP string null
________________◦ TargetPort number
________________◦ PlatformPort number
________________◦ ProtocolIn string
________________◦ ProtocolOut string
________▪ Delay number
________▪ Sharpen
____________• Enabled boolean
____________• Amplitude number
____________• Profile number
________▪ Chromakey
____________• 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

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"

• AvailablePixotopeNetworks
Returns an array of active Stores (and so Pixotope Networks, as there is one Store per Pixotope Network) that are broadcasting themselves.
This is useful when you want to connect to another Pixotope Network.
Value example: "[{"name":"DESKTOP-GO883O4","ip":"192.168.0.190","port":16206},…]"

• DefaultKeyerParameters

• CompositingColorSpaceOptions