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. ◦ Experimental ▪ BOOLEANEXPERIMENTALVIDEOIOOUTPUT ▪ BOOLEANVIDEOIODEBUGTOOLS ▪ 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 ◦ Cameras MAP

element

▪ Name STRING ▪ Ancillary • Fingerprint STRING • Delay NUMBER • VideoInputDelay NUMBER • VideoOutputDelay NUMBER • CameraType STRING NULL • AssignedCTS STRING • Timecode ◦ 1 STRING ◦ 2 STRING ◦ 3 STRING ◦ 4 STRING • FrameMatchingMethod STRING • 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 STRINGMULTICASTGROUPIP ▪ 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 • Delay NUMBER • VideoInputDelay NUMBER • VideoOutputDelay NUMBER • CameraType STRING NULL • AssignedCTS STRING • Timecode ◦ 1 STRING ◦ 2 STRING ◦ 3 STRING ◦ 4 STRING • FrameMatchingMethod STRING • 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 STRINGMULTICASTGROUPIP ▪ 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 • Delay NUMBER • VideoInputDelay NUMBER • VideoOutputDelay NUMBER • CameraType STRING NULL • AssignedCTS STRING • Timecode ◦ 1 STRING ◦ 2 STRING ◦ 3 STRING ◦ 4 STRING • FrameMatchingMethod STRING • 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 STRINGMULTICASTGROUPIP ▪ 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 ▪ Rgbrange BOOLEAN ▪ Format STRING ▪ InputType STRING ▪ Type STRING ▪ BufferSize NUMBER ▪ Parent STRING ▪ Audio • Enabled BOOLEAN • Delay NUMBER ▪ Sharpen • Enabled BOOLEAN • Amplitude NUMBER • Profile NUMBER ▪ Denoise ▪ { Enabled BOOLEAN ▪ 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] ◦ LumaBoost 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