Store API - State | Pixotope Help Center

Service name: Store (singleton, one per network).

State

The full state of the system.

• 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 "XR" "Identify" "Pattern" "Calibrate" "Syncing"
____________• Mode "InnerFrustumOnly" "FrameEverythingInSingleFrustum" "SeparateInnerAndOuterFrustum"
____________• SampleOutsideFrustumColor Color
________________◦ R number
________________◦ G number
________________◦ B number
________________◦ A number
____________• RenderOutsideType "Cube" "AutoCapture" "AutoCaptureAndCube"
____________• UpdateFrequencyOfOutsideCameraView number
____________• Overscan number
____________• DisableMotionBlur boolean
________▪ AngleMatching
____________• Gamma number
________▪ WorkingColorSpace "sRGB" "Rec2020" "ACESAP1" "UseProjectSetting"
____◦ General
________▪ FrameRate number
________▪ EnableFilmicTonemapper boolean
________▪ MultimachineSyncing "Off" "Timecode"
________▪ CameraSwitchingEnabled boolean
________▪ AllowNegativeBuffer boolean
________▪ AllowSubFrameDelay boolean
________▪ AllowSetExtensionDelay boolean
________▪ AllowAdvancedOptions boolean
________▪ KnownLevelTags string array
________▪ LowLatencyMode boolean
____◦ Experimental
________▪ ExperimentalVideoIOOutput boolean
________▪ VideoIODebugTools boolean
____◦ CameraInputSwitching map

CameraInputSwitching

________▪ ActiveCameraSet string array
________▪ CameraSets map

____◦ Defaults
________▪ Units "CM" "Inches"
________Default tracking units. CM or Inches.
________▪ EditorOptions map
________Additional options to use when launching Pixotope Engine. // Refer to Unreal Engine documentation for more info.

EditorOptions

____________• Enabled boolean
____________• Label string
____________• Arguments string
____________• Editor boolean
____________• Live boolean

________▪ VideoIOOptions map
________Additional options to use when launching Pixotope Pipeline.

VideoIOOptions

____________• Enabled boolean
____________• Label string
____________• Arguments string

________▪ VideoFormat VideoFormat
____________• Resolution string
____________• CustomResolutionWidth number
____________• CustomResolutionHeight number
________▪ Type "AJA" "File" "BMD" "NDI" "SRT" "GPU" "Webcam" "WebRTC"
________Default video input type. AJA, File, BMD, or NDI.
________▪ ColorSpace string
________▪ Delays
____________• Tracking number
____________• ExecutionTime number
____________• Video number
____________• Audio number
____◦ Machines map

Machines

________▪ Refsource string
________▪ Timecode
____________• Config TimecodeSelection
________________◦ 1
____________________▪ Family string
____________________▪ Type string
____________________▪ Device number
____________________▪ Source string
________________◦ 2
____________________▪ Family string
____________________▪ Type string
____________________▪ Device number
____________________▪ Source string
________________◦ 3
____________________▪ Family string
____________________▪ Type string
____________________▪ Device number
____________________▪ Source string
________________◦ 4
____________________▪ Family string
____________________▪ Type string
____________________▪ Device number
____________________▪ Source string
____________• Enabled boolean
________▪ PixelStreaming
____________• Enabled boolean
________▪ Trackers map

Trackers

____________• FrameMatchingMethod "BufferSize" "Timecode" "IdealerTimer"
____________• Delay number
____________• UseLensDelay boolean
____________• LensDelay number

________▪ UseGlobalExecutionTimeOffset boolean
________▪ ExecutionTimeOffset number
________▪ Routing map

Routing

____________• IOType "Input" "Output"
____________• Name string
____________• Camera string
____________cameraID or empty if media input
____________• VideoFormat VideoFormat
________________◦ Resolution string
________________◦ CustomResolutionWidth number
________________◦ CustomResolutionHeight number
____________• ColorSpace string
____________• SMPTEColorRange boolean
____________• SBColorRange boolean
____________• Format string
____________• InputType "AJA" "File" "BMD" "NDI" "SRT" "GPU" "Webcam" "WebRTC"
____________• Type "Fill" "Key" "NormalMap" "DepthMap"
____________• Parent string
____________• Source VideoIOSourceType
________________◦ Type "Base" "Advanced"
________________◦ Name "Engine" "Engine-Preview" "Keyer" "Engine-MD" "NormalMap" "DepthMap"
________________◦ PreviewInput
____________________▪ Id string
____________________▪ Name string
____________• Audio AudioSelection
________________◦ Delay number
________________◦ EmbedAudioEngine string
________________◦ PassThroughAudio string
____________• Network VideoIONetwork
________________◦ Video
____________________▪ Codec "mpeg4" "h264" "mjpeg"
____________________▪ BitrateScale number
____________________▪ SRTLatency number
____________________▪ Profile string
____________________▪ Threads number
____________________▪ TransportFormat "mjpeg" "mpegts"
____________________▪ PixelFormat string
____________________▪ GOPSize number
____________________▪ PassPhrase string
____________________▪ Mode "listener" "caller"
________________◦ SMPTE2110 SMPTE2110
____________________▪ TTL number
____________________▪ Main
________________________• TransmissionMethod string
________________________• Video
____________________________◦ NetworkAdapter string
____________________________◦ IP string
____________________________◦ Port number
________________________• Ancillary
____________________________◦ NetworkAdapter string
____________________________◦ IP string
____________________________◦ Port number
________________________• Video
____________________________◦ NetworkAdapter string
____________________________◦ IP string
____________________________◦ Port number
____________________________◦ EnableFlow boolean
________________________• Ancillary
____________________________◦ NetworkAdapter string
____________________________◦ IP string
____________________________◦ Port number
____________________________◦ Enabled boolean
____________________________◦ EnableFlow boolean
____________________▪ Secondary
________________________• TransmissionMethod string
________________________• Video
____________________________◦ NetworkAdapter string
____________________________◦ IP string
____________________________◦ Port number
________________________• Ancillary
____________________________◦ NetworkAdapter string
____________________________◦ IP string
____________________________◦ Port number
____________• 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
____________• SharedFrameConfig
________________◦ Enabled boolean
________________◦ Config
____________________▪ Video string
____________________▪ Format string
____________________▪ VideoFormat
________________________• Resolution string

________▪ ZoneRouting ZoneTrackingOutputConfiguration
____________• Enabled boolean
____________• TrackingProtocol string
____________• SendTo "SendToCustomIp" string
____________• Output
________________◦ RemoteAddress string
________________◦ RemotePort number
________▪ LocalChains map

LocalChains

____________• Source
________________◦ Type string
________________◦ Value
____________________▪ IP string
____________________▪ MulticastGroupIP string
____________________▪ Port number
____________• Outputs map

Outputs

________________◦ Name

STRING

________________◦ IP

STRING

________________◦ Port

NUMBER

________________◦ TrackingProtocol

STRING

________▪ InputUsedForCalibration string
________▪ RefsourceData string
________▪ RefsourceResolution string
________▪ WebRTCInterface string
________▪ WebRTCPort number

____◦ 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
________▪ HDR boolean
____◦ Cameras map

Cameras

________▪ ZoneTracking
____________• TrackingFilePath string
____________• TrackingConfiguration map
________▪ Name string
________▪ Ancillary
____________• Fingerprint string
____________• CameraType string
____________TODO REMOVE
________▪ Input InputConfig
____________• TrackingProtocol string
____________• CameraSpecific 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 NoMountOffset TripodOffsets
____________• Type "No mount setup"
____________• Value
________________◦ GlobalPosition Vector
____________________▪ X number
____________________▪ Y number
____________________▪ Z number
________________◦ GlobalRotation Vector
____________________▪ X number
____________________▪ Y number
____________________▪ Z number
________________◦ CameraRotation EulerAngles
____________________▪ Pan number
____________________▪ Tilt number
____________________▪ Roll number
________▪ LensOffsets LensOffsets
____________• FieldOfView number
____________• FocusDistance number
____________• Aperture number
____________• CX number
____________• CY number
____________• NodalX number
____________• ShowCrosshair boolean
____________• K1 number
____________• K2 number
________▪ LensFileConfig 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
________▪ Type "CameraTracking" "ZoneTracking"
________▪ Ancillary
____________• Fingerprint string
____________• CameraType string

____◦ Chromakeys map

Chromakeys

________▪ Enabled boolean
________▪ KeyerMode "Chroma" "AI" "Depth"
________▪ OutputKey boolean
________▪ OutputKeyVisualizeExtremes boolean
________▪ ShaderParams ChromaKeyShaderParams
____________• 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

ChromakeysMeta

________▪ CapturedImage string
________▪ Strokes
____________• UndoOrder string
____________• Background number array array
____________• Foreground number array array
________▪ ImageWidth number
________▪ ImageHeight number

