r32.4 Change Log

Previous version: r32.3

Date: 03/09/2026, 14:47

Added

Classes

OmniCalQualityMetric

class OmniCalQualityMetric(_BlipValue):

    """

    :brief Aggregate quality metrics to compare similar OmniCal calibrations

WebDownloadManager

class WebDownloadManager(Subsystem):

    """

    A system for tracking CEF browser downloads and exposing their state to the GUI

OcioModuleOutputTransform

class OcioModuleOutputTransform(OcioModuleTransform):

    """

    OCIO transform that converts content from the working colour space to a configurable destination colour space.

OcioModuleInputTransform

class OcioModuleInputTransform(OcioModuleTransform):

    """

    OCIO transform that converts content from a configurable source colour space to the working colour space.

DownloadInfo

class DownloadInfo(_BlipValue):

    """

    Information about an active download

OmniCalAlertSettings

class OmniCalAlertSettings(_BlipValue):

    """

    Settings for optional features that provide OmniCal guidance or alert to potential issues.

OcioModuleLutTransform

class OcioModuleLutTransform(OcioModuleTransform):

    """

    OCIO transform that applies a LUT file to the content.

OCIOModule

class OCIOModule(ProjectionAwareModule):

    """

    An OCIO module.

OCIOModuleConfig

class OCIOModuleConfig(ModuleConfig):

    """

    An OCIO module config.

OcioModuleNamedTransform

class OcioModuleNamedTransform(OcioModuleTransform):

    """

    OCIO transform that applies a named transform to the content.

OcioModuleColourSpaceTransform

class OcioModuleColourSpaceTransform(OcioModuleTransform):

    """

    OCIO transform that converts content from one colour space to another.

ContentViewPoint

class ContentViewPoint(_BlipValue):

    """

    Represents a content viewpoint with tracking, source, and rendering information.

ObjectTracking

class ObjectTracking(_BlipValue):

    """

    Information about a point-in-time position and orientation of an object in 3D space.

CameraTracking

class CameraTracking(ObjectTracking):

    """

    Extends ObjectTracking with camera-specific parameters such as lens intrinsics and focus parameters.

WorkloadTransportDefinition

class WorkloadTransportDefinition(_BlipValue):

    """

    The transport definition of a given workload which includes the type, the format and the bit depth.

    

    Category: Renderstream

    """



    null: Self

    _classInfo: 'ClassInfo'

CalibrationResultsSummary

class CalibrationResultsSummary(_BlipValue):

    """

    High-level OmniCal results for all cameras and projectors, including aggregate score.

CameraRenderTracking

class CameraRenderTracking(CameraTracking):

    """

    Extends CameraTracking with rendering-specific parameters such as clipping planes and overscan.

TrackedLensEncoderData

class TrackedLensEncoderData(_BlipValue):

    """

    Unitless lens encoder data, from physical lens encoders.

SceneAnimationModule

class SceneAnimationModule(Module):

    """

    A module which controls the animations of scene meshes (e.g. FBX and Alembic) from the timeline.

OcioModuleTransform

class OcioModuleTransform(Resource):

    """

    Abstract base class for a single OCIO transform entry in an OCIOModule.

ContentViewPointSource

class ContentViewPointSource(_BlipValue):

    """

    Identifies the source object and index for a content viewpoint.

OcioModuleLookTransform

