Designer Plugins

null : Self

selectManipulator(key: int) → None

class d3.App

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.Array2

Bases: _BlipValue

h() → int

item(arg0: int, arg1: int) → Vec2

null : Self

set(arg0: int, arg1: int, arg2: Vec2) → None

w() → int

class d3.ArrayBox

Bases: ValueBox

property addIsUnnamed : bool

property allowDuplicates : bool

property allowSelections : bool

property elementContainer : ScrollWidget2

property elementCreateCallable : Callable

property enumerateItems : bool

property hideButtons : bool

isSupportedType : Callable

mouseSelect() → None

Select the item under the mouse cursor

property newElementCreatedAction : ParamAction

property newObjectPrefix : str

null : Self

property objectViewCloseOnSelect : bool

property onElementsMovedAction : ParamAction

onSelectionChangedAction() → ParamAction

selectAll() → None

Select all items

selectNone() → None

setAddViewFilter(filter: Callable) → None

setColourOfElement(resource: Resource, col: Colour) → None

setNewClassMenuFilter(filter: Callable) → None

setResourceSelection(newSelection: List[Resource]) → None

update() → None

class d3.ArrayBoxProperty(arg0: ReflectionValue, arg1: FieldInfo, arg2: int)

class d3.ArrayBoxProperty(other: ArrayBoxProperty)

null : Self

class d3.Arrow

Bases: Resource

property conflicted : bool

property dest : Layer

property destUid : int

duplicateName : Callable

duplicatePath : Callable

property isValid : bool

null : Self

property src : Layer

property srcUid : int

property t : float

class d3.ArrowSourceData

Bases: _BlipValue

property dataGetter : Callable

property lines : List[AudioLine]

null : Self

class d3.AudioFile

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property header : AudioInfo

property ingestionDate : DateStamp

null : Self

class d3.AudioFileHeader

Bases: Resource

property codecInfo : str

The native format of the hardware or software buffer that will be used to play this track

property codecName : str

duplicateName : Callable

duplicatePath : Callable

property duration : float

property nChannels : int

changeRenderType() → None

duplicateName : Callable

duplicatePath : Callable

property gain : float

Input signal level is multiplied by this number; 1 is normal

property iLine : int

Select a physical audio input line

property lineNames : List[str]

null : Self

render() → None

texture() → DxTexture

class d3.AudioLink

Bases: Resource

property decay : float

duplicateName : Callable

duplicatePath : Callable

property from_ : int

property line : AudioLine

property mode : int

null : Self

property to : int

class d3.AudioModule

Bases: Module

property at_end_point : int

property balance : float

property mode : int

null : Self

property output : LogicalAudioOutDevice

Logical audio device that the audio will play from

prevPlayerAudibility() → float

property track : AudioTrack

The audio track to play

property transition_time : float

property volume : float

class d3.AudioOutDevice

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.AudioOutDeviceMap

Bases: DeviceMap

null : Self

class d3.AudioOutDeviceMap2

Bases: Resource

audioDelayFor(arg0: LogicalDevice) → float

changeSampleRate(arg0: str, arg1: int) → None

channelMapFor(arg0: LogicalDevice) → List[int]

duplicateName : Callable

duplicatePath : Callable

findHardware(arg0: LogicalDevice) → AudioHardwareIdentifier

getHardwareDevices() → List[AudioHardwareIdentifier]

property hardware : List[AudioHardwareIdentifier]

property mappingChangedAction : Action

property mappings : List[Mapping]

null : Self

setMapping(arg0: LogicalDevice, arg1: str, arg2: List[int], arg3: float) → None

class d3.AudioOutputs

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property outputs : List[LogicalAudioOutDevice]

class d3.AudioPlayer

Bases: _BlipValue

null : Self

class d3.AudioPlayerThread

Bases: Thread

null : Self

class d3.AudioPlayer_Impl

Bases: _BlipValue

null : Self

class d3.AudioSystem

Bases: Subsystem

maxNumberOfPatches() → int

null : Self

class d3.AudioTrack

Bases: Resource

class Marker

Bases: _BlipValue

property beat : float

null : Self

property time : float

class OldMarker

Bases: _BlipValue

property beat : float

null : Self

property time : float

property audioFile : AudioFile

duplicateName : Callable

duplicatePath : Callable

property filename : str

property header : AudioInfo

property iPivotBeat : float

property markers : List[Marker]

property nBeatsPerLoop : float

null : Self

property stereoOption : int

class d3.AudioWaveform

Bases: _BlipValue

null : Self

class d3.AutoFilter3Monitor

Bases: MetricMonitor

null : Self

togglePause : Callable

class d3.AutoProfiler

Bases: Subsystem

null : Self

class d3.AutoSoftEdgeMaterial

Bases: ProjectorViewMaterial

null : Self

class d3.AutoSoftEdgeProfile

Bases: Resource

DEFAULT_GRAPH_HEIGHT : Final = 200

DEFAULT_GRAPH_WIDTH : Final = 340

property autoSoftEdgeAlpha : float

Controls the brightness of centre of the blended region

property autoSoftEdgeGamma : float

Set this to match the gamma curve of physical projectors

property autoSoftEdgePower : float

Controls the shape of the brightness curve of blended region.
(1.0 is recommended for camera tracking, 2.0 is recommended for smoother blend).

property autoSoftEdgeSharpness : float

Controls the size of the blend zones created; the higher the number, the smaller the blend zones

duplicateName : Callable

duplicatePath : Callable

getGraphDescriptor() → GraphDescriptor

null : Self

setDefault() → None

setGraphWidth(width: int) → None

property videoBlackLevel : float

Set this to compensate for the video black level in regions covered by 1 projector. Effects Dynamic Blend mask.

property videoBlackMaxProjectors : float

Set this to the maximum number of incident projectors

class d3.AutomaticSetList

Bases: SetList

null : Self

class d3.AutomationAxisValue

Bases: Resource

property automationAxisName : str

property automationDeviceName : str

property automationValue : float

property axisDirection : int

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.AverageMipmappedMaskTexture

Bases: MipmappedMaskTexture

null : Self

class d3.AxisAngle

Bases: _BlipValue

null : Self

class d3.AxisCameraTrackingSource

Bases: CameraTrackingSource

property apertureAxis : ScreenPositionAxis

property centerShiftXAxis : ScreenPositionAxis

property centerShiftYAxis : ScreenPositionAxis

property focalLengthAxis : ScreenPositionAxis

property focusDistanceAxis : ScreenPositionAxis

property focusEncoderAxis : ScreenPositionAxis

property hFovAxis : ScreenPositionAxis

property k1Axis : ScreenPositionAxis

property k2Axis : ScreenPositionAxis

property k3Axis : ScreenPositionAxis

null : Self

property sensorSizeXAxis : ScreenPositionAxis

property sensorSizeXYAspectAxis : ScreenPositionAxis

The aspect ratio (x / y) of the sensor

property sensorSizeYAxis : ScreenPositionAxis

property xAxis : ScreenPositionAxis

property xrotAxis : ScreenPositionAxis

property yAxis : ScreenPositionAxis

property yrotAxis : ScreenPositionAxis

property zAxis : ScreenPositionAxis

property zoomEncoderAxis : ScreenPositionAxis

property zrotAxis : ScreenPositionAxis

class d3.AxisObjectTrackingSource

null : Self

property xAxis : ScreenPositionAxis

property xrotAxis : ScreenPositionAxis

property yAxis : ScreenPositionAxis

property yrotAxis : ScreenPositionAxis

property zAxis : ScreenPositionAxis

property zrotAxis : ScreenPositionAxis

class d3.BandwidthEstimationResult

Bases: _BlipValue

property fragments : List[FrameFragment]

property machine : RenderStreamMachine

null : Self

property outgoingBandwidthEstimate : float

property textureParamBandwidthEstimate : float

class d3.BarWidget(*args, **kwargs)

Bases: Widget

adjustZoom(dir: int) → None

canZoom(dir: int) → bool

focusedWidget : Callable

jumpToTime(time: float) → None

loadLayer() → None

Import layer

mergeSection() → None

Merge the section starting here with previous

mouseDragCursor(dragState: int, startPos: Vec2, pos: Vec2) → None

Drag the time cursor around the timeline

mouseDragSelection(dragState: int, startPos: Vec2, pos: Vec2) → None

Select an area of the timeline

moveLayer(layer: SuperLayer, newTime: float) → None

moveLayers(layers: List[SuperLayer], newTime: float) → None

moveNoteTagSection(dragState: int, startPos: Vec2, pos: Vec2) → None

Drag a note/tag/section to a new location

moveNoteTagSectionTogether(dragState: int, startPos: Vec2, pos: Vec2) → None

Drag note/tag along with the section

newLayerNamed(str: str) → None

newNote() → None

Create a note here

newTag() → None

Create a tag here

newUnnamedLayer() → None

Create a new layer

nextBeat(t: float, dir: int, big: bool) → float

nextFeature(t: float, dir: int) → float

null : Self

property onSetNote : Action

openTimecodeJumpBox() → None

Jump to specified timecode

pasteLayer() → None

property pixelsPerBeat : float

popupBarMenu() → None

Popup a menu bar at the current cursor location.

property screenWidth : float

property selectionEnd : float

property selectionStart : float

set(transport: TransportManager) → BarWidget

setLayersExtents(layers: List[SuperLayer], newTStart: float, newTEnd: float) → None

showLayerExtent(sl: SuperLayer) → None

snapBeat(t: float, dir: int, big: bool) → float

snapFeature(t: float, dir: int) → float

splitSectionAndCreateNote() → None

Split the section and create a note here

tToX(t: float) → float

property tagTypeFromPopup : int

uiTransparencyDisabled : Callable

xPhysicalToT(xScreen: float) → float

xToT(x: float) → float

zoomIn() → None

Track zoom in

zoomLevel() → str

zoomOut() → None

Track zoom out

class d3.BarcoEncore

Bases: DVIMatrix

property IP_address : str

null : Self

property port : SerialDevice

class d3.BarcoMatrixPro

Bases: DVIMatrix

property IP_address : str

The IP address to send commands to

null : Self

property port : SerialDevice

property telnet_port : int

The TCP port to send commands on

class d3.BarcoProjectorDevice

Bases: ProjectorDevice

null : Self

class d3.BatteryMonitor

Bases: MetricMonitor

hasBattery : Callable

null : Self

togglePause : Callable

class d3.BeamQuadShaderMaterial

Bases: DxMaterial

add : Final

alpha : Final

alphaMtl : DxMaterial

anisotropic : Final

lineStrip : Final

linearSample : Final

mipmap : Final

multiply : Final

multiplyAlpha : Final

null : Self

over : Final

pointSample : Final

textureBorder : Final

textureBorderU : Final

textureBorderV : Final

textureClamp : Final

textureWrap : Final

zCmpAlways : Final

zCmpLessEqual : Final

class d3.BeamShaderMaterial

Bases: DxMaterial

add : Final

alpha : Final

alphaMtl : DxMaterial

anisotropic : Final

lineStrip : Final

linearSample : Final

mipmap : Final

multiply : Final

multiplyAlpha : Final

null : Self

over : Final

pointSample : Final

textureBorder : Final

textureBorderU : Final

textureBorderV : Final

textureClamp : Final

textureWrap : Final

zCmpAlways : Final

zCmpLessEqual : Final

class d3.BitmapModule

property bitmap : DxTexture

property bottom : float

property colour_shift : ColourShift

property left : float

null : Self

property pos : Vec2

property right : float

property rotation : float

property scale : Vec2

property scale_mode : int

property size : float

property top : float

property transition : float

class d3.BitmapMoveModule

Bases: Module

property aspect : float

property bitmap : DxTexture

property bottom : float

property colour_shift : ColourShift

property left : float

null : Self

property pos : Vec2

property right : float

property rotation : float

property scale : float

property top : float

property cx : float

property cy : float

property ellipse : RotatedBlobRect

property iProjector : int

property inertia : float

property levelDetectThreshold : int

null : Self

property sc : int

class d3.BlobCaptureProcess

Bases: FastCaptureProcess

property blobSettings : BlobSettings

property blur : int

This is a test for now, this option will disappear in final version

property blurRadius : int

this is a test for now, will disappear

displayBlobPreview() → None

null : Self

property observation : CameraCalibrationObservation

renderStageAtObservation : Callable

startObservation(arg0: Camera) → None

stopBlobPreview() → None

updateBlobPreview() → None

property useLegacyCapture : bool

Use legacy frame capture process (Slower but more tolerant of dropped frames)

class d3.BlobDetectionSettings

class d3.BlobDetectionSettings(arg0: BlobDetectionSettings)

Bases: _BlipValue

property blobAreaLimits : Vec2

property blobCircularityLimits : Vec2

property blobConvexityLimits : Vec2

property blobInertiaLimits : Vec2

null : Self

class d3.BlobObservationCount(arg0: BlobObservationCount)

Bases: _BlipValue

property name : str

property noObservers : int

null : Self

property oneObserver : int

property statusColour : Colour

property threeOrMoreObservers : int

property twoObservers : int

class d3.BlobSettings

Bases: _BlipValue

getOrAdd(display: Display) → DisplayBlobSettings

property blockSize : float

property field : int

null : Self

property population : float

Controls the number of bugs. 0 is none, 1 is maximum. The closer the number is to 1, the more bugs

property speed : float

property turniness : float

Controls the chance that a bug will turn on a given step. At 0, bugs never turn; at 1, they always turn

class d3.Button(*args, **kwargs)

Bases: Widget

attention(attention: bool) → None

property clickAction : Action

flash(onOff: bool, period: float, c: Colour, duration: float) → None

focusedWidget : Callable

fontSize(pixels: float) → Button

property highlight : bool

imageColour(c: Colour) → Button

null : Self

onClick() → None

Perform the action associated with clicking on the button

onOpenPopupMenu() → None

Open an option menu

property popupMenuAction : Action

set(*args) → Any

parameters are all optional and in any order - name, image and callable or action

setImage(s: str, images: ImagePair) → None

showPress() → None

textColour(c: Colour) → Button

property tint : Colour

uiTransparencyDisabled : Callable

class d3.CDL

Bases: Resource

property acesPostTransform : AcesInputTransformParameters

Transform from LUT working space to Linear ACES AP0

property acesPreTransform : AcesOutputTransformParameters

Transform from Linear ACES AP0 to LUT working space

duplicateName : Callable

duplicatePath : Callable

exportCC(path: Path, id: str) → bool

null : Self

property ocioTransform : OcioColourSpace

Colour space to apply CDL

property offset : Vec

property power : Vec

property saturation : float

property slope : Vec

class d3.CDLContainer

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.CDLModule

property cdl : CDL

duplicateName : Callable

duplicatePath : Callable

findLineUpForCurrentPose(precise: bool) → int

getRefPointPath() → Path

getSupportedCalibrationStatusNames : Callable

getSupportedCalibrationStatuses : Callable

property movedWorldPos : Vec

null : Self

property point : ReferencePoint

rasterPos(idx: int) → Vec2

property singlePosePoints : List[SinglePoseCalibratedPoint]

property worldPos : Vec

class d3.CalibratedReferencePoint

Bases: _BlipValue

null : Self

class d3.CalibrationLutMapping

Bases: Resource

property active : bool

property camera : Camera

duplicateName : Callable

duplicatePath : Callable

property lutfile : LutFile

null : Self

property screen : LedScreen

class d3.CalibrationLutMappingOld

Bases: _BlipValue

null : Self

class d3.CalibrationProjectorSettings

Bases: _BlipValue

null : Self

class d3.CalibrationResultsData(arg0: CalibrationResultsData)

Bases: _BlipValue

property deviceType : str

property errorColour : Colour

property errorRMS : float

property hasSquarePixels : bool

property isCalibrated : bool

property name : str

null : Self

class d3.CalibrationSettings

class d3.CalibrationSettings(arg0: CalibrationSettings)

Bases: _BlipValue

property cameraCalibration : CameraCalibrationSettings

property centroidMode : int

null : Self

property projectorCalibration : ProjectorCalibrationSettings

property reconstruction : ReconstructionSettings

property redoBlobDetection : bool

class d3.CalibratorFactory

Bases: CalibratorSystem

getDistortionModeNames : Callable

getMinimumEnabledCalibMethod : Callable

isCalibMethod4PointEnabled : Callable

isCalibMethod4PointExperimentalEnabled : Callable

isCalibMethod4PointRansacEnabled : Callable

isCalibMethodDistortionEnabled : Callable

isCalibMethodEnabled : Callable

isCalibMethodGoldEnabled : Callable

isCalibMethodOpenCV : Callable

isCalibMethodSolvePnP : Callable

isCalibMethodZhang : Callable

isCalibMethodZhangEnabled : Callable

isCalibratesExtrinsicOnly : Callable

isRequiresIntrinsicEstimates : Callable

isRequiresPlanarObject : Callable

isSupportsLensDistortion : Callable

isSupportsPlanarObject : Callable

null : Self

class d3.CalibratorSystem

Bases: Subsystem

getDistortionModeNames : Callable

getMinimumEnabledCalibMethod : Callable

isCalibMethod4PointEnabled : Callable

isCalibMethod4PointExperimentalEnabled : Callable

isCalibMethod4PointRansacEnabled : Callable

isCalibMethodDistortionEnabled : Callable

isCalibMethodEnabled : Callable

isCalibMethodGoldEnabled : Callable

isCalibMethodOpenCV : Callable

isCalibMethodSolvePnP : Callable

isCalibMethodZhang : Callable

isCalibMethodZhangEnabled : Callable

isCalibratesExtrinsicOnly : Callable

isRequiresIntrinsicEstimates : Callable

isRequiresPlanarObject : Callable

isSupportsLensDistortion : Callable

isSupportsPlanarObject : Callable

null : Self

class d3.CamCaps

Bases: _BlipValue

property maxWhiteBalanceGain : float

null : Self

class d3.CamCapturePaths

Bases: _BlipValue

property imageFile : str

null : Self

class d3.CamParams

Bases: _BlipValue

property aperture : float

property camParamMode : int

property exposureBias : float

property exposureDur : float

property exposureMode : int

property exposureTarget : float

property fieldOfViewNominal : float

property focalLength : float

property focusMode : int

property isAdjustingExposure : bool

property isAdjustingFocus : bool

property isAdjustingWB : bool

property iso : float

property lensPos : float

property lensPosComp : int

null : Self

property poi : Vec2

property resolution : Int2

property wbChroma : Vec2

property wbMode : int

property wbRgbGains : Vec

property zoom : float

class d3.Camera

Bases: SlcAwareDisplay

TargetBackplate : Final = 1

TargetFrontplate : Final = 2

TargetTransmission : Final = 0

property activeMixedRealitySets : List[MixedRealitySet]

property aperture : float

Aperture (f-stop) value, defined as the focal length / aperture diameter

applyCalibrationToLockedOffCamera() → None

property aspectRatio : float

property cameraImagingPredictionSamples : int

Number of samples to use for camera imaging forward prediction

property cameraImagingPredictionTerms : int

Number of terms to use for camera imaging forward prediction

property centerShiftMM : Vec2

property doesTrackingSourceSupportLensData : bool

property fieldOfViewH : float

property fieldOfViewV : float

property focalLengthMM : float

property focusDistance : float

Distance to the focal plane in m

property frontplateCompositeOrder : int

Order in which the distorted and undistorted front plates are composited

property frontplateFade : float

property frontplateReprojectionMode : int

Mode used for frontplate delay compensation and reprojection:
Backplate Aligned: The frontplate is delayed and reprojected with the backplate.
No Reprojection: The frontplate is delayed with the backplate but not reprojected.
Minimal Latency: The most recently rendered frontplate is composited with no reprojection.

property isLiveCamera : bool

property k1k2k3 : Vec

property lens : LensIntrinsics

property lensFocusMode : int

property lensFocusParams : LensFocusParams

property lensFocusTrackedObject : Object

Object used to calculate focus distance when focus mode is set to Object Tracking

localVisualiserCamera : Callable

property minOverscan : Vec2

null : Self

property orthographicScale : float

property overscan : Vec2

Generate extra content outside the original canvas resolution to compensate for lens distortion.
1 means 100% of original resolution, 2 means 200%.

property overscanResolution : Int2

property paWidthMM : float

property projectionMatrixType : int

Perspective or orthographic view of stage

property radialMaskScale : float

Apply a radial mask to the filmed content. Scales between 0 and 1 based on the image diagonal.

property renderTimeToCameraCaptureTime : float

Amount of time between rendering a frame and the camera taking the picture of the stage showing that frame

property renderTimeToVideoReceiveTimeSec : float

Amount of time between rendering a frame and receiving the corresponding video frame

saveCurrentView(filename: str) → None

property setExtensionAlpha : float

Set to 1 for set extension, or 0 to turn it off

property setExtensionFeather : int

The size of the feathering blending the set extension with reality

property spatialCalibration : SpatialCalibrationConfig

property spatialCalibrationChangedAction : Action

property sphericalRenderParams : SphericalRenderParams

property stageRenderSettings : StageRenderSettings

property blueGain : float

null : Self

class d3.CameraBookmark

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property fieldOfView : float

property name : str

null : Self

property pos : Vec

property rotation : Vec

property scale : float

setFeedView(pos: Vec2, scale: float) → None

setOrthographic(pos: Vec, rotation: Vec, fieldOfView: float, orthographicScale: float) → None

setPerspective(pos: Vec, rotation: Vec, fieldOfView: float) → None

property type : int

Perspective/orthographic view of stage or view of feed

class d3.CameraBookmarkState

Bases: Resource

property bookmarks : List[CameraBookmark]

duplicateName : Callable

duplicatePath : Callable

get : Callable

null : Self

class d3.CameraCalibration

Bases: Resource

property cameraNames : List[str]

captures(cam: MobileCam, iAcquisition: int) → List[int]

property chessSquaresSizeDefault : Vec2

Set chessboard size via total chessboard width and height, e.g. 0.7584 x 0.5688 [m].

property chessboardSizeDefault : Int2

Number of black & white squares on the chessboard, e.g. 12x9.

property chessboardSquareLength : float

discardCapture(cam: MobileCam, iAcquisition: int, iFrame: int) → None

duplicateName : Callable

duplicatePath : Callable

getAvailableIntrinsics(cam: MobileCam) → List[str]

getBlobs(cam: MobileCam, iAcquisition: int) → List[Blob]

getIntrinsicBestMatchAlert(cam: MobileCam) → str

getIntrinsicIndex(cam: MobileCam, intrPath: str) → int

iAcquisitionLatest(cam: MobileCam) → int

property infoAction : ParamAction

property intrMatchTolerance : float

Tolerance that determines which intrinsics are considered for a camera [0-1].

property intrMaxError : float

Camera intrinsics with pixel reprojection error above this value are ignored.

loadCapture(cam: MobileCam, iAcquisition: int, iFrame: int) → bool

nCaptures(cam: MobileCam, iAcquisition: int) → int

null : Self

processCapture(cam: MobileCam, iAcquisition: int, iFrame: int) → bool

recoverCapture(cam: MobileCam, iAcquisition: int, iFrame: int) → None

reset() → None

runCalibration(cam: MobileCam, iAcquisition: int, iCalRun: int, calibFlags: int) → bool

runningTasks(cam: MobileCam) → int

saveCalibrationConfig(cam: MobileCam, iAcquisition: int, radialDistCoeffMode: int) → int

scan() → None

sendCaptureCalibImagePng(cam: MobileCam, iAcq: int) → None

setDefaultIntrinsic(cam: MobileCam) → None

setIntrinsic(cam: MobileCam, intrPath: str) → None

class d3.CameraCalibrationObservation

Bases: Resource

property blobSettings : BlobSettings

property capturedIntrinsics : LensIntrinsics

duplicateName : Callable

duplicatePath : Callable

property enabledForCalibration : bool

property maxCaptureTimeErrorMs : float

null : Self

property outliers : List[CameraObservationPoint]

property points : List[CameraObservationPoint]

property resolution : Vec2

show3dObservation(debugObject: DbgObject, label: str, registration: CameraTrackerRegistration, kTranslation: float, kRotation: float) → None

property solvedError : float

property solvedPos : Vec

property solvedPose : CameraPose

property solvedRot : Vec

property trackedFocus : float

property trackedPos : Vec

property trackedPose : CameraPose

property trackedRot : Vec

property trackedZoom : float

property validPoints : List[CameraObservationPoint]

class d3.CameraCalibrationSettings

class d3.CameraCalibrationSettings(arg0: CameraCalibrationSettings)

Bases: _BlipValue

property BAIterations : int

property bundleAdjustTarget : int

property calibrationModel : int

property confidence : float

property confidenceAuto : int

property fixedIntrinsics : int

property inlierMaxReprojectionError : float

property inlierNormalPercentile : int

null : Self

property outlierMode : int

property planarAngle : float

property planarType : int

property refineMethod : int

property useDistortion : int

property useLensShift : int

class d3.CameraCalibrationSystem

Bases: Subsystem

alignObservation(obs: ManualCameraCalibrationObservation, spatialCalibration: SpatialCalibrationConfig) → None

captureNewObservation(camera: Camera) → None

deleteObservation(obs: CameraCalibrationObservation) → None

findConfigForObservation : Callable

get : Callable

getCoordinateSystemInfo(spatialCalibration: SpatialCalibrationConfig) → List[List[str]]

isLowerCoordinateSystemNorm : Callable

property lastCalibrationError : Vec

null : Self

observationIsPrimary(obs: CameraCalibrationObservation, spatialCalibration: SpatialCalibrationConfig) → bool

property onCalibrationChanged : Action

property overallError : float

property progress : float

resetAllObservations(calibration: SpatialCalibrationConfig) → None

runCalibrateAll(calibration: SpatialCalibrationConfig) → None

runCalibrateForObservation(obs: CameraCalibrationObservation) → None

runSetValidPointsForCameraObservations(calibration: SpatialCalibrationConfig) → None

setValidPointsForCameraObservations(spatialCalibration: SpatialCalibrationConfig, objects: List[Object], referenceObservation: CameraCalibrationObservation) → None

class d3.CameraCommand

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.CameraCommunication

Bases: _BlipValue

property cameras : List[MobileCam]

clearAndDisconnectCameras() → None

isCameraAlive(cam: MobileCam) → bool

property isSimulating : bool

nAliveCameras() → int

null : Self

receivedAcksList() → List[str]

receivedAllAcks() → bool

receivedNoAcksList() → List[str]

class d3.CameraConfig

Bases: CameraCommand

duplicateName : Callable

duplicatePath : Callable

property exposure : int

property focus : float

property gain : float

property iris : float

null : Self

property pan : float

property shutter : float

property tilt : float

property zoom : float

class d3.CameraControlModule

Bases: Module

property camera : CameraDevice

property command : CameraCommand

filterCommandForAvailability(resource: Resource) → bool

filterCommandForCreation(classNode: ClassNode) → bool

null : Self

class d3.CameraCutControl

Bases: IndirectionControl

SetExtensionAddition : Final

SetExtensionMask : Final

property calibrationError : float

property direction : Vec

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

property rayColours : List[Colour]

property rayEndpoints : List[Vec]

property rayOrigins : List[Vec]

class d3.CameraObservationPoint

Bases: _BlipValue

property cameraPoint : Vec2

property meshPos : Vec

null : Self

property object : Object

property objectUV : Vec2

class d3.CameraOld

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.CameraOnOff

Bases: CameraCommand

duplicateName : Callable

duplicatePath : Callable

null : Self

property switch : int

class d3.CameraPanTilt

Bases: CameraCommand

duplicateName : Callable

duplicatePath : Callable

null : Self

property pan : float

property tilt : float

class d3.CameraPlate

Bases: Projection

null : Self

property pixelBorder : int

UV islands on screens are expanded by this many pixels to cover edge sampling artifacts such as black fringing.
Note that there must be an equivalent amount of empty space in the screen UV map to take advantage of this.

property plate : int

Which Camera plate the mapping targets.

property reprojectionDist : float

Set to the approximate distance between the camera and the main virtual content. 0 to turn off reprojection

class d3.CameraPose(arg0: CameraPose)

Bases: _BlipValue

property matrix : Mat

null : Self

property pos : Vec

property rotation : Vec

scaleDifference(other: CameraPose, kTranslation: float, kRotation: float) → CameraPose

class d3.CameraPoseInfo

Bases: _BlipValue

null : Self

property source : ContentViewPointSource

property timeStamp : float

class d3.CameraPosition

Bases: Resource

property distance_to_pivot : float

duplicateName : Callable

duplicatePath : Callable

property elevation : float

getViewPos() → None

property heading : float

null : Self

property pivot : Vec

property roll : float

property view_angle : float

property virtual_camera_coordinates : int

Apply virtual camera position and rotation offsets relative to original camera, or in global coordinate space.

property virtual_camera_position : Vec

property virtual_camera_rotation : Vec

property virtual_camera_zoom : float

Gain applied to focal length of camera to give virtual zoom in or out.

class d3.CameraRecallPreset

Bases: CameraCommand

property drive_speed : int

1 (Slow) - 50 (Fast)

duplicateName : Callable

duplicatePath : Callable

null : Self

property preset : int

The preset to be recalled (0 - 99)

Bases: _BlipValue

clear() → None

getInfo(arg0: int) → CameraSwitchFrameInfo

property isActive : bool

property nFramesCapturedAfterSwitch : int

null : Self

size() → int

property switchFinishedAction : Action

property triggerOnTrackingChange : bool

class d3.CameraSwitchFrameInfo

Bases: _BlipValue

property backplateSwitchPhase : str

property feedOutputDisplay : Display

property frame : DxTexture

property frontplateSwitchPhase : str

null : Self

property tFrame : float

property targetDisplay : Display

property targetDisplayFrontplate : Display

property viewpointDisplay : Display

property viewpointDisplayFrontplate : Display

class d3.CameraTallyDisplay

Bases: DisplayIndirection

property debugger : CameraSwitchDebugger

null : Self

class d3.CameraTrackerObservationsTester

property iObservation : int

null : Self

property sourceCamera : Camera

property view : int

class d3.CameraTrackerRegistration

Bases: _BlipValue

apply(tracker: CameraPose) → CameraPose

property distortion : Mat

property focal : Mat

null : Self

property origin : Mat

class d3.CameraTrackerTester

property delaySec : float

Artificial delay to source camera tracking data

property focalOffset : Vec

Offset to apply to camera focal plane

property focalRotation : Vec

Rotation to apply to camera focal plane

property focusEncoderOverride : float

Override the focus encoder value. Set to -1 to keep source camera value.

property maxFieldOfViewH : float

Maximum value of the range used to scale the FOV

property minFieldOfViewH : float

Minimum value of the range used to scale the FOV

null : Self

property originOffset : Vec

Offset to apply to source camera position

property originRotation : Vec

Rotation to apply to source camera rotation

property sourceCamera : Camera

Camerea to use a source of tracking data

property trackingSourceType : int

Determines whether the driver creates a camera or object tracking source

property zoomEncoderOverride : float

Override the zoom encoder value. Set to -1 to keep source camera value.

class d3.CameraTrackingSource

property aperture : float

Aperture (f-stop) value

property aspectRatio : float

Raw aspect ratio intrinsic value (w / h)

property centerShift : Vec2

Raw center shift intrinsic value (mm)

property fieldOfViewH : float

Raw horizontal FOV intrinsic value (degrees)

property fieldOfViewV : float

Raw vertical FOV intrinsic value (degrees)

property focalLength : float

Raw focal length intrinsic value (mm)

property focusDistance : float

Focus distance value (m)

property focusEncoder : float

Raw focus encoder value

getFocusEncoderHint() → str

getZoomEncoderHint() → str

property k1k2k3 : Vec

Raw lens distortion intrinsic values

property lensDelayOffset : float

Time in seconds between the spatial tracking data arriving and the lens data arriving.
If negative lens data arrives before the spatial frame.
If positive, lens data arrives after the spatial frame.

lockFocusEncoderValue(lock: bool) → None

lockZoomEncoderValue(lock: bool) → None

property lockedFocusValue : float

property lockedZoomValue : float

null : Self

property sensorSize : Vec2

Raw sensor size intrinsic value (mm)

property zoomEncoder : float

Raw zoom encoder value

class d3.CameraVideoIn

Bases: VideoIn

null : Self

duplicatePath : Callable

null : Self

property showAdvanced : int

Show Advanced Options

property showStackedProjectors : int

Show Stacked Projectors

class d3.CatchupGroup

Bases: _BlipValue

null : Self

class d3.Change

Bases: _BlipValue

null : Self

class d3.ChannelInfo

class d3.ChannelInfo(arg0: ChannelInfo)

Bases: _BlipValue

property hardwareId : str

property name : str

null : Self

class d3.ChannelInstance

class d3.ChannelInstance(arg0: ChannelInstance)

Bases: _BlipValue

STRATEGY_MANUAL : Final = 2

property assigner : ClusterAssigner

property channel : str

property fragments : List[FrameFragment]

property iViewpoint : int

property mapping : Projection

null : Self

class d3.ChannelInstanceIdentifier

Bases: _BlipValue

null : Self

class d3.ChannelMappingAssigner

Bases: _BlipValue

property assigner : ClusterAssigner

How to split and transport the video stream

property channel : str

Which channel to use from the asset.

property loadWeight : float

The amount of load to take from the cluster pool. Higher means more machines are assigned to the instance.

property mapping : Projection

Which mapping to use for viewpoints and compositing

null : Self

class d3.ChannelRouterModule

property aComponent : int

property bComponent : int

property gComponent : int

null : Self

property rComponent : int

property source0 : ContentSource

property source1 : ContentSource

class d3.ChevronModule

property angle : float

property firstBrightness : float

null : Self

property rotation : float

property spacing : float

property speed : float

property width : float

class d3.ChristieProjectorDevice

Bases: ProjectorDevice

exportWarpFilesHelper : Callable

null : Self

class d3.ChromaKeyModule

property colourCutoff : float

property colourFeathering : float

property despill : float

property despillLuminanceAdd : float

property keyColour : Colour

property maskFeathering : float

null : Self

property sharpening : float

property source : ContentSource

class d3.ChromaticitySet

Bases: _BlipValue

property blue : Vec2

property ca : int

property green : Vec2

null : Self

property red : Vec2

property white : Vec2

class d3.ClassEditorAttribute

Bases: ReflectionAttributeT

null : Self

property removeFields : List[str]

property separators : List[str]

class d3.ClassInfo

action(arg0: string_view) → ActionInfo

property actions : List[ActionInfo]

property base : ClassInfo

property constructors : List[ConstructorInfo]

field(arg0: string_view) → FieldInfo

property fields : List[FieldInfo]

findProperty(arg0: string_view) → PropertyInfo

method(arg0: string_view) → MethodInfo

property methods : List[MethodInfo]

property name : str

null : Self

property properties : List[PropertyInfo]

property_(arg0: string_view) → PropertyInfo

property size : int

staticField(arg0: string_view) → ReflectionValue

staticMethod(arg0: string_view) → Callable

property templates : List[Type]

property type : Type

class d3.ClassMenu(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

set(className: str, a: ParamAction, sortIntoCategories: bool, showOnlyUserVisibleClasses: bool) → bool

setFilter(filtrFunc: Callable) → None

uiTransparencyDisabled : Callable

class d3.ClassNode

Bases: _BlipValue

property categoryName : str

property creator : Resource

property group : str

property name : str

null : Self

property rpType : Type

property userName : str

class d3.Client

Bases: _BlipValue

null : Self

class d3.CloudExportTask

Bases: Task

null : Self

class d3.CloudSystem

Bases: Subsystem

activeUsername() → str

addExportTask(selectionStartBeat: float, selectionEndBeat: float) → None

cancelExportTask() → None

exportConfig() → ExportConfig

exportStatus() → ExporterStatus

hasExporter() → bool

null : Self

onActiveUserChanged() → Action

onStorageInfoChanged() → Action

onUploadAssetsResponse() → Action

refreshStorageInfo() → None

retryUploadTask() → bool

storageDrives() → List[str]

storageOrganizations() → List[str]

class d3.CloudUploadTask

Bases: Task

null : Self

class d3.ClusterAssigner

Bases: Resource

SPLIT_TYPE_MANUAL : Final = 2

SPLIT_TYPE_TILES : Final = 0

TRANSPORT_BIT_DEPTH_10 : Final = 1

TRANSPORT_BIT_DEPTH_12 : Final = 2

TRANSPORT_BIT_DEPTH_16 : Final = 3

TRANSPORT_BIT_DEPTH_8 : Final = 0

TRANSPORT_FORMAT_RGB444 : Final = 0

TRANSPORT_FORMAT_YUV420 : Final = 2

TRANSPORT_FORMAT_YUV422 : Final = 1

TRANSPORT_TYPE_COMPRESSED : Final = 2

TRANSPORT_TYPE_NDI : Final = 0

TRANSPORT_TYPE_UNCOMPRESSED : Final = 1

duplicateName : Callable

duplicatePath : Callable

property enableAlpha : bool

isUpscaleSupported() → bool

isValidCombination() → bool

isValidWorkloadTransportCombination : Callable

property maxTileSize : Int2

Largest resolution before viewports are split into tiles.
Null values default to a safe limit

maxTransportResolution() → Int2

null : Self

property overlap : int

Overlap between splits that is blended together.
Use to hide simulation imperfections.

property padding : int

Padding between splits that is rendered, but cut off before compositing.
Use to remove screen-space edge artifacts.
If in Full-Frame mode, padding will apply on the outside of the frame

property preferredNetwork : IPAddress

property proxySettings : ProxySettings

property scaleFactor : float

Scale factor for the resolution. Downscaled streams will be upscaled using Super Resolution techniques

property splitter : int

property transportBitDepth : int

property transportFormat : int

property transportType : int

class d3.ClusterPool

Bases: Resource

assetErrors(asset: RenderStreamAsset) → List[str]

assignerErrors(assigner: ClusterAssigner) → List[str]

duplicateName : Callable

duplicatePath : Callable

getOnlineRenderMachines() → List[RenderStreamMachine]

getOnlineUnderstudies() → List[RenderStreamMachine]

property machines : List[RenderStreamMachine]

null : Self

property understudies : List[RenderStreamMachine]

class d3.Col

class d3.Col(rgb: Col)

class d3.Col(arg0: int, arg1: int, arg2: int)

class d3.Col(arg0: int, arg1: int, arg2: int, arg3: int)

class d3.Col(c: Colour)

Bases: _BlipValue

property a : int

property b : int

black : Col

blackZeroAlpha : Col

blue : Col

caramel : Col

cyan : Col

darkGrey : Col

fromHSL : Callable

property g : int

green : Col

grey : Col

lightGrey : Col

lime : Col

magenta : Col

mix(c: Col, f: float) → Col

null : Self

orange : Col

pink : Col

property r : int

red : Col

salmon : Col

toHSL() → Vec

toNormalisedColour() → Colour

transparent : Col

turquoise : Col

white : Col

whiteZeroAlpha : Col

yellow : Col

class d3.CollapsableTitleButton(*args, **kwargs)

Bases: CollapsableWidget

null : Self

set(title: str, id: str, canClose: bool) → None

class d3.CollapsableWidget(*args, **kwargs)

Bases: Widget

collapse() → None

expand() → None

property expandAction : Action

property expanded : bool

focusedWidget : Callable

property header : Widget

linkExpansionTo(other: CollapsableWidget) → None

null : Self

set(name_: str, id: str) → CollapsableWidget

setTitleText(text: str) → None

startCollapse() → None

startExpand() → None

uiTransparencyDisabled : Callable

class d3.CollapseHeaderWidget(*args, **kwargs)

Bases: Widget

property clickAction : Action

property drawLine : bool

flash(onOff: bool, period: float, c: Colour, duration: float) → None

focusedWidget : Callable

null : Self

onClick() → None

Expand or collapse the group

setArrow(tex: DxTexture) → None

tint(c: Colour) → CollapseHeaderWidget

uiTransparencyDisabled : Callable

class d3.CollapseTitleHeader

Bases: TitleButton

null : Self

toggleExpand() → None

Expand or collapse the window

class d3.Colour

class d3.Colour(arg0: Colour)

class d3.Colour(arg0: Colour, arg1: float)

class d3.Colour(arg0: float, arg1: float, arg2: float)

class d3.Colour(arg0: float, arg1: float, arg2: float, arg3: float)

class d3.Colour(arg0: Col)

class d3.Colour(arg0: HDRColour)

Bases: _BlipValue

property a : float

property b : float

black : Colour = <d3.Colour object>

blackZeroAlpha : Colour = <d3.Colour object>

blue : Colour = <d3.Colour object>

caramel : Colour = <d3.Colour object>

cyan : Colour = <d3.Colour object>

darkGrey : Colour = <d3.Colour object>

fromHSL : Callable

property g : float

green : Colour = <d3.Colour object>

grey : Colour = <d3.Colour object>

lightGrey : Colour = <d3.Colour object>

lime : Colour = <d3.Colour object>

magenta : Colour = <d3.Colour object>

mix(arg0: Colour, arg1: float) → Colour

null : Self

orange : Colour = <d3.Colour object>

pink : Colour = <d3.Colour object>

property r : float

red : Colour = <d3.Colour object>

toCol() → Col

toHSL() → Vec

toNormalisedColour() → Colour

toVec() → Vec

transparent : Colour = <d3.Colour object>

turquoise : Colour = <d3.Colour object>

white : Colour = <d3.Colour object>

whiteZeroAlpha : Colour = <d3.Colour object>

yellow : Colour = <d3.Colour object>

class d3.ColourAdjustModule

property ccBrightness : float

property ccContrast : float

property ccKelvin : float

property ccSaturation : float

property ccTint : float

property ccWhiteBalanceMode : int

Controls which white balance preset is applied

property gainColour : Colour

property midtoneColour : HDRColour

null : Self

property outputLevelHigh : float

property outputLevelLow : float

property shadowColour : Colour

property source : ContentSource

class d3.ColourInspector

Bases: ResizableWidget

exportColourCheckerResult() → None

property isStickyable : bool

null : Self

set(getTextureCallable: Callable, fullRes: Vec2, imageName: str, getOcioIOColourSpaceCallable: Callable, getAcesIOColourSpaceCallable: Callable) → ColourInspector

class d3.ColourModule

null : Self

class d3.ColourProfile

Bases: Resource

property colourspace : int

property customPrimaries : ChromaticitySet

When the colour space is set to ‘Custom’, these will be used.

duplicateName : Callable

duplicatePath : Callable

property gammaLevel : float

Gamma

Type:
Gamma level for gamma curve

property gammacurve : int

null : Self

property paperwhite : float

Paper white surface luminance in nits/candela.

property peakwhite : float

The maximum display intensity in nits/candela.

property profilename : str

User defined description of the profile

property tonemapping : int

Technique to use for HDR content on an SDR output

class d3.ColourResponseToDisplay

Bases: Resource

property ccm : Mat

property display : Display

duplicateName : Callable

duplicatePath : Callable

property gainBlue : float

property gainGreen : float

property gainRed : float

null : Self

class d3.ColourShift

Bases: Resource

property RGB_controlled : int

If ‘Separate’, you can control min/max/gamma separately; otherwise, all work together

property blue_gamma : float

Gamma curve setting. Higher numbers produce darker results; 1 means no change

property blue_max : float

Levels higher than ‘max’ are scaled up to full

property blue_min : float

Levels lower than ‘min’ are scaled down to black

property brightness__shift_ : float

property contrast__scale_ : float

duplicateName : Callable

duplicatePath : Callable

property green_gamma : float

Gamma curve setting. Higher numbers produce darker results; 1 means no change

property green_max : float

Levels higher than ‘max’ are scaled up to full

property green_min : float

Levels lower than ‘min’ are scaled down to black

property hardness : float

Lower numbers produce softer edges between transparent and opaque areas

property hue_shift : float

Shifts hue; in degrees

property key_colour : Colour

The key colour becomes transparent

null : Self

property red_gamma : float

Gamma curve setting. Higher numbers produce darker results; 1 means no change

property red_max : float

Levels higher than ‘max’ are scaled up to full

property red_min : float

Levels lower than ‘min’ are scaled down to black

property saturation_scale : float

When less than 1, desaturates (0 is b/w); when greater than 1, enhances saturation

property threshold : float

Colours closer than ‘Threshold’ to the key colour become transparent

class d3.ColourShiftData

class d3.ColourShiftData(arg0: ColourShiftData)

Bases: _BlipValue

property brightness : float

property contrast : float

property gamma : Vec

property keyColour : Colour

property keyHardness : float

property keyThreshold : float

null : Self

setShaderParameters(mtl: ShaderMaterial, objectName: str) → None

setup(satScale: float, hueShift: float, minLevel: Vec, maxLevel: Vec) → None

class d3.ColourShiftMaterial

Bases: DxMaterial

add : Final

addMtl : DxMaterial

alpha : Final

alphaMtl : DxMaterial

anisotropic : Final

lineStrip : Final

linearSample : Final

mipmap : Final

multMtl : DxMaterial

multiply : Final

multiplyAlpha : Final

null : Self

over : Final

overMtl : DxMaterial

pointSample : Final

set(cs: ColourShiftData, texture: DxTexture) → None

textureBorder : Final

textureBorderU : Final

textureBorderV : Final

textureClamp : Final

textureWrap : Final

zCmpAlways : Final

zCmpLessEqual : Final

class d3.ColourWheel

Bases: Resource

property channel : int

duplicateName : Callable

duplicatePath : Callable

null : Self

property primaries : List[Primary]

class d3.ColourWheelWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

property hue : float

name(text: str) → None

null : Self

property offset : float

property saturation : float

set(diameter: float) → ColourWheelWidget

uiTransparencyDisabled : Callable

class d3.Colours

Bases: _BlipValue

colourNames() → List[str]

getItem(arg0: int) → Colour

instance : Callable

null : Self

class d3.Column

Bases: _BlipValue

property field : FieldAccessor

property lockable : bool

property name : str

null : Self

property visible : bool

class d3.CommonCommandInfo

Bases: _BlipValue

null : Self

class d3.Comms

Bases: IComms

Active : Final = 0

Evasive : Final = 2

Finished : Final = 4

Hung : Final = 3

Inactive : Final = 1

allNodeNames() → List[str]

nodeName() → str

null : Self

class d3.CommsSystem

Bases: Subsystem

property comms : Comms

null : Self

class d3.ComposeModule

Bases: Module

property blendBorder : float

property content_source_1 : ContentSource

property content_source_2 : ContentSource

property content_source_3 : ContentSource

property content_source_4 : ContentSource

property horizontalShift : float

null : Self

property rotationSpeed : float

property source_1 : float

property source_2 : float

property source_3 : float

property source_4 : float

property verticalShift : float

class d3.CompositeCameraTrackingSource

Bases: CameraTrackingSource

property lensSource : CameraTrackingSource

Tracking source to get lens encoder data and intrinsics from

null : Self

property poseSource : ObjectTrackingSource

Tracking source to get position and rotation from

class d3.CompositeTexture

addItem() → None

property blendModes : List[int]

null : Self

removeItem(index: int) → None

property size : Int2

property textures : List[DxTexture]

class d3.CompositorTargetKey

Bases: _BlipValue

property display : Display

property displayTarget : int

null : Self

property resolution : Int2

property uvRectangle : Rect

class d3.CompressionOptions

Bases: _BlipValue

property compressionLevel : int

property normalsQuantizationBits : int

null : Self

property positionsQuantizationBits : int

property texCoordsQuantizationBits : int

class d3.ComputeShaderSystem

Bases: Subsystem

null : Self

class d3.ConnectedField

Bases: _BlipValue

null : Self

setFloat(v: float) → None

setString(v: str) → None

property value : ReflectionValue

property variable : ExpressionVariable

class d3.ConnectionArgs

Bases: _BlipValue

null : Self

class d3.ConsoleEndpoint

Bases: _BlipValue

null : Self

class d3.ConsoleExternalMutexProvider

Bases: _BlipValue

null : Self

class d3.ConstructorInfo

property args : TCallArgs

null : Self

class d3.ContentSource

class d3.ContentSource(arg0: int)

class d3.ContentSource(arg0: ContentSource)

class d3.ContentSource(arg0: int, arg1: DxTexture)

Bases: _BlipValue

property arrow : int

property recoveryCommand : ControlString

sendFailover(source: str) → None

sendRecovery(source: str) → None

class d3.ControlModule

Bases: Module

property auto_resend : int

property command : ControlString

property control_device : ControlDevice

null : Self

property variable : int

class d3.ControlPatch

Bases: Resource

controlsField(fieldUndecoratedName: str) → bool

duplicateName : Callable

duplicatePath : Callable

property embeddedInResource : bool

property layerDescriptionSuffix : str

null : Self

class d3.ControlString

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property string : str

class d3.ControlSurface

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.CopyData

Bases: _BlipValue

null : Self

class d3.CoreResourceManager

Bases: Subsystem

ArrowBitmap : Final = 0

CheckerBoardBitmap : Final = 3

DemoLogoBitmap : Final = 1

LuxmapBitmap : Final = 5

OneOnOneOffBitmap : Final = 2

UnknownThumb : Final = 4

getBitmap(name: int) → DxTexture

null : Self

class d3.Core_Impl

Bases: _BlipValue

null : Self

class d3.CoutEndpoint

Bases: ConsoleEndpoint

null : Self

class d3.CpsAxisState

null : Self

class d3.CustomEngineDefinition

Bases: EngineDefinition

fetchAllRegisteredEngineIdentifiers : Callable

null : Self

class d3.CustomTiming

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property hActive : int

property hBack : int

property hFront : int

property hPolarity : int

property hSync : int

property interlaced : int

null : Self

property pixelClock : int

property vActive : int

property vBack : int

property vFront : int

property vPolarity : int

property vSync : int

class d3.Cylindrical

Bases: Projection

property anchor : int

property arc : float

Arc around the cylinder axis the content is projected from.
Extends symmetrically either side of the X axis of the object.

null : Self

property pixelBorder : int

property projectionMode : int

Whether the content is on the inside or outside of the target surface.

class d3.CylindricalProjectionObject

null : Self

property size : Vec

Controls the size of the cylinder

class d3.D3

Bases: App

alertError(message: str) → None

Alert the user regarding a critical error

alertInfo(message: str) → None

Alert the user regarding a notable event

alertWarning(message: str) → None

Alert the user regarding a potential issue

clipObjects() → List[Resource]

currentContext() → str

Get the current function context

cycleFeeds() → None

Cycle feed output display on the GUI head

property debugOutput : str

directorForceQuitAll() → None

Kill all machines (kill process)

directorForceQuitSingle(hostname: str) → None

Kill single machine (kill process)

directorQuitAll() → None

Quit all machines (polite)

directorQuitSingle(hostname: str) → None

Quit single machine (polite)

directorRestartAll() → None

Restart all machines

directorRestartSingle(hostname: str) → None

Start single machine

directorStartAll() → None

Start all machines

directorStartSingle(hostname: str) → None

Start single machine

duplicateName : Callable

duplicatePath : Callable

property gpuLoad : float

property iHeadGui : int

isCrashReportingEnabled() → bool

lock() → None

Lock D3

property majorVersion : str

Get the major version

property minorVersion : str

Get the minor version

notify(shortName: str, detail: str) → None

Create a notification for user

null : Self

property password : str

property postOutputRenderAction : Action

property preOutputRenderAction : Action

property projectFolder : str

Get the current project folder

property projectLoadedAction : Action

property projectName : str

Get the current project name

property projectPaths : ProjectPathsManager

Get the current project paths object

quit() → None

Quit D3

property readyAction : Action

property refreshFromDirectorDelegate : Callable

saveAndBackup() → int

Save and backup the D3 scene (quietly)

saveAndBackupInteractive() → int

Save and backup the D3 scene

setClipObjects(r: List[Resource], cut: bool) → None

setCrashReportingEnabled(enabled: bool) → None

property shutdownAction : Action

property space : Space

property state : D3State

takeScreenshot() → None

Take a screenshot of the GUI head

takeScreenshotAtPath(savePath: Path) → None

Take a screenshot of the GUI head and save it to a specific path

toggleGui() → None

Toggle GUI

writeDependencies(package: IFilesystem) → None

class d3.D3Command(arg0: str, arg1: str)

class d3.D3Command(arg0: str, arg1: float)

class d3.D3Command(arg0: str, arg1: float, arg2: float)

class d3.D3Command(arg0: str, arg1: str, arg2: float, arg3: float, arg4: float, arg5: float)

Bases: _BlipValue

null : Self

class d3.D3NetManager

Bases: Resource

UNDERSTUDY_STATE_NO_TARGETS : Final = 2

UNDERSTUDY_STATE_OK : Final = 0

UNDERSTUDY_STATE_TARGET_OVERLAP : Final = 1

property actorMode : bool

property actors : List[Machine]

property currentFeedSceneChangedAction : Action

property dedicatedDirectorMode : bool

property director : Machine

property directorMode : bool

property director_type : bool

dispatchCommandAll(cmd: RemoteCommand, sessionOnly: bool) → None

dispatchCommandDirect(hostname: str, cmd: RemoteCommand, sessionOnly: bool) → bool

duplicateName : Callable

duplicatePath : Callable

findMachineByHostname(hostname: str) → Machine

getUnderstudyConfigStatus(understudy: Machine) → int

property hasValidDirector : bool

isUnderstudy(machine: Machine) → bool

property localMachine : Machine

property machineFeedChangedAction : ParamAction

property machineListChangedAction : Action

machineStatus(nodeId: int) → MachineStatus

property machines : List[Machine]

property mobileEditorMode : bool

property nonDedicatedDirectorMode : bool

property normal_preset : str

null : Self

property onMachineRoleChangedAction : Action

sendMatrixRouting(machine: Machine, feed: FeedScene) → None

property soloMode : bool

property thisMachine : Machine

property timeout : float

Automatic failover timeout - 0 is disabled

property understudies : List[Machine]

property understudy : bool

understudyAvailableFor(machine: Machine) → bool

class d3.D3NetManagerSystem

Bases: Subsystem

property d3NetManager : D3NetManager

null : Self

class d3.D3SSIAxis

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.D3SSIAxisState

null : Self

class d3.D3SSIDriver

null : Self

class d3.D3State

Bases: Resource

ACES : Final = 2

Disabled : Final = 0

DragStart : Final = 1

GammaSpace : Final = 1

OCIO : Final = 3

property activeEditorMan : ActiveEditorManager

property archiveAction : int

archiveUnusedMedia(paths: List[str], action: int) → None

property autoSaveFrequency : int

property bit_depth : int

Set bit depth for video outputs.

cmdMachineFailed(machineHostname: str) → None

cmdMachineRestored(machineHostname: str) → None

property colourManagementAllowed : bool

property colourManager : int

property colourManagerChangedAction : Action

property colourManagerVmap : int

‘Disabled’ performs no colour space conversion on assets. ‘Gamma Space’ assets are blended to a common sRGB colour/gamma space, then converted to selected output space. ‘ACES’ a linear colour/gamma space with ACES v1.2 CM & sweeteners

property commit_mode : int

property currentSetList : SetList

property currentTransportManager : TransportManager

property currentTransportManagerChangedAction : ParamAction

customFps() → optional

property defaultGammaSpaceDisplayProfile : ColourProfile

Default display profile

property defaultGammaSpaceIngestProfile : ColourProfile

Default ingest profile

property defaultTransitionInfo : TrackTransitionInfo

Default UX fade transition behaviour

property deviceMan : DeviceManager

property devices : DeviceManager

Input and output devices

property displaySettingsChangedAction : Action

property domain_number : int

Set domain number for PTP

duplicateName : Callable

duplicatePath : Callable

property enableBlackout : int

property feed : FeedScene

The current output feed configuration

property force_dmx_send : int

getTestNames() → List[str]

getUnusedMedia() → List[str]

property globalRefreshRate : Rational

property isInShow : bool

property lastExportDate : DateStamp

property license : str

listUnused() → None

localOrDirectorState() → LocalState

property lockedToDirector : bool

property lockedToNetworkChangedAction : Action

property m : int

property m_hasDoneScheduledExit : int

property mixedRealityAllowed : bool

property monitorAudio : LogicalAudioOutDevice

property nOldVersionsToKeep : int

null : Self

property ocioConfig : OcioConfig

property player : TrackPlayer

property projectName : str

property ptpprofile : int

Set PTP Profile

queryNDaysLeft() → int

property quit_h : int

property realtimeConnectorLicenceActive : bool

property rename_table : RenameTableSetting

property resetOnStop : int

Defines behaviour of the stop button; you can either reset to the start of the bar, or stay where you are

runTest(iTest: int) → None

sendCommand(cmd: str, param: float, p2: float, p3: float, p4: float, iParam: int) → None

Send a command

property slcRegionManagement : unique_ptr

smpteClockType() → int

property stage : Stage

The current stage

property stageUid : int

strikeFixtures(onOff: bool) → None

property sync_source : int

Sync to external signal or sync to PTP from IP VFC

property target_speed : int

property track : Track

The current track being edited

unpack() → None

property use_video_thumbnails : int

property videoOverlayOption : int

class d3.DL1

Bases: Fixture

property focus : float

property infraRed : bool

null : Self

property xFlip : bool

property zoom : float

class d3.DVIMatrix

Bases: Device

null : Self

class d3.DVIMatrixControlModule

Bases: Module

property command : DVIMatrixCommand

null : Self

class d3.DVIMatrixControlModuleConfig

Bases: ModuleConfig

property devices : List[DVIMatrix]

null : Self

class d3.DateStamp

class d3.DateStamp(rhs: DateStamp)

class d3.DateStamp(fsds: FilesystemDateStamp)

Bases: FilesystemDateStamp

localNow : Callable

null : Self

utcNow : Callable

class d3.DbgObject

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

arrow(label: str, v0: Vec, v1: Vec, c: Colour) → None

box(label: str, topLeft: Vec, size: Vec, c: Colour) → None

force(onOff: bool) → None

getPufferSphereMesh : Callable

getSphereMesh : Callable

line(label: str, v0: Vec, v1: Vec, c: Colour) → None

matrix(label: str, mat: Mat, lineSize: float, c: Colour) → None

normal(label: str, v0: Vec, normal: Vec, lineSize: float, c: Colour) → None

null : Self

on() → bool

point(label: str, v0: Vec, c: Colour) → None

property updateAction : Action

class d3.DcsDriver

null : Self

property sensor_width : float

class d3.DebugEndpoint

Bases: ConsoleEndpoint

null : Self

class d3.DebugOptions

Bases: _BlipValue

null : Self

options() → Options

class d3.DecodedAudioPlayer_Impl

Bases: _BlipValue

null : Self

class d3.DecodedFrame

Bases: _BlipValue

null : Self

class d3.DefaultEngineSettings

Bases: EngineSettings

null : Self

class d3.DefaultEngineSettingsResource

Bases: EngineSettingsResource

null : Self

property settings : DefaultEngineSettings

class d3.DeferredRenderer

Bases: _BlipValue

allItemsById(idFilter: str) → List[DeferredRendererItem]

calculateDisplayProxyLevels(visibleAreaRect: Rect, levels: VisibilityProxyLevels) → None

deferBoundedText(id: str, data: ReflectionValue, pos: Vec2, halign: int, valign: int, width: float, text: str) → Rect

deferCenterText(id: str, data: ReflectionValue, pos: Vec2, size: float, text: str) → Rect

deferCenteredQuad(id: str, data: ReflectionValue, pos: Vec2, size: Vec2, tex: DxTexture, col: Colour) → None

deferCircle(id: str, data: ReflectionValue, center: Vec2, radius: float, col: Colour) → None

deferDisplayQuad(id: str, data: ReflectionValue, rect: Rect, display: Display, iTarget: int, helper: FeedDisplayRenderHelper, col: Colour) → None

deferDynamicPlaceholderQuad(id: str, data: ReflectionValue, rectCallable: Callable) → None

deferDynamicPreviewQuad(id: str, data: ReflectionValue, rectCallable: Callable, textureCallable: Callable, col: Colour) → None

deferDynamicQuad(id: str, data: ReflectionValue, rectCallable: Callable, tex: DxTexture, col: Colour) → None

deferDynamicSelectionQuad(id: str, data: ReflectionValue, rectCallable: Callable) → None

deferDynamicText(id: str, data: ReflectionValue, posCallable: Callable, halign: int, valign: int, textCallable: Callable) → None

deferFeedOutputQuad(id: str, data: ReflectionValue, rect: Rect, helper: FeedSceneRenderHelper, iHead: int, bgCol: Colour, lineupTex: DxTexture) → None

deferItem(item: DeferredRendererItem) → None

deferPreviewQuad(id: str, data: ReflectionValue, rect: Rect, textureCallable: Callable, col: Colour) → None

deferQuad(id: str, data: ReflectionValue, rect: Rect, col: Colour) → None

deferText(id: str, data: ReflectionValue, pos: Vec2, halign: int, valign: int, text: str) → Rect

deferTextRightAlign(id: str, data: ReflectionValue, rpos: Vec2, text: str) → Rect

deferThumbnailQuad(id: str, data: ReflectionValue, rect: Rect, thumbResource: Resource) → None

property dirty : bool

getExtents() → Rect

intersectingItems(rect: Rect, idFilter: str) → List[DeferredRendererItem]

itemAtPoint(pos: Vec2, idFilter: str) → DeferredRendererItem

null : Self

render(viewMat: Mat) → None

reset() → None

setScale(s: float) → None

class d3.DeferredRendererItem

class d3.DeferredRendererItem(arg0: str, arg1: ReflectionValue, arg2: Rect, arg3: int)

Bases: _BlipValue

RenderType_Circle : Final = 8

RenderType_DisplayQuad : Final = 2

RenderType_FeedOutputQuad : Final = 5

RenderType_Line : Final = 6

RenderType_None : Final = 0

RenderType_Quad : Final = 1

RenderType_SelectionQuad : Final = 7

RenderType_Text : Final = 4

property bounds : Rect

property colCallable : Callable

property data : ReflectionValue

property id : str

null : Self

property renderType : int

class d3.DeformCircularMaterial

Bases: DxMaterial

add : Final

addMtl : DxMaterial

alpha : Final

alphaMtl : DxMaterial

anisotropic : Final

lineStrip : Final

linearSample : Final

mipmap : Final

multMtl : DxMaterial

multiply : Final

multiplyAlpha : Final

null : Self

over : Final

overMtl : DxMaterial

pointSample : Final

textureBorder : Final

textureBorderU : Final

textureBorderV : Final

textureClamp : Final

textureWrap : Final

zCmpAlways : Final

zCmpLessEqual : Final

class d3.DeformStack

Bases: Resource

property draw_control_points_on_output : int

duplicateName : Callable

duplicatePath : Callable

empty() → bool

insert(index: int, item: DeformStackItem) → None

item(index: int) → DeformStackItem

property lookupTexture : DxTexture

null : Self

remove(index: int) → None

renderLookup(size: Int2) → None

renderTo(finalTarget: DxTexture) → None

size() → int

property stack : List[DeformStackItem]

class d3.DeformStackItem

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property enabled : bool

property manipulationTechnique : str

null : Self

render(mtl: DxMaterial, targetSize: Vec2) → None

property techniqueValues : HashTable

property userName : str

class d3.DeformStackItem_Circular

Bases: DeformStackItem

duplicateName : Callable

duplicatePath : Callable

getMaxPoints() → int

property m_points : int

property m_radii : List[float]

null : Self

size() → int

class d3.DeformStackItem_Lens

Bases: DeformStackItem

duplicateName : Callable

duplicatePath : Callable

property lens : LensIntrinsics

null : Self

class d3.DeformStackItem_Mesh

duplicateName : Callable

duplicatePath : Callable

property m_focus : float

null : Self

class d3.DeformStackItem_Reference

Bases: DeformStackItem

property display : Display

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.DeformationSettings

Bases: _BlipValue

property anchorMode : int

property autoApply : int

property lockBoundaries : int

property maxAngle : float

property maxDist : float

property mode : int

null : Self

property topologyBehaviour : int

duplicatePath : Callable

property name : str

null : Self

property receiving : bool

start() → None

property started : bool

stop() → None

class d3.DeviceManager

Bases: Resource

property devices : List[Device]

duplicateName : Callable

duplicatePath : Callable

null : Self

property redistributionDelay : int

class d3.DeviceMap

Bases: Resource

class Mapping

Bases: _BlipValue

property hardwareId : str

property logicalDevice : LogicalDevice

null : Self

addHardware(hwId: HardwareIdentifier) → None

duplicateName : Callable

duplicatePath : Callable

findHardware(logical: LogicalDevice) → HardwareIdentifier

getHardwareById(hardwareId: str) → HardwareIdentifier

getHardwareDevices() → List[HardwareIdentifier]

getMappedHardwareDevices() → List[HardwareIdentifier]

property hardware : List[HardwareIdentifier]

mapDevice(hardwareId: HardwareIdentifier, logical: LogicalDevice) → None

property mappingChangedAction : Action

property mappings : List[Mapping]

null : Self

removeHardware(hwId: str) → None

class d3.DeviceMapping

Bases: Resource

property audioOut : AudioOutDeviceMap2

duplicateName : Callable

duplicatePath : Callable

null : Self

property vfcs : VFCDeviceMap

property videoIn : VideoInDeviceMap

class d3.DfxFile

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property handle : NotchHandle

property isHandleValid : bool

null : Self

class d3.DfxLicenseData

Bases: _BlipValue

property daysRemaining : int

property isBundled : bool

property isExpired : bool

property isPerpetual : bool

property isUsed : bool

property isValid : bool

null : Self

property state : str

property type : str

class d3.DfxSystem

Bases: Subsystem

getAvailableLicenseData() → List[DfxLicenseData]

null : Self

releaseVideoMemory() → None

class d3.DimmableScreen

Bases: Screen2

null : Self

class d3.DirectProjection

Bases: Projection

null : Self

class d3.Discovery

Bases: _BlipValue

null : Self

class d3.DiskMonitor

Bases: MetricMonitor

null : Self

togglePause : Callable

class d3.Display

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

property acesFinalMatrix : Mat

ACES final matrix

property acesTransform : AcesOutputTransformParameters

ACES Output Display Transform (ODT)

property alpha : float

If the screen is translucent, this controls its opacity

property blendMode : int

Controls the way the screen is composited with the rest of the stage

property canBeFeedRectSource : bool

property colourprofile : ColourProfile

Colour/Gamma space of the output display

property colourshift : ColourShift

Colour Shift applied to correct display device output; does not appear in visualiser

property content : int

Controls which side of the screen shows content

getImageMosaic(iTarget: int, etf: int) → ImageMosaic

getPufferSphereMesh : Callable

getSphereMesh : Callable

property holdOutput : bool

If enabled, stop the output of this display from changing

property isConnected : bool

property lutfile : LutFile

Cube LUT applied to correct display device output; does not appear in visualiser

property master_fade : float

Controls output brightness; is not reflected in the visualiser

property mesh : Mesh

The mesh that defines the shape of the object

property nTargets : int

needsContent(iTarget: int) → bool

null : Self

property ocioShaderProperties : OcioShaderProperties

Available OCIO transform parameters for a given colour space.

property ocioTransform : OcioColourSpace

OCIO colour space of the display

property pixel_mask : DxTexture

Bitmap showing the appearance of each pixel

property pixel_mask_size : Vec2

Allows the pixelmask to represent a grid of pixels

property population_mask : DxTexture

Bitmap that controls whether an output pixel exists or not; should have the same resolution as the screen

property product : Product

Product

property resolution : Vec2

The resolution, in pixels

resolveTarget(iTarget: int) → Display

property mode : DisplayMode

null : Self

property vfcs : List[unique_ptr]

class d3.DisplayBlobSettings

Bases: _BlipValue

property dotSize : int

property gridSpacing : int

property include : bool

null : Self

class d3.DisplayIndirection

Bases: ForwardingDisplay

property indirectionController : IndirectionController

Control which camera’s view the MRSet outputs. Change the controller’s value to do camera switching.

null : Self

class d3.DisplayList(arg0: DisplayList)

Bases: _BlipValue

add(arg0: DisplayList) → None

clear() → None

null : Self

outlineBounded(arg0: DxMaterial, arg1: Rect, arg2: Colour, arg3: Rect) → None

property pos : Vec2

print(arg0: ~d3.SlugFont, arg1: str, arg2: ~d3.Vec2, arg3: int = 1, arg4: ~d3.Colour = <d3.Colour object>) → None

printBounded(arg0: SlugFont, arg1: str, arg2: Vec2, arg3: float, arg4: float, arg5: int, arg6: Colour) → None

print_(arg0: ~d3.SlugFont, arg1: str, arg2: ~d3.Vec2, arg3: int = 1, arg4: ~d3.Colour = <d3.Colour object>) → None

quad(arg0: DxMaterial, arg1: Rect, arg2: Colour, arg3: Rect) → None

quadBounded(arg0: DxMaterial, arg1: Rect, arg2: Colour, arg3: Rect, arg4: float) → None

quadRounded(arg0: int, arg1: Rect, arg2: Colour, arg3: Rect, arg4: Rect) → None

remove(arg0: DisplayList) → None

sublist(arg0: Vec2, arg1: int) → DisplayList

tag() → int

class d3.DisplayListWidget(*args, **kwargs)

Bases: Widget

property dl : DisplayList

focusedWidget : Callable

forAll(callable: Callable) → None

forAllVisible(callable: Callable) → None

null : Self

uiTransparencyDisabled : Callable

class d3.DisplayManagement_Client

Bases: _BlipValue

null : Self

class d3.DisplayManagerSubsystem

Bases: Subsystem

property displaysChangedAction : ParamAction

getMachineTargetModesForRefresh(hostname: str, targetIndex: int, refresh: Rational) → List[DisplayMode]

loadDisplayAdapterList(hostname: str, path: str) → bool

null : Self

saveDisplayAdapterList(hostname: str, path: str) → bool

class d3.DisplayMode(mode: DisplayMode)

Bases: _BlipValue

property bpc : int

property height : int

null : Self

property refresh : Rational

property smpte : SMPTE

property timing : Timing

property transferCharacteristics : int

property videoFormat : VideoFormat

property videoOutput : int

property width : int

class d3.DisplayOutputVFC

Bases: _BlipValue

property generation : int

property model : int

null : Self

property slot : int

property splitMode : int

property targets : List[unique_ptr]

class d3.DisplayTarget

Bases: _BlipValue

property currentMode : DisplayMode

property device : str

property fsStart : int

property modes : List[DisplayMode]

property name : str

null : Self

property preferredMode : DisplayMode

property redundantLines : int

property vfcPort : int

class d3.DisplayValueBox

Bases: ValueBox

isSupportedType : Callable

null : Self

set(container: Resource, unitType: int, prop: ValueBoxProperty) → DisplayValueBox

class d3.DistributeTask

Bases: Task

null : Self

class d3.Dmx

Bases: Subsystem

actAs : Callable

debugInput(iUniverse: int, iChannel: int, value: int) → None

get(iSignal: int) → int

isUniverseFrozen(universe: int) → bool

last(iSignal: int) → int

lastSent(iSignalStart: int, iSignalEnd: int) → float

lastValid(iSignalStart: int, iSignalEnd: int) → float

null : Self

remoteNodes(driverType: str) → List[RemoteNodeInfo]

class d3.DmxAssignRule

Bases: Resource

property do : int

duplicateName : Callable

duplicatePath : Callable

property every : int

null : Self

property starting_at : int

property step : int

class d3.DmxAssigner

Bases: FixtureAssigner

null : Self

property strings : List[DmxString]

class d3.DmxBank

Bases: Resource

property bankVersion : int

duplicateName : Callable

duplicatePath : Callable

getResource(i: int) → Resource

maxSlots : Final = 256

property name : str

null : Self

setResource(i: int, r: Resource) → None

property slotVersions : List[int]

property slots : List[Resource]

class d3.DmxBankSlot(arg0: DmxBankSlot)

Bases: _BlipValue

property bank : int

null : Self

property slot : int

class d3.DmxCommand

Bases: Resource

A command sent to a DMX fixture to get it to do things (eg turn off, reset, etc)

property channel : int

The channel (1-based) to send the number to

duplicateName : Callable

duplicatePath : Callable

property encoding : int

property max_value : int

Allows you scale the ‘value’ to any range. ‘max’ specifies the upper number in the range

property min_value : int

Allows you scale the ‘value’ to any range. ‘min’ specifies the lower number in the range

null : Self

property time : int

If the number must be sent for a certain duration to active the command, specify it here (in seconds)

property value : int

The number to send to activate the command

class d3.DmxControlModule

Bases: Module

property dmx_command_1 : DmxCommand

property dmx_command_2 : DmxCommand

property dmx_command_3 : DmxCommand

property dmx_command_4 : DmxCommand

property dmx_command_5 : DmxCommand

property dmx_command_6 : DmxCommand

property dmx_command_7 : DmxCommand

property dmx_command_8 : DmxCommand

null : Self

property value_1 : float

property value_2 : float

property value_3 : float

property value_4 : float

property value_5 : float

property value_6 : float

property value_7 : float

property value_8 : float

class d3.DmxDevice

Bases: Device

ArtnetDevice : Final = 0

EnttecDevice : Final = 1

EzdmxDevice : Final = 3

property IP_address : str

IP address to send or receive DMX commands

KinetV1Device : Final = 4

KinetV2Device : Final = 5

Receive : Final = 2

SacnDevice : Final = 6

Send : Final = 1

SendAndReceive : Final = 0

SoundlightDevice : Final = 2

WendiUnsupportedDevice : Final = 7

property actualStatus : str

property configured : bool

property directionality : int

property driver : int

Defines the protocol the driver accepts

property driverSpecificOptions : DmxDriverSpecificOptions

driverStatus() → str

driverType() → str

duplicateName : Callable

duplicatePath : Callable

property ipChangedAction : Action

lastSent() → float

lastValid() → float

property machine : Machine

Machine designated to output DMX through this device. If (none), director outputs DMX

property mappingSynopsis : str

null : Self

property speed : int

Limit send frequency, as a multiple of video output frames. Set to 44Hz if experiencing issues on receiving devices.
At 60fps, 44Hz limit would output at 30Hz - every other frame, as 60Hz exceeds the limit.

property start_universe : int

In conjunction with ‘number of universes’, defines the universe range of the device. ‘start universe’ is the 1-based number of the first universe handled by the device

property universe_mapping : List[int]

property universes : int

In conjunction with ‘start universe’, defines the universe range of the device. ‘number of universes’ is the number of universes in the range

updateDriverOptions() → None

class d3.DmxDisplay

Bases: DownloadableDisplay

null : Self

class d3.DmxDriver

Bases: FixtureDriver

property amber_level : float

property horizontal : int

property mode : int

null : Self

property rotation : int

property vertical : int

property white_level : float

class d3.DmxDriverInfo

Bases: FixtureDriverInfo

property channel : int

null : Self

property universe : int

class d3.DmxDriverSpecificOptions

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.DmxIndirectionController

property iChannel : int

DMX channel of the 8-bit bank/8-bit slot (1-based)

null : Self

property universe : int

DMX universe of the 8-bit bank/8-bit slot (1-based)

class d3.DmxLibrary

Bases: Resource

deletePatch(patch: DmxPatch) → None

duplicateName : Callable

duplicatePath : Callable

property editorTracking : int

property enableAutoPopulate : int

findOrAddSet(className: str) → DmxObjectSet

null : Self

property parameterTracking : bool

repatchAllLayers(className: str, personality: DmxPersonality) → str

property sets : List[DmxObjectSet]

unpatchAllLayers(patch: DmxPatch) → None

class d3.DmxMachineControl

Bases: Device

property dmxPatch : DmxPatch

property dmxPersonality : DmxPersonality

duplicateName : Callable

duplicatePath : Callable

property enabled : bool

property enabledRange : str

Command range for enabling machine control

property enabled_channel : int

Safety enable channel (1-based), set 0 to disable

property fieldActivity : List[str]

property holdStartTime : float

property holdTime : float

Time in seconds before the signal is acted on

property idleRange : str

Command range for idle state, applies to both restart and enable channels, values outside of these ranges are invalid.

null : Self

property restartRange : str

Command range for machine restart

property shutdownRange : str

Command range for machine shutdown

property shutdown_channel : int

Machine shutdown channel (1-based), set 0 to disable

class d3.DmxObjectSet

Bases: Resource

addBank(iBank: int, name: str) → DmxBank

autoPopulateAllBanks() → None

property autoPopulateFolder : str

property banks : List[DmxBank]

property className : str

property classType : Type

duplicateName : Callable

duplicatePath : Callable

getBank(iBank: int) → DmxBank

getNumberOfBanks() → int

null : Self

onChanged() → Action

removeBank(iBank: int) → None

class d3.DmxPatch

Bases: ControlPatch

duplicateName : Callable

duplicatePath : Callable

property iChannel : int

property iUniverse : int

make : Callable

property moveable : int

null : Self

property personality : DmxPersonality

property username : str

class d3.DmxPatchSet

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property tracking : int

class d3.DmxPersonality

Bases: Resource

addProperty(fieldName: str, displayName: str, group: str) → DmxProperty

property className : str

property classUserName : str

duplicateName : Callable

duplicatePath : Callable

isSameAs(p: DmxPersonality) → bool

property nChannels : int

property nProperties : int

null : Self

property properties : List[DmxProperty]

sortProperties() → None

property variantName : str

property vmapVersion : int

class d3.DmxPersonalityRegistry

Bases: Resource

classes() → List[Type]

duplicateName : Callable

duplicatePath : Callable

getPersonality(className: str) → DmxPersonality

iVersionSelected(className: str) → int

nVersions(className: str) → int

null : Self

personalityVersion(className: str, iVersion: int) → DmxPersonality

selectVersion(className: str, iVersion: int) → None

property sets : List[DmxPersonalitySet]

supportedModules : Callable

class d3.DmxPersonalitySet

Bases: Resource

property className : str

duplicateName : Callable

duplicatePath : Callable

property iVersion : int

null : Self

property versions : List[DmxPersonality]

class d3.DmxProjectorControlDevice

Bases: ProjectorControlDevice

property channel : int

property defaults : List[DmxCommand]

property focus_channel : int

property focus_fine_channel : int

property focus_range : Vec2

property intensity_channel : int

property intensity_fine_channel : int

property intensity_range : Vec2

property lens_shift_h_channel : int

property lens_shift_h_fine_channel : int

property lens_shift_h_range : Vec2

property lens_shift_v_channel : int

property lens_shift_v_fine_channel : int

property lens_shift_v_range : Vec2

null : Self

property pan_channel : int

property pan_fine_channel : int

property pan_range : Vec2

property shutdown : List[DmxCommand]

property startup : List[DmxCommand]

property tilt_channel : int

property tilt_fine_channel : int

property tilt_range : Vec2

property universe : int

property zoom_channel : int

property zoom_fine_channel : int

property zoom_range : Vec2

class d3.DmxProperty

Bases: Resource

Dmx16BigEndian : Final = 2

Dmx8 : Final = 0

DmxBankSlot : Final = 1

DmxOptions : Final = 4

DmxRgbColour : Final = 3

property channelOffset : int

property default : float

property displayName : str

duplicateName : Callable

duplicatePath : Callable

property fieldName : str

getNaturalValue(dmx: Dmx, iSignalBase: int) → ReflectionValue

property group : str

property max : float

property min : float

property nChannels : int

property name : str

null : Self

property options : List[DmxPropertyOption]

property type : int

property typeAsInt : int

class d3.DmxPropertyOption

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property max : int

property min : int

property name : str

null : Self

class d3.DmxScreen

Bases: DmxDisplay

property altClickAction : Action

property always_show_channels : int

property amberCompensation : float

Adjustment of amber component output

property array : int

The addressing order of the pixels - either Horizontal or Vertical

assignString(iArraySelect: int, channel: int, nFixtures: int, direction: int, highlightOnly: bool) → None

channel(iArray: int) → int

property channels : List[int]

Displays the DMX channel assignment in the visualiser

displayChannels(onOff: bool) → None

property fixture_type : int

The pixel type

hasAmberChannel() → bool

hasWhiteChannel() → bool

iArraySelect() → int

property iChannel : int

DMX channel of the first screen pixel (1-based)

isTableMalformed() → bool

property luminance : float

Light output (NITS); only affects visualiser

property neutral_white : Colour

null : Self

property origin : int

The start point of the addressing order - which corner of the screen

property personalities : List[DmxPersonality]

property status__ : int

Either active or muted. If muted, no DMX data is sent

property table : Table

DMX Screens only support comma-separated tables with 4 columns

property universe : int

DMX universe of the first screen pixel (1-based)

property universe_size : int

There are usually 512 channels in a universe; however, it’s sometimes useful to restrict a screen to a smaller number of channels within a universe

property universe_step : int

Whether a universe jump is allowed within a row/column, or not

property whiteCompensation : float

Adjustment of white component output

class d3.DmxScreenPositionDriver

property axis : str

property axisPrefixInput : str

property channel : int

property isLittleEndian : bool

Little or big endian data.

property isSigned : bool

Signed or unsigned data.

property nAxes : int

Number of axes. 4 channels per axis plus any padding.

property nChannels : int

Number of 8 bit DMX channels per axis.

null : Self

property padding : int

Padding between channels.

setAxisPrefixFromInput() → None

property universe : int

class d3.DmxShareModule

Bases: Module

property enable_blackout : int

null : Self

property output : int

class d3.DmxString

Bases: Resource

property channel : int

property direction : int

duplicateName : Callable

duplicatePath : Callable

property minorDirection : int

property nUnits : int

null : Self

property order : int

property start_pos : Vec2

property start_unit : int

property step : int

property universe : int

property universe_step : int

class d3.DmxTransport

Bases: Transport

property channel__1_based_ : int

property cue_index__bottom_2_digits_ : int

property cue_index__decimal_digits_ : int

property cue_index__top_2_digits_ : int

property master_brightness : int

null : Self

property on_sectionJump : int

property trigger_next : int

property trigger_nextCue : int

property trigger_playToEndOfSection : int

property trigger_prev : int

property trigger_returnToStartAndPause : int

property trigger_sectionJump__0_disabled_ : int

property trigger_stop : int

property trigger_trackJump__0_disabled_ : int

property universe__1_based_ : int

class d3.DmxTransport2

Bases: Transport

property brightnessChannel : int

property channel : int

property commandChannel : int

property cueXXnumber : int

property cueYYnumber : int

property cueZZnumber : int

property go_to_cue : str

property loop_section : str

property next_cue : str

property next_section : str

null : Self

property operating_mode : int

property parameterChannel : int

property play : str

property playStatus : int

property play_mode : int

property play_to_end_section : str

property prev_section : str

property return_to_start : str

property stop : str

property track_select : str

property triggerChannel : int

null : Self

property string : str

class d3.Domain

Bases: _BlipValue

Bases: App

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.DxAdapterGroupDevice

Bases: _BlipValue

null : Self

class d3.DxDevice

Bases: _BlipValue

null : Self

class d3.DxHistogram

Bases: _BlipValue

property blue : bool

compute(input: DxTexture) → None

property green : bool

property histogramMtl : Material

property limits : Vec2

property luma : bool

null : Self

property red : bool

class d3.DxMaterial(*args)

Bases: _BlipValue

add : Final = 2

addMtl : DxMaterial

alpha : Final = 1

alphaMtl : DxMaterial

anisotropic : Final = 128

blendMode(mode: int, i: int) → None

property blendMode0 : int

property blendMode1 : int

property colour : Colour

getTexAddressModeU(iStage: int) → int

getTexAddressModeV(iStage: int) → int

getZCmpMode(zMode: int) → int

lineStrip : Final = 32

linearSample : Final = 0

static make(tex0, bm0, tex1=None, bm1=0) → Any

mipmap : Final = 64

multMtl : DxMaterial

multiply : Final = 3

multiplyAlpha : Final = 5

null : Self

over : Final = 0

overMtl : DxMaterial

pointSample : Final = 16

set(tex0=None, bm0=0, tex1=None, bm1=0) → Any

setBlendState(name: int, blendMode: int, iBlendTargetMask: int) → None

setMacro(name: int, iValue: int) → None

setWorldMatrix(mat: Mat) → None

property texture0 : DxTexture

property texture1 : DxTexture

textureBorder : Final = 768

textureBorderU : Final = 256

textureBorderV : Final = 512

textureClamp : Final = 1024

textureWrap : Final = 0

zCmpAlways : Final = 2048

zCmpLessEqual : Final = 0

property zWriteEnable : bool

class d3.DxRenderer

Bases: _BlipValue

DX11_ALL_TARGETS : Final = 18446744073709551615

LineList : Final = 3

PointList : Final = 2

TriangleList : Final = 0

TriangleStrip : Final = 1

allocMaterial(type: Type) → DxMaterial

property backbufferEtf : int

cancelClip() → None

clear(c: Colour, iTarget: int) → None

clearZBuffer(bClearStencil: bool, depthValue: float) → None

clip(rect: Rect, offset: Vec2) → None

property composeMatrix : Mat

property compositorEtf : int

createMaterial() → DxMaterial

customMatrices(trans: Mat, proj: Mat) → None

fullscreenQuadImmediate(mtl: DxMaterial) → None

getBlackTexture() → DxTexture

getBlackZeroAlphaTexture() → DxTexture

getModelView(mat: Mat) → Mat

getModelViewProj(mat: Mat) → Mat

getNullMaterial() → DxMaterial

getProj() → Mat

getWhiteTexture() → DxTexture

getWhiteZeroAlphaTexture() → DxTexture

property heads : List[HeadInfo]

instance : Callable

line(v0: Vec, v1: Vec, c0: Colour, c1: Colour, mtl: DxMaterial) → None

lineList(m: DxMaterial) → DxTriStrip

lineStrip(m: DxMaterial) → DxTriStrip

null : Self

ortho() → None

perspective() → None

pointList(m: DxMaterial) → DxTriStrip

quad(m: DxMaterial, r: Rect, col: Colour, depth: float, texRect: Rect, texRect2: Rect) → None

render() → None

renderNoSort(renderSlug: int) → None

size() → Int2

target(tex: DxTexture, iTarget: int, iSlice: int, mipLevel: int, bNoDepth: bool) → None

targetHead(head: int) → None

triList(m: DxMaterial) → DxTriStrip

triStrip(m: DxMaterial) → DxTriStrip

withSlugs : Final = 1

withoutSlugs : Final = 0

addVert(vert: DxVert) → None

null : Self

class d3.DxSlugVert

Bases: _BlipValue

property banding : Colour

property colour : Col

property jacobian : Colour

null : Self

property position : Colour

property texcoord : Colour

class d3.DxTargetRestorer

class d3.DxTargetRestorer(newTarget: DxTexture)

Bases: _BlipValue

null : Self

class d3.DxTexture

Bases: Resource

ETF_NONE : Final = 0

property acesTransform : AcesInputTransformParameters

ACES Input Display Transform (IDT)

beginWritingPixels() → None

blitToFormat(fmt: int) → DxTexture

property bpp : int

clear(c: Colour) → None

deletePixels() → None

download(bResolve: bool) → None

duplicateName : Callable

duplicatePath : Callable

property etf : int

forceUpload() → None

formatStrings : List[str]

getScaleMatrix() → Mat

hasPixels(yesNo: bool) → None

load(x: int, y: int) → Colour

property name : str

null : Self

property ocioShaderProperties : OcioShaderProperties

property ocioTransform : OcioColourSpace

OCIO Input Display Transform (IDT)

resize(size: Int2) → None

resizeNoPixels(size: Int2) → None

resizeTarget(size: Int2, etf: int, eMsaa: int, allocFlags: int, sliceCount: int, mipCount: int) → None

saveFile(path: str) → None

property size : Int2

store(x: int, y: int, c: Colour) → None

class d3.DxTextureHistogram(texture: DxTexture)

Bases: _BlipValue

property channelColours : List[Col]

property channelNames : List[str]

property channels : List[List[int]]

property nBuckets : int

property nPixels : int

null : Self

class d3.DxTriStrip

Bases: _BlipValue

addVert(vert: DxVert) → None

null : Self

class d3.DxVectorscope

Bases: _BlipValue

compute(input: DxTexture) → None

property exposure : float

null : Self

property vectorscopeMtl : Material

class d3.DxVert

class d3.DxVert(arg0: Vec, arg1: Vec, arg2: Colour)

Bases: _BlipValue

property col : Colour

property normal : Vec

null : Self

property pos : Vec

property tex1 : Vec2

property tex2 : Vec2

property tex3 : Vec2

class d3.DxWaveform

Bases: _BlipValue

compute(input: DxTexture) → None

property exposure : float

property limits : Vec2

property mode : int

modeNames : Callable

null : Self

property outputResolution : Vec2

property waveformMtl : Material

class d3.EdgeFilterModule

null : Self

property source : ContentSource

property strength : float

class d3.EditManipulator(parent: SpaceWidget)

Bases: Manipulator

editObjectUnderCursor() → None

Select an object

null : Self

objectAltClick() → bool

Alt click on objects

class d3.Editor(**kwargs)

Bases: cEditor

greyOutField(fieldName, onOff) → Any

null : Self

static onAction(*properties: property) → Callable

Used as a decorator, call the decorated function when the edited resource’s action(s) specified are run

Preferred approach: ensures each subscription is automatically tracked
and unsubscribed when the Editor closes, avoiding leftover references.

populate(disallowExtendedValueBoxes: bool = False) → None

class d3.ElementChangedArgs

Bases: _BlipValue

null : Self

class d3.EmberPlusMatrix

Bases: DVIMatrix

property ipAddress : str

null : Self

property port : int

class d3.EngineDefinition

Bases: _BlipValue

fetchAllRegisteredEngineIdentifiers : Callable

null : Self

class d3.EngineSettings

Bases: _BlipValue

property additionalArgs : List[str]

property CueMode : int

property cueMode : int

duplicateName : Callable

duplicatePath : Callable

property fieldActivity : List[str]

null : Self

property transportManager : TransportManager

class d3.EventTransportDmx

Bases: EventTransport

property brightnessChannel : int

property commandChannel : int

property cueXXnumber : int

property cueYYnumber : int

property cueZZnumber : int

property dmxPatch : DmxPatch

property dmxPersonality : DmxPersonality

duplicateName : Callable

duplicatePath : Callable

property fadeDown : str

property fadeUp : str

property failoverChannel : int

property gotoCue : str

property hold : str

property loopSection : str

property nextCue : str

property nextSection : str

null : Self

property operatingMode : int

property outputModeChannel : int

property parameterChannel : int

property play : str

property playStatus : int

property playToEndSection : str

property play_mode : int

property prevSection : str

property returnToStart : str

property stateLoopSection : str

property stateNext : str

property stateNextCue : str

property statePlay : str

property statePlayToEndSection : str

property statePrev : str

property stateStop : str

property stop : str

property trackSelect : str

property triggerChannel : int

class d3.EventTransportInputMap

Bases: EventTransport

duplicateName : Callable

duplicatePath : Callable

fadeDown() → None

Fade down

fadeUp() → None

Fade up

jumpBarBack() → None

Jump a bar backwards

jumpBarForward() → None

Jump a bar forwards

jumpFrameBack() → None

Jump a frame backwards

jumpFrameForward() → None

Jump a frame forwards

jumpQuarterBeatBack() → None

Jump a quarter second backwards

jumpQuarterBeatForward() → None

Jump a quarter second forwards

jumpSectionBack() → None

Jump a section backwards

jumpSectionBackSetList() → None

Jump a section backwards across the set list

jumpSectionForward() → None

Jump a section forwards

jumpSectionForwardSetList() → None

Jump a section forwards across the set list

jumpToEnd() → None

Jump to end of track

loopSectionToggle() → None

Toggle play section looped mode

nextTrack() → None

Jump to next track

null : Self

outputHold() → None

Output hold

playToEndSectionToggle() → None

Toggle play to end of section mode

playToggle() → None

Toggle play mode

previousTrack() → None

Jump to previous track

returnToStart() → None

Jump to start of track

toggleFadeDir() → None

Toggle output fade direction

toggleOutputHold() → None

Output output hold

toggleSendTranpsortCommandsMode() → None

Toggle sending transport commands

class d3.EventTransportMidiController

Bases: EventTransport

duplicateName : Callable

duplicatePath : Callable

property input_channel__1_16_ : int

property midi_device : int

property next_cue : int

property next_section : int

property next_track : int

null : Self

property play_to_end_of_section : int

property previous_section : int

property previous_track : int

property return_to_start : int

property stop : int

class d3.EventTransportMidiNote

Bases: EventTransport

duplicateName : Callable

duplicatePath : Callable

property iChannel : int

property loopSection : int

property loopSectionInputType : int

property midiIn : MidiIn

property midiInName : str

property nextCue : int

property nextCueInputType : int

property nextSection : int

property nextSectionInputType : int

property nextTrack : int

property nextTrackInputType : int

null : Self

property on_midi_note_jump : int

property play : int

property playInputType : int

property playToEndOfSection : int

property playToEndOfSectionInputType : int

property previousSection : int

property previousSectionInputType : int

property previousTrack : int

property previousTrackInputType : int

property returnToStart : int

property returnToStartInputType : int

property stop : int

property stopInputType : int

property transportBrightness : int

property transportBrightnessInputType : int

property transportVolume : int

property transportVolumeInputType : int

class d3.EventTransportMsc

Bases: EventTransport

property cueList : str

duplicateName : Callable

duplicatePath : Callable

property midi_device : int

property mscDeviceId : int

null : Self

property on_section_jump : int

class d3.EventTransportOSC

Bases: EventTransport

FeedbackModeAlwaysSend : Final = 1

FeedbackModeNeverSend : Final = 2

FeedbackModeSendChangesOnly : Final = 0

property brightness : str

OSC string mapped to control master brightness; the message should be a float between 0 and 1

property cue : str

property cue_play_mode : int

duplicateName : Callable

duplicatePath : Callable

property fade_down : str

property fade_up : str

property feedbackInterval : float

Sets the time interval between two messages, in seconds

property feedbackMode : int

property floatCue : str

Cue sent as floating point number, in the form xx.yy
yy is always taken to be 2 digits, so 2.1 is interpreted as 2.10

property hold : str

property loop_section : str

property next_section : str

property next_track : str

null : Self

property osc_device : OscDevice

property outputs : List[OutputOSCExpression]

property play : str

property play_section : str

property previous_section : str

property previous_track : str

property return_to_start : str

property stop : str

property track_id : str

property track_name : str

property volume : str

OSC string mapped to control audio volume; the message should be a float between 0 and 1

class d3.EventTransportTrackWidget

Bases: EventTransport

buttonLoopSection() → None

buttonNextSection() → None

buttonNextTrack() → None

buttonPlay() → None

buttonPlaySection() → None

buttonPrevSection() → None

buttonPrevTrack() → None

buttonReturn() → None

buttonStop() → None

duplicateName : Callable

duplicatePath : Callable

message(shortName: str, detail: str) → None

null : Self

property onMessageReceivedAction : ParamAction

class d3.ExceptionMessage

Bases: _BlipValue

getDetails() → List[str]

getDetailsCount() → int

null : Self

property shortName : str

property tReceived : float

class d3.ExifData

Bases: _BlipValue

property data : List[Pair]

null : Self

class d3.ExportConfig

Bases: Resource

property cloudDrive : str

disguise Cloud drive used for export

property cloudOrganization : str

disguise Cloud organization

duplicateName : Callable

duplicatePath : Callable

property exportToCloud : bool

Export to a disguise Cloud location

property exportToLocal : bool

Export to the local project folder

property gltfExportOptions : GltfExportOptions

property latestPrevizDateUTC : str

property latestPrevizUrl : str

property localExportPath : str

Set the location for your local export

null : Self

onChanged() → Action

property timelineOption : int

Select timeline range to export

class d3.ExportOptions

Bases: _BlipValue

null : Self

class d3.ExportOptionsResource

Bases: Resource

property displayName : str

duplicateName : Callable

duplicatePath : Callable

null : Self

supportsExtension(extension: str) → bool

class d3.ExporterStatus

class d3.ExporterStatus(arg0: ExporterStatus)

Bases: _BlipValue

Exporting : Final = 1

Idle : Final = 0

Uploading : Final = 2

null : Self

property state : int

class d3.Expression

Bases: Resource

property auto_switch : int

cleanName : Callable

duplicateName : Callable

duplicatePath : Callable

property error : str

property expression : str

property expressionString : str

property isOK : bool

property isSelf : bool

null : Self

reset() → None

class d3.ExpressionVariable

class d3.ExpressionVariable(arg0: ExpressionVariable)

Bases: _BlipValue

FloatType : Final = 0

FunctionType : Final = 2

StringType : Final = 1

property defaultFloat : float

property defaultString : str

property errorText : str

makeExpression() → str

property name : str

null : Self

property type : int

class d3.ExpressionVariablesContainer

Bases: _BlipValue

null : Self

property variables : List[ExpressionVariable]

class d3.ExpressionVariablesDevice

Bases: Device

property container : ExpressionVariablesContainer

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ExpressionVariablesModule

Bases: Module

property fields : List[ConnectedField]

property fieldsChangedAction : Action

null : Self

class d3.ExpressionVariablesModuleConfig

Bases: ModuleConfig

property container : ExpressionVariablesContainer

null : Self

class d3.ExtendedTaskStatus

Bases: _BlipValue

property name : str

null : Self

property status : TaskStatus

property statusColour : Colour

property statusString : str

class d3.EzDriver

property enablePacketTimingGraph : bool

Log incoming packet times to a graph

null : Self

class d3.FSDuplicateMultiple

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property number_of_duplicates : int

property output_offset : Vec2

property source_offset : Vec2

class d3.FadeModule

Bases: Module

property fade_0 : float

property fade_1 : float

property fade_2 : float

property fade_3 : float

property fade_4 : float

property fade_5 : float

property fade_6 : float

property fade_7 : float

property group_0 : Projection

property group_1 : Projection

property group_2 : Projection

property group_3 : Projection

property group_4 : Projection

property group_5 : Projection

property group_6 : Projection

property group_7 : Projection

null : Self

class d3.FailoverData

Bases: _BlipValue

null : Self

class d3.FastCaptureProcess

null : Self

property numFramesPerTest : int

subscribeToFrames() → None

unsubscribeFromFrames() → None

warningStatus() → str

class d3.FastCaptureTestProcess

Bases: FastCaptureProcess

capturedTestsForCamera(camera: Camera) → List[ReceivedTestData]

clearFastCaptureResults() → None

null : Self

update() → None

class d3.FastColourCaptureTestProcess

Bases: FastCaptureTestProcess

null : Self

property removeCurrentColourEffectors : bool

Removes Colour effects specific to screens during the capture process. Should normally be enabled
Disables screen luts, MrSet luts and any colour shift.

class d3.FastSpatialCaptureTestProcess

Bases: FastCaptureTestProcess

null : Self

class d3.Feed

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property feedRects : List[FeedRect]

property head : int

null : Self

property offset : Vec2

class d3.FeedChangeDetector

Bases: _BlipValue

null : Self

class d3.FeedDisplayRenderHelper(arg0: Display, arg1: int)

Bases: _BlipValue

null : Self

renderDisplay(brightnessTint: Colour, localMat: Mat, csData: ColourShiftData, scale: float) → None

class d3.FeedHeadConfig

Bases: Resource

property clearBackground : DxTexture

A lineup image to help match specifications - not outputted

property clearColour : Colour

The background colour of the output

duplicateName : Callable

duplicatePath : Callable

property framesLatency : int

The number of frames of latency to delay this output by.
Negative values delay all other heads.

property headConfigDeleted : Action

property liveDot : Int2

The location of a flashing pixel to give confidence everything is still working while outputting black

make : Callable

property matrixOutputs : str

The matrix output this logical feed output is routed to (e.g. “1.1”)

property name : str

null : Self

property resolution : Int2

class d3.FeedProjection

Bases: Projection

property feed_scene : FeedScene

importRectsFromTable(table: Table, clearImportedDisplays: bool) → None

null : Self

class d3.FeedProjectionObject

null : Self

class d3.FeedRect

Bases: Resource

RenderNormal : Final = 0

RenderTest : Final = 1

RenderTestLineup : Final = 2

property active : bool

canonicalRect() → Rect

property contentMode : int

Which channels to display

property deformStack : DeformStack

property displayTarget : int

duplicateName : Callable

duplicatePath : Callable

property feedRectDeleted : Action

property head : int

property lock_sizes : bool

lodFactor() → float

property mask : DxTexture

null : Self

outputRect() → Rect

property rect : Rect

property referenceDisplay : Display

renderDeformLookup() → None

property renderMode : int

property resolveDisplay : Display

rotateRect(r: Rect, rotationIndex: int) → Rect

property rotation : float

property rotationIndex : int

property screenRect : Rect

property screenSizeSet : Vec2

class d3.FeedScene

Bases: Resource

property activeRegions : List[ActiveScreenRegion]

add(r: FeedRect) → None

addHeadConfig(feedHeadConfig: FeedHeadConfig) → None

currentMachines : Callable

duplicateName : Callable

duplicatePath : Callable

ensureHeadConfig(iHead: int, resolution: Int2) → FeedHeadConfig

property excludeMode : int

property excludedMaps : List[Projection]

exportRectsAsTable : Callable

property feedRects : List[FeedRect]

getUsedHeads() → List[int]

property headConfigs : List[FeedHeadConfig]

importRectsFromTable(table: Table, clearImportedDisplays: bool) → None

isPrimaryMachine(machine: Machine) → bool

null : Self

remove(r: FeedRect) → None

removeHeadConfig(i: int) → None

renderOverlays(localMat: Mat, headFilter: int) → None

class d3.FeedSceneEventLogger

Bases: _BlipValue

null : Self

class d3.FeedSceneRenderHelper(arg0: FeedScene)

Bases: _BlipValue

FeedHead : Final = 1

GuiHead : Final = 0

null : Self

renderHead(iHead: int, brightnessTint: Colour, localMat: Mat, csData: ColourShiftData, func: int, scale: float) → None

property scene : FeedScene

class d3.FeedSceneVisualiser(*args, **kwargs)

Bases: Widget

copySelection() → None

Copy the currently selected rectangles

cutSelection() → None

Cut the currently selected rectangles

deleteSelection() → None

Delete the selected feed rectangles

property editFeedWarpDelegate : Callable

property editVec2Value : Vec2

property feedScene : FeedScene

focusedWidget : Callable

isolateSelected() → None

Isolate the currently selected rectangle

mouseClickClearAndSelect() → None

Select the feed rectangle under the cursor

mouseClickIsolate() → None

Toggle isolation for the rectangle that is clicked on

mouseClickSelect(action: int) → None

Select the feed rectangle under the cursor

mouseClickToggleSelect() → None

Toggle selection for the feed rectangle under the cursor

mouseDragDispatch(state: int, startPos: Vec2, pos: Vec2) → None

Depends on what the cursor is over…

mouseDragPan(state: int, startPos: Vec2, pos: Vec2) → None

Pan the view

mouseDragZoom(state: int, startPos: Vec2, pos: Vec2) → None

Zoom in and out of the feed

mousePopupMenu() → None

Open the popup menu

mouseScrollZoom(dir: float) → None

Zoom in and out of the feed

nudgeDown() → None

Nudge the selection down

nudgeLeft() → None

Nudge the selection to the left

nudgeRight() → None

Nudge the selection to the right

nudgeSelection(nudge: Vec2) → None

Nudge the selection in the direction specified

nudgeUp() → None

Nudge the selection up

null : Self

pasteCopyBuffer() → None

Paste the copied rectangles

property popupMenuAction : ParamAction

refresh() → None

selectAll() → None

Select all feed rectangles

property selectedRectangles : List[FeedRect]

set(fp: D3State) → FeedSceneVisualiser

setProj(arg0: FeedProjection) → FeedSceneVisualiser

switchOpLocation() → None

Switch between input and output areas

uiTransparencyDisabled : Callable

property xform_selection : List[int]

zoomToActual() → None

Zoom to actual size

zoomToAll() → None

Frame all in the viewport

zoomToSelection() → None

Frame the selection in the viewport

class d3.FeedViewSettings

Bases: _BlipValue

property feedColumns : int

property machinesPerColumn : int

null : Self

class d3.Field(*args, **kwargs)

Bases: Widget

property attention : bool

property backColourOverride : Colour

focusedWidget : Callable

null : Self

openOptions() → None

Open an editor for the field data

pulse() → None

select() → None

Select the field and begin editing

property selectOverrideAction : Action

selectValue() → None

set(arg0: str, arg1: ValueBox, arg2: bool = False) → Field

setUserVisibleNameAndLabel(arg0: str) → None

uiTransparencyDisabled : Callable

property userVisibleName : str

property valueBox : ValueBox

class d3.FieldAccessor

Bases: _BlipValue

null : Self

property undecoratedName : str

class d3.FieldEditorAttribute

Bases: ReflectionAttributeT

property hasOptions : bool

null : Self

property optionsStrings : List[str]

property optionsValues : List[int]

property separatorGroup : str

class d3.FieldInfo

property containerType : Type

instanceValue(arg0: ReflectionValue) → ReflectionValue

property isRP : bool

property name : str

null : Self

property type : Type

property undecoratedName : str

property writable : bool

class d3.FieldProperty(other: FieldProperty)

class d3.FieldProperty(object: ReflectionValue, field: FieldInfo)

class d3.FieldProperty(arg0: ReflectionValue, arg1: str)

null : Self

class d3.FieldSequence

Bases: Resource

property containerClass : str

property defaultValue : ReflectionValue

property disableSequencing : bool

duplicateName : Callable

duplicatePath : Callable

eval(t: float, ttl: int) → float

property expression : Expression

externallyControlled() → bool

property isPatched : bool

property layer : Layer

property name : str

property noSequence : bool

property notSequencable : bool

notifyEdit() → None

null : Self

options() → List[str]

property sequence : KeySequence

setExpression(expr: str) → None

setRange(min: float, max: float, gran: float) → None

setSockpuppetDisabled(onOff: bool) → None

sockpuppetControlled() → bool

property type : Type

property typeName : str

property userName : str

class d3.FifoDataSeries

Bases: Resource

property colour : Colour

duplicateName : Callable

duplicatePath : Callable

property mode : int

property name : str

null : Self

property totalLifetimeSamples : int

class d3.File

Bases: _BlipValue

null : Self

class d3.FileEndpoint

Bases: ConsoleEndpoint

null : Self

class d3.FileSys

Bases: _BlipValue

canonicalPath : Callable

createDirectory : Callable

deleteFolder : Callable

deleteFolderContents : Callable

exists : Callable

property driver : FixtureDriver

duplicateName : Callable

duplicatePath : Callable

property fixture_model : int

selection of fixture Model

property lightScatteringshadows : int

enables light scattering shadows for this fixture

property light_scattering : int

enables light scattering for this fixture

property lightsourcetype : int

Light source type

property mask : DxTexture

property max_beam_angle : float

property min_beam_angle : float

property nChannels : int

null : Self

property output_brightness : float

output brightness (lumens)

property pivot_height : float

property resolution : Vec2

property shadows : int

enables shadows for this fixture

duplicatePath : Callable

null : Self

class d3.FixtureGroup

Bases: DmxDisplay

property active : int

Controls whether DMX is being sent to the actual fixtures

property always_show_channels : int

Displays the DMX channel assignments in the visualiser

property assignment : FixtureAssigner

Controls how DMX channels are assigned to the fixtures in the screen

property fixture : Fixture

The DMX Fixture to use

property fixtureMask : DxTexture

Like population mask, controls which fixtures are present and which are absent. Use instead of population mask

property global_transform : FixtureRotation

Applies a global rotation & offset to all fixture bases in the screen

property instances : List[FixtureInstance]

property lumens : float

Fixture brightness, in ANSI Lumens. Affects visualiser only

property nAcross : int

Number of fixtures across in the fixture grid

property nDown : int

Number of fixtures down in the fixture grid

null : Self

property positioning : int

Controls how fixture positions are generated

property shared : int

property use_normals : int

If set, fixture bases are oriented along the screen surface

property xmlFile : XmlFile

class d3.FixtureInstance

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

property driverInfo : FixtureDriverInfo

property fixture : Fixture

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

property pan_tilt : int

property shift : Vec

class d3.FixtureLine

Bases: FixtureGroup

null : Self

property show_cursors : int

Shows the fixture positions as crosshairs in the visualiser

class d3.FixtureRotation

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property offset : Vec

property rotation : Vec

class d3.FixtureTarget

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property offset : Vec

property render : int

property rotation : Vec

property scale : Vec

set(offset: Vec, scale: Vec, rotation: Vec) → None

class d3.FixtureTargetObject

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

set(target: FixtureTarget) → None

class d3.FloatSequence

Bases: KeySequence

null : Self

setFloat(t: float, v: float) → None

null : Self

class d3.ForwardingDisplay

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

property currentTarget : Display

This display forwards onto others. This is the current target.

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.FpClearMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.FrameFragment

class d3.FrameFragment(arg0: FrameFragment)

Bases: _BlipValue

property loadWeight : float

property machine : RenderStreamMachine

null : Self

property renderArea : RenderArea

class d3.FrameFragmentCluster

Bases: RenderStreamCluster

property cameras : List[ChannelInstance]

null : Self

class d3.FrameRateFraction

Bases: _BlipValue

null : Self

class d3.FreeDDriver

property enablePacketTimingGraph : bool

Log incoming packet times to a graph

null : Self

class d3.FsrMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.FuzzySearchItem

class d3.FuzzySearchItem(arg0: str, arg1: ReflectionValue)

Bases: _BlipValue

property item : ReflectionValue

null : Self

property rank : int

property text : str

class d3.FuzzySearchValues

Bases: _BlipValue

addValue(name: str, value: ReflectionValue) → None

null : Self

search(text: str) → None

property values : List[FuzzySearchItem]

class d3.FxaaMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.GPUMemoryMonitor

Bases: MetricMonitor

null : Self

togglePause : Callable

class d3.GPUProfilerMonitor

Bases: MetricMonitor

null : Self

togglePause : Callable

class d3.GPUSubsystem

Bases: Subsystem

applyFanSpeeds() → None

null : Self

resetFanSpeeds() → None

class d3.GVGMatrix

Bases: DVIMatrix

property ipAddress : str

null : Self

property port : int

sendCommand(command: str, params: List[str]) → None

property waitForResponse : int

Wait for response from the device before for sending the next command.
May be required by AJA KUMO routers.

class d3.GamutWalkProcess

Bases: FastCaptureProcess

property colourSteps : float

Number of colour steps per channel.
Higher steps means colour calibration will be better but will also take longer.

property estimatedDuration : float

property fillFactor : float

Factor of the screen covered with the colour & mask

null : Self

property numFramesPerTest : int

How long each colour is held before changing.
Set in pre-calibration step.

property onSettingChangedAction : Action

property removeCurrentColourEffectors : bool

Removes Colour effects specific to screens during colour calibration. Should normally be enabled
Disables screen luts, MrSet luts and any colour shift.

class d3.GefenMatrix

Bases: DVIMatrix

property IP_Address : str

property Port : int

null : Self

class d3.GeneratedCameraTrackingSource

Bases: CameraTrackingSource

property default_commands : List[DmxCommand]

property lamp : LampController

null : Self

property pan_tilt : PanTiltController

property reset : DmxCommand

property tester : LampTester

class d3.GenericLampInfo

Bases: DmxDriverInfo

null : Self

property pan : float

property pan_flip : int

property tilt : float

property tilt_flip : int

class d3.Gizmo

Bases: _BlipValue

null : Self

null : Self

class d3.GradientModule

Bases: Module

property Inner_radius : float

property angle : float

property dither : bool

property gamma : float

property interpolation : int

property length : float

null : Self

property position : Vec2

property scale : Vec2

property type : int

class d3.GradientTexture

property endCol : Colour

property gammaCurve : float

property interpolation : int

property isDitherEnabled : bool

Dithers texture to reduce banding. Works better with higher resolution textures.

property length : float

property midPoint : Vec2

null : Self

property rotation : float

property startCol : Colour

class d3.Graph(*args, **kwargs)

Bases: GraphWidget

null : Self

set(arg0: MetricMonitor) → Graph

class d3.GraphDescriptor

Bases: Resource

property dataSeries : List[FifoDataSeries]

duplicateName : Callable

duplicatePath : Callable

property graphTitle : str

property maxData : float

property maxValue : float

property minData : float

null : Self

property thresholds : List[GraphThreshold]

property xUnits : str

property xZoom : float

property yUnits : str

class d3.GraphThreshold

Bases: Resource

property colour : Colour

duplicateName : Callable

duplicatePath : Callable

property label : str

null : Self

property value : float

class d3.GraphWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

property maxData : float

property minData : float

null : Self

overrideTitle(newTitle: str) → None

set(graphDescriptor: GraphDescriptor) → GraphWidget

setPlotSize(plotSize: Vec2) → None

uiTransparencyDisabled : Callable

class d3.GreenScreen

Bases: Prop

null : Self

class d3.GridAlignmentErrorData

Bases: _BlipValue

property alignMat : Mat

property avgError : float

property iProjector : int

property maxError : float

property minError : float

null : Self

property pointCount : int

class d3.GroupLayer

Bases: SuperLayer

areAllLayersLocked() → bool

areAnyLayersLocked() → bool

property arrows : List[Arrow]

property expanded : bool

property layers : List[SuperLayer]

nLayers() → int

null : Self

removeChild(l: SuperLayer) → None

set(layers: List[SuperLayer]) → GroupLayer

class d3.GroupScrollList(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.GrpcReceiverDriver

property ipaddr : str

IP address to communicate with RPC server

null : Self

property port : int

class d3.GrpcServer

Bases: Subsystem

null : Self

class d3.Gui

Bases: Resource

property arrowStart : Vec2

createValueBox(container: ReflectionValue, prop: ValueBoxProperty) → ValueBox

property cursorPos : Vec2

property dpiChangedAction : Action

property dpiScale : Vec2

drawArrow(from_: Vec2, to: Vec2, thickness: float, col: Colour) → None

drawSelectionMarquee(defRect: Rect) → None

duplicateName : Callable

duplicatePath : Callable

enableNewWidgetFocus(onOff: bool) → None

findEditor(r: Resource) → cEditor

property font : SlugFont

helpSystem() → HelpSystem

makeDuplicateName(str: str, predicate: Callable) → str

null : Self

property resourceManager : GuiResourceManager

property smallFont : SlugFont

class d3.GuiResourceManager

Bases: Subsystem

AddBitmap : Final = 15

AddNoteBitmap : Final = 84

ArrowDownBitmap : Final = 67

ArrowUpBitmap : Final = 66

BackBitmap : Final = 54

BoxBitmap : Final = 57

BrightnessBitmap : Final = 21

CheckButtonBitmap : Final = 23

ClockBitmap : Final = 71

CloseBitmap : Final = 0

CollapseBitmap : Final = 19

ColourPickerBitmap : Final = 29

CubicMarkerBitmap : Final = 28

DotPatternBitmap : Final = 27

ExpandBitmap : Final = 18

ExpandHorizontalBitmap : Final = 20

FilledNoteBitmap : Final = 85

FilledNoteUnseenBitmap : Final = 86

FolderBitmap : Final = 56

ForwardBitmap : Final = 55

GenlockBitmap : Final = 78

GlobalLocalBitmap : Final = 76

HatchingBitmap : Final = 31

InkDropperBitmap : Final = 83

InputBitmap : Final = 80

KeyBlackBitmap : Final = 36

KeyCenterBitmap : Final = 34

KeyLeftBitmap : Final = 33

KeyRightBitmap : Final = 35

KeyboardBackground : Final = 52

LayerEndBitmap : Final = 14

LexicalSortBitmap : Final = 22

LinkBitmap : Final = 87

ListBitmap : Final = 25

LockedBitmap : Final = 30

LoopSectionBitmap : Final = 7

MarkerBitmap : Final = 58

MinusBitmap : Final = 62

MirrorButtonBitmap : Final = 40

NetworkBitmap : Final = 79

NextSectionBitmap : Final = 9

NextTrackBitmap : Final = 11

NowPtrBitmap : Final = 26

OptionBitmap : Final = 59

OutputBitmap : Final = 81

Owly000 : Final = 46

Owly001 : Final = 48

Owly010 : Final = 50

Owly020 : Final = 51

Owly100 : Final = 47

Owly101 : Final = 49

PadlockBitmap : Final = 45

PlayBitmap : Final = 5

PlaySectionBitmap : Final = 6

PlaySmallBitmap : Final = 69

PlusBitmap : Final = 61

PrevSectionBitmap : Final = 10

PrevTrackBitmap : Final = 12

ReceivingSmallBitmap : Final = 70

RecordBitmap : Final = 63

RecordSmallBitmap : Final = 68

RemoveBitmap : Final = 16

ResetBitmap : Final = 88

ReturnBitmap : Final = 13

RotaryBitmap : Final = 32

RotateAnticlockwiseButtonBitmap : Final = 43

RotateClockwiseButtonBitmap : Final = 42

RotationBitmap : Final = 74

ScaleBitmap : Final = 75

ScissorsButtonBitmap : Final = 39

ScrollDownBitmap : Final = 4

ScrollLeftBitmap : Final = 1

ScrollRightBitmap : Final = 2

ScrollUpBitmap : Final = 3

SliderBackBitmap : Final = 37

SliderButtonBitmap : Final = 38

StickyPinBitmap : Final = 44

StopBitmap : Final = 8

StopwatchBitmap : Final = 82

TickBoxBitmap : Final = 24

Toggle3DBitmap : Final = 77

TranslationBitmap : Final = 73

TrashCanBitmap : Final = 17

VerticalMirrorButtonBitmap : Final = 41

VolBitmap : Final = 53

ZoomMinusBitmap : Final = 65

ZoomPlusBitmap : Final = 64

getBitmap(name: int, highlight: bool) → DxTexture

imagePair(res: int) → ImagePair

null : Self

class d3.GuiSystem

Bases: Subsystem

VisualiseFeed : Final = 2

VisualiseNone : Final = 0

VisualiseSpace : Final = 1

property acceptDropDelegate : Callable

closeActiveWidget() → None

Close active widget

closeAllWidgets() → None

Close all non-sticking widgets

property closedAllWidgetsAction : Action

property consoleWindowDelegate : Callable

copyTextToClipboard(arg0: str) → None

cycleBackward() → None

Cycle backwards through windows

cycleEditFieldNext() → None

Select the next editable field in the current window

cycleEditFieldPrev() → None

Select the previous editable field in the current window

cycleForward() → None

Cycle forwards through windows

property debugWindowDelegate : Callable

directorForceQuitAll() → None

Force quit all machines in the session

directorQuitAll() → None

Quit all machines in the session

directorRestartAll() → None

Restart all machines in the session

directorStartAll() → None

Start all machines in the session

property editorDisplayProxyLevelsAction : ParamAction

editorDisplayProxyLevelsCallback(arg0: VisibilityProxyLevels, arg1: Display, arg2: float) → None

property feedDisplayProxyLevelsDelegate : Callable

getDeviceManager() → DeviceManager

property getSeparatorOpenDelegate : Callable

getTextFromClipboard() → str

property gui : Gui

property hasCustomEditorDelegate : Callable

property inputMapTransport : EventTransportInputMap

property makeCueListDelegate : Callable

property makeDropOperationDelegate : Callable

property makeEditorDelegate : Callable

property makeLinkDelegate : Callable

property makeListEditorDelegate : Callable

property makeWidgetDelegate : Callable

mouseDragArrow(arg0: int, arg1: Vec2, arg2: Vec2) → None

Create an arrow connection between two widgets

null : Self

onAppStarted() → None

property onUpdateAction : Action

property populateEditorDelegate : Callable

printTrialWarning(arg0: str, arg1: Vec2) → None

quitEverything() → None

Save and exit all machines in session without confirmation

quitOption() → None

Save and exit with confirmation

property restoreFeedBookmarkDelegate : Callable

property setFeedBookmarkDelegate : Callable

property setSeparatorOpenDelegate : Callable

toggleConsole() → None

Toggle dynamic console window

toggleDebugWindow() → None

Toggle debug output window

toggleHelpWindow() → None

Toggle context-sensitive shortcuts window

property toggleQuantiserWindowDelegate : Callable

property toggleStickyDelegate : Callable

property visualiseMode : int

writeNoteConsole() → None

Write user note to Console

class d3.HDRColour(arg0: HDRColour)

class d3.HDRColour(colour: Colour)

Bases: float4

property a : float

property b : float

property g : float

null : Self

property r : float

toNormalisedColour() → Colour

class d3.HTTPPatch

Bases: ControlPatch

duplicateName : Callable

duplicatePath : Callable

null : Self

personality(l: Layer, disabledSequenceIndices: List[int]) → str

class d3.HTTPSockpuppetSystem

Bases: Subsystem

null : Self

class d3.HTTPSystem

Bases: Subsystem

null : Self

class d3.HardwareIdentifier

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property hardwareId : str

property name : str

null : Self

property temporary : int

class d3.HardwareVideoInIdentifier

Bases: HardwareIdentifier

property currentFormat : VideoInFormat

duplicateName : Callable

duplicatePath : Callable

property formats : List[VideoInFormat]

makeTemporary : Callable

null : Self

class d3.HashTable

class d3.HashTable(arg0: HashTable)

Bases: _BlipValue

clear() → None

exists(arg0: str) → bool

findSingle(arg0: str) → int

keys() → List[str]

null : Self

replace(arg0: str, arg1: int) → None

class d3.HeadConfig

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.HeadInfo

Bases: _BlipValue

property adapterIndex : int

property linkMode : int

property logicalHead : int

null : Self

property redundantLines : int

resize(arg0: Int2) → None

property size : Int2

property splitMode : int

class d3.HelpSystem

Bases: Subsystem

help(className: str, paramName: str) → str

null : Self

readTable() → None

writeTable() → None

class d3.HistogramComputeMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.HmcAxisState

null : Self

class d3.HmcDriver

null : Self

class d3.HoldOutputSystem

Bases: Subsystem

property newStatusAction : Action

null : Self

class d3.HorizScrollBar2

Bases: ScrollBar

property receiving : bool

property tReceived : float

class d3.IFilesystem

Bases: _BlipValue

CHUNK_KEEP_REVISIONS : Final = 1

disableWrite() → None

exists(file: str) → bool

findAllBeginsWith(s: str) → List[str]

isDir(search: str) → bool

isFile(file: str) → bool

lastWriteDate(file: str) → FilesystemDateStamp

null : Self

read(filename) → Any

remove(file: str) → bool

rename(file: str, newFilename: str) → bool

search(s: str) → List[str]

setLastWriteDate(file: str, dateStamp: FilesystemDateStamp) → None

size(file: str) → int

write(file, buffer, keep) → Any

class d3.IMessageHandler

Bases: _BlipValue

null : Self

class d3.IPAddress

class d3.IPAddress(unknown: IPAddress)

class d3.IPAddress(ipAddressStr: str)

class d3.IPAddress(arg0: int, arg1: int, arg2: int, arg3: int)

Bases: _BlipValue

property addr4 : int

null : Self

class d3.IPAddressBox

Bases: ValueBox

expectsMulticastAddress(shouldBeMulticast: bool) → IPAddressBox

isSupportedType : Callable

null : Self

updateAttention() → None

validateRelatedIPSubnet(relatedIP: ValueBoxProperty, subnetMask: ValueBoxProperty) → IPAddressBox

class d3.IPEndpoint

class d3.IPEndpoint(arg0: IPEndpoint)

Bases: _BlipValue

property address : IPAddress

null : Self

property port : int

class d3.IPEndpointBox

Bases: ValueBox

isSupportedType : Callable

null : Self

class d3.IPNetConfig

Bases: _BlipValue

property domain : str

property gw : IPAddress

property host : str

property interface : int

property ip : IPAddress

property mask : IPAddress

property mode : int

null : Self

class d3.ISubsystemManager

Bases: _BlipValue

null : Self

class d3.IView

Bases: _BlipValue

null : Self

class d3.Icon(*args, **kwargs)

Bases: Widget

property allowScale : bool

property blendMode : int

property colour : Colour

property drawCheckerBoard : bool

focusedWidget : Callable

property image : DxTexture

null : Self

set(imagePath: DxTexture, altImagePath: DxTexture) → Icon

setBlendedPair(image: DxTexture, image2: DxTexture, blend: float) → None

toggleScale() → None

Switch between 1

and small size

uiTransparencyDisabled : Callable

class d3.IdentityDomain

Bases: Domain

null : Self

class d3.IdentityDomainConnection

null : Self

class d3.IgnoreTimecodeModule

Bases: Module

property mode : int

null : Self

class d3.ImageInfo

Bases: ResolutionInfo

property bitsPerPixel : int

property codec : str

property hasAlpha : bool

null : Self

class d3.ImageMosaic

Bases: _BlipValue

null : Self

saveToFile(path: str) → None

class d3.ImagePair

class d3.ImagePair(arg0: ImagePair)

class d3.ImagePair(arg0: DxTexture)

class d3.ImagePair(arg0: DxTexture, arg1: DxTexture)

Bases: _BlipValue

image(highlight: bool) → DxTexture

null : Self

valid() → bool

class d3.ImageSequenceInfo

Bases: ImageInfo

property fps : float

property frames : int

null : Self

class d3.ImportMenu(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.InDevice

Bases: _BlipValue

null : Self

class d3.Indirection

Bases: KeyContainer

property controller : IndirectionController

property expectedClass : ClassNode

property expectedType : Type

closeInkDropper() → None

focusedWidget : Callable

getSelectedColour() → Colour

property hasInkDropperBeenSelected : bool

instantiateBufferedTextureDownloader() → None

null : Self

selectColourFromScene() → None

suggestCursor() → int

uiTransparencyDisabled : Callable

class d3.InputMap

Bases: _BlipValue

add(inst: Callable, ai: str, state: str, global_: bool) → None

clearMappings() → None

enableByName(name: str, enabled: bool) → None

null : Self

class d3.InputMapManager

Bases: Subsystem

instance : Final = None

property isMappingActive : bool

null : Self

class d3.Int2

class d3.Int2(arg0: Int2)

class d3.Int2(v: Vec2)

class d3.Int2(arg0: int, arg1: int)

Bases: _BlipValue

anyLargerThan(v: Int2) → bool

anySmallerThan(v: Int2) → bool

area() → int

aspect() → float

length() → float

property maxComponent : int

property minComponent : int

null : Self

restrict(a: Int2, b: Int2) → Int2

vmax(o: Int2) → Int2

vmin(o: Int2) → Int2

property x : int

property y : int

class d3.Int2Box

Bases: ValueBox

isSupportedType : Callable

null : Self

class d3.InterlacedField

class d3.InterlacedField(arg0: InterlacedField)

Bases: _BlipValue

Even : Final = 2

Odd : Final = 1

Progressive : Final = 0

property image : DxTexture

property index : int

null : Self

property pixelFormat : int

property tReceived : float

class d3.InternalParams

class d3.InternalParams(imgSize: Int2, focal: float, pixSize: Vec2, ppShift: Vec2)

Bases: _BlipValue

getAspectRatio() → float

getFocalLengthPixels() → Vec2

getFovX(bAdjustForFocus: bool) → float

getFovY(bAdjustForFocus: bool) → float

getMatrix(verbose: int) → Mat

getPixelAspectRatio() → float

getPrincipalPoint() → Vec2

getSensorAspectRatio() → float

getSensorSize() → Vec2

getThrowRatio() → float

null : Self

tEpsilon : Final = 0.0009765625

class d3.KeyAsKeyContainer

Bases: Key

property kc : KeyContainer

null : Self

class d3.KeyContainer

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.KeyFloat

Bases: Key

null : Self

property v : float

class d3.KeyManipulatorSelector

null : Self

selectManipulator() → None

class d3.KeyResource

Bases: Key

null : Self

property r : Resource

class d3.KeySequence

Bases: KeyContainer

duplicateName : Callable

duplicatePath : Callable

evalString(t: float) → str

find(t: float) → int

findCurrentKeyTime(t: float) → float

findNextKeyTime(t: float) → float

getIndirectionKey(keyTime: float) → Indirection

insert(ik: int, t: float, i: int) → None

insertKeyContainer(t: float, i: int, ks: KeyContainer) → None

key(ik: int) → Key

property keys : List[Key]

property looping : int

nKeys() → int

null : Self

remove(ik: int, n: int) → None

setString(ik: int, s: str) → None

stripToFirstKey() → None

t(ik: int) → float

class d3.KeyString

Bases: Key

null : Self

property s : str

class d3.KeyThumbnail

Bases: Thumbnail

adjustSelfNoSnapping(state: int, startPos: Vec2, pos: Vec2) → None

Move the keyframe to the desired point in time; do not snap to markers

adjustSelfSnap(state: int, startPos: Vec2, pos: Vec2) → None

Move the keyframe to the desired point in time

null : Self

removeSelf() → None

Remove the keyframe from the sequence

class d3.KeyWidget(*args, **kwargs)

Bases: Widget

adjustSelectedFloatKeys(move: float) → None

Alter the value of the selected keys

adjustZoom(move: float) → None

Zoom into or out of a part of the timeline

copyKeys() → None

Copy the selected keys into the clipboard

cut() → None

Cut the selected keys into the clipboard

deleteKeysAll() → None

Delete selected keys

floatDragSnap(state: int, start: Vec2, cursor: Vec2) → None

Drag key with snapping

floatDragStraightNoSnapping(state: int, start: Vec2, cursor: Vec2) → None

Drag key straight without snapping

floatDragStraightSnap(state: int, start: Vec2, cursor: Vec2) → None

Drag key straight with snapping

floatRightClick() → None

Delete the key or open the options menu

focusedWidget : Callable

property isFloat : bool

jumpKey(delta: int) → None

Jump by delta keyframes

jumpToNextKey() → None

Jump to the next key

jumpToPrevKey() → None

Jump to the previous key

mouseDragSelection(state: int, start: Vec2, pos: Vec2) → None

Select a range of key frames

notifyEdit() → None

null : Self

property openObjectViewDelegate : Callable

paste() → None

Paste the keys in the clipboard into the widget here

popupOptionsMenu() → None

Open the options menu

refresh() → None

selectAllKeys() → None

Select all keys

selectQuickSelectSlot(iKey: int) → None

Select quick select slot

selectSlot() → None

Select Quick Select Slot 9

set(sequences: List[FieldSequence], vb: ValueBox, transport: TransportManager) → KeyWidget

slipPreviousKeyframeTime(direction: int) → None

Slip previous keyframe time

slipPreviousKeyframeTimeBackward() → None

Slip previous keyframe time backward

slipPreviousKeyframeTimeForward() → None

Slip previous keyframe time forward

uiTransparencyDisabled : Callable

property valueBox : ValueBox

zoomIn() → None

Zoom in

zoomOut() → None

Zoom Out

class d3.KeyWidgetOptionBox

Bases: ValueBox

isSupportedType : Callable

mouseDragSelfNoSnap(state: int, startPos: Vec2, pos: Vec2) → None

Adjust the key under the cursor without snapping

mouseDragSelfSnap(state: int, startPos: Vec2, pos: Vec2) → None

Adjust the key under the cursor

null : Self

removeSelf() → None

Remove the key under the cursor

class d3.Keyboard

Bases: OsDevice

A : Final = 65

ALT : Final = 18

APOST : Final = 192

APOSTROPHE : Final = 192

B : Final = 66

BACKSLASH : Final = 226

BACKSPACE : Final = 8

BREAK : Final = 19

C : Final = 67

CAPS : Final = 20

COLON : Final = 186

CTRL : Final = 17

D : Final = 68

DEL : Final = 46

DELETE : Final = 83

DIVIDE : Final = 111

DOWN : Final = 40

E : Final = 69

END : Final = 35

ENTER : Final = 13

ESC : Final = 27

F : Final = 70

F1 : Final = 112

F10 : Final = 121

F11 : Final = 122

F12 : Final = 123

F2 : Final = 113

F3 : Final = 114

F4 : Final = 115

F5 : Final = 116

F6 : Final = 117

F7 : Final = 118

F8 : Final = 119

F9 : Final = 120

G : Final = 71

H : Final = 72

HASH : Final = 222

HOME : Final = 36

I : Final = 73

INSERT : Final = 45

J : Final = 74

K : Final = 75

KEYPAD0 : Final = 96

KEYPAD1 : Final = 97

KEYPAD2 : Final = 98

KEYPAD3 : Final = 99

KEYPAD4 : Final = 100

KEYPAD5 : Final = 101

KEYPAD6 : Final = 102

KEYPAD7 : Final = 103

KEYPAD8 : Final = 104

KEYPAD9 : Final = 105

L : Final = 76

LALT : Final = 164

LCTRL : Final = 162

LEFT : Final = 37

LESS : Final = 188

LSHIFT : Final = 160

LSQBRACE : Final = 219

LWIN : Final = 91

M : Final = 77

MINUS : Final = 109

MORE : Final = 190

N : Final = 78

N0 : Final = 48

N1 : Final = 49

N2 : Final = 50

N3 : Final = 51

N4 : Final = 52

N5 : Final = 53

N6 : Final = 54

N7 : Final = 55

N8 : Final = 56

N9 : Final = 57

NUMLOCK : Final = 144

O : Final = 79

P : Final = 80

PGDN : Final = 34

PGUP : Final = 33

PLING : Final = 223

PLUS : Final = 107

PRTSCRN : Final = 44

Q : Final = 81

R : Final = 82

RALT : Final = 165

RCTRL : Final = 163

RETURN : Final = 13

RIGHT : Final = 39

RSHIFT : Final = 161

RSQBRACE : Final = 221

RWIN : Final = 92

S : Final = 83

SCRLCK : Final = 145

SHIFT : Final = 16

SLASH : Final = 111

SPACE : Final = 32

STAR : Final = 106

T : Final = 84

TAB : Final = 9

U : Final = 85

UP : Final = 38

V : Final = 86

W : Final = 87

X : Final = 88

Y : Final = 89

Z : Final = 90

charToCode : Callable

down(iKey: int) → bool

getChar() → int

isModifierKey : Callable

keyName : Callable

null : Self

parseKey : Callable

pressed(iKey: int) → bool

released(iKey: int) → bool

stroke(iKey: int) → bool

class d3.KeyedIndirectionResource

Bases: _BlipValue

property key : str

null : Self

property resource : Resource

class d3.KeyedListIndirectionController

duplicateName : Callable

duplicatePath : Callable

property matchMode : int

Defines how to match the key against the received packet

null : Self

property resources : List[KeyedIndirectionResource]

property selectedIndex : int

property verbose : bool

Log more information to the console to help set up the controller

class d3.Kinesys

property close_shutter : DmxCommand

property cmyk_flipMode : int

property cyan_channel : int

property dimmer_channel : int

property dimmer_flipMode : int

duplicateName : Callable

duplicatePath : Callable

property green_channel : int

property lamp_off : DmxCommand

property lamp_on : DmxCommand

property magenta_channel : int

property min_brightness : int

null : Self

property open_shutter : DmxCommand

property red_channel : int

property white_channel : int

property yellow_channel : int

property zoom_channel : int

property zoom_channel_fine : int

class d3.LampTester

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property lamp : int

null : Self

property pan : float

property shutter : int

property test_channel : int

property test_colour : Col

property test_intensity : int

property test_universe : int

property tilt : float

class d3.LatencyCaptureProcess

capturedFieldsForCamera(camera: Camera) → List[InterlacedField]

null : Self

property strobeFlashesAt : float

property totalCaptureFrames : int

update() → None

class d3.Layer

Bases: SuperLayer

changeModuleClass(type: Type) → None

property controlPatch : ControlPatch

property dmxDisabled : List[int]

property fields : List[FieldSequence]

findSequence(name: str) → FieldSequence

findSequenceOfType(type: str, name: str) → FieldSequence

isGraphical() → bool

property isOutput : int

If set to ‘Input’, received values will control the layer. If set to ‘Output’, the layer values will be sent.

isStringValidForDynamicNaming : Callable

makeNewNames : Callable

property module : Module

property moduleBaseVersion : int

property moduleConfig : ModuleConfig

property moduleType : Type

property moduleVersion : int

nSequences() → int

notifyEdit(fs: FieldSequence) → None

null : Self

property onFieldsChangedAction : Action

property patchChangedAction : ParamAction

sequence(i: int) → FieldSequence

setControlPatch(patch: ControlPatch, isOutput: bool) → None

class d3.LayerStack

Bases: Resource

property arrows : List[Arrow]

duplicateName : Callable

duplicatePath : Callable

findLayerByName(name: str) → Layer

property layers : List[Layer]

makeArrow(src: Layer, dest: Layer) → None

newLayerOfClass(layerName: str, className: str) → None

null : Self

removeArrow(arrow: Arrow) → None

class d3.LayerStackPlayHead

Bases: PlayHead

activePlayHeadFor : Callable

null : Self

overrideProjection(projection: Projection) → None

set(stack: LayerStack) → None

updateSequencingForModules() → None

class d3.LayerViewHelper

Bases: _BlipValue

null : Self

precompExtents : Callable

class d3.LdsDriver

null : Self

property sensor_width : float

class d3.LdsState

Bases: TrackingState

null : Self

class d3.LedModule

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property resolution : Vec2

property size : Vec

class d3.LedProduct

Bases: Product

property dotPitchMM : float

Pixel spacing, in mm

null : Self

property tileRes : Int2

Tile resolution in pixels

class d3.LedScreen

Bases: SlcAwareDisplay

A physical LED screen on a stage

property colourMap : DxTexture

the mesh must have texture coordinates for this to work properly

Type:
Image to be applied to the surface of the object as a colour map, if any. Note

property densityMap : DxTexture

Object denisty map for Subsurface scattering approximation

property densityScale : float

Object denisty map for Subsurface scattering approximation

property luminanceNits : float

NIT-rating of LED product; affects visualisation only

property luminosity : float

Luminosity of the object

property normalMap : DxTexture

the mesh must have texture coordinates for this to work properly

Type:
Image to be applied to the surface of the object as a normal map, if any. Note

property normalMapScalar : Vec2

Normal map UV scalar

null : Self

property reflectivity : float

Proportion of incident light returned by the screen surface

property viewingAngle : float

Angle in degrees, where luminance is at 50%. Visualisation in Lux only. Setting a value of 0 will disable the visualisation

class d3.Lens

Bases: Resource

property aspectRatio : float

property centerShift : Vec2

duplicateName : Callable

duplicatePath : Callable

property k1 : float

property k2 : float

property k3 : float

null : Self

property paWidth : float

class d3.LensCalibrationPose

Bases: _BlipValue

property intrinsics : LensIntrinsics

null : Self

property trackedFocus : float

property trackedZoom : float

class d3.LensDistortion

class d3.LensDistortion(arg0: VecD, arg1: VecD, arg2: float, arg3: float)

Bases: _BlipValue

property k123 : VecD

property k456 : VecD

null : Self

property p1 : float

property p2 : float

setZero() → None

class d3.LensFocusParams

Bases: _BlipValue

Disabled : Final = 0

Manual : Final = 1

ObjectTracking : Final = 2

property aperture : float

Aperture (f-stop) value, defined as the focal length / aperture diameter

property focusDistance : float

Distance to the focal plane in m

null : Self

class d3.LensIntrinsics

Bases: _BlipValue

property aspectRatio : float

property centerShift : Vec2

property centerShiftMM : Vec2

property focalLength : float

property focalLengthMM : float

property k1 : float

property k1k2k3 : Vec

property k2 : float

property k3 : float

null : Self

property paWidthMM : float

class d3.Light

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

property brightness : float

Brightness in lux of a surface perpendicular to the light’s direction.
Sunlight at midday can be 111000 lux, while moonlight could be 0.25 lux.

property colour : Colour

The colour of the light.
It is recommended to select a ‘full brightness’ version of colours chosen, by changing Luminance in the colour picker to 1.

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.LightwareMatrix

Bases: DVIMatrix

property IP_address : str

The IP address to send commands to

property delay : int

Delay sending matrix commands for n milliseconds

addColumn(name: str, constructor: Callable, comparator: Callable) → Column

property cellSpacing : float

property columns : List[Column]

computeMinSize() → None

contextMenuAction() → ParamAction

property contextMenuEnabled : bool

ctrlDownAction() → None

ctrlUpAction() → None

property data : ListEditorDataSource

downAction() → None

exportToCSV(fileName: str) → None

getColumns() → List[str]

getRows() → List[ListEditorRow]

getSelectedRowIndices() → List[int]

getSelectedRows() → List[ListEditorRow]

moveColumn(name: str, index: int) → None

null : Self

onRefreshAction() → Action

property overrideDuplicate : Callable

primarySelectionIndex() → int

property reflectionType : Type

refresh() → None

removeAllColumns() → None

removeColumn(name: str) → None

removeColumnIndex(index: int) → None

renameColumn(from_: str, to: str) → None

selectAll() → None

selectNone() → None

property selectionChangedAction : Action

property selectionEnabled : bool

set(dataSource: ListEditorDataSource) → ListEditor

setCellColour(resource: Resource, name: str, col: Colour) → None

setCellSuggestion(resource: Resource, name: str, suggestion: str) → None

setColumnVisibility(name: str, visible: bool) → None

setColumnVisibilityIfExists(name: str, visible: bool) → None

setData(type: Type, resources: List[Resource]) → ListEditor

setInternalComparator(comparator: Callable) → None

shiftDownAction() → None

shiftUpAction() → None

sort() → None

property sortMethod : int

sortOnColumn(index: int, sortAscending: bool) → None

property sortOnColumnEnabled : bool

sortOnColumnToggle(index: int) → None

property thumbnailsEnabled : bool

toggleSelectAll() → None

Toggle select all rows

upAction() → None

update() → None

context() → None

Open row context menu

copyText() → None

Copy the currently selected text into the clipboard

focusedWidget : Callable

getRowResource() → Resource

property isSelected : bool

null : Self

pasteIntoColumn(iColumn: int, subcomponent: str, text: str) → None

pasteText() → None

Paste the clipboard to the caret location

selfOrSelected() → List[ListEditorRow]

uiTransparencyDisabled : Callable

class d3.ListIndirectionController

duplicateName : Callable

duplicatePath : Callable

null : Self

property resources : List[Resource]

property selectedIndex : int

Selected resource in the indirection controller list

property selectedIndexExpression : Expression

property selectedIndexExpressionText : str

class d3.LocalCoordSystem

class d3.LocalCoordSystem(_t: VecD, _R: Mat, _scale: VecD)

Bases: _BlipValue

getAngles() → VecD

getAnglesEuler() → VecD

getAnglesOrbit() → VecD

getLookAt() → VecD

getLookAtDistance() → float

getPosition() → VecD

getRotation() → Mat

getScale() → VecD

getSphericalCoords() → VecD

getTransformation2Camera() → Mat

getTransformation2World() → Mat

getTranslation() → VecD

getVecDirection() → VecD

getVecRight() → VecD

getVecUp() → VecD

null : Self

class d3.LocalGuiDisplay

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

localGui : Callable

null : Self

class d3.LocalOutputCameraDisplay

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.LocalState

Bases: Resource

FadeDown : Final = 0

FadeUp : Final = 1

Hold : Final = 2

property activeLatencyOverride : int

This overrides the latency for renderstream nodes.
Frame received above this latency will be dropped.
Setting to 0 allows d3 to manage the latency automatically.

property currentTransport : TransportManager

directorState : Callable

duplicateName : Callable

duplicatePath : Callable

localOrDirectorState : Callable

localState : Callable

property manageRenderStreamWorkloads : bool

Automatically manage RenderStream workload lifetimes

property muted : MapTable

null : Self

property output : int

property recordingStatesByRecorderName : HashTable

property track : Track

property transport : SuperTransportManager

class d3.Locale

Bases: _BlipValue

null : Self

refreshCurrentLocale() → None

translationAction(string: str) → str

class d3.LogicalAudioOutDevice

Bases: LogicalDevice

null : Self

class d3.LogicalDevice

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.LogicalVideoInDevice

Bases: LogicalDevice

property acesTransform : AcesInputTransformParameters

ACES Input Display Transform (IDT)

property cropOffset : Vec2

Size of the crop frame offset in pixels.

property cropRectangle : Rect

property cropSize : Vec2

Size of crop frame in camera feed in pixels.

property deinterlaceMethod : int

deinterlaceMethodCount : Final = 11

deinterlaceMethodName : Callable

duplicateName : Callable

duplicatePath : Callable

getCurrentFrame(guiRequest: bool) → DxTexture

getDeinterlaceHelpText : Callable

getPreviewFrame(size: Int2) → DxTexture

getResolution() → Vec2

property interlaced : int

property layerStack : LayerStack

A Layer Stack is a time-independent stack of effects which are applied directly to a VideoIn object.
You can add, remove and re-order effects in a Layer Stack via its editor.

property localVideoIn : VideoIn

makeACESLabel : Callable

null : Self

property ocioTransform : OcioColourSpace

OCIO colour space of the video input

property pixelFormat : str

property placeholder : DxTexture

property placeholderImage : DxTexture

property resolution : Vec2

setFormat(resolution: Vec2, interlaced: bool, pixelFormat: str) → None

updateTexture() → None

class d3.LogicalVideoInSystem

Bases: Subsystem

null : Self

class d3.LookAtManipulable

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

matchRotationOfProjector() → None

Match the Rotation of the look-at points projector.

null : Self

set(proj: Projector) → LookAtManipulable

class d3.LookupTexture

eval(x: float) → float

insertPointAfter(iPoint: int) → None

lookupRange : Final = 256

null : Self

point(i: int, vv: Vec2) → None

property points : List[Vec2]

removePoint(i: int) → bool

setPoints(indices: List[int], points: List[Vec2]) → None

class d3.LumaKeyComponents

class d3.LumaKeyComponents(arg0: LumaKeyComponents)

Bases: _BlipValue

property chromaHardwareId : str

property lumaKeyHardwareId : str

property lumaKeyInverted : bool

null : Self

class d3.LumaKeyVideoIn

Bases: VideoIn

makeHardwareId : Callable

null : Self

parseHardwareId : Callable

class d3.LumaKeyVideoInSystem

Bases: Subsystem

null : Self

class d3.LutFile

Bases: Resource

property acesPostTransform : AcesInputTransformParameters

Transform from LUT working space to Linear ACES AP0

property acesPreTransform : AcesOutputTransformParameters

Transform from Linear ACES AP0 to LUT working space

duplicateName : Callable

duplicatePath : Callable

null : Self

property ocioTransform : OcioColourSpace

Colour space to apply LUT

class d3.LutModule

property lutChromaIntensity : float

property lutLumaIntensity : float

property lutfile : LutFile

Cube LUT

null : Self

property source : ContentSource

class d3.MDCModule

Bases: Module

property controlDevice : ControlDevice

null : Self

property panelControl : int

property powerControl : int

property screenBacklight : int

property screenBrightness : int

property screenContrast : int

property screenIds : str

class d3.MSCMessage

Bases: _BlipValue

null : Self

class d3.MSCState

Bases: IDataState

null : Self

class d3.MTCState(arg0: MTCState)

Bases: IDataState

property mtcFps : float

property mtcFrames : int

property mtcHours : int

property mtcMinutes : int

property mtcRate : int

property mtcRunning : bool

property mtcSeconds : int

null : Self

class d3.MVCameraStatsDisplay

Bases: _BlipValue

property bandwidth : int

property fps : float

property fpsLocal : float

property framesDelivered : int

property nFramesDelivered : int

property nFramesDropped : int

property nFramesDroppedDelta : int

property nFramesIncomplete : int

property nFramesIncompleteDelta : int

property nFramesRescued : int

property nFramesRescuedDelta : int

property nFramesShoved : int

property nFramesShovedDelta : int

property nFramesUnderrun : int

property nFramesUnderrunDelta : int

property nPacketErrors : int

property nPacketErrorsDelta : int

property nPacketMissed : int

property nPacketReceived : int

property nPacketResendReceived : int

property nPacketResendRequest : int

null : Self

property tElapsed : float

class d3.Machine

Bases: Resource

Actor : Final = 3

BITS_10 : Final = 2

BITS_8 : Final = 1

BP_MODEL_1 : Final = 0

BP_MODEL_2 : Final = 1

BP_MODEL_UNKNOWN : Final = 2

CustomRenderNode : Final = 23

DEVICE_STATUS_DIFFERENT_BIT_DEPTH : Final = 3

DEVICE_STATUS_DIFFERENT_EDID_EMULATION : Final = 4

DEVICE_STATUS_DIFFERENT_IPNETCONFIG_0 : Final = 10

DEVICE_STATUS_DIFFERENT_IPNETCONFIG_1 : Final = 11

DEVICE_STATUS_DIFFERENT_IPNETNVMCONFIG_0 : Final = 12

DEVICE_STATUS_DIFFERENT_IPNETNVMCONFIG_1 : Final = 13

DEVICE_STATUS_DIFFERENT_PTP_DOMAIN_NUMBER : Final = 16

DEVICE_STATUS_DIFFERENT_PTP_PROFILE : Final = 17

DEVICE_STATUS_DIFFERENT_REFRESH_RATE : Final = 2

DEVICE_STATUS_DIFFERENT_RESOLUTION : Final = 1

DEVICE_STATUS_DIFFERENT_VIDEOSINK_RATE : Final = 15

DEVICE_STATUS_DIFFERENT_VIDEO_OUTPUT_MODE : Final = 14

DEVICE_STATUS_ERROR : Final = 19

DEVICE_STATUS_INCOMPATIBLE_VFC : Final = 8

DEVICE_STATUS_INVALID_BIT_DEPTH : Final = 9

DEVICE_STATUS_NORMAL : Final = 0

DEVICE_STATUS_NO_MACHINE_CONNECTED : Final = 5

DEVICE_STATUS_NO_OUTPUT_CONNECTED : Final = 6

DEVICE_STATUS_NO_SFP_CONNECTED : Final = 7

DEVICE_STATUS_PTP_NOT_LOCKED : Final = 18

DEVICE_STATUS_UNRESPONSIVE : Final = 20

DEVICE_STATUS_VFC_FAILED_INIT : Final = 21

property DVI_matrix_preset : str

DedicatedDirector : Final = 1

Deltacast : Final = 0

Designer : Final = 0

Ex_2 : Final = 25

Ex_2c : Final = 26

Ex_3 : Final = 20

Ex_3Plus : Final = 27

FIFO_OK : Final = 0

FIFO_OVERFLOW : Final = 2

FIFO_UNDERRUN : Final = 1

FIFO_UNKNOWN : Final = 3

Gx_1 : Final = 8

Gx_2 : Final = 9

Gx_2c : Final = 12

Gx_3 : Final = 18

property IP_address : str

Matrox : Final = 1

MobileEditor : Final = 5

NET_MODE_DHCP : Final = 1

NET_MODE_STATIC : Final = 0

NET_MODE_UNKNOWN : Final = 2

NO_BP : Final = 3

Node : Final = 6

NonDedicatedDirector : Final = 2

PORT_STATUS_DESIGNER : Final = 10

PORT_STATUS_DIFFERENT_BIT_DEPTH : Final = 5

PORT_STATUS_DIFFERENT_COL_CONV_PRO : Final = 15

PORT_STATUS_DIFFERENT_QUAD_DIVISION : Final = 7

PORT_STATUS_DIFFERENT_REFRESH_RATE : Final = 3

PORT_STATUS_DIFFERENT_REFRESH_RATE_GLOBAL : Final = 4

PORT_STATUS_DIFFERENT_RESOLUTION : Final = 1

PORT_STATUS_DIFFERENT_SPLIT_MODE : Final = 2

PORT_STATUS_DIFFERENT_SUBSAMPLING : Final = 17

PORT_STATUS_DIFFERENT_TIMING_MODE : Final = 6

PORT_STATUS_DIFFERENT_TRANSPORT_TYPE : Final = 18

PORT_STATUS_DIFFERENT_TRANS_CHAR : Final = 16

PORT_STATUS_DIFFERENT_TXIPDEST_ETH0 : Final = 13

PORT_STATUS_DIFFERENT_TXIPDEST_ETH1 : Final = 14

PORT_STATUS_ERROR : Final = 19

PORT_STATUS_INCOMPATIBLE_VFC : Final = 11

PORT_STATUS_NORMAL : Final = 0

PORT_STATUS_NO_MACHINE_CONNECTED : Final = 8

PORT_STATUS_NO_OUTPUT_CONNECTED : Final = 9

PORT_STATUS_STREAM_DISABLED : Final = 12

PORT_STATUS_VFC_FAILED_INIT : Final = 20

PTP_PROFILE_SMPTE2059_2015 : Final = 0

PTP_PROFILE_SMPTE2059_2021 : Final = 1

PTP_PROFILE_UNKNOWN : Final = 2

PTP_STATES_FREERUN : Final = 1

PTP_STATES_LOCKED : Final = 4

PTP_STATES_LOCKING : Final = 3

PTP_STATES_STOPPED : Final = 0

PTP_STATES_UNKNOWN : Final = 5

PTP_STATES_UNLOCKED : Final = 2

Plus_2x2 : Final = 4

Pro_2x4 : Final = 7

Pro_4x2 : Final = 2

Pro_4x4 : Final = 3

Pro_4x4_NoVfcs : Final = 5

RenderNode : Final = 7

Rx : Final = 13

Rx_II : Final = 14

Rx_III : Final = 24

SFP_TYPE_10G : Final = 1

SFP_TYPE_25G : Final = 2

SFP_TYPE_DUAL_SDI : Final = 5

SFP_TYPE_INVALID_SFP_FOR_SLOT : Final = 6

SFP_TYPE_NONE : Final = 0

SFP_TYPE_SINGLE_SDI : Final = 4

SFP_TYPE_UNKNOWN : Final = 7

STATUS_GENLOCK : Final = 2

STATUS_GENLOCK_BY_PTP : Final = 1

STATUS_NO_GENLOCK : Final = 0

SYNC_STATUS_CONFLICTING_EDIDS : Final = 5

SYNC_STATUS_CONFLICTING_RESOLUTIONS : Final = 4

SYNC_STATUS_FREE_RUN : Final = 0

SYNC_STATUS_LOCKED_EXTERNAL : Final = 2

SYNC_STATUS_LOCKED_INTERNAL : Final = 1

SYNC_STATUS_LOCKED_PTP : Final = 3

SYS_SYNC_MODE_DP : Final = 2

SYS_SYNC_MODE_EXT : Final = 1

SYS_SYNC_MODE_PTP : Final = 0

SYS_SYNC_MODE_UNKNOWN : Final = 3

Solo : Final = 0

Solo_v1 : Final = 10

USE_PROJECT_BIT_DEPTH : Final = 0

Understudy : Final = 4

UnknownRole : Final = 6

V2_5 : Final = 1

VID_OUTPUT_NONE : Final = 2

VID_OUTPUT_SDI : Final = 1

VID_OUTPUT_ST2110 : Final = 0

Vx_1 : Final = 15

Vx_2 : Final = 16

Vx_2Plus : Final = 21

Vx_3 : Final = 22

Vx_4 : Final = 11

Vx_4Plus : Final = 17

Vx_4n : Final = 19

property active : bool

allRequiredOutputsGenlocked() → bool

property alternate_feed : FeedScene

applyDisplaySettings() → None

applyDisplaySettingsWillRequireReboot() → bool

applyPortConfigs(arg0: bool) → None

assertHouseSync() → None

assignNewFeed() → None

property audio : int

property bit_depth_selection : int

bpModel() → int

property captureCardVariant : int

Select which capture card the server has

captureCardVendor : Callable

clearHouseSync() → None

property content_distribution_target_mode : int

property d3ProjectsFolder : str

property d3_projects_folder : str

property d3_projects_folder_netname : str

property device_mapping : DeviceMapping

duplicateName : Callable

duplicatePath : Callable

property failed : bool

property failoverDisabled : bool

property feed : FeedScene

fifoState(arg0: int, arg1: int) → int

findDisplayAdapterList() → DisplayAdapterList

getSlotToSyncPTP() → optional

getbitDepth() → int

gpuVendor() → int

property hasDedicatedGui : bool

hasIncomingHouseSyncSignal() → bool

property hostname : str

incomingHouseSyncSignal() → float

ipVfcSdpPath(arg0: int, arg1: int, arg2: int) → str

isApplyingFeeds() → bool

isExRange() → bool

property isGuiVisible : bool

isVfcReady(arg0: int) → bool

machineRoleToString : Callable

property machineType : int

machineUsesMapping(arg0: Projection) → bool

property media : MachineMediaRegistry

property name : str

needsDisplaySettingsApplied() → bool

needsNVMNetworkSettingsApplied() → bool

property networkConnected : bool

property networkStatus : int

property nodeId : optional

property nodeName : str

null : Self

outputMode(arg0: int) → DisplayMode

refreshDisplayAdapters() → None

property renderstream_engines_folder : str

property renderstream_projects_folder : str

resetEdids() → None

resetHDMI(arg0: int) → None

property role : int

runVFCDebugCommand(arg0: int, arg1: str) → None

property runningAs : Machine

setCompatibleQuadResolution() → None

setVFCTracing(arg0: int, arg1: bool) → None

slotsWithInvalidSFPState() → List[int]

property startupGuiMode : int

streamEnabled(arg0: int, arg1: int) → bool

supports10Bit() → bool

supportsMultipleCaptureCardVendors() → bool

swapVFCinterlacedField(arg0: int, arg1: int) → None

syncStatus(arg0: int) → int

property targets : List[Machine]

property typeName : str

vfcDNSConfig(arg0: int, arg1: bool) → str

vfcFPGATemperature(arg0: int) → float

vfcFirmwareVersion(arg0: int) → VFCFpgaVersion

vfcGeneration(arg0: int) → int

vfcIPNetConfigAddress(arg0: int, arg1: int, arg2: bool) → IPAddress

vfcMacAddress(arg0: int, arg1: int) → str

vfcPTPClkID(arg0: int) → str

vfcPTPDomainNbr(arg0: int) → int

vfcPTPLockDistance(arg0: int) → int

vfcPTPLockState(arg0: int) → int

vfcPTPPortNbr(arg0: int) → int

vfcPTPProfile(arg0: int) → int

vfcPortCurrentDisplayMode(arg0: int, arg1: int) → DisplayMode

vfcPortDisplayModes(arg0: int, arg1: int) → List[DisplayMode]

vfcPortFsStart(arg0: int, arg1: int) → int

vfcPortLed(arg0: int, arg1: int) → Colour

vfcPortSelectedDisplayMode(arg0: int, arg1: int) → DisplayMode

vfcPortState(arg0: int, arg1: int) → str

vfcPortStatus(arg0: int, arg1: int) → int

vfcSFPType(arg0: int, arg1: int) → int

vfcSoftwareVersion(arg0: int) → VFCFpgaVersion

vfcStatus(arg0: int) → int

vfcSysAlertMissingGenlock() → int

vfcSysAlertMissingIpVfc() → List[int]

vfcSysAlertMissingPtp() → int

vfcSysAlertStatusBoardTempExceeded(arg0: int) → bool

vfcSysAlertStatusFPGATempExceeded(arg0: int) → bool

vfcSysAlertStatusPTPStepped(arg0: int) → bool

vfcSysAlertStatusSynError(arg0: int) → bool

vfcSysAlertStatusTime(arg0: int) → str

vfcSysPtpDomainMismatch() → int

vfcSysSyncFrate(arg0: int) → float

vfcSysSyncMode(arg0: int) → int

vfcSysSyncModeMismatch() → List[int]

vfcTemperature(arg0: int) → float

vfcVideoOutputMode(arg0: int) → int

class d3.MachineListIndirectionController

property default : Resource

duplicateName : Callable

duplicatePath : Callable

getMachineResource(machineKey: Machine) → Resource

null : Self

setMachineResource(machineKey: Machine, newResource: Resource) → None

class d3.MachineMedia

Bases: _BlipValue

property machine : Machine

null : Self

property path : str

property resource : Resource

class d3.MachineMediaFile

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property mediaDateStamp : DateStamp

property mediaHeader : MediaFileHeader

property mediaPath : str

property mediaSize : int

property mediaType : str

null : Self

class d3.MachineMediaRegistry

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.MachineMonitor

Bases: MetricMonitor

null : Self

togglePause : Callable

class d3.MachineStatus

Bases: _BlipValue

property guiVisible : bool

null : Self

property states : List[State]

property tUpdated : int

class d3.Manipulator

Bases: _BlipValue

null : Self

class d3.Manipulator3D(parent: SpaceWidget)

Bases: Manipulator

duplicatePath : Callable

null : Self

class d3.ManualCameraCalibrationObservation

Bases: CameraCalibrationObservation

property alignmentData : AlignmentData

property alignmentObjects : List[Object]

distortPoint(coord: Vec2) → Vec2

duplicateName : Callable

duplicatePath : Callable

property frame : DxTexture

getCameraMats() → CameraMats

property identifier : str

loadFrame() → None

nPoints() → int

null : Self

setAlignmentPoints(alignmentData: AlignmentData, alignmentObjects: List[Object]) → None

undistortPoint(coord: Vec2) → Vec2

updateTracking(config: SpatialCalibrationConfig) → None

class d3.ManualIndirectionController

duplicateName : Callable

duplicatePath : Callable

null : Self

property selection : Resource

class d3.ManualProjectorSettings

Bases: _BlipValue

null : Self

class d3.Map

Bases: _BlipValue

null : Self

class d3.MapSupport

Bases: _BlipValue

null : Self

class d3.MapTable

Bases: _BlipValue

clear() → None

null : Self

class d3.MappedMedia

class d3.MappedMedia(arg0: MappedMedia)

Bases: _BlipValue

property isValid : bool

property locations : List[MappedMediaLocation]

null : Self

property resourcePath : Path

class d3.MappedMediaDomain

Bases: Domain

exportResourceUsageToFile(mappedMedia: MappedMedia) → bool

findResourceUsage(resource: Resource) → MappedMedia

getMappedContent(projection: Projection) → List[MappedMediaLocation]

null : Self

resourceUsageExportPath(resourcePath: string_view) → Path

class d3.MappedMediaDomainConnection

property audioChanged : ParamAction

property mediaChanged : ParamAction

null : Self

class d3.MappedMediaLocation

Bases: _BlipValue

ModuleConfig : Final = 2

Sequencing : Final = 0

Sockpuppet : Final = 1

contentSequencingEnd() → float

contentSequencingStart() → float

description() → str

expectedNode() → ClassNode

layer() → Layer

mappedResource() → Resource

mappingType() → int

null : Self

property coefficient : List[float]

compose(tr: Mat) → Mat

getRotation() → Vec

getScale() → Vec

getTranslation() → Vec

inverse() → Mat

property m00 : float

property m01 : float

property m02 : float

property m03 : float

property m10 : float

property m11 : float

property m12 : float

property m13 : float

property m20 : float

property m21 : float

property m22 : float

property m23 : float

property m30 : float

property m31 : float

property m32 : float

property m33 : float

null : Self

perspectiveTransform(v: Vec) → Vec

setAxes(arg0: Vec, arg1: Vec, arg2: Vec) → Mat

setRotation(arg0: Vec) → Mat

setScale(arg0: Vec) → Mat

setTranslation(arg0: Vec) → Mat

transform(v: Vec) → Vec

transformRect(r: Rect) → Rect

transpose() → Mat

class d3.MatBox

Bases: ValueBox

isSupportedType : Callable

null : Self

class d3.Material

Bases: _BlipValue

null : Self

class d3.MatroxSystem

Bases: Subsystem

asynchronousMode(hardwareId: str) → bool

getCardInfoDisplay(hardwareId: str) → str

isClockSource(hardwareId: str) → bool

null : Self

setAsynchronousMode(hardwareId: str, value: bool) → None

setClockSource(hardwareId: str) → None

useInputClock(hardwareId: str, value: bool) → None

usingInputClock(hardwareId: str) → bool

class d3.MatroxThread

Bases: VideoInThread

null : Self

class d3.MayaBridgeDevice

Bases: Device

property IP_Address : str

property Port : int

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.McAxisState

null : Self

class d3.Measurement

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property obj1 : Object

property obj2 : Object

property vert1 : int

property vert2 : int

class d3.MeasurementManipulator(parent: SpaceWidget)

Bases: Manipulator

dragMeasuringTape(state: int, startPos: Vec2, pos: Vec2) → bool

Create a measurement

null : Self

removeMeasurement() → bool

Remove a measurement

class d3.MeasurementSet

Bases: Object

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

property measurements : List[Measurement]

null : Self

class d3.MediaFileHeader

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.MediaInfo

Bases: _BlipValue

null : Self

class d3.MediaInfoDomain

Bases: Domain

null : Self

class d3.MediaInfoDomainConnection

null : Self

class d3.MediaManager

Bases: Subsystem

return a tuple of (min, max) points representing the extents of the mesh

hasBoneInfo() → bool

property materials : List[DxMaterial]

property nodes : List[Node]

null : Self

renderTriBuffer(type: int, mtl: DxMaterial) → None

renderTriBufferSetup() → None

property triangles : List[Triangle]

updateMesh() → None

property vertNormalVisualiser : VertNormalVisualiser

property verts : List[Vert]

class d3.MeshFromObj

Bases: Mesh

property flip_U : int

property flip_V : int

null : Self

property swap_U_V : int

property useFileNormals : int

class d3.MeshFromScene

Bases: Mesh

property center : Vec

property duration : float

property meshcount : int

null : Self

property particlecount : int

property polycount : int

property scenesize : Vec

property time : float

property vertcount : int

class d3.MeshInfo

Bases: MediaInfo

property centroid : Vec

property extentsMax : Vec

property extentsMin : Vec

null : Self

property triangles : int

property vertices : int

class d3.MeshProjection

Bases: Projection

property actualFoVs : Vec2

cameraInDisplays() → bool

property debugViewType : int

property eye_point : Vec

Position the 3D scene is rendered from

property followCamera : bool

Eyepoint follows the position of any MR set or camera added to displays

property idealFoVs : Vec2

property initialRotationCentre : Vec

property mappingResolutionScale : float

Scale of mapped content, relative to screen resolution

null : Self

renderDebugView(resolution: Vec2) → DxTexture

property renderResolutionScale : float

Scale of rendered RenderStream content (before perspective warp), relative to mapping resolution

Bases: _BlipValue

null : Self

class d3.MessageBus

Bases: _BlipValue

addHandler(handler: IMessageHandler) → None

null : Self

removeHandler(handler: IMessageHandler) → None

sendMessage(message: Message) → None

class d3.MessageReceivedData

Bases: _BlipValue

property clear : bool

property detail : str

property isNew : bool

property message : ExceptionMessage

null : Self

class d3.MessageSystem

Bases: Subsystem

property messageBus : MessageBus

null : Self

class d3.MetaField

Bases: Resource

property className : str

property damping : float

property displayName : str

duplicateName : Callable

duplicatePath : Callable

property edited : bool

property fieldName : str

get : Callable

property max : float

property min : float

null : Self

set(min: float, max: float, step: float) → None

property step : float

class d3.MetaFieldPopulateArgs

Bases: _BlipValue

property field : Field

null : Self

class d3.MethodInfo

property argTypes : TCallArgs

property name : str

null : Self

property returnType : Type

class d3.MetricGraphCategories

Bases: _BlipValue

categories : Callable

null : Self

class d3.MetricMonitor

Bases: Resource

addSample(idx: int, sample: float) → None

addSeries(title: str, bufferSize: int, colour: Colour, mode: int) → int

clearData() → None

dumpDataToDisk(folder: str) → None

duplicateName : Callable

duplicatePath : Callable

property expired : bool

graphDescriptor(returnSnapshotIfPaused: bool) → GraphDescriptor

nSeries() → int

property name : str

null : Self

paused() → bool

property pausedChangedAction : Action

property pollInterval : float

property pollUnits : int

seriesAverage(title: str, nSamples: int) → float

seriesAverageByIndex(idx: int, nSamples: int) → float

property title : str

togglePause : Callable

property xZoom : float

class d3.MidiBeatClockState

Bases: IDataState

property bpm : float

property iBeat : float

null : Self

property running : bool

property song : int

property startedThisFrame : bool

property tStart : float

class d3.MidiControl

Bases: Resource

property control_surface : ControlSurface

duplicateName : Callable

duplicatePath : Callable

null : Self

property schedule : Schedule

property status : int

property transport : Transport

class d3.MidiControlSet

Bases: Resource

property controls : List[MidiControlSetEntry]

duplicateName : Callable

duplicatePath : Callable

nObjects() → int

null : Self

object(i: int) → MidiControlSetEntry

property objects : List[MidiControlSetEntry]

property type : int

class d3.MidiControlSetEntry

Bases: Resource

property ccNumber : int

property cc_number : int

duplicateName : Callable

duplicatePath : Callable

property midiChannel : int

property midi_channel : int

null : Self

class d3.MidiControlSurface

Bases: ControlSurface

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.MidiControllerState(arg0: MidiControllerState)

Bases: IDataState

property channel : int

property controllerNumber : int

property getValue : int

null : Self

property tChanged : float

class d3.MidiDevice

Bases: Device

controlChanged(iControl: int) → bool

controlSet(i: int) → MidiControlSet

property controlSets : List[MidiControlSet]

property controlSetsChangedAction : Action

controlVal(iControl: int) → int

property controlVals : List[int]

property control_sets : List[MidiControlSet]

property damping : float

duplicateName : Callable

duplicatePath : Callable

forceControl(iControl: int, val: int) → None

getControllerState(iControl: int) → MidiControllerState

getLastChangedControllerState() → MidiControllerState

getLastChangedNoteOnState() → MidiNoteState

getNoteState(iControl: int) → MidiNoteState

property iChanIn : int

property iChanOut : int

property iControlToAddress : List[int]

property io_mode : int

property midiIn : MidiIn

property midiInName : str

property midiOut : MidiOut

property midiOutName : str

property midi_in : str

property midi_in_channel : int

property midi_out : str

property midi_out_channel : int

nControlSets() → int

nControls() → int

null : Self

setControl(command: int, iControl: int, value: int) → None

class d3.MidiIn

Bases: _BlipValue

property deviceName : str

findChangedControllerAddressSince(tActual: float) → int

findChangedNoteOnAddressSince(tActual: float) → int

property name : str

null : Self

class d3.MidiLink

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.MidiMap

Bases: Resource

property deviceName_ : str

duplicateName : Callable

duplicatePath : Callable

property fieldNames : List[str]

property moduleClassName : str

null : Self

class d3.MidiNoteModule

Bases: Module

property channel : int

property device : int

property duration : float

property note : int

The integer value of the note to send. The valid range is 0 - 127. Outside of this, no message will be sent.

property midi_play_to_end_of_section : int

property midi_prev : int

property midi_return_to_start : int

property midi_section_jump : int

property midi_stop : int

null : Self

property on_clock_lost : int

property on_clock_regained : int

property on_jump_to_cue : int

property phase_lock__beat_clock_only_ : int

property play_mode : int

property track_select : int

class d3.MidiTrigger

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.MipmappedMaskTexture

Bases: DxTexture

duplicateName : Callable

duplicatePath : Callable

formatStrings : List[str]

null : Self

class d3.MissingMediaDomain

Bases: Domain

Filter_AllowAll : Final = 1

Filter_AllowLocalOrNonEditors : Final = 0

notFound(filter: int) → List[NotFoundMedia]

notFoundMedia(filter: int) → List[NotFoundMediaMachineInfo]

notFoundMediaSize(filter: int) → int

null : Self

syncMissingMedia(filename: str, filter: int) → None

class d3.MissingMediaDomainConnection

property notFoundChanged : Action

null : Self

class d3.MixedRealitySet

Bases: CameraTallyDisplay

property activeCamera : Camera

property calibrationLuts : List[CalibrationLutMapping]

property cameraOverride : Camera

Overrides the controller so that this selected camera is always used.

null : Self

property onStageObjects : List[Object]

The on-stage, physically present objects that will be used as the immediate backdrop behind live action in the MR effect.
They receive the forced perspective effect, if possible.
Areas not covered by these objects in the camera view are masked out and replaced with set extension, if it is enabled.

property setExtensionMesh : Mesh

Add a mesh here that extends the virtual set beyond the edges of the physical LED set.
This can be used to correct spatial reprojection discontinuities at the edges of the physical set.

class d3.MoSysF4Driver

property enablePacketTimingGraph : bool

Log incoming packet times to a graph

null : Self

class d3.MobileCam

Bases: _BlipValue

property appBuild : str

property appVersion : int

property caps : CamCaps

property capturedImage : DxTexture

property data : MobileCamData

property destroyAction : Action

property exif : ExifData

property fieldOfView : Vec2

property id : str

property imageCapturedAction : Action

property intrinsicLocked : bool

property intrinsicPath : str

property intrinsicValid : bool

property ipAddress : str

property isEnabled : int

property isReceivingStats : bool

property isSaveImages : bool

property isSendRgbImages : bool

property licenseMethod : int

modeNamesAuto1 : List[str]

modeNamesAuto2 : List[str]

modeNamesAuto3 : List[str]

modeNamesLensPosComp : List[str]

property model : str

property nAcks : int

property name : str

null : Self

property params : CamParams

property receivedAcks : bool

property resolution : Int2

property stats : MVCameraStatsDisplay

property status : str

property tLastAreaChange : float

property tLastSeenAlive : float

class d3.MobileCamData(unknown: MobileCamData)

Bases: _BlipValue

property appBuild : str

property appVersion : int

focalLengthSafe() → float

property id : str

property isSaveImages : bool

property isSendRgbImages : bool

property model : str

property name : str

null : Self

property sensorPreset : int

class d3.MobileCamPair

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.MobileCameraCommunication

Bases: CameraCommunication

disconnectAllCameras() → None

enableCameraStats(cam: MobileCam, enable: bool) → None

enableCameraStatsAll(enable: bool) → None

getUnlicensedCameras() → List[MobileCam]

property iFrameSendIdRequest : int

isReceivingStats(cam: MobileCam) → bool

null : Self

sendCaptureOutputImagePng(cam: MobileCam) → bool

sendCaptureOutputImageRaw(cam: MobileCam) → bool

sendSetCameraAuto(cam: MobileCam, mode: int, poi: Vec2) → bool

sendSetExposure(cam: MobileCam, exposureDur: float, iso: float, poi: Vec2) → bool

sendSetExposureTarget(cam: MobileCam, exposureTarget: float) → bool

sendSetFocalLength(cam: MobileCam, focalLength: float) → bool

sendSetLensPos(cam: MobileCam, normalisedLensPos: float, poi: Vec2) → bool

sendSetLensPosCompensation(cam: MobileCam, compMode: int) → bool

sendSetPointOfInterest(cam: MobileCam, poi: Vec2) → bool

sendSetSendRgbImages(cam: MobileCam, onOff: bool) → bool

sendSetWhiteBalance(cam: MobileCam, wbRgbGains: Vec) → bool

serialLicenseCamCount() → int

class d3.MobileCameraReference

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property id : str

property name : str

null : Self

class d3.Module

Bases: Resource

property blendMode : int

Controls how the module composites its output with layers below it

property brightness : float

Controls the brightness of the module. If the module is on alpha mode then zero brightness means fully transparent

property canvas : DxTexture

property canvasSize : Vec2

property colour : Colour

defaultResourceSequence() → str

duplicateName : Callable

duplicatePath : Callable

property forceTint : Colour

property isExternalControl : bool

property isGraphical : bool

property isInternalControl : bool

property isRendering : bool

property layer : Layer

property mapping : Projection

Controls which screens receive the content of the module and the mapping technique used

property moduleConfigObject : ModuleConfig

nSourceModules() → int

property needsPreview : bool

null : Self

property ocioInputSpace : OcioColourSpace

property ownCanvas : bool

property palette : DxTexture

Bitmap from which palette colours (tints) are read

patchDynamicFields(personality: DmxPersonality) → None

renderPreview(drawRect: Rect, colour: Colour, showAlpha: bool, inGuiColourSpace: bool) → None

resourceDuration(sequenceName: str) → float

resourceDurationDescription(sequenceName: str) → str

sourceName(i: int) → str

property tint : Colour

property xCol : float

Horizontal lookup position within the palette. 0 is left, 1 is right

property yCol : float

Vertical lookup position within the palette. 0 is top, 1 is bottom

class d3.ModuleConfig

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ModuleEventLogger

Bases: _BlipValue

null : Self

class d3.MonitorCollection

class d3.MonitorCollection(arg0: MonitorCollection)

Bases: _BlipValue

active() → List[RemoteMonitor]

all() → List[RemoteMonitor]

expired() → List[RemoteMonitor]

fuzzyMatch(string: str) → MonitorCollection

null : Self

uncategorised() → MonitorCollection

withCategories(categories: List[str]) → MonitorCollection

class d3.MonitoringGroup

Bases: _BlipValue

null : Self

class d3.MonitoringManager

Bases: Subsystem

clearAllMonitors() → None

dumpDataToDisk(folder: str) → None

dumpSelectionToDisk(folder: str, monitors: List[MetricMonitor]) → None

findLocalMonitor(name: str) → MetricMonitor

findOrCreateLocalMonitor(path: Path, type: Type) → MetricMonitor

findRemoteMonitor(nodeName: str, monitorName: str) → MetricMonitor

localMonitors() → MonitorCollection

null : Self

property onUpdateRemoteMonitorsAction : Action

preserveExpiredGraphs() → bool

remoteMetricMonitorsForNode(nodeName: str) → MonitorCollection

remoteMonitors() → MonitorCollection

remoteNodes() → List[str]

property searchString : str

useMonitor(remoteMonitor: RemoteMonitor, isInUse: bool) → None

useMonitorByName(nodeName: str, monitorName: str, isInUse: bool) → None

class d3.MotionBlurModule

property blur_amount : float

null : Self

property source : ContentSource

class d3.Mouse

Bases: OsDevice

Left : Final = 0

Middle : Final = 2

Right : Final = 1

Scroll : Final = -1

lockToPosition(onOff: bool) → None

null : Self

property scrollWheelMove : int

property x : int

property xMove : int

property y : int

property yMove : int

class d3.MouseClickManipulatorSelector

null : Self

selectManipulator() → None

class d3.MouseCursor

Bases: _BlipValue

CursorAddRefPoint : Final = 16

CursorArrow : Final = 1

CursorCrossHair : Final = 5

CursorHand : Final = 2

CursorIBeam : Final = 14

CursorInkDropper : Final = 17

CursorNavDolly : Final = 8

CursorNavRotate : Final = 6

CursorNavTrack : Final = 7

CursorNo : Final = 3

CursorNoDrop : Final = 15

CursorNone : Final = 0

CursorSizeAll : Final = 9

CursorSizeNESW : Final = 13

CursorSizeNS : Final = 11

CursorSizeNWSE : Final = 12

CursorSizeWE : Final = 10

CursorWait : Final = 4

null : Self

set : Callable

class d3.MouseDragManipulatorSelector

null : Self

selectManipulator(state: int, startPos: Vec2, pos: Vec2) → None

class d3.MouseScrollManipulatorSelector

null : Self

selectManipulator(scrollAmount: float) → None

class d3.MoveAIDriver

Bases: GrpcReceiverDriver

null : Self

supportedResolutions : Callable

class d3.MtcModule

Bases: Module

duplicateName : Callable

duplicatePath : Callable

property iDevice : int

null : Self

property play_mode : int

property start_frame : int

property start_hour : int

property start_min : int

property start_sec : int

property type : int

class d3.MtcSystem

Bases: Subsystem

null : Self

class d3.MultiCalibratorFactory

Bases: CalibratorSystem

getDistortionModeNames : Callable

getMinimumEnabledCalibMethod : Callable

isCalibMethod4PointEnabled : Callable

isCalibMethod4PointExperimentalEnabled : Callable

isCalibMethod4PointRansacEnabled : Callable

isCalibMethodDistortionEnabled : Callable

isCalibMethodEnabled : Callable

isCalibMethodGoldEnabled : Callable

isCalibMethodOpenCV : Callable

isCalibMethodSolvePnP : Callable

isCalibMethodZhang : Callable

isCalibMethodZhangEnabled : Callable

isCalibratesExtrinsicOnly : Callable

isRequiresIntrinsicEstimates : Callable

isRequiresPlanarObject : Callable

isSupportsLensDistortion : Callable

isSupportsPlanarObject : Callable

null : Self

class d3.MultiCameraCluster

Bases: RenderStreamCluster

null : Self

class d3.MultiChannelClusterAssigner

Bases: Resource

property channelAssigners : List[ChannelMappingAssigner]

property defaultAssigner : ClusterAssigner

duplicateName : Callable

duplicatePath : Callable

null : Self

property port : int

class d3.MultiTransportManager

Bases: SuperTransportManager

property eventTransport : MultiEventTransport

null : Self

property transportManagers : List[TransportManager]

class d3.MulticastDelegate

class d3.MulticastDelegate(rhs: MulticastDelegate)

Bases: _BlipValue

null : Self

valid() → bool

class d3.MultiviewData

class d3.MultiviewData(other: MultiviewData)

Bases: _BlipValue

null : Self

property pos : Vec2

property size : Vec2

property sourceHardwareId : str

class d3.MultiviewVideoIn

Bases: VideoIn

dataFromHardwareId : Callable

null : Self

class d3.MyClassV

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.NCAMDriver

connected() → bool

connecting() → bool

property enablePacketTimingGraph : bool

Log incoming packet times to a graph

failedToConnectWithCurrentSettings() → bool

property ipAddress : str

IP address of the NCAM server

null : Self

property port : int

Port number of the NCAM server

class d3.NG360Driver

property address : int

property comPort : str

property distributor : ScreenPositionDriverDistributor

null : Self

class d3.NameWidget

Bases: Widget

property assignOptionAction : Callable

focusedWidget : Callable

null : Self

onFocusLabel(focus: bool) → None

set(text: str, contents: str, a: Callable) → NameWidget

setText(text: str) → None

property textBox : TextBox

uiTransparencyDisabled : Callable

class d3.NatNetDriver

connectToServer(serverAddress: str) → None

property dataPort : int

Data Port on which to receive data.

property getCurrentServerCommandPort : str

property getCurrentServerDataPort : str

property getCurrentServerDescription : str

property getCurrentServerVersion : str

property getSDKVersion : str

property getServers : List[str]

property intervalThresholdSec : float

Interval to filter out noise. If the interval time between samples is bigger, detection will be ignored.

property multicastAddress : str

Multicast Address. Leave blank for broadcast or unicast.

property newMarkerTimeoutS : float

null : Self

property onServerDiscoveryCompletedAction : Action

property onServerDiscoveryUpdateAction : Action

property predictionSamples : int

Number of samples to use for prediction.

property predictionTerms : int

Term of curve. Prediction is done by curve fitting.

property serverDiscoveryInProgress : bool

property serverIPAddress : str

Server IP Address to connect.

startServerDiscovery() → None

stopServerDiscovery() → None

property tToPredictAheadSec : float

Time ahead to predict (in seconds).

class d3.NatNetMarkerState

Bases: TrackingVectorState

null : Self

class d3.NatNetRigidBodyState

null : Self

class d3.NavigationManipulator(parent: SpaceWidget)

Bases: Manipulator

gotoDefaultMark() → None

Go to default camera bookmark

gotoMark(i: int) → None

Go to camera bookmark

property mouseLock : bool

mouseScrollCamera(dir: int) → None

Move the camera forwards or backwards

moveCameraBack() → None

Move the camera backwards

moveCameraForward() → None

Move the camera forwards

moveCameraForwardBack(state: int, startPos: Vec2, pos: Vec2) → bool

Move the camera forwards or backwards

null : Self

orbitCamera(state: int, startPos: Vec2, pos: Vec2) → bool

Orbit camera around clicked point

panCamera(state: int, startPos: Vec2, pos: Vec2) → bool

Pan camera

rotateCamera(state: int, startPos: Vec2, pos: Vec2) → bool

Rotate camera

storeMark(i: int) → None

Store camera bookmark

zoomToSelection() → bool

Zoom to selection

class d3.NavigatorAxisState

null : Self

class d3.NavigatorDriver

null : Self

class d3.NetSys

Bases: _BlipValue

getHostname : Callable

getIPAddresses : Callable

getNetworkAdaptors : Callable

null : Self

class d3.NetworkBase

Bases: _BlipValue

null : Self

class d3.NewFileMessage

class d3.NewFileMessage(arg0: NewFileMessage)

Bases: Message

null : Self

property path : str

class d3.NewNames(rhs: NewNames)

Bases: _BlipValue

property needsConfirmation : bool

property newNames : List[str]

null : Self

class d3.NewTekNDIRelaySystem

Bases: Subsystem

null : Self

class d3.NewTekNDIRelayVideoIn

Bases: BufferedVideoIn

null : Self

class d3.Node

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property local : Mat

property name : str

null : Self

property originalTrans : Mat

property parent : str

property rotation : Vec

class d3.NodeUserInfoIdentifier

Bases: _BlipValue

null : Self

class d3.NodeUserInfoMessage

Bases: _BlipValue

null : Self

class d3.NodeUserInfoTable

Bases: _BlipValue

null : Self

class d3.NoiseModule

property colour : int

property mode : int

null : Self

property source : ContentSource

property strength : float

class d3.NormalisedMipmappedMaskTexture

Bases: MipmappedMaskTexture

duplicateName : Callable

duplicatePath : Callable

formatStrings : List[str]

null : Self

class d3.NotFoundMedia

Bases: _BlipValue

description() → str

property location : MappedMediaLocation

property machine : Machine

property missingPath : Path

null : Self

property oldVersionAvailable : bool

class d3.NotFoundMediaMachineInfo

Bases: _BlipValue

property filename : str

property missingMachines : List[Machine]

null : Self

class d3.NotchCameraData

class d3.NotchCameraData(arg0: NotchCameraData)

Bases: _BlipValue

null : Self

class d3.NotchEngineDefinition

Bases: EngineDefinition

fetchAllRegisteredEngineIdentifiers : Callable

null : Self

class d3.NotchEngineSettings

Bases: EngineSettings

property disableLiveLoading : bool

Disable live reloading of Notch blocks

property enableNDI : bool

Allow blocks to use their own internal NDI stream. May cause instability

property lazyLoading : bool

Disable preloading of Notch blocks on startup

null : Self

property useDisguiseClippingPlanes : bool

Allow cameras to control clipping planes for depth clipping effects

class d3.NotchEngineSettingsResource

Bases: EngineSettingsResource

duplicateName : Callable

duplicatePath : Callable

null : Self

property settings : NotchEngineSettings

property connectDynamicFieldsAction : ParamAction

property currentLayerName : int

property dfxFileGeneration : int

property drywetblend : float

duplicateName : Callable

duplicatePath : Callable

property framerateFraction : int

The fraction of the framerate this layer renders at. Can help performance with particularly heavy blocks.
Does not help when in low latency output modes.

loadDfx() → None

property mode : int

null : Self

property processingSize : int

class d3.NotchModuleConfig

Bases: ModuleConfig

class Field

Bases: _BlipValue

property containerRef : ReflectionValue

property enums : List[str]

property group : str

property key : str

property metaMax : float

property metaMin : float

property metaStep : float

property name : str

null : Self

property readOnly : bool

property sanitizedUndecoratedName : str

property undecoratedName : str

property value : ReflectionValue

property valueType : Type

Bases: _BlipValue

property elementCount : int

property group : str

property key : str

property name : str

null : Self

property type : int

typeName() → str

class d3.Note

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

markSeen() → None

property modified : DateStamp

null : Self

property seen : bool

property text : str

class d3.Notification

Bases: _BlipValue

null : Self

class d3.OS

Bases: _BlipValue

property DebugOptions : DebugOptions

property iFrame : int

property keyboard : Keyboard

property mouse : Mouse

null : Self

property threadPool : ThreadPool

property timer : Timer

class d3.OSCSender

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.Object

Bases: Resource

Backplate : Final = 3

Frontplate : Final = 2

OffStage : Final = 0

OnStage : Final = 1

SetExtensionAddition : Final = 5

SetExtensionMask : Final = 4

add(child: Object) → None

centroid() → Vec

property children : List[Object]

duplicateName : Callable

duplicatePath : Callable

property externalUpdate : bool

findAllObjectsOfType(type: Type) → List[Object]

findObjectOfType(type: Type) → Object

getPufferSphereMesh : Callable

getSphereMesh : Callable

property hasTrackingSource : bool

isAncestorOf(obj: Object) → bool

isInActiveStage() → bool

property isReceivingFromTrackingSource : bool

property local : Mat

property mesh : Mesh

property meshChangedAction : Action

property needsMesh : bool

null : Self

property offset : Vec

Position in the scene, in meters; relative to parent object in hierarchy, and mesh position.

onExternalUpdateChanged() → Action

property parent : Object

remove() → None

property renderLayer : int

Where the screen appears.
On stage, the screen is physically present.
Off stage: the screen is temporarily removed from the scene.
Frontplate: Cameras view the screen content as AR content overlaying the stage. Invisible to Projectors.
Backplate: If MR is enabled, the camera projects the content onto the MR set.
Set Extension mask: If MR is enabled, the object cuts away at any set extension, leaving only live video and AR effects.
Set Extension addition: If MR is enabled, the object masks any live video and AR effects, rendering the set extension instead
Live action volume: If MR is enabled, the object defines a volume outside of which set extension is always rendered

property rotation : Vec

Rotation around x, y, z axes, in degrees; relative to parent object in hierarchy, and mesh orientation.

property scale : Vec

property sortOverride : int

Manually override depth sorting.
Objects with lower values are rendered before objects with higher values

property trackingSource : ObjectTrackingSource

property trackingSourceChangedAction : Action

property world : Mat

class d3.ObjectBox

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property name : str

null : Self

property objects : List[Resource]

class d3.ObjectBoxOld

Bases: _BlipValue

null : Self

class d3.ObjectDeformationSettings

Bases: _BlipValue

add(obj: Object) → None

null : Self

property objects : List[ObjectDeformationSettingsPair]

remove(obj: Object) → None

class d3.ObjectDeformationSettingsPair

Bases: _BlipValue

null : Self

property objectRef : ResourceReference

property settings : DeformationSettings

class d3.ObjectSet

Bases: Resource

property boxes : List[ObjectBox]

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ObjectTrackingSource

Bases: Resource

property driver : Resource

property driverSendingFlags : TrackingFlags

dumpTrackingDeltaHistory() → None

duplicateName : Callable

duplicatePath : Callable

property enabledFlags : TrackingFlags

property frameOfReference : AnimationAxisSettings

property isReceiving : bool

null : Self

property pos : Vec

property rot : Vec

property rotationDelayOffset : float

Time in seconds between the positional tracking data arriving and the rotational tracking data arriving.
If negative rotational data arrives before the spatial frame.
If positive, rotational data arrives after the spatial frame.
Typically only used in complex gimbal systems.

property smoothReceiveTime : bool

Select to smooth out the receive time of data packets, reducing jitter at a cost of added latency

class d3.ObjectView(className, **kwargs)

Bases: ResizableWidget

addFilteredBox(filter: ObjectViewBoxFilter) → None

allowNull(on: bool, nullText: str) → ObjectView

allowNullDefault : Callable

canClose(on: bool) → ObjectView

property className : str

property closeOnSelect : bool

property contents : ScrollWidget2

property creationEnabled : bool

property filter : ReturnParamAction

property indirectionsEnabled : bool

keepFocusOnSearchBox(on: bool) → ObjectView

null : Self

property onSet : Callable

property quickSelectSlotsEnabled : bool

refreshBoxContents() → None

refreshFilteredBox(boxName: str) → None

renameBox(oldName: str, newName: str) → None

property searchField : Field

set(className: str) → ObjectView

setClassMenuFilter(filtrFunc: Callable) → None

setFilter(filtrFunc: Callable) → None

property titleButton : TitleButton

class d3.ObjectViewBoxFilter(arg0: str, arg1: Callable)

class d3.ObjectViewBoxFilter(arg0: str, arg1: ClassNode)

Bases: _BlipValue

hideIfEmpty() → None

null : Self

setDefault() → None

class d3.ObjectViewState

Bases: Resource

property constraintSize : Vec2

property displayAs : int

duplicateName : Callable

duplicatePath : Callable

null : Self

property searchText : str

property selectedTag : ResourceTag

class d3.ObjectViewThumbnail

Bases: Thumbnail

mouseDragResource(state: int, startPos: Vec2, cursor: Vec2) → None

Move the resource to a different box

null : Self

property resource : Resource

selectResource() → None

Select the resource

class d3.OcioBuiltinConfig

Bases: OcioConfig

property configName : str

property configUIName : str

null : Self

class d3.OcioColourSpace

class d3.OcioColourSpace(arg0: OcioColourSpace)

Bases: _BlipValue

Input : Final = 1

Output : Final = 2

Working : Final = 3

null : Self

set(name: str, view: str, isBuiltin: bool) → None

class d3.OcioColourSpaceBox

Bases: ValueBox

findOrCreateSelectorWidget : Callable

property includeDefaultColourSpace : bool

isSupportedType : Callable

null : Self

class d3.OcioColourSpaceSelector(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

onSetSetter(callable: Callable) → None

uiTransparencyDisabled : Callable

class d3.OcioConfig

Bases: Resource

property defaultInputColourSpace : OcioColourSpace

Default colour space used for input transforms

property defaultOutputColourSpace : OcioColourSpace

Default colour space used for output transforms

duplicateName : Callable

duplicatePath : Callable

null : Self

printDefaultInputShader() → None

printDefaultOutputShader() → None

null : Self

printShader() → None

class d3.OcioShaderProperties

Bases: _BlipValue

property contrast : float

property exposure : float

property gamma : float

isContrastAvailable() → bool

isExposureAvailable() → bool

isGammaAvailable() → bool

null : Self

class d3.OcioShaderPropertiesBox

Bases: ValueBox

isSupportedType : Callable

null : Self

set(arg0: Resource, arg1: ValueBoxProperty) → OcioShaderPropertiesBox

class d3.OcioSystem

makeParam(resource: Resource, object: ReflectionValue, fieldInfo: FieldInfo, customExpression: str) → None

null : Self

property params : List[Param]

removeParam(fullName: str) → None

class d3.OpenModuleConfig

Bases: ModuleConfig

class Param

Bases: _BlipValue

property connected : bool

property fullName : str

init(arg0: Resource, arg1: str, arg2: str, arg3: str) → None

null : Self

property paramId : str

property resource : Resource

property type : str

property value : ReflectionValue

null : Self

property params : List[Param]

class d3.Operation(arg0: str)

Bases: _BlipValue

null : Self

class d3.OptiCalCameraPlan

Bases: Camera

property blobStats : PlannedBlobStatistics

property camParams : PlannedMobileCamParams

property cropFactor : float

property focalLength35mm : float

getCameraFocalLengthPreset() → int

getCameraFocalLengthPresetNames : Callable

getCameraFocalLengthPresetValues : Callable

getCameraPreset() → int

getCameraSensorPresetNames : Callable

getCameraSensorPresetValues : Callable

hasCamera() → bool

imageRotation() → int

isOnline() → bool

property isSimulated : int

localVisualiserCamera : Callable

property mobileCam : MobileCam

property mobileCameraRef : MobileCameraReference

property name : str

null : Self

property referenceImage : DxTexture

property sensorSizeMM : Vec2

setCameraPreset(sensorPreset: int, focalLengthPreset: int) → None

setImageRotation(angle: int) → None

property throwRatio : float

class d3.OptiCalCameraPlanReport(arg0: str, arg1: str, arg2: str, arg3: Stage, arg4: List[OptiCalCameraPlan])

Bases: _BlipValue

generateCsv(revision: str, overwrite: bool) → None

generatePdf(revision: str, comment: str, overwrite: bool) → None

getCsvPath(revision: str) → str

getPathPrefix() → str

getPdfPath(revision: str) → str

property iFrameReady : int

null : Self

class d3.OptiCalCaptureSetup(base: str)

class d3.OptiCalCaptureSetup(arg0: OptiCalCaptureSetup)

class d3.OptiCalCaptureSetup(basePath: str, settings: CaptureSettings, camComms: CameraCommunication)

Bases: _BlipValue

buildCaptureGroups(camBlobs: PerCameraBlobs, task: OptiCalTask, debounce: bool) → None

clearRenderStateOnCompletion() → None

detectBlobCodes(updateCamBlobs: PerCameraBlobs, task: OptiCalTask, debounce: bool) → None

detectBlobs(task: OptiCalTask, debounce: bool) → PerCameraBlobs

property getBasePath : str

getCamResolution(camName: str) → Int2

property getCamerasData : List[MobileCamData]

property getCaptureSettings : CaptureSettings

getGridImagePaths(iProjector: int, camName: str) → OptiCalGridImagePaths

property isLiveCapture : bool

loadBlobs(suffix: str) → PerCameraBlobs

null : Self

saveBlobs(camBlobs: PerCameraBlobs, suffix: str) → None

startCaptureAlignment() → None

startCaptureBits() → None

startCaptureGrids() → None

startFocus() → None

startSetupCapture(imageType: int) → None

class d3.OptiCalCaptureSystem

Bases: Subsystem

null : Self

property progressRatio : float

resetStageState() → None

saveStageState() → None

class d3.OptiCalDeform

Bases: _BlipValue

null : Self

resetScreenToAlignmentMesh : Callable

resetScreenToOrigMesh : Callable

class d3.OptiCalGridImagePaths(arg0: OptiCalGridImagePaths)

Bases: _BlipValue

property alignment : CamCapturePaths

property alignmentGuideLines : CamCapturePaths

property blackLevel : CamCapturePaths

property focus : CamCapturePaths

property grid : CamCapturePaths

null : Self

property whiteLevel : CamCapturePaths

null : Self

str() → str

class d3.OptiCalResult

Bases: OptiCalStagePlan

null : Self

class d3.OptiCalRun

Bases: Resource

property BAIterations : int

property blobAreaLimits : Vec2

property blobCircularityLimits : Vec2

property blobConvexityLimits : Vec2

property blobInertiaLimits : Vec2

property bundleAdjustTarget : int

property calibrateCameraPosition : int

property calibrationModel : int

property camCalConfidence : float

property camCalConfidenceAuto : int

property camCalUseDistortion : int

property camCalUseLensShift : int

property cameraAutoMode : int

property cameraWeightFactor : float

property cameraWeightMode : int

property centroidMode : int

duplicateName : Callable

duplicatePath : Callable

property gridTolerance : float

property gridToleranceMethod : int

property iCalRun : int

property inlierMaxReprojectionError : float

property inlierNormalPercentile : int

property intersectionHandling : int

null : Self

property outlierMode : int

property overlapThreshold : float

property parallelCaptureMode : int

property planarAngle : float

property planarType : int

property refineMethod : int

property scaleCalcMethod : int

property scaleOutlierPercent : float

property worldAlignMatrix : Mat

property worldAlignOffset : Vec

property worldAlignRotation : Vec

property worldAlignScale : float

class d3.OptiCalSettings

Bases: _BlipValue

getCameraGraphScoreModeNames : Callable

getPointCloudModeNames : Callable

getPointCloudModeValues : Callable

null : Self

class d3.OptiCalStagePlan

Bases: Resource

addAlignmentDataPose() → AlignmentDataPose

property alignmentData : AlignmentData

alignmentFromCamerasAndProjectors(bProjectors: bool) → Mat

alignmentFromData(ad: AlignmentData) → Mat

property alignmentObjects : List[Object]

alignmentPoseCapturePath(poseName: str) → Path

alignmentPoseNamePrefix() → str

applyAlignmentToStage(alignMat: Mat) → None

applyManualAlignment() → None

applyMobileCamParams() → None

property blobDetectionSettings : BlobDetectionSettings

property calibrationCompleteAction : Action

property calibrationSettings : CalibrationSettings

property calibrationSummaryTable : List[CalibrationResultsData]

cameraImageRotation(camName: str) → int

property cameras : List[OptiCalCameraPlan]

property captureCompleteAction : Action

capturePath() → Path

property captureSettings : CaptureSettings

property captureViewSettings : CaptureViewSettings

cleanupMobileCams() → None

property deformationSettings : ObjectDeformationSettings

distortPoint(p: Vec2, camName: str) → Vec2

duplicateName : Callable

duplicatePath : Callable

enableMobileCamStats(cam: MobileCam, enable: bool) → None

enableMobileCamStatsAll(enable: bool) → None

enableMobileCamStreaming(enable: bool) → None

ensureMasterScreensAreValid() → None

estimateAlignmentBasic() → Mat

findCameraPlan(cameraName: str) → OptiCalCameraPlan

getAlignmentImageBasePose(camName: str, guideLines: bool) → DxTexture

getAlignmentImagePose(camName: str, guideLines: bool, poseName: str) → DxTexture

getAlignmentObjects() → List[Object]

getAlignmentObjectsWithChangedMeshes() → List[Object]

getAutoApplyDeformObjects() → List[Object]

getCameraMats(camName: str) → CameraMats

getCameraNames() → List[str]

getGridImage(camName: str, iDisplay: int) → DxTexture

getProjectionSurfaces() → List[Screen2]

property gridErrors : List[GridAlignmentErrorData]

property gridImageLoadedAction : ParamAction

hasActiveCamerasAndProjectors() → bool

hasCalibration() → bool

hasCapture() → bool

hasStackedProjector() → bool

isCalibrating() → bool

isCameraCalibrated(cameraName: str) → bool

isCapturing() → bool

isDeforming(objectUid: int) → bool

isExecuting() → bool

isLoadedFromFiles() → bool

isRunning() → bool

property isSimulated : int

makeProjectorRestorer(restoreShutterStates: bool) → ProjectorRestorer

makeVirtualCamComms() → VirtualCameraCommunication

nAliveCameras() → int

nAliveMVCameras() → int

nCameraPlans() → int

null : Self

property projectors : List[Projector]

property quickAlignViewSettings : QuickAlignViewSettings

property report : OptiCalReport

requestCalibrate() → OptiCalTask

requestCapture(resume: bool) → OptiCalTask

requestDeform(deformationSettings: ObjectDeformationSettingsPair) → OptiCalTask

requestDeformObjects(objects: List[Object]) → OptiCalTask

requestExecute() → OptiCalTask

requestGridImage(camName: str, iDisplay: int) → None

requestUpdateStackingWarps() → OptiCalTask

resetProjectors() → None

property rigCheckAlignmentData : AlignmentData

setCameraImageRotation(camName: str, angle: int) → None

setMobileCamBandwidth() → None

setStackedProjectorShutters(open: bool) → None

undistortPoint(p: Vec2, camName: str) → Vec2

undistortTexture(camName: str, dxt: DxTexture) → DxTexture

updateAlignmentData() → None

updateCaptureSettings() → None

updatePoseMasterScreenData(pose: AlignmentDataPose) → None

validateCapture() → bool

class d3.OptiCalStepResult

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.OptiCalTask

Bases: _BlipValue

cancel() → None

error() → str

null : Self

progress() → float

report() → str

running() → bool

success() → bool

class d3.OptiCal_io

Bases: _BlipValue

null : Self

saveCaptureSurfacesToPointClouds : Callable

savePlanToPointClouds : Callable

class d3.OpticalCalibrator

Bases: Resource

property applyAlignment : int

Apply the alignment of the currently selected plan or result to the stage via open module

property cameraBandwidthGbit : float

Total network bandwidth allocation for machine vision cameras in Gigabits per second. This will be divided evenly among active cameras in a plan.

property cameraBandwidthMode : int

Whether camera bandwidth is automatically manage or not

clearMeshDataCache() → None

clearRenderedObjects() → None

disableWarps() → None

property discoveryAdapterName : str

duplicateName : Callable

duplicatePath : Callable

executePlan() → OptiCalTask

getAutoAlignTargetNames : Callable

getCentroidModeNames : Callable

getGridToleranceMethodNames : Callable

getObject() → OpticalCalibratorObject

getOutlierModeNames : Callable

getVisualisationNames : Callable

isBusy() → bool

isCapturing() → bool

property manageOnlyInternalProcesses : int

Whether d3 only stop its own camera server processes, or also externally launched ones.

null : Self

property plan : OptiCalStagePlan

The plan for execution at this venue

property renderFrameDelay : int

Delay in [frames] between setting OmniCal render state and assuming visible projector output for camera capture. Try values above 5 if the downstream signal chain has additional delays.’

renderStageFromCamera(cameraMats: CameraMats, widgetViewMat: Mat, imageScale: Vec2, imageCentre: Vec2, stageRenderOpacity: float) → None

renderWireframeFromCamera(mesh: Mesh, worldMat: Mat, cameraMats: CameraMats, widgetViewMat: Mat, imageScale: Vec2, imageCentre: Vec2, wireframeParams: WireframeRenderParams) → None

property report : OptiCalReport

requestResetAndRescan() → OptiCalTask

property resetAndRescanTask : OptiCalTask

property result : OptiCalResult

saveCalibratedCameras() → None

sendWarps() → None

property showCode : int

showRenderedObjects() → None

property simulateProjectorLensDistortion : bool

property simulateProjectorWarpGrid : bool

property simulateStackedProjectorOutputs : bool

property testSimulatedProjectorWarps : bool

property testWarpGridSize : Int2

property visualisation : int

visualisationPlan() → OptiCalStagePlan

property visualisationSource : int

class d3.OpticalCalibratorObject

Bases: Object

property displayIndex : int

Projector filter for point cloud

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

property pointCloudLabels : int

Whether point labels are drawn and what value they will display

property pointCloudMaxLineLength : float

Max line length between points in reconstructed 3D point cloud.

property pointCloudMode : int

Mode for visualising reconstructed 3D point cloud.

property pointCloudScale : float

Scale factor for rendering points in the grid. The drawn point size also depends on visualisation mode.

class d3.OpticalCalibratorSystem

Bases: Subsystem

property calibrator : OpticalCalibrator

property camComms : MobileCameraCommunication

property cameraCal : CameraCalibration

property discoveryEnabled : bool

findOnlineCamera(camFilename: str) → MobileCam

findOnlineCameraById(id: str) → MobileCam

findOrCreateMobileCamRef(id: str, name: str) → MobileCameraReference

getDiscoveryAdapterIp() → str

inErrorStatus() → bool

property isStoppingVimbaCamServer : bool

isVimbaInstalled() → bool

null : Self

property paths : unique_ptr

requestDiscovery(requested: bool, reqKey: str) → bool

setDiscoveryAdapterIp(physicalIp: str, broadcastIp: str) → None

class d3.OptionParam

class d3.OptionParam(other: OptionParam)

Bases: _BlipValue

null : Self

class d3.OptionValue

Bases: _BlipValue

null : Self

class d3.Options

Bases: _BlipValue

property GPUFanSpeedPercentOverride : OptionValue

property RgbEasyVideoFormat : OptionValue

property additionalCommandLatency : OptionValue

property allocateExtraMB : OptionValue

property allowOpenEditorsWhilePlaying : OptionValue

property allowPersistentMute : OptionValue

property allowPrefetcherLookaheadModulation : OptionValue

property allowProjectCorruption : OptionValue

property applyCalibrationLUTInVisualiser : OptionValue

property audioInputDriver : OptionValue

property audioLinePcmSize : OptionValue

property audioMinFadeRamp : OptionValue

property audioStreamBufferSize : OptionValue

property automationKeyframeInterval : OptionValue

property blackMagicMatrixSendDelay : OptionValue

property bluefishVITCEnabled : OptionValue

property cameraVideoInFpsDivisor : OptionValue

property cefLoggingVerbosity : OptionValue

property commsProcessingTime : OptionValue

property commsResendWindowSize : OptionValue

property crtBreakAlloc : OptionValue

property debugBlackBox : OptionValue

property debugCameraTrackingReceiveDelta : OptionValue

property debugCameraTrackingSync : OptionValue

property debugComms : OptionValue

property debugControlDevice : OptionValue

property debugGPUAllocation : OptionValue

property debugLevelAudio : OptionValue

property debugLevelBluefish : OptionValue

property debugLiveUpdate : OptionValue

property debugLiveUpdateMaxCache : OptionValue

property debugLocalisation : OptionValue

property debugMediaManager : OptionValue

property debugMessaging : OptionValue

property debugPrefetchScan : OptionValue

property debugPresentData : OptionValue

property debugResourceFileDeletion : OptionValue

property debugRivermaxStream : OptionValue

property debugSockPuppetTimecode : OptionValue

property debugTextureLifetimes : OptionValue

property debugVSyncEstimationLevel : OptionValue

property defaultDetachedBankEditorResources : OptionValue

property deferActorStartup : OptionValue

property disableActiveLatencyPhaseAdjustment : OptionValue

property disableAlignmentTransport : OptionValue

property disableAltTab : OptionValue

property disableAudioASIODriver : OptionValue

property disableAudioCrossfade : OptionValue

property disableAudioInput : OptionValue

property disableCaptureDropFrameNotifications : OptionValue

property disableColourCalAcceleration : OptionValue

property disableConfirmationDialog : OptionValue

property disableDMXKeepAlive : OptionValue

property disableDllVersionCheck : OptionValue

property disableDmxAdapterPoll : OptionValue

property disableDmxPacketSendWait : OptionValue

property disableDmxScreenChannelConflictCheck : OptionValue

property disableDormantMode : OptionValue

property disableFeedRectangleProxies : OptionValue

property disableFrameBlending : OptionValue

property disableFreeSpaceCheck : OptionValue

property disableFullscreenCheck : OptionValue

property disableHdrOnPrimary : OptionValue

property disableInputInCameraEditor : OptionValue

property disableLicenseOverLAN : OptionValue

property disableLiveUpdate : OptionValue

property disableNonSurfaceProxies : OptionValue

property disableOutputModeHotkeys : OptionValue

property disableOverlayMessages : OptionValue

property disablePrefetcherNotifications : OptionValue

property disableProxyMaker : OptionValue

property disableRefWarnings : OptionValue

property disableResourceSend : OptionValue

property disableSendDisengagedObjects : OptionValue

property disableShaderCache : OptionValue

property disableTelnetNotification : OptionValue

property disableTrackSanityChecks : OptionValue

property disableTrackingDataRedistribution : OptionValue

property disableUnrealConfigUpdate : OptionValue

property disableUnsupportedEmbeddedAudioNotification : OptionValue

property disableVFCConfigOnStartup : OptionValue

property disableVR : OptionValue

property disableVideoInDeviceMap : OptionValue

property disableVideoclipThumbnailVersions : OptionValue

property disableWDGA36ACRC : OptionValue

property drawMouseCursor : OptionValue

property dumpFrameStats : OptionValue

property dumpReflectionTypePointers : OptionValue

property enableACESFinalMatrix : OptionValue

property enableActiveRegions : OptionValue

property enableAlphaMaskDSE : OptionValue

property enableArtificialLatency : OptionValue

property enableChromaKeyModule : OptionValue

property enableColourFormat : OptionValue

property enableCrashReporting : OptionValue

property enableDeleteOldMedia : OptionValue

property enableDualModeVFC : OptionValue

property enableExperimentalOutput : OptionValue

property enableFeedAlpha : OptionValue

property enableFfmpegLogging : OptionValue

property enableGuiFeed : OptionValue

property enableHighDynamicRange : OptionValue

property enableIPSDIExperimentalModes : OptionValue

property enableLensCalibrationLoading : OptionValue

property enableMeshDeform : OptionValue

property enableMixedReality : OptionValue

property enableMultiview : OptionValue

property enableNotchNDI : OptionValue

property enablePerAxisScreenPositionLockout : OptionValue

property enablePrefetcherGraphDebug : OptionValue

property enableProjectorDeviceLogging : OptionValue

property enableProjectorDeviceRetries : OptionValue

property enableProjectorStacking : OptionValue

property enableProofOfPlay : OptionValue

property enableRenderStreamEngineSync : OptionValue

property enableRenderStreamNDI : OptionValue

property enableResourceFileDeletion : OptionValue

property enableSLC : OptionValue

property enableSeparateRotationAndSpatialDelays : OptionValue

property enableShaderSourceDebugging : OptionValue

property enableSharedLayers : OptionValue

property enableSmartGroups : OptionValue

property enableSpinelFloor : OptionValue

property enableTimelineZoomOnScroll : OptionValue

property enableUnusedMediaManagement : OptionValue

property enableVicon : OptionValue

property enableVideoBlackCompensation : OptionValue

property enableVideoFileBuffering : OptionValue

property enableWebGL : OptionValue

property enableWebGLPublish : OptionValue

property etwLevel : OptionValue

property fixedModeTimerFPS : OptionValue

property forceDXGIColorSpace : OptionValue

property forceDXGISwapEffect : OptionValue

property forceDirectorLiveUpdateBlocked : OptionValue

property forceOpenCL : OptionValue

property forceOutputBitDepth : OptionValue

property forcePIDTimecodeChase : OptionValue

property forcePrimaryOutputTo8Bit : OptionValue

property forceRSUCNumaNode : OptionValue

property forceShadowBufferRendering : OptionValue

property forceVsyncOnPrimary : OptionValue

property generateWorkloadHTTPCommands : OptionValue

property genlockPhaseAdjustLines : OptionValue

property genlockPhaseAdjustPixels : OptionValue

property gpuPoolLogLevel : OptionValue

property gpuPoolMemoryPercentage : OptionValue

property importUsingVmap : OptionValue

property isAudioInMovDisabled : OptionValue

property isAutoCalib4PointDisabled : OptionValue

property isAutoCalib4PointExperimentalEnabled : OptionValue

property isAutoCalib4PointPlusEnabled : OptionValue

property isAutoCalibAltMethodEnabled : OptionValue

property isAutoCalibDeveloper : OptionValue

property isAutoCalibDistortionEnabled : OptionValue

property isAutoCalibGoldDisabled : OptionValue

property isAutoCalibMethodsEnabled : OptionValue

property isAutoCalibUpdateViewEnabled : OptionValue

property isAutoCalibWarnMovedRefPointsEnabled : OptionValue

property isAutoCalibZhangDisabled : OptionValue

property isBlackBoxPlaybackIgnoreD3Version : OptionValue

property isCITPVerbose : OptionValue

property isCefSingleThreaded : OptionValue

property isClearArrowsEnabled : OptionValue

property isDebugFullScreen : OptionValue

property isDebugMultiHead : OptionValue

property isDebuggingBlackTrax : OptionValue

property isDebuggingFolderWatcher : OptionValue

property isDebuggingInReleaseAllowed : OptionValue

property isDebuggingNDI : OptionValue

property isDebuggingTargetChanges : OptionValue

property isDebuggingTexturePool : OptionValue

property isDeveloper : OptionValue

property isForceGPUFanControl : OptionValue

property isInputMapTracingEnabled : OptionValue

property isKalmanFilterEnabled : OptionValue

property isMouseUnrestricted : OptionValue

property isNotCachingTextureHandles : OptionValue

property isPythonVerbose : OptionValue

property isQuietFeedMapEdit : OptionValue

property isRenameTableEnabled : OptionValue

property isSingleKeyGlobalJumpEnabled : OptionValue

property isSockPuppetBidirectional : OptionValue

property isSyncProjectFromDirectorDisabled : OptionValue

property isTelnetVerbose : OptionValue

property isWatchingForFrameJumps : OptionValue

property isWindowed : OptionValue

property lockMouseWhileOrbiting : OptionValue

property logicalVideoInDeviceBufferSize : OptionValue

property luxProjectorBatchSize : OptionValue

property matroxClockNotificationsDisabled : OptionValue

property matroxClockWaitOverride : OptionValue

property matroxDisableContinuousEnqueuing : OptionValue

property matroxInputClockEnabled : OptionValue

property matroxOverrideAsyncPrequeue : OptionValue

property matroxOverrideAsyncPreroll : OptionValue

property matroxOverrideAsyncWait : OptionValue

property matroxSurfaceNodeDepthOverride : OptionValue

property matroxSurfacePoolSizeOverride : OptionValue

property matroxSurfaceReadTimeoutOverride : OptionValue

property matroxTimebaseCorrectionModeEnabled : OptionValue

property matroxTimingLoggingVerbosity : OptionValue

property matroxVITCEnabled : OptionValue

property matroxVerboseTimingMonitoringEnabled : OptionValue

property matroxWriteToReadDelayOverride : OptionValue

property maxAutomationPacketQueueSize : OptionValue

property maxCameraSwitchingDelay : OptionValue

property maxContentLightLevel : OptionValue

property maxFrameAverageLightLevel : OptionValue

property maxHeads : OptionValue

property maxMasteringLuminance : OptionValue

property maxTextureHeight : OptionValue

property maxTextureWidth : OptionValue

property maxVideoAudioDrift : OptionValue

property minMasteringLuminance : OptionValue

property modernFrameStatsMode : OptionValue

property mouseOrbitInvertY : OptionValue

property multicastSACNTTL : OptionValue

property nDecoders : OptionValue

property noSplashScreen : OptionValue

property noStartupStatus : OptionValue

property notchAutoPurgeVram : OptionValue

property notchCameraSwitchingResetInstances : OptionValue

property notchDisableLiveLoading : OptionValue

property notchLCKeepAlive : OptionValue

property notchLCMinBuffers : OptionValue

property notchLazyLoading : OptionValue

property notchMaxFramerateFraction : OptionValue

property notchMaxInstances : OptionValue

property notchTracingLevel : OptionValue

property notchUnloadOutOfOrder : OptionValue

property notchUseDisguiseClippingPlanes : OptionValue

null : Self

property omniCalBackupCapturesEnabled : OptionValue

property omniCalCameraDistance : OptionValue

property omniCalCameraTimeout : OptionValue

property omniCalEnableBlobDetectionMasks : OptionValue

property omniCalEnableProjectorCalibrationRetry : OptionValue

property omniCalEnableResumeCaptures : OptionValue

property omniCalIgnoreMeasuredCameraIntrinsics : OptionValue

property omniCalMaxBlobDetectionConcurrency : OptionValue

property omniCalMaxThreadsPng : OptionValue

property omniCalUseProjectorDevicesInSimulation : OptionValue

property outputColorSpace : OptionValue

property overrideUnpatchedMediaFields : OptionValue

property precompChainDepth : OptionValue

property preserveExpiredGraphs : OptionValue

property profileGPUPoolFromLaunch : OptionValue

property projectSyncTimeout : OptionValue

property projectorCullVertexCount : OptionValue

property projectorDepthBuffersVisible : OptionValue

property projectorDeviceMaxActiveTasks : OptionValue

property projectorDeviceThreadPoolSize : OptionValue

property propSelectionPriority : OptionValue

property renderStreamDebugOverlaySize : OptionValue

property renderStreamTransmissionSpeed : OptionValue

property renderstreamBufferSize : OptionValue

property renderstreamOutputSyncDelay : OptionValue

property reportMainThreadHangMsec : OptionValue

property restrictGUISizeHD : OptionValue

property rmaxBufferSize : OptionValue

property rmaxReceiverPool : OptionValue

property rmaxUploadBufferCount : OptionValue

property rmaxUploadTextureCount : OptionValue

property sectionTestMode : OptionValue

property sessionStartNodeDiscoveryDelay : OptionValue

property sessionSyncTimeout : OptionValue

property setExtensionFeatherScale : OptionValue

property showChicagoSettings : OptionValue

property shutdownWatchdogTimeoutSeconds : OptionValue

property smoothVideoInputFramesDelay : OptionValue

property soloMode : OptionValue

property ssaoMode : OptionValue

property staleStreamEvictionThreshold : OptionValue

property suppressActorsAtStartup : OptionValue

property telnetConsolePort : OptionValue

property timedExitSeconds : OptionValue

property trackedPointConfidenceThreshold : OptionValue

property trackedPointReceiveTimeout : OptionValue

property trackedPointRemoveFromStageTimeout : OptionValue

property undoSpam : OptionValue

property use11On12 : OptionValue

property use128kReadGranularity : OptionValue

property use64kReadGranularity : OptionValue

property useApplicationWindow : OptionValue

property useApproximateGamma : OptionValue

property useAutomaticProfiling : OptionValue

property useLegacyFrameComputation : OptionValue

property useLegacyGpuPool : OptionValue

property useLegacySLCRegionTag : OptionValue

property useLegacyStreamNames : OptionValue

property useOldCapsCtrlZoom : OptionValue

property usePhotoJpegAccurate : OptionValue

property useSwapGroup : OptionValue

property verboseDseChangeDetection : OptionValue

property verboseSlcChangeDetection : OptionValue

property videoAudioUnderrunTimeout : OptionValue

property videoCaptureLockstep : OptionValue

property videoConcurrentReads : OptionValue

property videoInCaptureTextures : OptionValue

property videoInUploadTextures : OptionValue

property voidVfcWarranty : OptionValue

class d3.OsDevice

Bases: _BlipValue

null : Self

class d3.OscArgument

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property type : int

property value : str

A fixed value or a variable index (e.g. $1 for variable 1)

class d3.OscCommand

Bases: Resource

property address : str

property arguments : List[OscArgument]

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.OscControlModule

Bases: Module

property auto_resend : int

property command : OscCommand

duplicateName : Callable

duplicatePath : Callable

null : Self

property osc_device : OscDevice

property variable_1 : float

property variable_2 : float

property variable_3 : float

property variable_4 : float

class d3.OscDevice

Bases: Device

duplicateName : Callable

duplicatePath : Callable

property ipFromFilter : str

Filter by sender IP. Leave blank for any IP.

null : Self

property receivePort : int

The IP address that d3 should receive OSC commands from

send(message: OscMessage) → None

property sendIPAddress : str

The IP address that d3 should send OSC commands to

property sendPort : int

The port that d3 should send OSC commands on

property supportsSendingMessageBundles : bool

Does this device support receiving batches of multiple OSC messages in one bundle

property verboseSend : int

Output all sent messages to the console

class d3.OscDriver

property addressFilter : str

Enter the OSC address string (excluding the axis names) for which OSC messages will be received. Leave empty to receive all OSC data.

null : Self

property oscDevice : OscDevice

class d3.OscIndirectionController

property address : str

OSC address that accepts a single string parameter

property device : OscDevice

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.OscMachineControl

Bases: Device

property displayQueryAddress : str

Address to query display resolutions - accepts a string parameter which is the machine host name to query

duplicateName : Callable

duplicatePath : Callable

property failoverAddress : str

Address to cause machine failover - accepts a string parameter which is the machine host name to make failover

property machineResolutionOutputAddress : str

Root address of response to displayQueryAddress with 2 integer data with x & y resolution
e.g. /d3/showcontrol/display/resolution/myMachine/0/0 1920 1080

null : Self

property oscDevice : OscDevice

property restoreAddress : str

Address to cause machine restore - accepts a string parameter which is the machine host name to restore

class d3.OscMessage

class d3.OscMessage(address: str)

Bases: _BlipValue

addBinary(data: int, length: int) → OscMessage

addFloat(f: float) → OscMessage

addInt(i: int) → OscMessage

addString(s: str) → OscMessage

getEntireMessageAsString() → str

Bases: IDataState

null : Self

class d3.OscTester

Bases: Device

clearReceiveBuffer() → None

duplicateName : Callable

duplicatePath : Callable

null : Self

property oscDevice : OscDevice

property receiveAddress : str

All addresess which start with this address are received and shown

property receiveBuffer : str

property receiveBufferCapacity : int

Maximum number of messages shown

class d3.OutDevice

Bases: _BlipValue

null : Self

class d3.OutputOSCExpression

class d3.OutputOSCExpression(arg0: OutputOSCExpression)

Bases: _BlipValue

property address : str

property description : str

property expr : Expression

property lastSentString : str

null : Self

class d3.PClass

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.PTPInfo

Bases: _BlipValue

null : Self

property profile : int

property ptpClkId : str

property ptpDomainNbr : int

property ptpPortNbr : int

property state : PTPLockState

class d3.PTPLockState

Bases: _BlipValue

property distance : int

null : Self

property state : int

class d3.Package(path: str)

Bases: IFilesystem

null : Self

class d3.PackageEventMonitoringSystem

Bases: Subsystem

null : Self

class d3.PackageSystem

Bases: Subsystem

null : Self

setPackage : Callable

class d3.Pair

Bases: _BlipValue

property key : str

null : Self

property value : ReflectionValue

class d3.PanTiltController

Bases: Resource

property accelLimit : Vec2

duplicateName : Callable

duplicatePath : Callable

null : Self

property pan_channel : int

property pan_fine_channel : int

property pan_range__degrees_ : float

property speedLimit : Vec2

property tilt_channel : int

property tilt_fine_channel : int

property tilt_max : float

property tilt_min : float

class d3.Parallel

Bases: Projection

Content2D : Final = 1

Content3D : Final = 0

property anchor : int

property angleMaskEnd : float

The screen angle for the black level in angle-based masking fade

property angleMaskStart : float

The screen angle for the white level in angle-based masking fade

property contentMode : int

For realtime rendered content, the mapping can provide camera parameters in 3D mode.

property frame_of_reference : AnimationAxisSettings

property lock : int

null : Self

property pixelBorder : int

property size : Vec2

class d3.ParallelProjectionObject

null : Self

class d3.ParamAction

class d3.ParamAction(arg0: ParamAction)

class d3.ParamAction(arg0: Callable)

Bases: _BlipValue

add(action: Callable) → None

clear() → None

doit(param: List[int]) → None

null : Self

remove(action: Callable) → None

size() → int

valid() → bool

class d3.ParamID

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ParameterCollection

Bases: Resource

getBasis() → Mat

getControlPoint(x: int, y: int) → Vec

lerpInnerPoints(biasX: float, biasY: float) → None

null : Self

setBasis(m: Mat) → None

setControlPoint(x: int, y: int, cp: Vec) → None

class d3.Path

class d3.Path(other: Path)

class d3.Path(c: str)

Bases: _BlipValue

createFolder() → None

property directory : str

property drive : str

property extension : str

property filename : str

property filenameAndExtension : str

property isInCommon : bool

property isInInternal : bool

property isInObjects : bool

property isInTrash : bool

property lastDirectory : str

null : Self

property rawFilename : str

replaceFilename(arg0: str) → Path

property shortened : str

class d3.PathsManager

Bases: _BlipValue

property appProjectDirectory : str

property archivedConsolesDirectory : str

property buildPath : int

property checkpointName : int

property commonInternalTexturesDir : str

commonTextureByFileName(file_name: str) → str

property consolePath : str

property currentConsoleArchivePath : str

property d3Exe : str

property d3Logo : str

property dataD3Path : int

property debugTxt : str

property desktopDirectory : str

property dllPath : str

property dmxTxt : str

property exePath : int

property helpTxtPaths : List[str]

property iniPath : int

property isDeveloperEnvironment : bool

property isRunningFromCheckpoint : bool

null : Self

property oldAuthorizationKeys : str

property oldAuthorizationKeysDefault : str

property oldAuthorizationUpdates : str

property oldAuthorizationUpdatesDefault : str

property pythonDir : str

property pythonExe : str

property rsyncDir : str

property rsyncExe : str

property runningPath : int

property scriptPaths : List[int]

property shadersFolderPath : str

property sourcePath : str

property trapTxt : str

class d3.PathsManagerOptiCal(baseFolder: str)

Bases: _BlipValue

property baseFolder : str

fileCameraInputCamParams(camName: str, lensPos: float, iAcquisition: int, iImage: int) → str

fileCameraInputExif(camName: str, lensPos: float, iAcquisition: int, iImage: int) → str

fileCameraInputImage(camName: str, lensPos: float, iAcquisition: int, iImage: int) → str

fileCameraIntrinsic(camName: str, lensPos: float, iAcquisition: int, iCamCal: int) → str

fileCameraIntrinsicCfg(camName: str, lensPos: float, iAcquisition: int, iCamCal: int) → str

fileCameraIntrinsicCfgList(camName: str, lensPos: float, iAcquisition: int, iCamCal: int) → str

fileCameraIntrinsicList(camName: str) → str

fileOutputCameraCamParams(camName: str, iImage: int) → str

fileOutputCameraExif(camName: str, iImage: int) → str

fileOutputCameraImage(camName: str, iImage: int) → str

property folderCalibration : str

folderCamera(camName: str) → str

folderCameraAcquisition(camName: str, lensPos: float, iAcquisition: int) → str

folderCameraInput(camName: str, lensPos: float, iAcquisition: int) → str

property folderCameras : str

folderCaptureSetup() → str

property folderOptiCal : str

property folderOutput : str

folderOutputCamera(camName: str) → str

property folderOutputCameras : str

null : Self

class d3.PciToCpuIOMonitor

Bases: MetricMonitor

duplicateName : Callable

duplicatePath : Callable

null : Self

togglePause : Callable

class d3.PerCameraBlobs

class d3.PerCameraBlobs(arg0: PerCameraBlobs)

Bases: _BlipValue

cameraBlobs(cameraName: str) → List[Blob]

hasCameraBlobs(cameraName: str) → bool

nDiscardedBlobs(cameraName: str) → int

null : Self

class d3.PercentageBar(*args, **kwargs)

Bases: Widget

property colour : Colour

focusedWidget : Callable

mouseDragValue(state: int, start: Vec2, pos: Vec2) → None

Change the value

null : Self

readOnly(value: bool) → None

uiTransparencyDisabled : Callable

property value : float

class d3.PerspectiveProjection

Bases: Projection

Content2D : Final = 0

Content3D : Final = 1

property centre_shift : Vec2

property clampContent : int

Outside the perspective frustum, stretch the content edges to cover the target surface.

property contentMode : int

For realtime rendered content, the mapping can provide camera parameters in 3D mode.

property eye_point : Vec

property field_of_view : float

property frame_of_reference : AnimationAxisSettings

null : Self

property overscan : Vec2

Ratio to expand projection area by, to account for distortion or other clipping.
1 means 100%, 2 means 200%.
Set by parent Camera, if available.

property pixelBorder : int

property rotation : Vec

class d3.PerspectiveProjectionObject

null : Self

class d3.PingMessage

class d3.PingMessage(arg0: PingMessage)

Bases: Message

null : Self

property timestamp : float

class d3.PinholeCamera

class d3.PinholeCamera(_t: VecD, _R: Mat, _scale: VecD)

Bases: LocalCoordSystem

getIntrinsics() → InternalParams

getMatrix() → Mat

property intrinsics : InternalParams

null : Self

class d3.PixelMapModule

Bases: Module

duplicateName : Callable

duplicatePath : Callable

property effect : float

property mode : int

null : Self

property pixel_map : ContentSource

property scale : float

property source : ContentSource

class d3.PixelMapShader(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.PixelateModule

property mask : ContentSource

null : Self

property size : float

property source : ContentSource

class d3.PlaceholderVideoIn

Bases: VideoIn

getClipFromHardwareId : Callable

makeHardwareId : Callable

null : Self

class d3.PlaceholderVideoInSystem

Bases: Subsystem

null : Self

duplicateName : Callable

duplicatePath : Callable

getModuleForLayer(layer: Layer) → Module

property holding : bool

property loopSectionMode : bool

null : Self

property playJustTriggered : bool

property playMode : PlayMode

property playing : bool

property sectionPlayMode : bool

property stopped : bool

property tCurrent : float

property tRender : float

property tRunForever : float

property tRunning : float

class d3.PlayMode

class d3.PlayMode(rhs: PlayMode)

class d3.PlayMode(arg0: int)

Bases: _BlipValue

null : Self

property state : int

class d3.PlayModeModule

Bases: Module

class d3.PongMessage(arg0: PongMessage)

Bases: Message

null : Self

property timestamp : float

class d3.PongModule

Bases: Module

property Output : LogicalAudioOutDevice

Logical audio device that the audio will play from

property argh : AudioFile

property ballSpeed : float

property batPadding : float

property batSize : float

property batSpeed : float

property bounce : AudioFile

duplicateName : Callable

duplicatePath : Callable

property hit : AudioFile

property leftBatAI : bool

property left_bat_pos : float

null : Self

property rightBatAI : bool

property right_bat_pos : float

property volume : float

class d3.PopupMenu(*args, **kwargs)

Bases: Widget

Popup Menu

property closeOnSelect : bool

editItem(title: str, contents: str, act: Callable) → PopupMenu

focusNextItem() → None

Select the next item in the menu

focusPrevItem() → None

Select the previous item in the menu

focusedWidget : Callable

item(title: str, callable: Callable) → PopupMenu

null : Self

set(_title: str, _closeButton: str) → PopupMenu

uiTransparencyDisabled : Callable

class d3.PosiStageNetDriver

null : Self

class d3.Posital

addEncoder() → None

property bridgeIP : str

property ids : List[str]

property ips : List[str]

null : Self

property pollIntervalMsec : int

removeEncoder(i: int) → None

property timestamps : int

property trace : int

class d3.PreComp

Bases: Projection

null : Self

class d3.PreCompDisplay

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

name : Final = ‘prefetcher’

null : Self

class d3.PreviewApp

Bases: App

duplicateName : Callable

duplicatePath : Callable

EightBit : Final = 2

Normalised : Final = 0

Percentage : Final = 1

property activeVisualiserCamera : Camera

addRename(rename: str) → None

property animationMovieType : int

property barWidgetInsertTime : float

property brightnessDisplay : int

Set UI representation of brightness

brightnessDisplayOption() → int

canMakeLargeMovies : Callable

clearCurrentStageSelection() → None

property colourDisplay : int

Set UI representation of colour

colourDisplayOption() → int

property disableKeyFrameEditorFilmStrip : bool

Turn off key frame editor film strip for extra performance

property disableUITransparency : bool

Turn off transparency on UI windows for extra performance

property doNotConfirmLayerRenames : bool

duplicateName : Callable

duplicatePath : Callable

expand(groupLayerUid: int, expanded: bool) → None

property feedViewSettings : FeedViewSettings

getCurrentActiveVisualiserCamera() → Camera

getCurrentStageSelection() → List[Object]

getValueRange : Callable

property gizmoCoordinateSpace : int

property guiDpiScale : int

DPI scale for the GUI.

property guiFramerateFraction : int

The fraction of the framerate the GUI renders at. Can help performance at the expense of responsivity.
Does not help when in low latency output modes.

isExpanded(groupLayerUid: int) → bool

isOutputMovieResolutionSupported : Callable

property isStageManipulationEnabled : bool

lastSeen(noteUid: int) → DateStamp

property loudnessDisplay : int

Set UI representation of volume

loudnessDisplayOption() → int

property manipulator3D : int

property manipulatorWidgetPos : Vec2

markSeen(noteUid: int, timestamp: DateStamp) → None

property measurementUnit : int

property networkWidgetPos : Vec2

null : Self

onObjectRemovedFromStage(removedObjects: List[Object]) → None

onStageSelectionChangedAction() → Action

outputMovieExtension() → str

property outputMovieType : int

property output_movie_bitrate : int

Set to 0 for d3 to use it’s best guess per-codec

property output_movie_extra_time_head : float

property output_movie_extra_time_tail : float

property output_movie_fps : float

property output_movie_quality : int

Only affects webm

property output_movie_size : Vec2

property password : str

property persistentKeyWidgets : bool

When enabled, key widgets will remain open on creation or selection of a new layer with the same property.
When disabled, the open state of a key widget will be remembered per layer.

privateState : Callable

property recentLayerRenames : List[str]

screenShotExtension() → str

screenShotTextureFormat() → int

property screenshot_format : int

property searchOrder : int

setCurrentStageSelection(stageSelection: List[Object]) → None

property stageSelection : List[int]

property stickyState : str

property tooltipOption : int

property waveformMode : int

class d3.ProceduralTexture

Bases: DxTexture

draw() → None

duplicateName : Callable

duplicatePath : Callable

formatStrings : List[str]

null : Self

class d3.ProcessMemoryMonitor

Bases: MetricMonitor

duplicateName : Callable

duplicatePath : Callable

null : Self

togglePause : Callable

class d3.Product

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property manufacturer : str

Short form name of the firm that makes the product, eg. ‘Roe’

null : Self

property productCode : str

Long-form Product Code including model, revision, etc - for disambiguation, eg. ‘BO3’

property shortName : str

Short name the product is commonly referred to by, eg. ‘Black Onyx’

class d3.ProfilerCallNode

Bases: _BlipValue

property children : List[ProfilerCallNode]

property name : str

null : Self

property tAverage : float

property tMax : float

class d3.ProfilerHTTPSystem

Bases: Subsystem

captureSystem(filename: str, frames: int) → None

null : Self

class d3.ProfilerSystem

Bases: Subsystem

getMonitoringReport() → str

getNodes() → ProfilerCallNode

isGpuPoolRecording() → bool

isRecording() → bool

null : Self

startGpuPoolRecording() → None

startMonitoring() → None

startRecording(filename: str) → None

stopGpuPoolRecording() → None

stopMonitoring() → None

stopRecording() → None

class d3.ProjectData

Bases: _BlipValue

null : Self

class d3.ProjectPathsManager

class d3.ProjectPathsManager(projectPathsManager: ProjectPathsManager)

class d3.ProjectPathsManager(arg0: str)

class d3.ProjectPathsManager(arg0: str, arg1: str)

Bases: _BlipValue

dllsTxt() → str

edidFolder() → str

folderName() → str

internalLutFolder() → str

null : Self

projectFile() → str

projectFileName() → str

projectFolder() → str

projectName() → str

projectSubFolder(subfolder: str) → str

sep() → str

setAbsolute() → None

setRelativeToProjectsFolder() → None

class d3.ProjectSnapshots

Bases: _BlipValue

archiveSnapshot : Callable

clearSnapshotTakenDelegate : Callable

generateSnapshotName : Callable

getBackups : Callable

getCurrentlyRestoredSnapshotName : Callable

getSnapshotsFilePaths : Callable

hoursSinceSnapshotTaken : Callable

null : Self

recallSnapshot : Callable

removeBackups : Callable

renameSnapshot : Callable

setSnapshotTakenDelegate : Callable

takeSnapshot : Callable

class d3.Projection

Bases: Resource

property clipOutsideRegion : bool

Clips pixels outside of rendered region, preserving existing colour.

duplicateName : Callable

duplicatePath : Callable

property filtering : int

Nearest & Bilinear are pixel perfect at 100% zoom, and fast
Multi-sample fixes issues with downscaled content but causes very slight blurring

getContentViewpoints(latency: float, fraction: FrameRateFraction) → List[ContentViewPoint]

property mask : DxTexture

Optional bitmap to multiply with all content passing through the mapping

property mode : int

property nContentViewpoints : int

null : Self

property projectionObject : ProjectionObject

property proxyCanvasResolution : Vec2

property resolution : Vec2

Resolution of the canvas, in pixels. This is the resolution the module renders to

property screens : List[Display]

List of screens to receive module content

setBorderColour(c: Colour) → None

property setScreenSize : Vec2

startEditing() → None

stopEditing() → None

class d3.ProjectionAwareModule

Bases: Module

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ProjectionMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.ProjectionObject

Bases: Object

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

property hidden : bool

null : Self

property projection : Projection

class d3.Projector

Bases: SlcAwareDisplay

FixedModeNone : Final = 0

FixedModePosition : Final = 1

FixedModePositionAndRotation : Final = 3

FixedModeRotation : Final = 2

property activeOutputMode : int

addScreen(s: Screen2) → None

addStackedProjector(p: Projector) → None

property antiAlias : int

Anti-aliasing technique - makes edges smoother, but reduces performance

property autoSoftEdge : int

Allows you to turn off Dynamic Blend on individual projectors

property autoSoftEdgeMembershipFunction : int

Dynamic Blend Membership Algorithm

property autoSoftEdgeSnapshotted : int

Lock Dynamic Blend snapshot

property barnDoorBottom : float

Bottom edge of Dynamic Blend barndoor; increase this to move the edge upwards

property barnDoorLeft : float

Left edge of Dynamic Blend barndoor; increase this to move the edge rightwards

property barnDoorRight : float

Right edge of Dynamic Blend barndoor; increase this to move the edge leftwards

property barnDoorTop : float

Top edge of Dynamic Blend barndoor; increase this to move the edge downwards

property blur_shadow : float

Masked object blur amount

clearWarpsAndMasks() → None

property colour : Colour

The colour of the projector frustum in the visualiser

property config : ProjectorConfig

Open this to enter the quick-calibration interface

property configAutoZClipping : bool

property configLensShift : Vec2

property configLensShiftInv : Vec2

property configLookAt : Vec

property configLookDistance : float

property configManualZFar : float

property configManualZNear : float

property configPosition : Vec

property configRadialDistortion : Vec

property configRotation : Vec

configSetFixedMode(mode: int) → None

property configSkew : float

property configTangentialDistortion : Vec2

property configThrowRatio : float

property configWarpGridSize : Int2

property deformStack : DeformStack

property disableAutoCalViewUpdate : bool

property dseCutoffAngle : float

Dynamic Blend cutoff angle in degrees. It’s a threshold for the angle between the projector’s incidence ray and the normal vector at a pixel.
Any angle equal or larger than this will lead to zero contribution from this projector for a given pixel.
Default is 90 degrees.

property dseExclude : List[Projector]

Specifies which projectors are included or excluded from this projector’s Dynamic Blend

property dseExcludeList : List[Projector]

property dseResolutionFactor : int

Resolution for calculating Dynamic Blend projector contributions.
Higher resolutions improve the resulting blend mask, reducing some visual artifcats such as overspill.
But this also increases the cost of calculating the blend.
Projectors should use reduced resolutions if they are affected by frequent Dynamic Blend recalculations e.g. if they target moving surfaces.
Default: 1/16th.

editingConfig(onOff: bool) → None

editingProjector(onOff: bool) → None

property faceCullMode : int

Can optionally skip rendering faces with normals pointing away (back) or toward (front) the projector.

property feather : float

Shrinks or grows screens in the projector’s view, to fix over-projection

property fieldOfView : float

property gammaBias : float

Adjusts the estimate of this projector’s gamma relative to the Stage’s global Blend gamma

getSupportedOutputModeNames : Callable

getSupportedOutputModes : Callable

getSupportedRenderModeNames : Callable

property gridSize : float

Controls the spacing of grid lines in Grid output mode

property gridThickness : float

Controls the thickness of grid lines in Grid output mode

property guiState : ProjectorGuiState

hasFeedAssigned() → bool

hasStackedProjectors() → bool

property includeOrExclude : int

lets you either remove projectors from Dynamic Blend consideration, or forces Blend to use only a specific list of projectors

property isActiveOutputModeNone : bool

property isAutoCalIntrinsicsUserEditable : bool

property isOutputNeededByGui : bool

isStackedProjector() → bool

property lensDistortionMode : int

property lightScattering : int

enables light scattering for this projector

property lightScatteringshadows : int

enables light scattering shadows for this projector

property lineupBitmap : DxTexture

Bitmap used as quickcal lineup cursor

property lumens : float

Projector brightness, in ANSI Lumens. Affects visualiser only

mainProjector() → Projector

property mask_objects : List[Object]

List of objects that this projector should render as black

property mask_resolution : int

Set shadow mask resolution

property masking_scale : float

Shrinks or grows the mask objects in the projector’s view

nScreens() → int

null : Self

onCloseConfigEditor() → None

onOpenConfigEditor() → None

onStackedProjectorsUpdated() → None

property outputBrightness : float

output brightness (lumens)

preferredOutputMode(mode: int) → None

property preferredOutputModeChangedAction : ParamAction

property projectionMatrix : Mat

removeScreen(s: Screen2) → None

renderMode(value: int) → None

renderStage(resolution: Int2, viewTarget: DxTexture) → None

property render_mode : int

Switches the projector’s output for easier identification or testing

property screens : List[Screen2]

List of screen surfaces that this projector should render. Other screens will not be visible in the projector.

property shadows : int

enables shadows for this projector

property simulatedShutterOpen : bool

property stackedProjectors : List[Projector]

updateStackingWarp() → None

class d3.ProjectorCalibrationSettings

class d3.ProjectorCalibrationSettings(arg0: ProjectorCalibrationSettings)

Bases: _BlipValue

property bundleAdjustIterations : int

property inlierMaxReprojectionError : float

property inlierPercentage : float

Estimated number of inliers as percentage of all point pairs [0..1]. Used in outlier handling algorithms. Default is 0.8 (=80%).

null : Self

property outlierHandling : int

How to detect outlier point pairs before Projector calibration.

property projectorCalibrationAlgorithm : int

property sampleSize : int

Number of points pairs to group together in outlier handling step (e.g. RANSAC). Must be >=6, default is 7.

property useDistortion : int

property useLensShift : int

property useManualIntrinsicsAsEstimate : int

class d3.ProjectorCalibratorDevice

Bases: Device

property currentRefPoint : ReferencePoint

property currentRotationIndex : int

property cursors : List[Vec2]

property draw_test_lines : int

duplicateName : Callable

duplicatePath : Callable

forceOsc(oscMessage: str, buttonState: float) → None

property iProjectorSelected : int

property isCapturing : bool

property isReceiving : bool

property mode : int

null : Self

onProjectorListChanged() → None

property osc : OscDevice

property projectors : List[Projector]

property selectedProjectorCursor : Vec2

property test_blob_size : float

property trackedPoint : TrackedPoint

class d3.ProjectorCaptureSettings

Bases: _BlipValue

property alignmentGuideLinesCol : Colour

property alignmentGuideLinesThickness : float

property alignmentGuideLinesXCount : int

property alignmentGuideLinesXOffset : float

property alignmentGuideLinesYCount : int

property alignmentGuideLinesYOffset : float

property alignmentWhiteLevel : int

property dotShape : int

property dotSize : int

property focusPattern : int

property focusPatternSpacing : int

property gridSize : int

null : Self

property whiteLevel : int

class d3.ProjectorCaptureSettingsPair

class d3.ProjectorCaptureSettingsPair(arg0: ProjectorCaptureSettingsPair)

Bases: _BlipValue

gridSize() → Int2

null : Self

property projector : ProjectorReference

property settings : ProjectorCaptureSettings

class d3.ProjectorChangeDetectionSystem

Bases: Subsystem

null : Self

class d3.ProjectorConfig

Bases: Resource

property autoZClipping : bool

property background : DxTexture

Sets the projector background colour during calibration

calcFlashFactor : Callable

property calcViewingDirection : Vec

property calibMethod : int

property calibMethodUsed : int

property calibrationErrorColour : Colour

property calibrationErrors : Vec

property calibrationSource : int

clearSelection() → None

property controlRotation : int

Rotate calibration controls to match projector angle

property cursorType : int

Controls the form of the calibration cursor; select the one that works best for you

debugAutoCal() → None

property disableReferencePointBounds : int

Off.

Type:
Whether to allow reference point lineup to move the cursor beyond the bounds of the feed (i.e. outside of the projector image). Default

property displayCalibValues : bool

property drawOccludedMarkers : int

Whether to draw calibration markers for hidden Reference Points, i.e. on the back face of objects (vertex normals point away from projector).
Not drawing hidden markers, or drawing them at lower opacity affects performance for large meshes. Default: Yes.

duplicateName : Callable

duplicatePath : Callable

property fieldOfView : float

property finalAdjustPos : Vec

Offset added to projector position, in meters; use this for last-minute micro-adjustments if necessary

property finalAdjustRotate : Vec

Offset added to projector rotation, in degrees; use this for last-minute micro-adjustments if necessary

findCalibratedPoint(point: ReferencePoint) → CalibratedPoint

findModifiedPoints() → List[CalibratedPoint]

findReferencePoint(point: ReferencePoint) → int

property fixThrowRatio : bool

property followRefPointMoves : bool

getReferencePointStatus(point: ReferencePoint) → int

getSupportedCalibMethodNames : Callable

getSupportedCursorTypeNames : Callable

property hideOtherReferencePoints : int

Off.

Type:
Hides reference points that are not calibrated in this projector config. Default

property isCalibMethodUsedExtrinsicOnly : bool

property isCalibMethodUsedSupportsDistortion : bool

property lensShift : Vec2

lineupReferencePoint2D(deltaPixels: Vec2) → None

lineupReferencePointEnd() → None

property lookAt : Vec

property lookDistance : float

property markerSize : int

Controls the size of the calibration markers in the output, in pixels

nLineUpsForStatus(status: int) → int

property nMinLineUps : int

null : Self

property numModifiedRefPoints : int

property numReferencePoints : int

property numReferencePointsForCurrentPose : int

property position : Vec

preferredOutputMode(mode: int) → None

property projector : Projector

property radialDistortion : Vec

recomputeMatrixOnUpdate() → None

property refPointEditMode : int

removeAllReferencePoints() → None

removeAllReferencePointsCurrentPose() → None

removeReferencePoint(point: ReferencePoint) → None

property rotation : Vec

selectReferencePoint() → None

setReferencePointColours() → None

setReferencePointStatus(point: ReferencePoint, _s: int) → None

property skew : float

property tangentialDistortion : Vec2

property throwRatio : float

updateManualSettings() → None

updateModifiedPoints() → None

usingAutoCalibration() → bool

usingOpticalCalibration(onOff: bool) → None

property warpGrid : Array2

property wireframeCleanup : float

If the angle between two surfaces is less than this angle, the edge is not displayed. Useful for removing excessive edges from curved objects.

property wireframeColour : Colour

property zFar : float

property zFarAuto : float

property zNear : float

property zNearAuto : float

class d3.ProjectorControlCommand

Bases: Resource

property delay : float

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ProjectorControlCommands

Bases: Resource

property commands : List[ProjectorControlCommand]

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ProjectorControlDevice

Bases: Device

property actualStatus : str

property commands : ProjectorControlCommands

deviceStatus() → str

duplicateName : Callable

duplicatePath : Callable

property focus : float

property homeRotation : Vec

property intensity : float

property lensShift : Vec2

null : Self

property panAxis : Vec

property panTilt : Vec2

property projector : Projector

property rotationSpeed : Vec2

setShutter(open: bool) → None

setWarpEnabled(enable: bool) → None

property shutterDelay : int

Delay in milliseconds for projector to reach full brightness after opening its shutter. This is used during OmniCal captures.

duplicateName : Callable

duplicatePath : Callable

null : Self

property projector : Projector

class d3.ProjectorPresets

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property presets : List[ProjectorPreset]

class d3.ProjectorReference

Bases: _BlipValue

property name : str

null : Self

property resolution : Int2

property uid : int

class d3.ProjectorRestorer

Bases: _BlipValue

null : Self

class d3.ProjectorStudy(arg0: str, arg1: str, arg2: Stage, arg3: int)

Bases: _BlipValue

exportCsv(revision: str) → bool

exportPdf(revision: str, comment: str) → bool

getPathPrefix() → str

property iFrameReady : int

null : Self

class d3.ProjectorViewMaterial

Bases: ScreenMaterial

null : Self

class d3.ProjectorYokeControlPreset

Bases: ProjectorControlPreset

property commands : ProjectorControlCommands

duplicateName : Callable

duplicatePath : Callable

property focus : float

property intensity : float

property lensShift : Vec2

null : Self

property panTilt : Vec2

property zoom : float

class d3.Prop

Bases: Object

property densityMap : DxTexture

Object denisty map for Subsurface scattering approximation

property densityScale : float

Object denisty map for Subsurface scattering approximation

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

property luminosity : float

Luminosity of the object

property mesh : Mesh

The mesh that defines the shape of the object

property normalMap : DxTexture

the mesh must have texture coordinates for this to work properly

Type:
Image to be applied to the surface of the object as a normal map, if any. Note

property normalMapScalar : Vec2

Normal map UV scalar

null : Self

property renderSettings : PropRenderer

property scale : Vec

Controls the size; this is a scale factor applied to mesh vertices

class d3.PropRenderer

Bases: _BlipValue

property blendMode : int

Controls how the object composites with other objects in the scene

property diffuseMap : DxTexture

the mesh must have texture coordinates for this to work properly

Type:
Image to be applied to the surface of the object, if any. Note

property displayMode : int

Controls the display of flat and/or wireframe

property dseExpandCM : float

How much to expand shadows generated from this Prop while calculating dynamic blend.

property flatCol : Colour

Flat colour to apply to the object surface

property isShadowCaster : int

Does this object cast shadows in Lux. This does not affect dynamic blend.

null : Self

property reflectance : float

property wireCol : Colour

If the object is displayed with wireframe, this controls the colour of the wireframe lines

property wireframeCleanup : float

If the angle between two surfaces is less than this angle, the edge is not displayed. Useful for removing excessive edges from curved objects

class d3.PropertyInfo

get(arg0: ReflectionValue) → ReflectionValue

property getter : MethodInfo

property isRP : bool

property name : str

null : Self

set(arg0: ReflectionValue, arg1: ReflectionValue) → None

property setter : MethodInfo

property type : Type

property writable : bool

class d3.PropertyProjectorControlCommand

Bases: ProjectorControlCommand

duplicateName : Callable

duplicatePath : Callable

null : Self

property property_ : int

property value : float

class d3.PropertyProperty(other: PropertyProperty)

class d3.PropertyProperty(object: ReflectionValue, _property: PropertyInfo)

class d3.PropertyProperty(arg0: ReflectionValue, arg1: str)

null : Self

class d3.ProxyFieldProperty(other: ProxyFieldProperty)

null : Self

class d3.ProxyListWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.ProxyMakerSettings

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property proxyScales : List[float]

toggleProxyScale(scale: float) → None

class d3.ProxyMakerSystem

Bases: Subsystem

null : Self

rescan() → None

class d3.ProxyMakerWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

onClick() → None

Pause/Unpause ProxyMaker

onRightClick() → None

Open Proxy List Viewer

set() → None

uiTransparencyDisabled : Callable

class d3.ProxySettings

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property preferredNetwork : IPAddress

property scaleFactor : float

Scale factor for the proxy stream

class d3.PsnTrackerState

null : Self

class d3.Puck

Bases: Object

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

property image_name : str

null : Self

property tint : Colour

class d3.PureLinkMatrix

Bases: DVIMatrix

property ipAddress : str

null : Self

property port : int

property routerId : int

Router ID set on the matrix

class d3.PythonApp

Bases: App

property d3 : App

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.PythonException

Bases: Exception

null : Self

class d3.PythonFile

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

getAttr(name: str) → PythonObject

null : Self

class d3.PythonObject

class d3.PythonObject(other: PythonObject)

Bases: _BlipValue

null : Self

class d3.PythonSystem

Bases: Subsystem

null : Self

class d3.Quantiser(*args, **kwargs)

Bases: Widget

property audioTrack : AudioTrack

dragBeat(state: int, startPos: Vec2, pos: Vec2) → None

Move the beat under the cursor

focusedWidget : Callable

jumpToMarker(dir: int) → None

jumpToNextMarker() → None

Jump to the next marker

jumpToPrevMarker() → None

Jump to the previous marker

property metronomeVolume : float

mouseDragPan(state: int, startPos: Vec2, pos: Vec2) → None

Pan the view

mouseDragZoom(state: int, startPos: Vec2, pos: Vec2) → None

Zoom in and out of the display

mouseRemoveMarker() → None

Remove the marker under the cursor

mouseRenumberBeat() → None

Set beat to be first in bar

mouseScrollZoom(move: float) → None

Zoom in and out of the display

null : Self

set(showTrack: Track, tp: TrackPlayer, tOffset: float) → Quantiser

uiTransparencyDisabled : Callable

class d3.QuantiserWaveform

Bases: _BlipValue

null : Self

class d3.Quaternion(_w: float, _x: float, _y: float, _z: float)

class d3.Quaternion(n: VecD, theta: float)

Bases: _BlipValue

fromEuler : Callable

inverse() → Quaternion

null : Self

property q0 : float

property q1 : float

property q2 : float

property q3 : float

toAxisAndTheta(v: VecD, theta: float) → None

toEuler() → VecD

class d3.QuickAlignViewSettings

Bases: Resource

property autoAlign : int

Automatically Align to Alignment Points when clicking set min/ max

property autoUpdateAlignment : bool

property drawWireframe : int

duplicateName : Callable

duplicatePath : Callable

property enableAddAlignmentPoints : bool

Enables adding alignment points in camera view

property enableDeformPoints : bool

property guideLines : int

property iCam1 : int

property iCam2 : int

property iScreen : int

property imageScale : float

Scale both images according to this factor.

property invertWireframeColour : int

property markerOpacity : float

Opacity of drawn markers that represent the alignment points.

property markerSize : float

Size of drawn markers that represent the alignment points.

null : Self

property realtimeAlignment : int

property setMinMaxForAllScreens : int

Set min/ max for all screens with alignment data in the Current Pose

property stageRenderOpacity : float

Opacity of drawn stage render, from 0 to 255.

property undistortPoints : bool

property wireframeCleanup : float

property wireframeOpacity : int

Opacity of drawn wireframe meshes, from 0 to 255.

property wireframeRenderParams : WireframeRenderParams

property zoomScale : float

class d3.QuickProfiler

Bases: Subsystem

captureSystem(filename: str, frames: int) → None

null : Self

class d3.QuickSelectSlots

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property quickSelectSlots : List[Resource]

class d3.QuickSelectSlotsView(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.QuitPopupMenu(*args, **kwargs)

Bases: PopupMenu

Quit Popup Menu

focusedWidget : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.RGBColourModule

property blue : float

duplicateName : Callable

duplicatePath : Callable

property green : float

null : Self

property red : float

class d3.RGBColourModuleConfig

Bases: ModuleConfig

property acesTransform : AcesInputTransformParameters

duplicateName : Callable

duplicatePath : Callable

null : Self

property ocioTransform : OcioColourSpace

class d3.RI

class d3.RI(arg0: RI)

class d3.RI(arg0: TransportManager)

Bases: _BlipValue

null : Self

resourceType() → Type

uid() → int

class d3.RMAXSystem

Bases: Subsystem

null : Self

class d3.RMAXVideoIn

Bases: VideoIn

null : Self

class d3.RSCompressedVideoIn

Bases: VideoIn

null : Self

class d3.RSCompressedVideoInSystem

Bases: Subsystem

null : Self

class d3.RSNode

class d3.RSNode(arg0: RSNode)

Bases: _BlipValue

property machineName : str

null : Self

property streamHandle : int

class d3.RTTrPMDriver

null : Self

class d3.RTTrPMModuleState

null : Self

class d3.RTTrPMTrackableState

Bases: TrackingState

null : Self

class d3.Radar

Bases: Module

property To_the_beat : bool

property beamSize : float

property direction : int

duplicateName : Callable

duplicatePath : Callable

null : Self

property offset : float

property speed : float

class d3.RadarModule

Bases: Module

property beamSize : float

property direction : int

duplicateName : Callable

duplicatePath : Callable

null : Self

Bases: _BlipValue

null : Self

class d3.ReceivedTestData

Bases: _BlipValue

property image : DxTexture

property label : str

null : Self

class d3.ReconstructionSettings

class d3.ReconstructionSettings(arg0: ReconstructionSettings)

Bases: _BlipValue

property calibrateCameraPosition : int

property cameraGraphBAIterations : int

property cameraGraphOptimisation : bool

property cameraGraphScoreMode : int

property cameraWeightFactor : float

property cameraWeightMode : int

property gridTolerance : float

property gridToleranceMethod : int

property intersectionHandling : int

null : Self

property scaleCalcMethod : int

property scaleOutlierPercent : float

class d3.Recorder

Bases: _BlipValue

RcAudio_ : Final = 0

RcDmx : Final = 2

RcMidi : Final = 3

RcTracking : Final = 1

RcVideo : Final = 5

RmLive : Final = 0

RmPlay : Final = 1

RmRecord : Final = 2

property active : bool

property category : int

getRecordings(track: Track) → List[RecordingTake]

getStates() → List[IDataState]

property name : str

null : Self

property playing : bool

property processing : bool

property receiving : bool

property recording : bool

property recordingMode : int

class d3.RecorderWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

onMouseDrag(state: int, startPos: Vec2, cursorPos: Vec2) → None

Move or resize recorded data

onMouseLeftClick() → None

Expand a recorded device into takes

onMouseRightClick() → None

Open recorded data options

set(transport: TransportManager) → RecorderWidget

uiTransparencyDisabled : Callable

class d3.RecordingFile

Bases: Resource

property actualEndTime : float

duplicateName : Callable

duplicatePath : Callable

property endTime : float

property length : float

null : Self

property recordingEndTime : float

property recordingLength : float

property recordingStartTime : float

property startTime : float

property track : Track

class d3.RecordingSystem

Bases: Subsystem

categoryDescription(category: int) → str

property hasRecordings : bool

modeDescription(mode: int) → str

null : Self

property recorders : List[Recorder]

property recordersChangedAction : Action

refresh() → None

class d3.RecordingTake

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property enabled : int

Enable recording

null : Self

property recordingFile : RecordingFile

Recording File

property scalar : float

Scalar

property tEnd : float

End Time

property tOffset : float

Offset time from start time

property tStart : float

Start Time

class d3.Rect

class d3.Rect(arg0: Rect)

class d3.Rect(pos: Vec2, size: Vec2)

class d3.Rect(x: float, y: float, w: float, h: float)

Bases: _BlipValue

property bl : Vec2

property br : Vec2

canonicalise() → Rect

container(r: Rect) → Rect

intersect(r: Rect) → Rect

intersects(r: Rect) → bool

null : Self

property origin : Vec2

property ox : float

property oy : float

pointInside(arg0: Vec2) → bool

property pos : Vec2

rectInside(arg0: Rect) → bool

property size : Vec2

property tl : Vec2

property tr : Vec2

property x0 : float

property x1 : float

property y0 : float

property y1 : float

class d3.RectBox

Bases: ValueBox

isSupportedType : Callable

null : Self

property posValue : ValueBox

property sizeValue : ValueBox

class d3.ReferencePoint

Bases: Object

clearSelection : Callable

property colour : Colour

deselectPoint : Callable

duplicateName : Callable

duplicatePath : Callable

getLastSelectedPoint : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

isInUse() → bool

property jointId : int

linedUpConfigCount() → int

linedUpConfigNames() → List[str]

property muted : bool

null : Self

onCreated : Callable

onMouseMove : Callable

onSelected : Callable

overrideKeyStroke : Callable

overrideMouseMove : Callable

property pos : Vec

requestDisplayManipulators : Callable

requestShowOnlyPointsFor : Callable

selectPoint : Callable

showAllPoints : Callable

property trueParent : Object

property worldPos : Vec

class d3.ReferencePointCameraCoordinates

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ReferencePointGizmo

Bases: Gizmo

lineupReferencePointDown : Callable

lineupReferencePointLeft : Callable

lineupReferencePointRight : Callable

lineupReferencePointUp : Callable

null : Self

class d3.ReferencePointSet

Bases: Resource

allPoints() → List[ReferencePoint]

append(point: ReferencePoint) → None

duplicateName : Callable

duplicatePath : Callable

findInactiveTracked() → List[ReferencePoint]

findUnparented() → List[ReferencePoint]

findUnused() → List[ReferencePoint]

null : Self

numReferencePointsLinedUp(muted: bool) → int

property points : List[ReferencePoint]

remove(point: ReferencePoint) → None

null : Self

class d3.ReflectionMessageHandler(arg0: Type)

class d3.ReflectionMessageHandler(arg0: Type, arg1: Callable)

Bases: IMessageHandler

null : Self

property onHandleMessage : Callable

class d3.ReflectionValue

Bases: _BlipValue

null : Self

class d3.ReflectionValueProperty(other: ReflectionValueProperty)

class d3.ReflectionValueProperty(rv: ReflectionValue)

null : Self

class d3.RefpointsManipulator(parent: SpaceWidget)

Bases: Manipulator

manipulatorKeyDown() → bool

manipulatorKeyLeft() → bool

manipulatorKeyRight() → bool

manipulatorKeyUp() → bool

mouseClick() → None

Create or select a reference point under the cursor

mouseDrag(state: int, startPos: Vec2, pos: Vec2) → bool

Move the reference point under the cursor

null : Self

property onGizmoClickAction : ParamAction

property onGizmoKeyDownAction : ParamAction

property onGizmoKeyLeftAction : ParamAction

property onGizmoKeyRightAction : ParamAction

property onGizmoKeyUpAction : ParamAction

property onObjectDragStartAction : Action

openReferencePointEditor() → bool

Open an editor for the reference point under the cursor

requestManageReferencePointsMode() → None

class d3.ReleaseVersion

Bases: _BlipValue

Bronze : Final = 3

Gold : Final = 1

Silver : Final = 2

Unknown : Final = 0

Uva : Final = 4

asString : Callable

branchName : Callable

customReleaseName : Callable

getBuildConfigurationString : Callable

getBuildSystemString : Callable

getCompilerString : Callable

getPhaseString : Callable

getPlatformString : Callable

getReleaseString : Callable

getTagsString : Callable

hasLocalPatches : Callable

hasTags : Callable

isBetaRelease : Callable

isCustomRelease : Callable

isDebug : Callable

isDebugMem : Callable

isFull : Callable

isReleaseCandidate : Callable

isSpecialRelease : Callable

isTrial : Callable

major : Callable

micro : Callable

minor : Callable

null : Self

osImageVersion : Callable

releaseStageCode : Callable

renderStreamVersionString : Callable

uniqueId : Callable

null : Self

class d3.RemoteMonitor

Bases: MetricMonitor

duplicateName : Callable

duplicatePath : Callable

property nodeName : str

null : Self

togglePause : Callable

class d3.RemoteNodeInfo(arg0: RemoteNodeInfo)

class d3.RemoteNodeInfo(arg0: str, arg1: str)

Bases: _BlipValue

property address : str

property description : str

null : Self

class d3.RemoteParameter

Bases: _BlipValue

property defaultValue : ReflectionValue

property displayName : str

property group : str

property key : str

property max : float

property min : float

property noSequence : bool

null : Self

property options : List[str]

property readOnly : bool

property step : float

property valueType : Type

class d3.RemoteParameterSchema

Bases: _BlipValue

property name : str

null : Self

property parameters : List[RemoteParameter]

class d3.RemoteRenderer

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.RemoteResourceAllocResponseInfo

Bases: _BlipValue

null : Self

class d3.RemoteStream

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property machineName : str

null : Self

property streamName : str

property workloadId : int

property workloadInstance : int

class d3.RemoteStreamFrame

Bases: _BlipValue

property image : DxTexture

property latencySec : float

null : Self

property pose : CameraPoseInfo

class d3.RemovedMediaMessage

property replace_table : Table

property search_table : Table

class d3.RenderArea

Bases: _BlipValue

null : Self

property overlapBr : Vec2

property overlapTl : Vec2

property paddingPxBr : Int2

property paddingPxTl : Int2

property region : Rect

class d3.RenderStreamAsset

Bases: Resource

property acesExposure : float

Input exposure transform (stops)

property acesGamma : float

Input gamma transform

property acesTransform : AcesInputTransformParameters

ACES Input Device Transform (IDT)

property assetInfo : AssetInfo

property available : bool

Is this asset available anywhere on the network, currently

property channels : List[str]

Channels published by this asset

property colourShift : ColourShift

This colourshift is always applied to received frames

property contentSource : RenderStreamMachine

The sync source for remote machines to obtain the asset from

duplicateName : Callable

duplicatePath : Callable

property engineName : str

Engine name reported by this asset

property engineSettings : EngineSettingsResource

Engine-specific settings used when starting this asset

property engineVersion : str

Engine version reported by this asset

property info : str

Info reported by this asset

null : Self

property ocioShaderProperties : OcioShaderProperties

Available OCIO transform parameters for a given colour space.

property ocioTransform : OcioColourSpace

OCIO colour space of the asset

property pluginVersion : str

Plugin version reported by this asset

property schema : List[RemoteParameterSchema]

property schemaChangedAction : Action

class d3.RenderStreamCluster

Bases: Resource

property anyInstanceIsRunning : bool

property anyInstanceIsTransitioning : bool

property channelInstances : List[ChannelInstance]

property channelInstancesChangedAction : Action

property controller : Machine

The machine remotely controlling rendering

controllerActive() → bool

duplicateName : Callable

duplicatePath : Callable

getAssignmentForecast(assigners: MultiChannelClusterAssigner, asset: RenderStreamAsset, clusterPool: ClusterPool) → List[ChannelInstance]

instanceHealth(iInstance: int) → WorkloadHealth

instanceMachine(iInstance: int) → RenderStreamMachine

property nInstances : int

null : Self

reconfigureWorkload(asset: RenderStreamAsset, clusterPool: ClusterPool, assigners: MultiChannelClusterAssigner, framerateDivisor: int) → None

startWorkload(asset: RenderStreamAsset, clusterPool: ClusterPool, assigners: MultiChannelClusterAssigner, framerateDivisor: int) → None

stopWorkload() → None

property workloadHealth : WorkloadHealth

property workloadIsStoppable : bool

class d3.RenderStreamMachine

Bases: Resource

property adaptors : List[netsys_NetworkAdaptor]

property adaptorsChangedAction : Action

property assets : List[RenderStreamAsset]

property assetsPath : str

property canFailover : optional

property detailedStatusString : str

duplicateName : Callable

duplicatePath : Callable

failover() → List[FailoverData]

getBandwidthEstimates() → List[BandwidthEstimationResult]

null : Self

property pool : ClusterPool

property proxyUpdatedAction : ParamAction

reconfigureWorkload() → None

Reconfigure the running workload

property sceneOptions : List[str]

startWorkload() → None

Start or restart the workload

stopWorkload() → None

Stop the workload

syncContent() → None

Synchronise content from the asset content source to other nodes in the pool

syncEngine() → None

updateProxySettings() → None

class d3.RenderStreamSystem

Bases: Subsystem

activeLatency() → float

activeSyncOperationStatuses(forAsset: RenderStreamAsset) → List[str]

activeSyncOperationsFor(asset: RenderStreamAsset) → int

activeWorkload(id: int) → ActiveWorkload

availableAdaptors() → List[netsys_NetworkAdaptor]

property discovery : Discovery

getLogPathForWorkloadInstance(id: int, instance: int) → str

getWorkloadLayers() → map

getWorkloadReceiveStatuses(workload: int) → List[SubscribedStreamStatus]

isProxy(id: StreamIdentifier) → bool

isRenderStreamMachineInUse(rsMachine: RenderStreamMachine) → bool

null : Self

stream(id: StreamIdentifier) → StreamObject

property textureParamsChangedAction : ParamAction

class d3.ReportTasksMessage

class d3.ReportTasksMessage(arg0: ReportTasksMessage)

Bases: Message

null : Self

class d3.RequestHandlerData

Bases: _BlipValue

null : Self

class d3.ResizableWidget(*args, **kwargs)

Bases: Widget

canDragBottom(onOff: bool) → None

canDragLeft(onOff: bool) → None

canDragRight(onOff: bool) → None

canDragTop(onOff: bool) → None

property constraint : Vec2

property constraintChangedAction : Action

property constraintSize : Vec2

focusedWidget : Callable

property minConstraint : Vec2

property minScrollSize : Vec2

null : Self

property overrideAssertConstraint : Callable

property posChangedAction : ParamAction

uiTransparencyDisabled : Callable

class d3.ResolutionInfo

Bases: MediaInfo

property height : int

null : Self

property width : int

class d3.Resource

Bases: _BlipValue

activate() → bool

addTag(tag: ResourceTag) → None

copy() → Resource

property description : str

property descriptionExtended : str

duplicate(p: Path) → Resource

duplicateName : Callable

duplicatePath : Callable

property extFileSize : int

findResourcesPointingToThis(resourceType: Type) → List[Resource]

hasTag(name: str) → bool

property isBad : bool

property isBeingEdited : bool

property isDirty : bool

property isInError : bool

property isIncomplete : bool

property isNotFoundLocal : bool

lock() → None

property locked : bool

moveToTrash() → None

notifyChange(adrProperty) → Any

notifyCreate() → None

null : Self

property onChangedAction : Action

property path : Path

reloadExternal() → None

removeTag(tag: ResourceTag) → None

rename(p: Path) → None

save() → None

saveOnDelete() → None

saveOnDeleteLocal(onOff: bool) → None

setLock(locked: bool) → None

status() → str

property tags : List[ResourceTag]

property uid : int

unlock() → None

property userInfoPath : str

property writeDateStamp : DateStamp

class d3.ResourceAddChange

Bases: Change

null : Self

class d3.ResourceBox

Bases: ValueBox

allowNulls(nullText: str) → ResourceBox

property enableIndirections : bool

Enable indirections on created object views

property enableQuickSelectSlots : bool

Enable quickselectslots on created object views

getResource() → Resource

isSupportedType : Callable

null : Self

setClassMenuFilter(filter: Callable) → None

setEnableIndirections(value: bool) → None

setResource(resource: Resource) → None

setViewFilter(filter: Callable) → None

property thumbnail : Thumbnail

class d3.ResourceCache

Bases: _BlipValue

null : Self

class d3.ResourceLinks

Bases: Subsystem

null : Self

class d3.ResourceLoadChange

Bases: Change

null : Self

class d3.ResourceLockChange

Bases: Change

null : Self

class d3.ResourceManager

Bases: _BlipValue

A singleton used to manage Resources

allResources(type: Type) → List[Resource]

anyResourceChangedAction(type: Type) → ParamAction

checkForCorruption() → None

emptyTrash(trashedResources: List[Resource]) → None

exists(path: Path) → bool

get : Callable

getMostRecentUserVisibleResourceOfType(type: Type) → Resource

property isSaveAllAllowed : bool

load(pathNeeded: Path, expectedType: Type) → Resource

loadOrCreate(pathNeeded: Path, expectedType: Type) → Resource

Load an existing Resource, or create a new Resource

Parameters:
- pathNeeded – A string containing the path for the Resource, formatted as follows ‘objects/{type}/{name}.apx’
- expectedType – The type of the Resource being created, written in PascalCase and passed as a raw Type, NOT as a String, e.g. ResourceManager
Return resource:
The Resource loaded or created by the function

property lockChangedResourceAction : ParamAction

property newResourceAction : ParamAction

null : Self

property package : IFilesystem

remove(path: Path) → None

property removeResourceAction : ParamAction

property renameResourceAction : ParamAction

resourceChangedAction(r: Resource) → ParamAction

property saveAction : Action

saveAll() → int

search(match: str) → List[str]

property statusChangedResourceAction : ParamAction

property typeChangedResourceAction : ParamAction

class d3.ResourceReference

Bases: _BlipValue

property name : str

null : Self

property t0 : float

property t1 : float

class d3.ResourceSequence

Bases: KeySequence

duplicateName : Callable

duplicatePath : Callable

evalResource(t: float) → Resource

property expectedClass : ClassNode

property expectedType : Type

null : Self

setResource(t: float, r: Resource) → None

class d3.ResourceSetColourParams

Bases: _BlipValue

property colour : Colour

null : Self

property resource : Resource

class d3.ResourceState

Bases: _BlipValue

null : Self

class d3.ResourceStatusChange

Bases: Change

null : Self

class d3.ResourceTag(arg0: str)

Bases: _BlipValue

property name : str

null : Self

class d3.ResourceTransport

Bases: Subsystem

InSync : Final = 1

NeverSynced : Final = 0

getClientSyncStatus(nodeId: int) → int

null : Self

class d3.ResourceTransportMechanism

Bases: _BlipValue

null : Self

class d3.ResourceUpdateChange

Bases: Change

null : Self

class d3.ResourceViewSystem

null : Self

class d3.RgbEasySystem

Bases: Subsystem

null : Self

class d3.RigidBodyTrackingSource

property actionOnTrackingLost : int

Action to carry out if tracking is lost for any reason

addPair() → None

property calibrated : int

property constrainXYZEnabled : Vec

Limiting motion in XYZ dimensions (0 = off, 1 = on)

property constrainXYZRotEnabled : Vec

Limiting motion in XYZ orientations (0 = off, 1 = on)

property constraintXYZMax : Vec

Limit in the +XYZ Axes (m)

property constraintXYZMin : Vec

Limit in the -XYZ Axes (m)

property constraintXYZRotMax : Vec

Limit the +XYZ Rotation (deg)

property constraintXYZRotMin : Vec

Limit the -XYZ Rotation (deg)

duplicateName : Callable

duplicatePath : Callable

property engaged : int

property fixed : List[ReferencePoint]

property isPositionApproximationEnabled : int

only valid for the RigidBody solver, which requires 3 visible tracked points for a full solve of position and rotation.

Type:
With this option enabled the RigidBody solver will attempt to track position (excluding any rotation) if there are 1 or 2 points visible. Note

property nSolverIterations : int

Number of iterations to improve base solved pose.

null : Self

property offset : Vec

Set a tweak offset. Only active when receiving tracking data

property offsets : List[Vec]

property posThreshold : float

Set this to a value greater than zero to prevent Dynamic Blend from recomputing because of static oscillation

removePair() → None

property resetPosition : Vec

Stage position to return to in ‘Reset’ mode

property resetRotation : Vec

Stage Orientation to return to in ‘Reset’ mode

property rotation : Vec

Set a tweak rotation. Only active when receiving tracking data

property rotationThreshold : float

Set this to a value greater than zero to prevent Dynamic Blend from recomputing because of static oscillation

property samplingSnapFixedPoints : bool

showBtMarkers(onOff: bool) → None

property smoothingFactorSolvedOffset : float

snapFixedPoints() → None

property solverMode : int

The RigidBody solver requires 3 visible tracked points for a full solve of position and rotation. The Actor solver will only solve for position and requires at least 1 visible tracked point.

property tpReceiveTimeoutSecs : float

Tracked point receive timeout after N seconds. Applies to all tracked points for rigid body.

property tpReceivingForThresholdSecs : float

Tracked point receiving with confidence threshold after N seconds. Applies to all tracked points for rigid body.

property tpStoppedReceivingForThresholdSecs : float

Tracked point remove from stage after N seconds. Applies to all tracked points for rigid body.

property tracked : List[TrackedPoint]

property trackingLostTimeout : float

How long to wait after tracking loss before executing the action

property trackingRegainedAnimationDuration : float

Duration of animating position to tracked position when tracking is regained

class d3.RotatedBlobRect

Bases: _BlipValue

property angle : float

property cx : float

property cy : float

property height : float

null : Self

property width : float

class d3.RotationGizmo

Bases: Gizmo3D

null : Self

class d3.RotationManipulator(parent: SpaceWidget)

copyDmxData() → List[int]

null : Self

property universe : int

class d3.SKMCAxisState

null : Self

class d3.SKVDriver

property Interface : int

property Jump_Threshold : float

property Motors_Recvd : int

property Status : int

property UDP_Listen_Port : int

property Use_Smoothing : int

property kD : float

property kF : float

property kI : float

property kP : float

null : Self

class d3.SMPTE

Bases: _BlipValue

property dualLink : bool

property interlaced : bool

property interleavedDivision : bool

null : Self

property type : int

class d3.ScaleGizmo

Bases: Gizmo3D

null : Self

class d3.ScaleManipulator(parent: SpaceWidget)

Bases: Manipulator3D

mouseDrag(arg0: int, arg1: Vec2, arg2: Vec2) → bool

Move the object controlled by the gizmo

null : Self

class d3.ScanModule

Bases: Module

property draw : int

duplicateName : Callable

duplicatePath : Callable

null : Self

property step : int

property timing : int

property x : int

property y : int

class d3.Scene

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.SceneOrigin

Bases: Object

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

property initOrigin : Vec

Position of origin in engine-space before it is transformed to d3-space

property initRotation : Vec

Orientation of origin in engine-space before it is transformed to d3-space

null : Self

property poseMode : int

Method used to place the camera into the 3D scene.
Scene global: place the origin of the 3D scene within d3’s stage, rotating around the scene origin
Scene local: place the origin of the 3D scene within d3’s stage, rotating around the chosen location
Camera parent: place a virtual parent transform of the camera. d3 stage position has no meaning in this mode.

startEditing() → None

stopEditing() → None

class d3.Schedule

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property events : List[ScheduleItem]

null : Self

property on_start : int

Playmode to set on project start

property transition : int

class d3.ScheduleItem

Bases: Resource

property days_of_week : int

duplicateName : Callable

duplicatePath : Callable

property duration : str

property end_date : str

property end_time : str

property every : str

null : Self

property start_date : str

property start_time : str

property track : Track

class d3.ScheduleLink

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property iProperty : int

null : Self

property operator : int

property uid : int

class d3.Screen2

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

property colourMap : DxTexture

the mesh must have texture coordinates for this to work properly

Type:
Image to be applied to the surface of the object as a colour map, if any. Note

property densityMap : DxTexture

Object denisty map for Subsurface scattering approximation

property densityScale : float

Object denisty map for Subsurface scattering approximation

getPufferSphereMesh : Callable

getSphereMesh : Callable

property luminosity : float

Luminosity of the object

property normalMap : DxTexture

the mesh must have texture coordinates for this to work properly

Type:
Image to be applied to the surface of the object as a normal map, if any. Note

property normalMapScalar : Vec2

Normal map UV scalar

null : Self

property projectorListChangedAction : Action

property projectorViewBlending : int

property projectors : List[Projector]

property reflectivity : float

Proportion of incident light returned by the screen surface

property screenBackground : int

class d3.ScreenAxisExpression

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property expression : Expression

property expressionStr : str

Arithmetic expression, containing axis id in lowercase, constants and symbols. E.g. axis_1 + 5 or pow(axis_1, 2)

property max_input : float

property max_output : float

property min_input : float

property min_output : float

null : Self

property object : Object

Stage object to output the resulting value to

property output : float

property propertyValid : bool

property property_ : str

Property of the object to receive the value.
For position, use offset.x, offset.y or offset.z; for rotation, use rotation.x, rotation.y or rotation.z

class d3.ScreenConfiguration

Bases: Resource

addObject(s: Object) → None

property animates : List[float]

containsObject(s: Object) → bool

duplicateName : Callable

duplicatePath : Callable

property lock_axes : List[int]

null : Self

property objects : List[Object]

property positions : List[Vec]

removeObject(s: Object) → None

property rotations : List[Vec]

property sizes : List[Vec]

updateConfigFromObject(object: Object, i: int) → None

class d3.ScreenMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.ScreenPositionAxis

Bases: Resource

property acceleration : float

axisDirectionToString : Callable

property delta : float

property destValid : bool

property devicePredictionEnabled : bool

duplicateName : Callable

duplicatePath : Callable

property filterOverrideEnabled : int

When switched on, filter parameters override the parent device’s parameters.

property frequency : float

property frequencyMax : float

property frequencyMin : float

property graph : int

Create a monitor in the monitoring manager for incoming packet and filter data

property id : str

Set this to match an ID provided by an active Screen Position Driver

property input : float

property max_input : float

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

property max_output : float

property min_input : float

property min_output : float

property movementThreshold : float

Minimum change needed before updating output value. Helps when data has unwanted movement when intended to be static. 0 means no threshold (disabled)

null : Self

property object : Object

Set this to the object that will receive the value (position or angle)

property offset : float

Offset the final output value.

property output : float

The output value (specified units).

property outputRaw : float

property outputScaled : float

property positionSamples : int

Number of position samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

property prediction : float

Compensate for time latency between received data and projector output. Use 0 to disable.

property predictionEnabled : int

When switched on, prediction uses the ‘bias’ property to predict tracked positions at a future time

property property_ : str

property smoothingFactor : float

Smoothing Factor (%). Higher values will smooth the data more but will increase latency and therefore the need for prediction. Conversely, for lower values.

property status : int

property timeSamples : int

Number of time samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

property velocity : float

property velocityCalcMode : int

If set to Calculate the system will attempt to calculate velocity data otherwise this will use velocity values from incoming packets.

property wrapInput : int

Input values wrap, jumping from Minimum input to Maximum input or vice versa

class d3.ScreenPositionDriver

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

generatedTrackingSources() → List[ObjectTrackingSource]

null : Self

class d3.ScreenPositionDriverDistributor

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property sender : Machine

d3 machine connected to the driver

class d3.ScreenPositionModule

Bases: Module

property axes : int

property config : ScreenConfiguration

property configsTablePath : Path

property cuesTablePath : Path

duplicateName : Callable

duplicatePath : Callable

exportConfigs() → None

exportCues() → None

exportPositions() → None

importPositions() → None

property master : float

null : Self

property positionsTablePath : Path

class d3.ScreenPositionReceiver

Bases: Device

property axes : List[ScreenPositionAxis]

canCreateAxes() → bool

clearAxes() → None

createAxes() → None

property drivers : List[ScreenPositionDriver]

duplicateName : Callable

duplicatePath : Callable

property engaged : bool

property expressions : List[ScreenAxisExpression]

property frameOfReference : AnimationAxisSettings

property movementThreshold : float

Minimum change needed before updating output value. Helps when data has unwanted movement when intended to be static. 0 means no threshold (disabled)

null : Self

property positionSamples : int

Number of position samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

property prediction : float

Compensate for time latency between received data and projector output. Use 0 to disable.

property predictionEnabled : int

When switched on, prediction uses the ‘bias’ property to predict tracked positions at a future time

property smoothingFactor : float

Smoothing Factor (%). Higher values will smooth the data more but will increase latency and therefore the need for prediction. Conversely, for lower values.

property status : int

Controls all show machines’ status
Independent editors are always disengaged
Director-locked editors follow this setting

property timeSamples : int

Number of time samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

class d3.ScrollBar(*args, **kwargs)

Bases: Widget

property absOffset : float

focusedWidget : Callable

immediateMode() → None

null : Self

property ratio : float

scrollByIncrement(fac: float) → None

scrollByPage(fac: int) → None

scrollByPixel(px: float) → None

property scrollIncrement : float

property scrollOffsetChangedAction : Action

uiTransparencyDisabled : Callable

class d3.ScrollModule

Bases: Module

property border : float

duplicateName : Callable

duplicatePath : Callable

null : Self

property offset : float

Horizontal offset for start of scroll as a percentage of the canvas

property source : ContentSource

property speed : float

class d3.ScrollWidget2(*args, **kwargs)

Bases: Widget

ensureHScrollVisible(onOff: bool) → None

ensureRectVisible(r: Rect) → None

focusedWidget : Callable

property hScroll : HorizScrollBar2

mouseScrollWheelHoriz(fac: float) → None

Scroll the view by a small amount horizontally

mouseScrollWheelVert(fac: float) → None

Scroll the view by a small amount vertically

null : Self

property offset : Vec2

scrollWithCursor(pos: Vec2) → None

set() → ScrollWidget2

uiTransparencyDisabled : Callable

usableArea() → Vec2

property vScroll : VertScrollBar2

class d3.ScrollWithAltWidget(*args, **kwargs)

Bases: ScrollWidget2

focusedWidget : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.SelectMenu(*args, **kwargs)

Bases: Widget

property allButtons : List[SelectMenuButton]

focusedWidget : Callable

null : Self

property selectAction : ParamAction

selectByName(arg0: str) → None

selectByNumber(boxNumber: int) → None

set(items: List[str]) → SelectMenu

uiTransparencyDisabled : Callable

class d3.SelectMenuButton(*args, **kwargs)

Bases: Button

focusedWidget : Callable

null : Self

property tag : str

uiTransparencyDisabled : Callable

class d3.SelectionData

Bases: _BlipValue

property selection : Resource

Add an IndirectionControl layer to sequence this indirection in the timeline

class d3.SerialCommand

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property string : str

class d3.SerialDevice

Bases: ControlDevice

property baud_rate : int

property data : int

null : Self

property parity : int

property port : int

reopen() → None

Bases: Resource

containsTrack(track: Track) → bool

duplicateName : Callable

duplicatePath : Callable

null : Self

property tracks : List[Track]

class d3.ShaderMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

getParameter(paramName: str) → ReflectionValue

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

setParameter(paramName: str, value: ReflectionValue) → None

class d3.ShadowRP

class d3.ShadowRP(arg0: ShadowRP)

Bases: _BlipValue

null : Self

class d3.ShadowResource(unknown: ShadowResource)

Bases: _BlipValue

null : Self

class d3.ShortcutView(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

property searchString : str

uiTransparencyDisabled : Callable

class d3.ShotRecorder

Bases: Device

changeSlateForTake : Callable

deleteTake : Callable

duplicateName : Callable

duplicatePath : Callable

property engaged : bool

Click to engage/disengage recording

exportAllRecordings() → bool

exportComparisonTableForSlate : Callable

exportComparisonTableToCsv : Callable

property exportSettings : ShotRecorderExportSettings

exportSlate(arg0: Path) → bool

exportTake(arg0: Path) → bool

null : Self

property parameters : ParameterCollection

The parameter collection to record when the system is engaged

property recording : bool

property recordingsChangedAction : Action

renameSlate : Callable

renameTake : Callable

resetTake() → None

property slate : str

The name of the slate for the current shot

slateOrTakeExists : Callable

slates : Callable

property take : int

The number of the take for the current shot

property takeScreenshot : bool

Take a screenshot at the end of each recording

property takeSnapshot : bool

Take a project snapshot at the end of each recording

takesforSlate : Callable

property timecode : TimecodeTransport

The timecode to record alongside parameters. Must be selected in a transport manager.

class d3.ShotRecorderExportSettings

Bases: _BlipValue

property animationAlignment : int

Whether exported animations start at zero time for each shot, or align with the recorded timecode

property autoExport : bool

Automatically export shots in the chosen formats when recording stops

property exportCsv : bool

Export shot recording in CSV format, removing duplicated values for compactness

property exportCsvDense : bool

Export shot recording in CSV format, retaining all values for each frame

property exportFbx : bool

Export shot recording in FBX format

property exportFbxAscii : bool

Export shot recording in FBX ASCII format

property exportJson : bool

Export shot recording in JSON format

null : Self

class d3.Simotion

Velocity limit in m/s to avoid points jumping when they start receiving after being lost

property solverMode : int

Solver used to calculate joint positions from tracked points.
Direct: Directly manipulate the positions of the tracked joints.
IK: Update joint positions using Inverse Kinematics.

class d3.SkeletalTrackingSource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.Skeleton

Bases: Object

JOINT_ID_INVALID : Final = 18446744073709551615

property boundingBoxOffset : Vec

Offset of the skeleton’s bounding box centre relative to the root joint

property boundingBoxScale : Vec

Scale of the skeleton’s bounding box

clearReferencePoints() → None

property colour : Colour

createReferencePoints() → None

property displayJointLabels : bool

property drawBones : bool

property drawNodes : bool

duplicateName : Callable

duplicatePath : Callable

getJointRetargeting(meshId: int) → int

getPufferSphereMesh : Callable

getSphereMesh : Callable

property joints : SkeletonJoints

property mesh : Mesh

The mesh that defines the shape of the object

null : Self

property renderSettings : PropRenderer

resetToDefaultPose() → None

setJointRetargeting(meshId: int, trackingId: int) → None

property skinnedMesh : SkinnedMesh2

property trackingJoints : SkeletonJoints

class d3.SkeletonJoint

Bases: _BlipValue

property layout : SkeletalJointLayout

null : Self

property pose : SkeletalJointPose

class d3.SkeletonJoints

Bases: _BlipValue

empty() → bool

getJoint(jointId: int) → SkeletonJoint

property joints : unordered_map

null : Self

onJointPoseChanged(jointId: int) → None

class d3.SkeletonTrackerTester

duplicateName : Callable

duplicatePath : Callable

null : Self

property originOffset : Vec

Offset to apply to source camera position

property originRotation : Vec

Rotation to apply to source camera rotation

property sourceSkeleton : Skeleton

Skeleton to use a source of tracking data

class d3.SkinVert

Bases: Vert

null : Self

class d3.SkinnedMesh

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.SkinnedMesh2

Bases: Mesh

null : Self

class d3.SkinnedMeshComputeMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.SkinnedMeshJoints

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.SlcAwareDisplay

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.SlcConfig

Bases: Resource

LATENCY_NEXTFRAME : Final = 1

LATENCY_NOW : Final = 0

LATENCY_ONCOMPLETED : Final = 2

duplicateName : Callable

duplicatePath : Callable

property intersectionExpansion : float

Amount of pixels the region will be expanded by for intersection testing.
Useful for consolidating adjacent regions into fewer regions without affecting isolated regions

property latency : int

Latency for view calculation solver

property maxRegionResolution : Int2

Resolution regions will split into

property maxRegionsPerView : int

A hard limit on the number of regions per view

property minRegionResolution : Int2

Resolution regions will be rounded up to

property minimumResolution : Int2

Threshold for enabling SLC view calculations

null : Self

property offsetThreshold : float

Movement threshold for forced recalculation of a view.
Increase if tracking jitter is causing high load due to SLC recalculations.

property overscan : float

Ratio to expand projection area by, to account for distortion or other clipping.
1 means 100%, 2 means 200%

property regionExpansion : float

Amount of pixels the region will be expanded by.
Can be used alongside overscan to expand regions to account for movement

AlignCenter : Final = 1

AlignLeft : Final = 0

AlignMiddle : Final = 1

AlignRight : Final = 2

AlignTop : Final = 0

property alignH : int

property alignV : int

property bold : bool

extent(s: str, fontSize: float) → Vec2

extentHeight(nLines: int) → float

property fontSize : float

property height : float

property italic : bool

property leadedLineHeight : float

property leading : float

property lineHeight : float

property maxHeightInPixels : float

property maxWidthInPixels : float

null : Self

printAndRender(text: str, pos: Vec, colour: Colour, debugBounds: int, useCache: bool) → None

printDynamic(text: str, pos: Vec, pixelSize: float, colour: Colour, alignH: int, alignV: int, tracking: float, leading: float) → None

property tracking : float

truncateMiddle(inputString: str, targetWidth: float, endChars: int, minTruncChars: int) → str

truncateToWidth(inputString: str, targetWidth: float) → str

class d3.SmartGroupLayer

duplicateName : Callable

duplicatePath : Callable

property frames : int

property hours : int

property minutes : int

null : Self

property on_clock_lost : int

property play_mode : int

property seconds : int

class d3.SockPuppetSystem

Bases: Subsystem

property library : DmxLibrary

null : Self

property registry : DmxPersonalityRegistry

property singleChange : bool

property singleChangedPatch : DmxPatch

property singleChangedProperty : DmxProperty

property singleChangedPropertyAction : ParamAction

property singleChangedType : str

singleChangedValue(iChan: int) → int

class d3.SockPuppetVideoModule

property acesExposure : float

Input exposure transform (stops)

property acesGamma : float

Input gamma transform

property at_end_point : int

property bottom : float

property cdl : CDL

ASC CDL format colour grading in Slope, Offset, Power and Saturation controls. (Only in ACES)

property clipEndFrame : int

property clipLoopEndFrame : int

property clipLoopStartFrame : int

property clipNFrames : int

property clipStartFrame : int

property clip_type : int

property colour_shift : ColourShift

property cropSoftness : float

Enables a vignette effect by softening the edges of the crop

duplicateName : Callable

duplicatePath : Callable

property frameNumberDisplay : int

property frame_index : int

property frames : int

property hours : int

property left : float

property loop_inFrame : int

property loop_outFrame : int

property minutes : int

property mode : int

null : Self

property ocioContrast : float

Input contrast transform

property ocioExposure : float

Input exposure transform (stops).

property ocioGamma : float

Imput gamma transform

property ocioShaderProperties : OcioShaderProperties

property on_clock_lost : int

property output : LogicalAudioOutDevice

property pos : Vec2

property right : float

property rotation : float

property scale : Vec2

property seconds : int

property size : float

property speed : float

property top : float

property transition_time : float

property trim_frames : int

property video : VideoClip

property volume : float

class d3.SocketSystem

Bases: Subsystem

null : Self

class d3.SoftEdgePoint

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property pos : Vec2

property unused : int

class d3.SoftEdgeTexture

property alphaMode : int

Allow generation of RGB or Alpha gradients

property draw_control_points_on_output : int

duplicateName : Callable

duplicatePath : Callable

formatStrings : List[str]

property gamma : float

insertPointAfter(iPoint: int) → None

property lookup : LookupTexture

null : Self

property points : List[SoftEdgePoint]

removePoint(iPoint: int) → bool

renderPointsToFeed(localMat: Mat, feedRect: Rect, screenRect: Rect, rotation: float) → None

setPoints(indices: List[int], points: List[Vec2]) → None

add(obj: SortedRenderObject) → None

null : Self

render() → None

class d3.SortedRenderObject

Bases: _BlipValue

null : Self

class d3.SourcePopupMenu(*args, **kwargs)

Bases: PopupMenu

focusedWidget : Callable

null : Self

property source : ListEditorRow

uiTransparencyDisabled : Callable

class d3.Space

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

property postRenderWithMatAction : ParamAction

setAmbientOcclusionMode(mode: int) → None

stage() → Stage

class d3.SpaceWidget(*args, **kwargs)

Bases: Widget

Manipulator3DRotation : Final = 1

Manipulator3DScale : Final = 2

Manipulator3DTranslation : Final = 0

addManipulator(manipulatorType: Type) → None

property camera : Camera

enable3DManipulation() → None

focusedWidget : Callable

getManipulatorOfType(manipulatorType: Type) → Manipulator

null : Self

removeManipulator(manipulatorType: Type) → None

resetCameraManipulator() → None

property selectedCameraPlate : int

property space : Space

property sphericalInteractiveView : bool

uiTransparencyDisabled : Callable

property withAlpha : bool

class d3.SparseStringArray

Bases: _BlipValue

class CompressedEntry

Bases: _BlipValue

null : Self

class d3.SpatialCalibrationConfig

Bases: Resource

calibrationReadSources() → List[str]

property calibrationSettings : SpatialCalibrationSettings

duplicateName : Callable

duplicatePath : Callable

property initialSolvedLensPose : LensCalibrationPose

property lensCalibrationRegistration : CameraTrackerRegistration

property lensPoses : List[LensCalibrationPose]

loadLensCalibration(calibrationReadSource: str) → None

null : Self

property observations : List[CameraCalibrationObservation]

The observations made to calibrate the camera position & lens information

projectedPointsAtObservation(obs: CameraCalibrationObservation, useSolvedPose: bool) → List[Vec2]

property registration : CameraTrackerRegistration

property registrationLensPose : LensCalibrationPose

resetTracking() → None

property resolution : Vec2

saveLensCalibration(calibrationReadSource: str, resolution: Vec2) → None

class d3.SpatialCalibrationFrameOfReference

Bases: AnimationAxisSettings

duplicateName : Callable

duplicatePath : Callable

null : Self

property originPos : Vec

property originRotation : Vec

property spatialCalibration : SpatialCalibrationConfig

class d3.SpatialCalibrationSettings

Bases: _BlipValue

property calibrationScope : int

Optimise both the lens intrinsics and the camera-tracker registration.

Lens Only: Optimise the lens intrinsics, take the position/rotation directly from the tracker.

Registration Only: Optimise the registration, take lens intrinsics from the tracker (if provided) or camera.

Lens and Manual Registration: Use regular observations to calibrate lens intrinsics and manual observations to calibrate registration.

Registration and Focal Length: Optimise the registration and camera focal length, but not distortion parameters.

Type:
Lens and Registration

property detectOutliers : bool

Detect outlier blobs and remove them from the calibration process.

property moveScreens : bool

Allow the calibration to move screens in the virtual stage to match observations.

null : Self

property reoptimiseIntrinsics : bool

property trackerDistortionCompensation : int

Near 1 to 1 tracker data, no modifications are performed other than basic smoothing operations.

Single Gain: Universal scaling factor for all axes, eg. scale X/Y/Z all by 10.

Gains: Scale individual axes as needed eg. scale X/Y/Z by 10/5/2.

Gains and Skews: Similar to Gains with the addition of corrections to individual axes eg. the Y axis is slightly rotated compared to the X/Z axes, or not perpendicular to them.

Matrix: Custom modifications to axes, only for highly advanced use.

Type:
None

class d3.SpatialMap

Bases: CameraPlate

property activeCamera : Camera

property engineCameraPos : Vec

property engineCameraRotation : Vec

null : Self

property sceneOrigin : SceneOrigin

Origin of the rendered scene relative to the stage

class d3.SpatialMapObject

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.SpatialMapPoseUpgrade(arg0: SpatialMapPoseUpgrade)

Bases: _BlipValue

null : Self

class d3.Spherical

Bases: Projection

property contentMode : int

For realtime rendered content, the mapping can provide camera parameters in 3D mode.

duplicateName : Callable

duplicatePath : Callable

property frameOfReference : AnimationAxisSettings

property horizontalAngle : float

Arc the horizontal dimension of the content is mapped over
360 = full sphere
180 = half sphere

null : Self

property pixelBorder : float

property pos : Vec

Position of the center of the sphere content is projected from

property projectionMode : int

property renderParams : SphericalRenderParams

property rot : Vec

Rotation around x, y & z axes, in degrees

property verticalAngle : float

Arc the vertical dimension of the content is mapped over
180 = north pole to south pole
90 = north pole to equator

class d3.SphericalCamera

Bases: Camera

localVisualiserCamera : Callable

null : Self

property sphericalImpl : SphericalCameraImpl

class d3.SphericalCameraImpl

Bases: _BlipValue

null : Self

property renderParams : SphericalRenderParams

class d3.SphericalCameraNavigationManipulator(parent: SpaceWidget)

Bases: NavigationManipulator

null : Self

class d3.SphericalProjectionObject

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.SphericalRenderParams

Bases: _BlipValue

property fov : int

Horizontal field of view of the spherical camera, in degrees

property isSpherical : bool

null : Self

property overlap : int

Additional pixels to be rendered outside each cube face, then blended between faces when combining into spherical image.
Used to avoid seams when using screen-space render effects.

property padding : int

Additional pixels to be rendered outside each cube face, then discarded when combining into spherical image.
Used to avoid seams when using screen-space render effects.

class d3.SpinBitmap

Bases: Module

property angle : float

property depth : int

property depth_Blend : int

duplicateName : Callable

duplicatePath : Callable

property moveSpeed : Vec2

null : Self

property offset : Vec2

property rotation_speed : float

property scale : float

property source : ContentSource

property tile : int

class d3.Stage

Bases: Object

property Adaptive_Tone_map : int

property Area_lighting : int

property Chicago_renderer : int

property Export_Frame_Of_Reference : AnimationAxisSettings

property Floor_normal_map : DxTexture

Normal map for the floor

property Glow : int

property Local_Frame_Of_Reference : AnimationAxisSettings

property Reflections : int

addReferencePoint(pt: ReferencePoint) → None

property ambientColour : Colour

The colour of the ambient light.
It is recommended to select a ‘full brightness’ version of colours chosen, by changing Luminance in the colour picker to 1.

property ambientLight : float

Brightness in lux that uniformly illuminates the scene. Sunlight at midday can be 111000 lux, while moonlight could be 0.25 lux

property areaLightingBrightness : float

property autoSoftEdge : int

Toggle dynamic blend on outputs

property blurPasses : int

property blurSigma : float

property cameras : List[Camera]

List of cameras viewing the stage

property debugObject : DbgObject

property depthFogDistance : float

Depth fog distance

display(i: int) → Display

property displays : List[Display]

property dmxLights : List[FixtureGroup]

List of lighting fixture grids driven via DMX

property dmxScreens : List[DmxScreen]

List of emissive LED screens driven via DMX

duplicateName : Callable

duplicatePath : Callable

property exportOptions : List[ExportOptionsResource]

exportStage(path: Path) → None

property extraSerialisedObjects : List[Object]

property floorAlpha : float

Floor alpha

property floorLuminosity : float

Floor luminosity

property floorNormalMapScalar : Vec2

Floor normal map UV scalar

property floor_plan : DxTexture

Bitmap to display on the floor. Useful when working to a plan view diagram

property floor_pos : Vec

Floor position, in meters

property floor_size : Vec2

Floor size, in meters

property footprintsQuality : float

Resolution multiplier for projector shadow buffers. 0 disables footprints

getGizmos() → List[Gizmo]

getPufferSphereMesh : Callable

getSphereMesh : Callable

property glowThreshold : float

property greenScreens : List[GreenScreen]

Surfaces used for background removal

property heatMapMaxLux : float

property heatMapMinLux : float

importObjectsFromTable(table: Table) → None

property ledScreens : List[LedScreen]

List of emissive LED screens

property lightBleedReduction : float

property lights : List[Light]

Lights which affect Lux rendering

luxTicks() → List[float]

property measurementsObject : MeasurementSet

property minVariance : float

property mixedRealitySets : List[MixedRealitySet]

List of mixed reality sets present

nDisplays() → int

null : Self

property people : int

Number of people to display

property projectors : List[Projector]

List of active projectors

property projfrustummultiplier : float

Set this to multiply the far distance of the projector

property pucks : List[Puck]

property refPointRemovedAction : ParamAction

removeReferencePoint(pt: ReferencePoint) → None

removeReferencePoints(pts: List[ReferencePoint]) → List[ReferencePoint]

property scatterDensity : float

property sceneAmbientColour : Col

property screenListChanged : Action

property scrollScalar : float

property shadowBias : float

simulatingStackedOutputs() → bool

simulatingWarps() → bool

property skeletons : List[Skeleton]

property softEdgeProfile : AutoSoftEdgeProfile

Configuration for dynamic blend profile

property stageReferencePoints : ReferencePointSet

property surfaces : List[Screen2]

List of passive screen surfaces hit by projectors

property twoPoint5DPlates : List[TwoPoint5DPlate]

property venue : Venue

List of props and buildings to display

class d3.StageKinetiksMoveCatDriver

null : Self

property protocolVersion : int

Default port for V2 is 16000 and for V3 it is 16200

class d3.StageRenderModule

Bases: Module

property artificialLatency : int

Add an artificial latency (in frames) for testing purposes

duplicateName : Callable

duplicatePath : Callable

null : Self

property renderLayer : int

Only render screens marked with this render layer in the stage

class d3.StageRenderSettings

Bases: Resource

Heatmap : Final = 2

Lux : Final = 1

Schematic : Final = 0

appliesToOmnicalCamera() → bool

appliesToSphericalCamera() → bool

property drawTrackedPoints : bool

BlackTrax LEDs)

Type:
Toggle display of incoming tracked points (eg

property drawVenue : bool

Toggle visibility of venue

duplicateName : Callable

duplicatePath : Callable

property exposure : float

Camera white point in Lux

property extraTransparencyPasses : int

Number of extra transparency renders to add detail to transparent objects.
Setting this to 0 handles one layer of transparency.
Increasing the value will impact performance.

property faceCullMode : int

Can optionally skip rendering faces with normals pointing away (back) or toward (front) the camera.

property glowBrightness : float

Impact of glow effect in Lux renderer

property light : int

How to display the light levels of the scene
Luminance: as seen by the camera
Illuminance: as seen by a light meter pointing at the light sources

property msaaMode : int

null : Self

property onLightChanged : ParamAction

property renderer : int

Schematic shows content; Lux shows what the content would actually look like in the real world; Heatmap shows lux-levels

setAllLabelVisibility(visible: bool) → None

property ssaoDownsample : int

property ssaoKernelSize : int

property ssaoNoiseSize : int

property ssaoPower : float

Power of the ambient occlusion effect in Lux renderer. 0 disables it

property ssaoRadius : float

property virtualObjectAlpha : float

Opacity of virtual objects (in render layers other than On-Stage or Off-Stage)

class d3.State

Bases: _BlipValue

Busy : Final = 3

Connection : Final = 0

Devices : Final = 3

Error : Final = 2

Genlock : Final = 2

Offline : Final = 4

Output : Final = 1

Ready : Final = 0

Warning : Final = 1

property category : int

property detail : str

property name : str

null : Self

property currentAssignmentInfo : str

Provide information about the role this stream plays in the workload

property currentTransportInfo : str

Provide information about active video transport parameters

property didReceiveFrameLocallyRecently : bool

property getWorkloadFriendlyName : str

Provide information on the workload from which the stream is sourced

property isStreamOnline : bool

property latestFrame : RemoteStreamFrame

property latestFrameTexture : DxTexture

property machineName : str

null : Self

property streamHandleString : str

property streamName : str

property workloadId : int

property workloadInstance : int

class d3.StreamStatusMsg(arg0: StreamStatusMsg)

Bases: _BlipValue

property message : str

null : Self

property priority : int

class d3.StreamingACNSystem

Bases: Subsystem

null : Self

class d3.StringProjectorControlCommand

Bases: ProjectorControlCommand

duplicateName : Callable

duplicatePath : Callable

null : Self

property string : ControlString

class d3.StringProjectorControlDevice

Bases: ProjectorControlDevice

property control_device : ControlDevice

property defaults : List[StringProjectorControlCommand]

duplicateName : Callable

duplicatePath : Callable

property focus_command : ControlString

property focus_range : Vec2

property intensity_command : ControlString

property intensity_range : Vec2

property lens_shift_h_command : ControlString

property lens_shift_h_range : Vec2

property lens_shift_v_command : ControlString

property lens_shift_v_range : Vec2

null : Self

property pan_command : ControlString

property pan_range : Vec2

property shutdown : List[StringProjectorControlCommand]

property startup : List[StringProjectorControlCommand]

property tilt_command : ControlString

property tilt_range : Vec2

property zoom_command : ControlString

property zoom_range : Vec2

class d3.StringSequence

Bases: KeySequence

duplicateName : Callable

duplicatePath : Callable

null : Self

setString(ik: int, s: str) → None

setStringAtT(t: float, s: str) → None

class d3.StrobeModule

Bases: Module

property attack : float

property cycle : float

property decay : float

duplicateName : Callable

duplicatePath : Callable

property locked : int

property min_brightness : float

null : Self

property proportion : float

property randomise : int

property rate : float

class d3.StructuredLightRenderSystem

Bases: Subsystem

ImageTypeAlignment : Final = 5

ImageTypeAlignmentGuideLines : Final = 6

ImageTypeBlack : Final = 1

ImageTypeFocus : Final = 3

ImageTypeGrid : Final = 4

ImageTypeWhite : Final = 2

null : Self

class d3.StsAxisState

null : Self

class d3.StsDriver

null : Self

class d3.StypeDriver

property enablePacketTimingGraph : bool

Log incoming packet times to a graph

null : Self

class d3.SubscribeMessage

class d3.SubscribeMessage(arg0: SubscribeMessage)

Bases: Message

property eventType : str

null : Self

class d3.SubscribedStreamStatus

Bases: _BlipValue

property activeLatency : float

generateStreamStatusMsg(ignoreDedicatedDirectorStatus: bool) → StreamStatusMsg

null : Self

property receiver : Machine

property recentDuration : float

property recentReceived : int

recentReceivedFPS() → float

property recentSent : int

recentSentFPS() → float

property streamIdentifier : StreamIdentifier

property subscribeSuccessful : bool

property subscriptionWanted : bool

property tLastDropped : float

property tLastError : float

property tLastErrorMessage : str

property tLastReceived : float

property totalDroppedPackets : int

property totalReceived : int

class d3.Subsystem

Bases: _BlipValue

property name : str

null : Self

class d3.SubsystemManager

Bases: ISubsystemManager

getSystem(arg0: Type) → Subsystem

maybeGetSystem(arg0: Type) → Subsystem

null : Self

subsystems() → List[Subsystem]

class d3.SuperLayer

Bases: Resource

property container : GroupLayer

contains(t: float) → bool

property crashed : bool

duplicateName : Callable

duplicatePath : Callable

exportToApx(filename: str) → None

property expressionReports : List[ResourceReport]

getAllLayers() → List[SuperLayer]

getLeafLayers() → List[Layer]

property indicator : str

property isDormant : bool

isExternallyControlled() → bool

property isShared : bool

property name : str

property nameChangedAction : Action

null : Self

overlaps(l: SuperLayer) → bool

property owners : List[Resource]

property render : bool

property renderEnable : bool

property resourceReports : List[ResourceReport]

setExtents(newStart: float, newEnd: float) → None

property tEnd : float

property tLength : float

property tStart : float

property track : SuperTrack

class d3.SuperResolutionModule

Bases: Module

duplicateName : Callable

duplicatePath : Callable

null : Self

property sharpness : float

property source : ContentSource

class d3.SuperTrack

Bases: Resource

class AudioSection

Bases: _BlipValue

null : Self

property DMX_fixtures : int

EditEnd : Final = 1

EditStart : Final = 0

Next : Final = 1

Prev : Final = -1

addLayer(arg0: SuperLayer, arg1: float, arg2: int) → None

addLayerToGroup(arg0: SuperLayer, arg1: GroupLayer) → None

addNewLayer(arg0: Type, arg1: float, arg2: float, arg3: str) → Layer

property arrows : List[Arrow]

audioTrack(arg0: float) → AudioTrack

property audioTrackChangedAction : ParamAction

property audio_sections : List[AudioSection]

beatIsEnd(arg0: float) → bool

beatIsStart(arg0: float) → bool

beatIsValid(arg0: float) → bool

beatToTime(arg0: float) → float

property bpm : float

bpmAt(arg0: float) → float

checkBadResources() → None

clearArrows() → None

property clock_divide : float

contains(arg0: SuperLayer, arg1: bool = True) → bool

property count_in_beats : float

duplicateLayer(arg0: SuperLayer, arg1: str) → SuperLayer

duplicateLayerIndex(arg0: SuperLayer, arg1: str, arg2: int) → SuperLayer

duplicateName : Callable

duplicatePath : Callable

enableRender(arg0: bool) → None

extractLayerFromGroup(arg0: SuperLayer) → None

findBeatOfLastNote(arg0: float) → float

findBeatOfNextNote(arg0: float) → float

findLayerByName(arg0: str) → Layer

findLayerIndex(arg0: SuperLayer) → int

getLayersAssociatedWithPatch(arg0: ControlPatch) → List[Layer]

getLeafLayers(arg0: Type) → List[Layer]

globalBeatToLocalBeat(arg0: float) → float

groupLayers(arg0: List[SuperLayer], arg1: str, arg2: bool) → None

property layerAddedAction : ParamAction

property layerChangedAction : ParamAction

property layerIndicatorChangedAction : ParamAction

property layerRemovedAction : ParamAction

property layers : List[SuperLayer]

property lengthInBeats : float

property lengthInSec : float

makeArrow(arg0: Layer, arg1: Layer) → None

moveLayerToIndex(arg0: SuperLayer, arg1: int) → None

moveLayerToIndexInGroup(arg0: SuperLayer, arg1: int) → None

moveLayersDown(arg0: List[SuperLayer]) → None

moveLayersUp(arg0: List[SuperLayer]) → None

nLayers() → int

noteAtBeat(arg0: float) → str

property notes : TimeSequence

null : Self

property quant : int

removeArrow(arg0: Arrow) → None

removeInvalidLayers() → None

removeLayer(arg0: SuperLayer) → int

setNoteAtBeat(arg0: float, arg1: str) → None

splitLayersAtBeat(arg0: List[SuperLayer], arg1: float) → List[SuperLayer]

timeToBeat(arg0: float) → float

ungroupLayer(arg0: GroupLayer) → None

class d3.SuperTransportManager

Bases: Resource

property brightness : float

property current : TransportManager

duplicateName : Callable

duplicatePath : Callable

null : Self

property startupBrightness : float

property startupVolume : float

property volume : float

class d3.SwitchableString

Bases: _BlipValue

getString() → str

null : Self

property on : bool

sectionVisibility(sectionName: int, isVisible: bool) → None

class d3.SyncCheckProcess

null : Self

start() → None

class d3.TCallArgs(arg0: TCallArgs)

Bases: _BlipValue, Sequence

null : Self

d3.TFormat(stringPattern: str, *args) → str

Helper function to translate strings with interpolation

class d3.Task

Bases: _BlipValue

null : Self

class d3.TaskExecutorSystem

Bases: Subsystem

property backgroundTasks : List[str]

null : Self

property onBackgroundTasksChangedAction : Action

class d3.TaskGroup

Bases: Task

null : Self

class d3.TaskMetrics

Bases: _BlipValue

null : Self

property tFinish : float

property tInit : float

property tStartTask : float

property tStopTask : float

class d3.TaskStatus

Bases: _BlipValue

Cancelled : Final = 3

Completed : Final = 2

Failed : Final = 2

Queued : Final = 0

Running : Final = 1

Success : Final = 1

Unknown : Final = 0

property info : str

property name : str

null : Self

property progress : float

property reason : int

property state : int

property type : str

property uid : str

class d3.TaskStatusMessage

class d3.TaskStatusMessage(arg0: TaskStatusMessage)

Bases: Message

null : Self

property status : TaskStatus

class d3.TaskSystem

Bases: Subsystem

activeTasksStatusesForType(type: Type) → List[ExtendedTaskStatus]

nActiveTasksForType(type: Type) → int

property routeFooter : str

property routeHeader : str

property telnet : TelnetDevice

class d3.TelnetDevice

Bases: ControlDevice

property IP_Address : str

IP Address to connect to

property Port : int

Port to connect to

property connect : int

Connnection mode, at startup will connect once when d3 starts or on disconnection, every send will connect/disconnect on each message

property connectionMessage : str

Message to send when connection is established, leave blank to disable

null : Self

class d3.TelnetModule

Bases: ControlModule

property IP_address : str

null : Self

property port : int

class d3.TelnetSystem

Bases: Subsystem

null : Self

class d3.TestApp

Bases: App

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.TestPatternModule

Bases: Module

property acesExposure : float

Input exposure transform (stops)

property acesGamma : float

Input gamma transform

property circleRadius : float

property circles : int

duplicateName : Callable

duplicatePath : Callable

property gridMode : int

property gridSpacing : int

property label : int

property logoBottomRight : DxTexture

property logoTopLeft : DxTexture

null : Self

property ocioContrast : float

Input contrast transform

property ocioExposure : float

Input exposure transform (stops).

property ocioGamma : float

Imput gamma transform

property ocioShaderProperties : OcioShaderProperties

property subGridSpacing : int

class d3.TestReceiverDriver

duplicateName : Callable

duplicatePath : Callable

property nMotors : int

null : Self

class d3.TextBox(*args, **kwargs)

Bases: Widget

allow(chars: str) → TextBox

property attention : bool

backspace() → None

Delete the character to the left of the caret

backspaceWord() → None

Delete the word to the left of the caret

canChangeValue() → bool

changeValue(changeFactor: float) → None

changeValueWithRounding(changeFactor: float, roundingFactor: float) → None

copyText() → None

Copy the currently selected text into the clipboard

cut() → None

Cut the currently selected text into the clipboard

decrementLarge() → None

Decrement the number in the text box by a large amount

decrementMedium() → None

Decrement the number in the text box by a medium amount

decrementSmall() → None

Decrement the number in the text box by a small amount

delWord() → None

Delete the word to the right of the caret

del_() → None

Delete the character to the right of the caret

disallow(chars: str) → TextBox

property editable : bool

focusedWidget : Callable

fontSize(pixelSize: float) → TextBox

formatFloat : Callable

ignoreMouseScroll(ignore: bool) → None

incrementLarge() → None

Increment the number in the text box by a large amount

incrementMedium() → None

Increment the number in the text box by a medium amount

incrementSmall() → None

Increment the number in the text box by a small amount

mousePlaceCursor() → None

Place the cursor at the desired location, twice rapidly to select all text

mouseScrollLarge(fac: float) → None

Change the value by a large amount

mouseScrollMedium(fac: float) → None

Change the value by a medium amount

mouseScrollSmall(fac: float) → None

Change the value by a small amount

mouseSelectRegion(state: int, start: Vec2, pos: Vec2) → None

Select a region of text

moveCursorDown() → None

Move the caret down

moveCursorFarLeft() → None

Move the caret to the beginning of the text

moveCursorFarRight() → None

Move the caret to the end of the text

moveCursorLeft() → None

Move the caret to the left

moveCursorLineEnd() → None

Move the caret to the end of the line

moveCursorLineStart() → None

Move the caret to the beginning of the line

moveCursorRight() → None

Move the caret to the right

moveCursorUp() → None

Move the caret up

moveCursorWordLeft() → None

Move the caret left to the next word boundary

moveCursorWordRight() → None

Move the caret right to the next word boundary

property multiline : bool

null : Self

onEnterPressed() → None

Submit the typed text.

onEnterTyped() → None

Enter new line into the text box

onType(c: int) → None

Enter characters into the text box

paste() → None

Paste the clipboard to the caret location

restrictLength(maxCharacters: int) → TextBox

property returnAction : Action

select(start: int, end: int) → None

selectAll() → None

Select all the text in the text box

selectCursorDown() → None

Extend the selection down a line using the cursor

selectCursorLeft() → None

Extend the selection using the cursor to the left

selectCursorRight() → None

Extend the selection using the cursor to the right

selectCursorUp() → None

Extend the selection up a line from the cursor

selectWordLeft() → None

Extend the selection to the left to the next word boundary

selectWordRight() → None

Extend the selection to the right to the next word boundary

set(text: str, editable: bool, p: Vec2, c: Colour) → TextBox

smallFont() → TextBox

property text : str

uiTransparencyDisabled : Callable

property upDownAction : ParamAction

property valueChangeAction : Action

class d3.TextFont

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.TextLabel(*args, **kwargs)

Bases: Widget

ElideMiddle : Final = 2

ElideNone : Final = 0

ElideRight : Final = 1

colour(c: Colour) → TextLabel

disableCache() → TextLabel

property elideMode : int

focusedWidget : Callable

fontSize(pixelSize: float) → TextLabel

null : Self

set(text: str, p: Vec2, c: Colour, shouldLocalise: bool) → TextLabel

smallFont() → TextLabel

uiTransparencyDisabled : Callable

class d3.TextModule

Bases: Module

duplicateName : Callable

duplicatePath : Callable

property font : TextFont

Use default font or load .ttf font file in /objects/textfonts

property fontSize : int

Size of the text (in pixel)

property hAlignment : int

Horizontal alignment for text

null : Self

property text : str

Text to display

property vAlignment : int

Vertical alignment for text

property xPosition : int

Horizontal position offset from alignment (in pixel)

property yPosition : int

Vertical position offset from alignment (in pixel)

class d3.TextureDownloader

Bases: Subsystem

null : Self

class d3.TextureParameterAssigner

Bases: _BlipValue

property assigner : ClusterAssigner

property controller : Machine

set(r: Resource, text: str, showText: bool) → Thumbnail

setSuggestion(s: str) → Thumbnail

property showText : bool

uiTransparencyDisabled : Callable

class d3.ThumbnailRequest

Bases: _BlipValue

null : Self

class d3.ThumbnailSystem

Bases: Subsystem

getTemporaryVideoFileThumbnail(file: VideoFile, iFrame: int) → DxTexture

getThumbnail(resource_: Resource, thumbSize: Int2, iFrame: int) → DxTexture

getThumbnailRenderSize(resource: Resource) → Int2

getThumbnailSize(r: Resource) → Int2

null : Self

supportsThumbnails : Callable

class d3.TickBoxWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

set() → TickBoxWidget

property ticked : bool

property tickedAction : ParamAction

toggle() → None

Toggle the value on or off

uiTransparencyDisabled : Callable

class d3.TickValueBox

Bases: ValueBox

fps() → float

fromString : Callable

fromStringWithFps : Callable

null : Self

property t : float

class d3.TimecodeCursor(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

onMouseDragCursor(dragState: int, startPos: Vec2, pos: Vec2) → None

Scrub timecode

uiTransparencyDisabled : Callable

class d3.TimecodeReadoutModule

Bases: Module

property display : int

duplicateName : Callable

duplicatePath : Callable

null : Self

property position : Vec2

property size : float

class d3.TimecodeSubmitWidget(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

onFocusLabel(focus: bool) → None

set(text: str, tc: float, a: Callable) → TimecodeSubmitWidget

uiTransparencyDisabled : Callable

class d3.TimecodeSystemTime

property SMPTE_clock_type : int

null : Self

class d3.TimecodeTester

property SMPTE_clock_type : int

jumpBack() → None

jumpForward() → None

property jump__sec_ : float

null : Self

reset() → None

start() → None

property start_tc : str

stop() → None

class d3.TimecodeTextBox(*args, **kwargs)

Bases: TextBox

focusedWidget : Callable

formatFloat : Callable

null : Self

uiTransparencyDisabled : Callable

class d3.TimecodeTransport

Bases: Resource

property current : Timecode

duplicateName : Callable

duplicatePath : Callable

null : Self

property statusString : str

property transportManager : TransportManager

class d3.TimecodeTransportBeat

Bases: TimecodeTransport

property adjust__sec_ : float

duplicateName : Callable

duplicatePath : Callable

property mode : int

null : Self

class d3.TimecodeTransportClocked

Bases: TimecodeTransport

property adjust__sec_ : float

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.TimecodeTransportLtc

property SMPTE_clock_type : int

duplicateName : Callable

duplicatePath : Callable

property bpmString : str

duplicateName : Callable

duplicatePath : Callable

property input : int

property min_bpm_taps : int

null : Self

class d3.TimecodeTransportVitc

property SMPTE_clock_type : int

duplicateName : Callable

duplicatePath : Callable

property nFramesToSync : int

Number of consecutive frames to be received before syncronising with the source

null : Self

property updateStatusString : str

property videoIn : LogicalVideoInDevice

Video input containing embedded timecodes

class d3.TimecodeValueBox

Bases: ValueBox

isSupportedType : Callable

null : Self

class d3.Timer

Bases: _BlipValue

actualFrameTime() → float

actualTime() → float

delta() → float

fixedMode(arg0: float) → None

frameTime() → float

normalMode() → None

null : Self

class d3.Timing

Bases: _BlipValue

property hActive : int

property hBack : int

property hFront : int

property hPolarity : int

property hSync : int

property interlaced : bool

null : Self

property pixelClock : int

property vActive : int

property vBack : int

property vFront : int

property vPolarity : int

property vSync : int

class d3.TitleButton(*args, **kwargs)

Bases: Widget

property canClose : bool

property clickAction : Action

property closeButton : Button

flash(onOff: bool, period: float, c: Colour, duration: float) → None

focusedWidget : Callable

property hasOptionButton : bool

null : Self

onClick() → None

Close the window

onDrag(state: int, start: Vec2, pos: Vec2) → None

Drag the floating window to a new location

onOpenPopupMenu() → None

Open an options menu

property optionButton : Button

property popupMenuAction : Action

property restrictPosCallback : Callable

set(text: str, _canClose: bool, _shouldLocalise: bool) → TitleButton

toggleSticky() → None

Toggle sticky state on the window

uiTransparencyDisabled : Callable

class d3.Toggle3DButton(*args, **kwargs)

Bases: Button

focusedWidget : Callable

distanceToSection(beatsToEdit: float, prevOrNext: int, startOrEnd: int) → float

duplicateName : Callable

duplicatePath : Callable

findBeatOfLastSection(tBeats: float) → float

findBeatOfLastTag(tBeats: float) → float

findBeatOfNextSection(tBeats: float) → float

findBeatOfNextTag(tBeats: float) → float

formatNoteForBeat(beatOfNote: float, tCurrentBeats: float) → str

globalTimeToBeat(tGlobal: float, clockType: int, tDiff: float, tcTagsLimitedToSection: bool) → float

layerByName(name) → Any

Access layers by a (hopefully) unique name

property nSections : int

noteTagSectionBeats() → List[float]

null : Self

readCueTable() → None

sectionLengthBeats(iSection: int) → float

sectionToBeat(iSection: int) → float

property sectionTransitions : List[TrackTransitionInfo]

property sections : TimeSequence

setTagAtBeat(iBeat: float, s: str) → None

splitSectionAtBeat(iBeat: float) → None

tLastBeatInSection(t: float) → float

tagAtBeat(iBeat: float) → str

property tags : TimeSequence

property tc_adjust : float

This value will be added to timecode chase time, in seconds

timeOfNoteContainingBeat(arg0: float) → float

transitionInfoAtBeat(beat: float) → TrackTransitionInfo

property playMode : int

How to play the track, in relation to this timeline

property refTrack : Track

The track to play

property tTrackStart : float

Start playing the track at this time (seconds)

class d3.TrackPlayHead

Bases: PlayHead

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.TrackPlayer

Bases: Resource

HoldEnd : Final = 5

HoldSection : Final = 4

LoopSection : Final = 2

Play : Final = 0

PlaySection : Final = 1

Stop : Final = 3

property activeLayers : List[Layer]

duplicateName : Callable

duplicatePath : Callable

property hasTrack : bool

property holding : bool

property isFreeRunning : bool

property loopSectionMode : bool

null : Self

property onChangedTrack : ParamAction

property onJumpToBeat : ParamAction

property onSwitchPlayMode : ParamAction

property playMode : PlayMode

property playing : bool

property sectionPlayMode : bool

property sectionTestMode : bool

property stopped : bool

property tCurrent : float

property tRender : float

property tRunForever : float

property tRunning : float

property track : Track

property transitionBeginAction : Action

class d3.TrackTransitionInfo

class d3.TrackTransitionInfo(arg0: TrackTransitionInfo)

Bases: _BlipValue

property durationBeats : float

property fadeDurationBeats : float

property loopUxFade : bool

property mode : int

null : Self

property track : Track

property trackSection : int

class d3.TrackTransitionInfoValueBox

Bases: ValueBox

isSupportedType : Callable

null : Self

class d3.TrackUtils

Bases: _BlipValue

CUE : Final = 2

MIDI : Final = 1

TC : Final = 0

null : Self

sanitiseTagText : Callable

tagTextAlreadyExists : Callable

class d3.TrackedFixedPoint

Bases: _BlipValue

property allowTwist : bool

property fixed : ReferencePoint

null : Self

property offset : Vec

property tracked : TrackedPoint

class d3.TrackedPoint

Bases: ReferencePoint

clearSelection : Callable

deselectPoint : Callable

duplicateName : Callable

duplicatePath : Callable

getLastSelectedPoint : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

property isReceiving : bool

property isReceivingOverride : bool

null : Self

onCreated : Callable

onMouseMove : Callable

onSelected : Callable

overrideKeyStroke : Callable

overrideMouseMove : Callable

requestDisplayManipulators : Callable

requestShowOnlyPointsFor : Callable

selectPoint : Callable

showAllPoints : Callable

class d3.TrackedSkeletalLayout

Bases: _BlipValue

property joints : unordered_map

null : Self

property v : int

class d3.TrackerDelayCalibrationProcess

property PREVIEW_LARGE_WIDTH : float

property PREVIEW_SMALL_WIDTH : float

property captureGridLineThickness : float

property captureGridLines : int

capturedFieldsForCamera(camera: Camera) → List[InterlacedField]

nTrackingDataForCamera(cam: Camera) → int

null : Self

overlaidFieldsForCamera(camera: Camera) → List[InterlacedField]

renderVirtualOverlays(cam: Camera) → None

start() → None

property captured : List[Vec]

clearRegistration() → None

duplicateName : Callable

duplicatePath : Callable

finaliseRegistration() → None

null : Self

property reference : List[ReferencePoint]

registerPoint(i: int) → None

property registerPointCompletedAction : ParamAction

property registration : int

property registrationBlockHeight : float

Set this value to the actual height of the registration block.

property samples : int

Number of samples for averaging the reported tracked point.

property samplingRegistrationPoint : bool

property tracked : List[TrackedPoint]

class d3.TrackingItem

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property label : str

null : Self

property object : Object

property type : int

class d3.TrackingMarkerModule

Bases: Module

property backgroundColour : Colour

property bottomCrop : float

Fraction of output to crop from the bottom

duplicateName : Callable

duplicatePath : Callable

property leftCrop : float

Fraction of output to crop from the left

property markerImage : DxTexture

property markerSize : float

property markerSpacing : float

null : Self

property rightCrop : float

Fraction of output to crop from the right

property topCrop : float

Fraction of output to crop from the top

class d3.TrackingMarkerModuleConfig

Bases: ModuleConfig

property acesTransform : AcesInputTransformParameters

duplicateName : Callable

duplicatePath : Callable

null : Self

property ocioTransform : OcioColourSpace

class d3.TrackingScalar

Bases: TrackingItem

duplicateName : Callable

duplicatePath : Callable

null : Self

property value : float

class d3.TrackingScalarState

Bases: TrackingState

property acceleration : float

null : Self

property position : float

property velocity : float

property enablePacketTimingGraph : bool

Log incoming packet times to a graph

null : Self

class d3.TransformedPositionDeltaMesh

Bases: DeltaMesh

null : Self

property transform : Mat

class d3.TranslationGizmo

Bases: Gizmo3D

null : Self

class d3.TranslationManipulator(parent: SpaceWidget)

Bases: Manipulator3D

mouseDrag(arg0: int, arg1: Vec2, arg2: Vec2) → bool

Move the object controlled by the gizmo

null : Self

class d3.Translator

Bases: _BlipValue

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

class d3.TransportCMDChaseTime

property correctionMode : int

property forceJump : bool

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property speed : float

class d3.TransportCMDOutputMode

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property outputMode : int

class d3.TransportCMDPlayMode

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property playMode : int

class d3.TransportCMDRecvTimecode

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property speed : float

property tSec : float

class d3.TransportCMDSetSpeed

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property speed : float

class d3.TransportCMDSmoothTime

property forceJump : bool

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property tSec : float

class d3.TransportCMDStatus

property brightness : float

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

property monitorString : str

null : Self

property playMode : int

property remoteTransportMode : int

property statusString : str

property tLastIssued : float

property tcStatus : int

property volume : float

class d3.TransportCMDStop

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

duplicateName : Callable

duplicatePath : Callable

makeJumpToBeat : Callable

makeJumpToCue : Callable

makeJumpToFrame : Callable

makeJumpToMidiNote : Callable

makeJumpToTime : Callable

makeNudgeBeat : Callable

makeNudgeFrame : Callable

makeNudgeSection : Callable

makeNudgeTrack : Callable

null : Self

property sourceIsTimecode : bool

property tm : TransportManager

property trackAndBeat : TrackAndBeat

class d3.TransportControl(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

set(tm: TransportManager, showRecordButton: bool) → None

uiTransparencyDisabled : Callable

class d3.TransportControlModule

Bases: Module

property command : TransportJumpCommand

duplicateName : Callable

duplicatePath : Callable

null : Self

property transportName : str

property trigger : int

class d3.TransportJumpCommand

Bases: Resource

property command : int

duplicateName : Callable

duplicatePath : Callable

property location : str

property location_type : int

jump to midi tag
Cue: jump to cue tag
Timecode: jump to track timecode, relative to TC tags hh:mm:ss:ff
Time: Jump to absolute track timecode, unaffected by TC tags hh:mm:ss:ff

Type:
Midi

null : Self

property track : str

property transition : float

class d3.TransportManager

Bases: SuperTransportManager

addCommand(trCmd: TransportCommand) → None

beatToTimecode(tBeat: float) → Timecode

custom : Final = 2

customFps() → optional

property customFpsType : int

property customTimelineFps : float

duplicateName : Callable

duplicatePath : Callable

property enableCustomFps : int

property engaged : bool

forceJump() → None

globalRefreshRate : Final = 1

property local_transports : List[EventTransport]

lockToDirector(source: Resource, jumpDirectorToMe: bool) → None

property monitorString : str

none : Final = 0

null : Self

property on_clock_lost : int

property on_clock_regained : int

property play_mode : int

property playbackStatusMonitor : PlaybackStatusMonitor

property player : TrackPlayer

property remote_transports : List[EventTransport]

property remotetransportmode : int

property schedule : Schedule

property sendTransportCommands : int

property sendTransportCommandsMode : int

property setList : SetList

smpteClockType() → int

property status : int

property statusString : str

property timecode : TimecodeTransport

property timecode_can_change_track : int

property traceLevel : int

property track : Track

The minimum depth in metres used when interpreting depth maps from imported assets
Set to -1 to reload default value from file

duplicateName : Callable

duplicatePath : Callable

exportToFile() → None

extractFromFile(isPrimaryMachine: bool) → None

property file : TwoPoint5DFile

property fovH : float

Horizontal field of view covered by the asset, in degrees

property fovV : float

Vertical field of view covered by the asset, in degrees

getPufferSphereMesh : Callable

getSphereMesh : Callable

hasFile() → bool

incrementEditorRefCount() → None

property isExtracted : bool

property maxDepth : float

Maximum depth of the plates in the asset, in metres

null : Self

onPlatesMoved(movedPlateIndices: List[int]) → None

property plates : List[TwoPoint5DPlate]

Array of plates which make up the 2.5D scene

property platesSortedAction : Action

renderPreview(resolution: Vec2, renderInGuiSpace: bool) → DxTexture

sceneAspect() → float

class d3.TwoPoint5DFile

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.TwoPoint5DModule

Bases: Module

property asset : TwoPoint5DAsset

Asset containing the 2.5D scene to be rendered

property assetChangedAction : Action

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.TwoPoint5DPlate

Bases: Display

Backplate : Final

Frontplate : Final

OffStage : Final

OnStage : Final

SetExtensionAddition : Final

SetExtensionMask : Final

decrementEditorRefCount() → None

property depthMapMean : float

getPufferSphereMesh : Callable

getSphereMesh : Callable

incrementEditorRefCount() → None

property layerStack : LayerStack

Layer stack containing the media to display on the plate

matchScaleToResolutionAspect() → None

null : Self

property offsetRatios : Vec

renderPreview() → DxTexture

property scaleRatios : Vec

property scaleWithDepth : bool

Scale the plate as depth is changed to maintain the view from the origin

class d3.TwoPoint5DSystem

Bases: Subsystem

null : Self

class d3.UVLookupModule

property contentSource : ContentSource

duplicateName : Callable

duplicatePath : Callable

property lookupSource : ContentSource

null : Self

property uvEncoding : int

The method in which the UV coordinates are encoded in the RGBA lookup source

class d3.UdpDevice

Bases: ControlDevice

property IP_Address : str

null : Self

property port : int

class d3.UdpIndirectionController

Bases: KeyedListIndirectionController

duplicateName : Callable

duplicatePath : Callable

property filterToIp : str

Specify that only messages from this IP should be listened to or leave blank to receive messages from any IP

null : Self

property port : int

class d3.UdpReceiverDriver

property Port : int

duplicateName : Callable

duplicatePath : Callable

property ipFromFilter : str

Filter by sender IP. Leave blank for any IP.

None_ : Final = 0

NormalisedColourChannel : Final = 4

property UnitType : int

null : Self

class d3.UnrealEngineDefinition

Bases: EngineDefinition

fetchAllRegisteredEngineIdentifiers : Callable

null : Self

class d3.UnrealEngineSettings

Bases: EngineSettings

property configFilename : str

Specific nDisplay config to use, for example with mesh policy
Value is the filename excluding the extension and should be placed in the folder
renderstream_workloadsunreal<asset_name><asset_name>

property ddcPath : str

Extra command line arguments to launch the asset with.

property enableEngineSynchronisation : bool

Use one large ndisplay cluster to ensure scene animation is kept in sync across render nodes.
Note: disguise controlled parameters are always applied in sync.
Note: disguise cannot guarantee all features synchronise correctly - this is an engine feature.

property enableUnrealWindow : bool

Show unreal window on render node, otherwise hidden.
Workload must be restarted before this takes effect.
Should only be used for debugging

property multiUserHost : str

Unreal multi-user server hostname.

property multiUserSessionName : str

Unreal multi-user session name to connect to.

null : Self

property useMultiUserEdit : bool

Appends CLI arguments to enable multi-user mode in Unreal.

class d3.UnrealEngineSettingsResource

Bases: EngineSettingsResource

duplicateName : Callable

duplicatePath : Callable

null : Self

null : Self

property userName : str

class d3.UserSetList

null : Self

class d3.VClass

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property i : int

null : Self

property rp1 : VClass

property rp2 : VClass

property str : str

property str2 : <property object at 0x00000117BBD54810>

class d3.VFCDevice

Bases: Resource

COLOUR_FMT_422 : Final = 2

COLOUR_FMT_444 : Final = 1

COLOUR_FMT_AUTO : Final = 5

COLOUR_FMT_RGB : Final = 0

COLOUR_FMT_RGB_LIMITED : Final = 4

GEN_ONE : Final = 0

GEN_TWO : Final = 1

MODEL_HDMI : Final = 4

MODEL_IP : Final = 5

MODEL_NO_VFC : Final = 0

MODEL_PASSTHROUGH : Final = 1

MODEL_QUAD_DVI : Final = 2

MODEL_QUAD_SDI : Final = 3

SLOTTYPE_BLANK_PLATE : Final = 3

SLOTTYPE_DIRECT : Final = 1

SLOTTYPE_GUI : Final = 0

SLOTTYPE_PLUGGABLE : Final = 2

SPLIT_DUAL : Final = 1

SPLIT_MIRROR : Final = 0

SPLIT_QUAD : Final = 2

SPLIT_QUAD_4K : Final = 3

VID_OUT_SDI : Final = 1

VID_OUT_ST2110 : Final = 0

property activePortConfigs : List[VFCPortConfig]

property colourFormat : int

duplicateName : Callable

duplicatePath : Callable

property emulateEDID : int

Always - Emulated EDID always, even when no display is connected
If Connected - Emulate EDID only when a display is connected to the output
Unmanaged - Do not modify current EDID emulation
Force Off - Do not emulate EDID, remove existing if set

getOrCreateIPNetNVMConfig(itf: int) → VFCIPNetConfig

property model : int

property modelString : str

property nActivePorts : int

property networkConfigEth : List[VFCIPNetConfig]

property networkConfigNVMEth : List[VFCIPNetConfig]

null : Self

onSplitModeChanged : Callable

property outputResolution : Int2

property portConfigs : List[VFCPortConfig]

property portsLayout : Int2

property slotType : int

property splitMode : int

property splitModeString : str

property subSampling : int

updateOutputResolution() → None

property videoOutputMode : int

class d3.VFCDeviceMap

Bases: Resource

property devices : List[VFCDevice]

duplicateName : Callable

duplicatePath : Callable

getSlotOrder() → List[int]

null : Self

class d3.VFCFpgaVersion

class d3.VFCFpgaVersion(arg0: int, arg1: int, arg2: int)

class d3.VFCFpgaVersion(v: VFCFpgaVersion)

Bases: _BlipValue

null : Self

toString() → str

class d3.VFCIPNetConfig

Bases: Resource

property dns : str

property domain : str

duplicateName : Callable

duplicatePath : Callable

property gw : IPAddress

property host : str

property ip : IPAddress

property mask : IPAddress

property networkMode : int

null : Self

class d3.VFCPortConfig

Bases: Resource

AUTO : Final = 3

BT_2020 : Final = 2

BT_601 : Final = 0

BT_709 : Final = 1

HLG : Final = 1

INTERLACED : Final = 0

PQ : Final = 2

PROGRESSIVE : Final = 1

QUAD_DIVISION_INTERLEAVED : Final = 1

QUAD_DIVISION_SQUARE : Final = 0

SDR : Final = 0

SMPTE_INVALID : Final = 0

TIMING_AUTO : Final = 0

TIMING_CVT : Final = 2

TIMING_CVT_RB : Final = 3

TIMING_CVT_RB_V2 : Final = 4

TIMING_SMPTE : Final = 1

Unspecified : Final = 3

property colourConversion : int

property dualLink : bool

duplicateName : Callable

duplicatePath : Callable

property fsStart : int

getOrCreateTxIPDestination(portIndex: int, itf: int) → VFCTxIPDestination

property interlaced : bool

property matrixInput : str

DVI Matrix input identifier (e.g. “1.1”)

null : Self

property quadDivision : int

property resolution : Int2

property sdiMode : int

property timingMode : int

property transferCharacteristics : int

property txIPDestination : List[VFCTxIPDestination]

class d3.VFCTxIPDestination

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property ip : IPAddress

null : Self

property port : int

property rtpPayloadTypeId : int

class d3.VRSettings

Bases: Resource

property camera : Camera

Camera settings for the VR scene

duplicateName : Callable

duplicatePath : Callable

property floor : Object

Select the scene object to use as the floor

property moveSpeed : float

speed at which user ‘walks’ through environment (m/s). Zero means jump immediately

null : Self

property offset : Vec

offset between stage origin and VR frame of reference; modify this to move the stage’s home position relative to the real room

property roomProp : Prop

Prop which represents the room the VR user is standing in

property scale : float

scale factor from real room space to stage space

property yawDegrees : float

rotation (in degrees) around vertical axis of stage relative to VR frame of reference; modify to set the orientation of the stage relative to the real room

class d3.VRSystem

Bases: Subsystem

hasHMD() → bool

property leftEyeTarget : DxTexture

null : Self

resetPosition() → None

property rightEyeTarget : DxTexture

property settings : VRSettings

class d3.VRUser

Bases: Object

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

class d3.ValueBox(x, *args, **kwargs)

Bases: Widget

addResourcePropertyPair(container: Resource, prop: ValueBoxProperty) → ValueBox

property alwaysSet : bool

property attention : bool

property changeAction : Action

closeObjectView() → None

property containingResource : Resource

property customPropertyExpression : str

focusedWidget : Callable

getExpression() → str

getHelpText() → str

getObjectView() → ObjectView

getVal() → ReflectionValue

property highlight : bool

insertResource(t: float, ks: KeyContainer) → None

property isOption : bool

property isOptionValid : bool

property isResource : bool

isSupportedType : Callable

limits(minLimit: float, maxLimit: float) → ValueBox

makeObjectView(pos: Vec2, keepFocusOnSearchBox: bool) → ObjectView

maybe(not_: str) → ValueBox

property metaField : MetaField

null : Self

property onReadOverride : Callable

property onSelectOverride : Callable

Edit the object

property openValueOptionsAction : ParamAction

property openValueOptionsOverride : Callable

property optionListElementCallback : ParamAction

property optionsStrings : List[str]

property optionsValues : List[int]

property property_ : ValueBoxProperty

readValue() → None

property readonly : bool

restrictContentsToSubClassesOf(baseClass: ClassNode) → None

selectValue() → None

Select the value and begin editing

set(container: Resource, prop: ValueBoxProperty) → ValueBox

setCustomResourceAndExpression(resource: Resource, expression: str) → None

setOptions(strings: List[str]) → None

setOptionsWithValues(strings: List[str], values: List[int]) → None

setVal(val: ReflectionValue) → bool

step(s: float) → ValueBox

property textBox : TextBox

property type : Type

property typeName : str

uiTransparencyDisabled : Callable

class d3.ValueBoxProperty(arg0: ValueBoxProperty)

class d3.ValueBoxProperty(arg0: str, arg1: Callable, arg2: Callable)

class d3.ValueBoxProperty(arg0: str, arg1: Callable, arg2: Callable, arg3: Type)

class d3.ValueBoxProperty(arg0: str, arg1: Callable, arg2: Callable, arg3: ReflectionValue, arg4: ReflectionAttributeContainer)

Bases: _BlipValue

attributes() → ReflectionAttributeContainer

field() → FieldInfo

getter() → Callable

property name : str

null : Self

object() → ReflectionValue

property_() → PropertyInfo

setter() → Callable

property type : Type

class d3.ValueRange(arg0: ValueRange)

Bases: _BlipValue

property min : float

null : Self

rangeSpan() → float

class d3.VariableVideoModule

property acesExposure : float

Input exposure transform (stops)

property acesGamma : float

Input gamma transform

property at_end_point : int

property bottom : float

property cdl : CDL

ASC CDL format colour grading in Slope, Offset, Power and Saturation controls. (ACES/OCIO)

property clipEndFrame : int

property clipLoopEndFrame : int

property clipLoopStartFrame : int

property clipNFrames : int

property clipStartFrame : int

property colour_shift : ColourShift

property cropSoftness : float

Enables a vignette effect by softening the edges of the crop

duplicateName : Callable

duplicatePath : Callable

property frameNumberDisplay : int

property left : float

property mode : int

null : Self

property ocioContrast : float

Input contrast transform

property ocioExposure : float

Input exposure transform (stops).

property ocioGamma : float

Imput gamma transform

property ocioShaderProperties : OcioShaderProperties

property output : LogicalAudioOutDevice

property pos : Vec2

property right : float

property rotation : float

property scale : Vec2

property size : float

property speed : float

property top : float

property transition_time : float

property video : VideoClip

property volume : float

class d3.VariableVideoTransitionModule

Bases: VariableVideoModule

property bias : float

duplicateName : Callable

duplicatePath : Callable

property mix_hardness : float

null : Self

property source0 : ContentSource

property source1 : ContentSource

class d3.Vec

class d3.Vec(_x: float, _y: float)

class d3.Vec(_x: float, _y: float, _z: float)

class d3.Vec(v: Vec2)

class d3.Vec(v: Vec)

Bases: _BlipValue

angles() → Vec

cross(v: Vec) → Vec

dot(v: Vec) → float

length() → float

property maxComponent : float

property minComponent : float

modulo(v: Vec) → Vec

normalise() → Vec

null : Self

restrict(min: Vec, max: Vec) → Vec

round(v: Vec) → Vec

vmax(v: Vec) → Vec

vmin(v: Vec) → Vec

property x : float

property y : float

property z : float

class d3.Vec2

class d3.Vec2(v: Vec2)

class d3.Vec2(v: Int2)

class d3.Vec2(v: Vec)

class d3.Vec2(_x: float, _y: float)

Bases: _BlipValue

abs() → Vec2

angle() → float

aspect() → float

dot(v: Vec2) → float

length() → float

property maxComponent : float

property minComponent : float

normalise() → Vec2

null : Self

restrict(min: Vec2, max: Vec2) → Vec2

rotate(a: float) → Vec2

round(f: float) → Vec2

vmax(v: Vec2) → Vec2

vmin(v: Vec2) → Vec2

property x : float

property y : float

class d3.Vec2Box(x, *args, **kwargs)

Bases: ValueBox

Bases: Object

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

property props : List[Prop]

List of prop objects (including buildings, people and props)

class d3.Vert

Bases: _BlipValue

property binormal : Vec

property colour : Col

property inode : int

property normal : Vec

null : Self

property pos : Vec

property tangent : Vec

property texCoord : Vec2

property texCoord2 : Vec2

property texCoord3 : Vec2

class d3.VertNormalVisualiser

Bases: _BlipValue

null : Self

class d3.VertScrollBar2(*args, **kwargs)

Bases: ScrollBar

focusedWidget : Callable

mouseDragBar(state: int, startPos: Vec2, pos: Vec2) → None

Move the scrollbar to the desired location

mouseScrollPage() → None

Move the scrollbar by one page towards the cursor

null : Self

uiTransparencyDisabled : Callable

class d3.VertexNormalComputeMaterial(*args)

Bases: DxMaterial

addMtl : DxMaterial

alphaMtl : DxMaterial

multMtl : DxMaterial

null : Self

overMtl : DxMaterial

class d3.ViconDataStreamDriver

duplicateName : Callable

duplicatePath : Callable

property ipEndpoint : IPEndpoint

IP address and port to connect to

null : Self

class d3.VideoAsset

Bases: Resource

add(file: VideoFile, version: str, region: str, proxyLevel: int, replaceFrames: bool, iFrame: int, force: bool) → bool

property audioSampleRate : float

Maximum number of bits per channel

property bitDepth : int

Bit depth of the original video (in Bits)

property codec : str

Codec of the original video

duplicateName : Callable

duplicatePath : Callable

enableFragment(frag: VideoFragment, enabled: bool) → None

fileToAssetData : Callable

property fps : float

property fragments : List[VideoFragment]

property hasAlpha : bool

property hasAudio : bool

hasMultipleFragments() → bool

insert(frag: VideoFragment) → None

moveFragment(srcIndex: int, destIndex: int) → None

property nFrames : int

null : Self

property proxyInfo : str

property regionSet : VideoRegionSet

remove(remFile: VideoFragment) → None

property resolution : Vec2

updateFileStatus() → None

class d3.VideoClip

Bases: Resource

property Video_Input : LogicalVideoInDevice

property acesExposure : float

Input exposure transform (stops)

property acesGamma : float

Input gamma transform

property acesTransform : AcesInputTransformParameters

ACES Input transform (IDT)

property audioBiasSec : float

If multi-channel audio files are not synchronised correctly, adjust this value to delay (-ve) or advance (+ve) audio relative to video

property audioOuts : AudioOutputs

set up the audio outputs used for each channel by creating a new AudioOut object, setting its outputs, and then sharing between all clips needing that configuration

property audioTracks : List[AudioTrack]

Additional audio tracks will play synchronously with the video clip, to logical audio outputs 0, 1, 2, etc

property bilinear_filtering : int

Set to ‘on’ if the video file should be bilinear filtered when scaled; otherwise, uses point-samping

property bottom : int

Amount to crop from the bottom edge of the video frame, in pixels

property clip : Rect

property clip_type : int

Controls how the video file is scaled to fit the canvas size

property colourProfile : ColourProfile

Colour/Gamma space of the video clip

property colourShift : ColourShift

Colour parameters for video file

consolidateAllClips : Callable

createVideoInClip : Callable

property dataRate : float

Data rate of the clip playback (MB/sec)

duplicateName : Callable

duplicatePath : Callable

property end : int

End frame index of the video clip. Use this to trim frames from the end of the clip

property file : VideoAsset

Select video asset

property fileFps : float

FPS of the original video

property fileFrameSize : Vec2

Resolution of the original video file (pixels)

property fileNFrames : int

Number of frames in the original video file

property fps : float

Current frames-per-second of the video clip

property frame_blending : int

Set to ‘on’ if the video file should be frame-blended for smoothness. Use this when playback frame-rate is different to original frame rate

property in_ : int

Loop in-point of the video clip

property isVideoIn : bool

property left : int

Amount to crop from the left edge of the video frame, in pixels

property logicalVideoIn : LogicalVideoInDevice

property nBeats : float

If quantised, the video file will play over this number of beats

null : Self

property ocioShaderProperties : OcioShaderProperties

Available OCIO transform parameters for a given colour space.

property ocioTransform : OcioColourSpace

OCIO colour space of the clip

property out : int

Loop out-point of the video clip

property prefetchOptions : PrefetchLookaheads

edit these settings if the clip isn’t playing well. Usually only required for very large clips

Type:
Advanced

property quantised : int

If set to ‘yes’, the video file will play over a specified number of beats, rather than at defined frame rate

property right : int

Amount to crop from the right edge of the video frame, in pixels

property sampleRateOption : int

property speed : float

property start : int

Start frame index of the video clip. Use this to trim frames from the start of the clip

property top : int

Amount to crop from the top edge of the video frame, in pixels

property video_file : VideoAsset

Select video asset

property zoom : Vec2

The point of interest zoomed in towards when the content is scaled

property zoom_point : Vec2

class d3.VideoFile

Bases: Resource

property bitDepth : int

duplicateName : Callable

duplicatePath : Callable

property info : VideoInfo

property ingestionDate : DateStamp

property ingestionDateLocal : DateStamp

property nFrames : int

null : Self

relockFile() → None

unlockFile() → None

class d3.VideoFileHeader

Bases: Resource

property audioBigEndian : bool

Whether the file’s audio is big-endian

property audioSampleRate : float

Audio sample rate of the file

property bitsPerPixel : int

Bits per pixel of the video frame

property codec : str

Codec of the file

duplicateName : Callable

duplicatePath : Callable

property fps : float

Number of frames per second

property gpuBpp : int

property gpuHeight : int

property gpuWidth : int

property hasAlpha : bool

Whether the file has an alpha channel

property hasAudio : bool

Whether the file has an audio track

property height : int

Height of the video frame (pixels)

property nFrames : int

Number of frames in the file

null : Self

property width : int

Width of the video frame (pixels)

class d3.VideoFormat

Bases: _BlipValue

null : Self

property transportType : int

class d3.VideoFragment

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property effectiveLengthFrames : int

property enabled : bool

findVideoFile(proxyLevel: int) → VideoFile

property iReplacedFrame : int

property isFrameReplacement : bool

isNewerThan(version: str) → bool

property nReplacedFrames : int

null : Self

property proxies : List[VideoFile]

property proxyInfo : str

property proxyMask : int

property region : str

property version : str

class d3.VideoFrame

Bases: _BlipValue

null : Self

class d3.VideoIn

Bases: _BlipValue

field(iFromMostRecent: int) → InterlacedField

property formatChangedAction : Action

getCurrentFrame(deinterlaceMethod: int) → DxTexture

getPreviewFrame(deinterlaceMethod: int, size: Int2) → DxTexture

property hardwareId : str

property hardwareIds : List[str]

property isInitialised : bool

property name : str

null : Self

redoLastFrameReceivedAction() → None

requestFrame(requestDurationFrames: int) → None

property videoInFormat : VideoInFormat

class d3.VideoInCaptureProcess

Bases: Resource

abort() → None

property aborted : bool

property cameras : List[Camera]

property captureOperation : int

Set this to ‘Write’ to record captured images to disk, ‘Read’ to get captures from recorded images

duplicateName : Callable

duplicatePath : Callable

property iReadFolder : int

Selects the folder to read pre-captured stage images from

property mixedRealitySets : List[MixedRealitySet]

Which mixed reality sets need to be calibrated for this camera

null : Self

property onStopAction : Action

property progress : float

run() → None

property running : bool

class d3.VideoInCaptureSystem

Bases: Subsystem

get : Callable

null : Self

property readSources : List[str]

runProcess(process: VideoInCaptureProcess) → None

class d3.VideoInDeviceMap

Bases: DeviceMap

duplicateName : Callable

duplicatePath : Callable

getLogicalDevices : Callable

null : Self

class d3.VideoInFormat

Bases: Resource

duplicateName : Callable

duplicatePath : Callable

property framerate : float

property interlaced : bool

make : Callable

property name : str

null : Self

property pixelFormat : str

property resolution : Vec2

class d3.VideoInMetrics

Bases: _BlipValue

null : Self

class d3.VideoInSystem

Bases: Subsystem

property autoMappedChannels : List[ChannelInfo]

property captureGroupsAvailable : bool

findVideoIn(hardwareId: str) → VideoIn

getHardwareIds(hardwareId: str) → List[str]

property inputChannels : List[ChannelInfo]

makeMultiviewVideoInHardwareId(sourceHardware: HardwareIdentifier, roi: Rect) → HardwareVideoInIdentifier

makeTeamedVideoInHardwareId(hardwareIds: List[str]) → HardwareVideoInIdentifier

null : Self

property updateMappedDeviceFormatsAction : Action

class d3.VideoInTexture

Bases: PreCompTexture

null : Self

property videoIn : LogicalVideoInDevice

class d3.VideoInThread

Bases: Thread

null : Self

class d3.VideoInfo

Bases: ImageSequenceInfo

property audioBigEndian : bool

property audioSampleRate : float

property hasAudio : bool

null : Self

class d3.VideoModule

property at_end_point : int

property bottom : float

property colour_shift : ColourShift

property cropSoftness : float

Enables a vignette effect by softening the edges of the crop

property currentFrame : float

duplicateName : Callable

duplicatePath : Callable

property left : float

property mode : int

null : Self

property output : LogicalAudioOutDevice

property pos : Vec2

property right : float

property rotation : float

property scale : Vec2

property size : float

property speed : float

property top : float

property transition_time : float

property video : VideoClip

property volume : float

class d3.VideoMonitor(*args, **kwargs)

Bases: Widget

focusedWidget : Callable

null : Self

set() → VideoMonitor

duplicateName : Callable

duplicatePath : Callable

null : Self

property regions : List[VideoRegion]

class d3.VideoRegions

Bases: _BlipValue

property canvasSize : Vec2

null : Self

property uvRectangles : List[Rect]

class d3.VideoSampler

Bases: Device

property device : int

duplicateName : Callable

duplicatePath : Callable

property format : int

null : Self

class d3.VideoStitcher

Bases: Subsystem

get : Callable

getFrameMaterial(asset: VideoAsset, iFrame: int, regions: VideoRegions) → Material

getFrameTexture(asset: VideoAsset, iFrame: int, regions: VideoRegions) → DecodedFrame

getFrameTextureBestAvailable(asset: VideoAsset, iFrame: int, regions: VideoRegions) → DecodedFrame

null : Self

requestVideo(asset: VideoAsset, iFrame: int, regions: VideoRegions, tDeadline: float, priority: int) → None

class d3.VideoTransitionModule

Bases: VideoModule

property bias : float

duplicateName : Callable

duplicatePath : Callable

property mix_hardness : float

null : Self

property source0 : ContentSource

property source1 : ContentSource

class d3.VideoTriggerModule

property bottom : float

property colour_shift : ColourShift

duplicateName : Callable

duplicatePath : Callable

property left : float

null : Self

property pos : Vec2

renderPreview(drawRect: Rect, colour: Colour, showAlpha: bool, inGuiColourSpace: bool) → None

property right : float

property rotation : float

property scale : Vec2

property size : float

property speed : float

property top : float

property trigger : float

property triggerDelay : int

property triggerMode : int

property video : VideoClip

class d3.Viewer

Bases: Object

duplicateName : Callable

duplicatePath : Callable

getPufferSphereMesh : Callable

getSphereMesh : Callable

null : Self

property status : int

class d3.VirtualCamera

Bases: Camera

INTRINSICS_FROM_PARENT : Final = 2

LOCAL_INTRINSICS : Final = 0

ZOOM_FROM_PARENT : Final = 1

property coordSystemDisplay : int

property lensSource : int

localVisualiserCamera : Callable

property maxZoomInFactor : float

Maximum factor the camera can zoom in by before using purely virtual content, to avoid excessive pixellation

null : Self

property objectPositionReference : Object

Object used as a reference for the average position of real objects on the stage.
Used to calculate virtual camera viewpoints.

property outputType : int

property parentCamera : Camera

Camera used as source for reprojection.

property posRelativeOrGlobal : Vec

property relativePosition : Vec

property relativeRotation : Vec

property rotRelativeOrGlobal : Vec

property sphericalImpl : SphericalCameraImpl

property zoomScale : float

Zoom scaling to be applied to the parent camera.

class d3.VirtualCameraCommunication(arg0: List[OptiCalCameraPlan])

Bases: CameraCommunication

null : Self

class d3.VirtualCameraPosition

Bases: CameraPosition

property animateZoomScale : bool

When ticked, animate the zoom scale relative to the parent camera. When unticked, animate the global field of view.

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.VirtualLineupModule

Bases: TestPatternModule

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.ViscaCamera

Bases: CameraDevice

property address : int

property cameraModel : int

Select the type of camera that supports the VISCA protocol.

property control_device : ControlDevice

null : Self

class d3.VisibilityProxyLevels

Bases: _BlipValue

null : Self

class d3.VisualActDriver

duplicateName : Callable

duplicatePath : Callable

null : Self

class d3.VisualActTrackerState