____◦ Projects string array
____◦ Version string
____◦ Sync
________▪ CommonSyncDelay number
________▪ ProjectionDelay number
________▪ EnableExtrapolation boolean
________▪ TimecodeType "Real" "Synthetic"
________▪ 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 CameraType array
________▪ id number
________▪ label string
________▪ camera_name string
________▪ width string
________▪ height string
____◦ Diagnostics
________▪ PhaseOffsetDetection
____________• Sensitivity number
________▪ NetworkCheck
____________• Latest NetworkHealthReport
________________◦ Individual map

Individual

____________________▪ AverageResponseTime number
____________________▪ MinResponseTime number
____________________▪ MaxResponseTime number
____________________▪ DiffOverAverage number
____________________▪ Rating NetworkRating
________________________• Value number
________________________• Description string
____________________▪ LastUpdated number

________________◦ Total TotalNetworkHealth
____________________▪ AverageResponseTime number
____________________▪ MaxResponseTime number
____________________▪ MinResponseTime number
____________________▪ MaxDiffOverAverage number
____________________▪ TotalRating NetworkRating
________________________• Value number
________________________• Description string
____________________▪ LastUpdated number
____◦ Presets
________▪ VideoKeyer PanelPresets(Chromakey)
____________• Items map

Items

________________◦ Time number
________________◦ Machine string
________________◦ Data DataType

____________• LastApplied map

LastApplied

________________◦ Preset string
________________◦ Machine string

____◦ TrackMen map
____◦ DataMapper
________▪ State
____________• Sources map

Sources

________________◦ SourceUrl string
________________◦ DataType string
________________◦ ReadFrequency number
________________◦ LastRead number
________________◦ Title string
________________◦ PersistData boolean

________▪ Data map
____◦ RenderBackup
________▪ ParameterThresholds map

ParameterThresholds

____________• warning number
____________• critical number

________▪ VideohubAutoConnect boolean
________▪ CriticalFailover boolean
________▪ AutomaticFailover boolean
________▪ MachineGroups map

MachineGroups

____________• Name string
____________• Main map

Main

________________◦ Routings array
____________________▪ Source number
____________________▪ Destination number
________________◦ Active boolean

____________• Backup map

Backup

________________◦ Routings array
____________________▪ Destination number
________________◦ Active boolean
________________◦ MainMachineName string

____◦ Integrations
________▪ IOBot
____________• IPAddress string
____________• Port number
________▪ Videohub
____________• IPAddress string
____________• Port number
____◦ NMOS map
____◦ Adjustments map
____◦ DigitalTwins map

DigitalTwins

________▪ Bodies map

Bodies

____________• Name string
____________• Source "Manual" "DigitalTwin" "SplineTwin"
____________• Panels map

Panels

________________◦ Row

NUMBER

________________◦ Column

NUMBER

________________◦ Resolution
____________________▪ X

NUMBER

____________________▪ Y

NUMBER

________________◦ Transform
____________________▪ Rotation
________________________• X

NUMBER

________________________• Y

NUMBER

________________________• Z

NUMBER

________________________• W

NUMBER

____________________▪ Scale3D
________________________• X

NUMBER

________________________• Y

NUMBER

________________________• Z

NUMBER

____________________▪ Translation
________________________• X

NUMBER

________________________• Y

NUMBER

________________________• Z

NUMBER

____________• AngleCorrection AngleCorrection
________________◦ Left Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
________________◦ Right Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
________________◦ Up Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
________________◦ Down Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
____________• ColorGrading ColorGrading
________________◦ Enabled boolean
________________◦ Gamma Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
________________◦ Gain Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
________________◦ Offset Color
____________________▪ R number
____________________▪ G number
____________________▪ B number
____________________▪ A number
____________• Enabled boolean

________▪ Mappings map

Mappings

____________• Name string
____________• PreviewColor Color
________________◦ R number
________________◦ G number
________________◦ B number
________________◦ A number
____________• SegmentMappings GroupMappingDefinition array
________________◦ BodyID string
________________◦ From
____________________▪ Column number
____________________▪ Row number
________________◦ To
____________________▪ Column number
____________________▪ Row number
________________◦ Offset
____________________▪ X number
____________________▪ Y number
________________◦ bScaleToFit boolean

________▪ Media map

Media

____________• Name string
____________• Position
________________◦ X number
________________◦ Y number
____________• Size
________________◦ X number
________________◦ Y number
____________• InputMinUV
________________◦ X number
________________◦ Y number
____________• InputMaxUV
________________◦ X number
________________◦ Y number
____________• Source string
____________• InputID string
____________• AssetPath string

____◦ UpdatedAt string