class OcioModuleLookTransform(OcioModuleTransform):

    """

    OCIO transform that applies a look transform between configurable colour spaces.

Class.properties

AlignmentData.nAlignmentPoints

    @property

    def nAlignmentPoints(self) -> int:

AlignmentData.maxAlignmentCoordinatesPerCamera

    @property

    def maxAlignmentCoordinatesPerCamera(self) -> int:

AlignmentData.nTotalAlignmentCoordinates

    @property

    def nTotalAlignmentCoordinates(self) -> int:

AlignmentDataPose.poseNamePrefix

    @property

    def poseNamePrefix(self) -> str:

    @poseNamePrefix.setter

    def poseNamePrefix(self, value: str) -> None:

AlignmentPoint.isValid

    @property

    def isValid(self) -> bool:

AlignmentPoint.normal

    @property

    def normal(self) -> Vec:

AlignmentPoint.worldNormal

    @property

    def worldNormal(self) -> Vec:

AlignmentPoint.worldPos

    @property

    def worldPos(self) -> Vec:

AlignmentPoint.pos

    @property

    def pos(self) -> Vec:

ChannelMappingAssigner.uid

    @property

    def uid(self) -> int:

    @uid.setter

    def uid(self, value: int) -> None:

FrameRateFraction.maxFractionOverride

    @property

    def maxFractionOverride(self) -> int:

    @maxFractionOverride.setter

    def maxFractionOverride(self, value: int) -> None:

FrameRateFraction.fractionIndex

    @property

    def fractionIndex(self) -> int:

    @fractionIndex.setter

    def fractionIndex(self, value: int) -> None:

LensIntrinsics.fovH

    @property

    def fovH(self) -> float:

LensIntrinsics.fovV

    @property

    def fovV(self) -> float:

MVCameraStatsDisplay.nFramesDeliveredDelta

    @property

    def nFramesDeliveredDelta(self) -> int:

MVCameraStatsDisplay.packetSizeGVSP

    @property

    def packetSizeGVSP(self) -> int:

MVCameraStatsDisplay.mainboardTemperature

    @property

    def mainboardTemperature(self) -> float:

MVCameraStatsDisplay.packetSizeGevSCPS

    @property

    def packetSizeGevSCPS(self) -> int:

MeshFromScene.loopEnd

    @property

    def loopEnd(self) -> float:

    @loopEnd.setter

    def loopEnd(self, value: float) -> None:

MeshFromScene.loopStart

    @property

    def loopStart(self) -> float:

    @loopStart.setter

    def loopStart(self, value: float) -> None:

MeshFromScene.animationEnd

    @property

    def animationEnd(self) -> float:

    @animationEnd.setter

    def animationEnd(self, value: float) -> None:

MeshFromScene.animationStart

    @property

    def animationStart(self) -> float:

    @animationStart.setter

    def animationStart(self, value: float) -> None:

NotchModule.animationSpeed

    @property

    def animationSpeed(self) -> float:

    @animationSpeed.setter

    def animationSpeed(self, value: float) -> None:

OptiCalResult.parentPlanRO

    @property

    def parentPlanRO(self) -> OptiCalStagePlan:

OptiCalStagePlan.calibrationResultsSummary

    @property

    def calibrationResultsSummary(self) -> CalibrationResultsSummary:

OptiCalStagePlan.alertSettings

    @property

    def alertSettings(self) -> OmniCalAlertSettings:

    @alertSettings.setter

    def alertSettings(self, value: OmniCalAlertSettings) -> None:

OpticalCalibrator.nDaysToKeepResults

    @property

    def nDaysToKeepResults(self) -> int:

    @nDaysToKeepResults.setter

    def nDaysToKeepResults(self, value: int) -> None:

OpticalCalibrator.fallbackResult

    @property

    def fallbackResult(self) -> OptiCalResult:

    @fallbackResult.setter

    def fallbackResult(self, value: OptiCalResult) -> None:

OpticalCalibrator.backupResults

    @property

    def backupResults(self) -> List[OptiCalResult]:

    @backupResults.setter

    def backupResults(self, value: List[OptiCalResult]) -> None:

PathsManager.workerScriptPath

    @property

    def workerScriptPath(self) -> str:

QuickAlignViewSettings.wireframeColour

    @property

    def wireframeColour(self) -> Colour:

    @wireframeColour.setter

    def wireframeColour(self, value: Colour) -> None:

Recorder.tLastReceived

    @property

    def tLastReceived(self) -> float:

    @tLastReceived.setter

    def tLastReceived(self, value: float) -> None:

RenderStreamMachinesList.autoGeneratedMachinesListSupported

    @property

    def autoGeneratedMachinesListSupported(self) -> bool:

    @autoGeneratedMachinesListSupported.setter

    def autoGeneratedMachinesListSupported(self, value: bool) -> None:

RenderStreamMachinesList.manualMachineSelectionEnabled

    @property

    def manualMachineSelectionEnabled(self) -> bool:

    @manualMachineSelectionEnabled.setter

    def manualMachineSelectionEnabled(self, value: bool) -> None:

RenderStreamModuleBase.animationSpeed

    @property

    def animationSpeed(self) -> float:

    @animationSpeed.setter

    def animationSpeed(self, value: float) -> None:

Class.constructors

FrameRateFraction.__init__

    def __init__(self) -> None:

Class.methods

LensIntrinsics.setFocalLengthFromFovH

    def setFocalLengthFromFovH(self, fovH: float) -> None:

LensIntrinsics.setFovHMaintainingFovV

    def setFovHMaintainingFovV(self, fovH: float) -> None:

LensIntrinsics.setFocalLengthFromFovV

    def setFocalLengthFromFovV(self, fovV: float, _aspectRatio: float) -> None:

LensIntrinsics.setFovVMaintainingFovH

    def setFovVMaintainingFovH(self, fovV: float) -> None:

MissingMediaDomain.dumpDiagnosticJson

    def dumpDiagnosticJson(self) -> None:

MobileCameraCommunication.nAliveMVCameras

    def nAliveMVCameras(self) -> int:

MultiChannelClusterAssignerBase.getNextChannelAssignerUID

    def getNextChannelAssignerUID(self) -> int:

OcioColourSpace.getFullName

    def getFullName(self) -> str:

OptiCalStagePlan.nAliveMVPlanCameras

    def nAliveMVPlanCameras(self) -> int:

OpticalCalibrator.deleteOldResults

    def deleteOldResults(self) -> bool:

OpticalCalibrator.canExecutePlan

    def canExecutePlan(self) -> bool:

OpticalCalibrator.findResultsToKeep

    def findResultsToKeep(self, nDaysToKeepResults: int) -> List[Path]:

OpticalCalibrator.canDeleteResults

    def canDeleteResults(self) -> bool:

OpticalCalibrator.canExecutePlanIgnoreDiscovery

    def canExecutePlanIgnoreDiscovery(self) -> bool:

OpticalCalibrator.noResultsToDeleteMessage

    def noResultsToDeleteMessage(self) -> str:

OpticalCalibrator.cannotExecutePlanReason

    def cannotExecutePlanReason(self) -> str:

OpticalCalibrator.cannotDeleteResultsReason

    def cannotDeleteResultsReason(self) -> str:

OpticalCalibrator.findOldResults

    def findOldResults(self, nDaysToKeepResults: int) -> List[Path]:

OpticalCalibrator.canRevertResult

    def canRevertResult(self) -> bool:

OpticalCalibrator.cannotRevertResultReason

    def cannotRevertResultReason(self) -> str:

OpticalCalibrator.revertResult

    def revertResult(self) -> None:

OpticalCalibratorSystem.removeDiscoveryRequest

    def removeDiscoveryRequest(self, reqKey: str) -> bool:

OpticalCalibratorSystem.isVimbaXInstalled

    def isVimbaXInstalled(self) -> bool:

OpticalCalibratorSystem.addDiscoveryRequestFromCurrentState

    def addDiscoveryRequestFromCurrentState(self, reqKey: str) -> bool:

Path.pathsToFilenames

    @staticmethod

    def pathsToFilenames(paths: List[Path]) -> List[Path]:

PathsManagerOptiCal.isOriginalMesh

    @staticmethod

    def isOriginalMesh(path: str) -> bool:

PathsManagerOptiCal.isDeformedMesh

    @staticmethod

    def isDeformedMesh(path: string_view) -> bool:

PathsManagerOptiCal.isReshapedMesh

    @staticmethod

    def isReshapedMesh(path: string_view) -> bool:

Rect.expandPoint

    def expandPoint(self, v: Vec2) -> Rect:

Rect.expand

    def expand(self, f: float) -> Rect:

RenderStreamModuleConfigBase.updateProxySettings

    def updateProxySettings(self) -> None:

Vec2.anySmallerThan

    def anySmallerThan(self, v: Vec2) -> bool:

Vec2.anyLargerThan

    def anyLargerThan(self, v: Vec2) -> bool:

Class.variables

MissingMediaDomain.Filter_AllowAllIncludingInactive

    Filter_AllowAllIncludingInactive: Final[int] = 2

Removed

Class.constructors

RI.__init__

    @overload

    def __init__(self, rp: TransportManager) -> None:

Class.properties

CalibrationResultsData.errorColour

    @property

    def errorColour(self) -> Colour:

MVCameraStatsDisplay.framesDelivered

    @property

    def framesDelivered(self) -> int:

OptiCalStagePlan.calibrationSummaryTable

    @property

    def calibrationSummaryTable(self) -> List[CalibrationResultsData]:

QuickAlignViewSettings.invertWireframeColour

    @property

    def invertWireframeColour(self) -> int:

    @invertWireframeColour.setter

    def invertWireframeColour(self, value: int) -> None:

RenderStreamMachinesList.manualMachineSelection

    @property

    def manualMachineSelection(self) -> bool:

    @manualMachineSelection.setter

    def manualMachineSelection(self, value: bool) -> None:

Class.methods

OptiCalStagePlan.nAliveCameras

    def nAliveCameras(self) -> int:

OptiCalStagePlan.nAliveMVCameras

    def nAliveMVCameras(self) -> int:

OpticalCalibrator.getCentroidModeNames

    @staticmethod

    def getCentroidModeNames() -> List[str]:

OpticalCalibratorSystem.isVimbaInstalled

    def isVimbaInstalled(self) -> bool:

RenderStreamLocalModuleConfig.usesManualMachineSelection

    def usesManualMachineSelection(self, mapping: Projection) -> bool:

RenderStreamModuleConfig.updateProxySettings

    def updateProxySettings(self) -> None:

Modified

Class.methods

RenderStreamLocalModuleConfig.getMachinesFromMapping

-    def getMachinesFromMapping(self, mapping: Projection) -> RenderStreamMachinesList:
-
+    def getMachinesFromMapping(self, cmaUID: int) -> RenderStreamMachinesList:
+

Class.properties

RenderStreamLocalModuleConfig.variable.machines

-    @property
-
-    def machines(self) -> MapTable[Projection, RenderStreamMachinesList]:
-
-    @machines.setter
-
-    def machines(self, value: MapTable[Projection, RenderStreamMachinesList]) -> None:
-
+    @property
+
+    def machines(self) -> MapTable[int, RenderStreamMachinesList]:
+
+    @machines.setter
+
+    def machines(self, value: MapTable[int, RenderStreamMachinesList]) -> None:
+

RenderStreamLocalModuleConfig.getter.machines

-    @property
-
-    def machines(self) -> MapTable[Projection, RenderStreamMachinesList]:
-
+    @property
+
+    def machines(self) -> MapTable[int, RenderStreamMachinesList]:
+

RenderStreamLocalModuleConfig.setter.machines

-    @machines.setter
-
-    def machines(self, value: MapTable[Projection, RenderStreamMachinesList]) -> None:
-
+    @machines.setter
+
+    def machines(self, value: MapTable[int, RenderStreamMachinesList]) -> None:
+

Deprecated

Class.properties

BlobCaptureProcess.getter.blur

    @property

    @deprecated('This is now officially deprecated and has been removed')

    def blur(self) -> int:

BlobCaptureProcess.setter.blur

    @blur.setter

    @deprecated('This is now officially deprecated and has been removed')

    def blur(self, value: int) -> None:

BlobCaptureProcess.getter.blurRadius

    @property

    @deprecated('This is now officially deprecated and has been removed')

    def blurRadius(self) -> int:

BlobCaptureProcess.setter.blurRadius

    @blurRadius.setter

    @deprecated('This is now officially deprecated and has been removed')

    def blurRadius(self, value: int) -> None: