Store API - State

State

• State
____◦ Compositing
________▪ VideoOutputColorSpacePassthrough BOOLEAN
________▪ OCIOConfigPath STRING
________▪ ShowMachineNameOutput BOOLEAN
________▪ XR
____________• DOFEnable BOOLEAN
____________• DOFGain NUMBER
____________• DisplayMode STRING
____◦ General
________▪ FrameRate NUMBER
________▪ EnableFilmicTonemapper BOOLEAN
________▪ MultimachineSyncing STRING
________▪ CameraSwitchingEnabled BOOLEAN
________▪ AllowNegativeBuffer BOOLEAN
________▪ AllowSubFrameDelay BOOLEAN
________▪ AllowSetExtensionDelay BOOLEAN
________▪ AllowAdvancedOptions BOOLEAN
____◦ Experimental
________▪ FileInput BOOLEAN
________▪ 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.

element

____________• Enabled BOOLEAN
____________• Label STRING
____________• Arguments STRING
____________• Editor BOOLEAN
____________• Live BOOLEAN

________▪ VideoFormat
____________• Resolution STRING
____________• CustomResolutionWidth NUMBER
____________• CustomResolutionHeight NUMBER
________▪ 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

________▪ Refsource STRING
________▪ Timecode
____________• Selection
________________◦ 1 STRING
________________◦ 2 STRING
________________◦ 3 STRING
________________◦ 4 STRING
____________• Devices MAP
____________• Enabled BOOLEAN
____________• Source STRING
________▪ 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
________________◦ ColorProfile STRING
________________◦ 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
________________◦ 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
________▪ LocalChains MAP
________▪ InputUsedForCalibration STRING
________▪ RefsourceData 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
____◦ 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
____________• VidehubConnection
________________◦ IPAddress STRING
________________◦ Port? NUMBER
____________• MachineMapping MAP
________▪ PixotopeSpace
____________• IOBotIPAddress STRING
____________• IOBotPort NUMBER
________▪ NMOS MAP

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