Store API - State

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
________▪ KnownLevelTags string array
________▪ LowLatencyMode 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.

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
________________◦ WebRTC
____________________▪ Quality STRING
________▪ LocalChains MAP
________▪ InputUsedForCalibration STRING
________▪ RefsourceData STRING
________▪ RefsourceResolution STRING
________▪ WebRTCInterface STRING
________▪ WebRTCPort NUMBER
____◦ CameraSets map
____◦ ColorMatching
________▪ ARLUT string
________▪ ARMachine string
________▪ Samples number
________▪ CalibrationGamma number
________▪ IsCalibrateLEDWall boolean
________▪ IsColorMatchARtoLEDWall boolean
________▪ CalibrationMachines string array
________▪ ShouldAbortEarly boolean
________this is a bit hacky
________▪ EnableCalibrationMachines boolean
____◦ 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
________▪ 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
________▪ UseLegacyOffsets 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
____________• DepthThreshold 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

____________• VideohubAutoConnect boolean
____________• CriticalFailover boolean
____________• AutomaticFailover boolean
____________• 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