PrivateState
Properties
activeVisualiserCamera : Camera
animationMovieType : int
Options: {0: ‘CSV’, 1: ‘FBX’, 2: ‘FBX ASCII’, 3: ‘Collada’}
UserName: Animation movie format
barWidgetInsertTime : float
brightnessDisplay : int
Set UI representation of brightness
Options: {0: ‘Normalised’, 1: ‘Percentage’, 2: ‘8-Bit’}
colourDisplay : int
Set UI representation of colour
Options: {0: ‘Normalised’, 1: ‘Percentage’, 2: ‘8-Bit’}
defaultLookLengthSec : float
Defines the default length of new Looks (in seconds)
defaultTrackLengthSec : float
Defines the default length of new Tracks (in seconds)
disableKeyFrameEditorFilmStrip : bool
Turn off key frame editor film strip for extra performance
UserName: Disable key frame editor film strip
disableUITransparency : bool
Turn off transparency on UI windows for extra performance
UserName: Disable UI transparency
doNotConfirmLayerRenames : bool
enabledZoomLevels : List[int] (Read-Only)
Get the list of enabled zoom levels
feedViewSettings : FeedViewSettings
gizmoCoordinateSpace : CoordinateSpace
guiDpiScale : int
DPI scale for the GUI.
Options: {0: ‘Default’, 1: ‘100%’, 2: ‘125%’, 3: ‘150%’, 4: ‘175%’, 5: ‘200%’, 6: ‘225%’, 7: ‘250%’}
UserName: DPI scale
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.
Options: {0: ‘1’, 1: ‘1/2’, 2: ‘1/3’}
UserName: Framerate fraction
guiTimeStep : TimeStep
Get or set the current GUI time step (zoom level)
isStageManipulationEnabled : bool
loudnessDisplay : int
Set UI representation of volume
Options: {0: ‘Normalised’, 1: ‘Percentage’, 2: ‘8-Bit’}
manipulator3D : Manipulator3DType
manipulatorWidgetPos : Vec2
measurementUnit : int
Options: {0: ‘Metric’, 1: ‘Imperial’}
UserName: Measurement unit
networkWidgetPos : Vec2
outputMovieType : int
Options: {0: ‘Photo-JPEG (no audio)’, 1: ‘Animation (no audio)’, 2: ‘MPEG-4 (with audio)’, 3: ‘Photo-JPEG mov (OLD QuickTime players)’, 4: ‘HAP (no audio)’, 5: ‘DPX image sequence (no audio)’, 6: ‘WEBM vp9 (audio as Vorbis output)’}
UserName: Output movie format
output_movie_bitrate : int
Set to 0 for d3 to use it’s best guess per-codec
UserName: Bitrate (Kb)
output_movie_extra_time_head : float
UserName: Add head to output movie (seconds)
output_movie_extra_time_tail : float
UserName: Add tail to output movie (seconds)
output_movie_fps : float
UserName: Output movie FPS
output_movie_quality : int
Only affects webm
Options: {0: ‘Balanced’, 1: ‘Best’, 2: ‘Fast’}
UserName: Quality
output_movie_size : Vec2
UserName: Stage movie size
password : str
UserName: Password
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.
UserName: Persistent key widgets
recentLayerRenames : List[str]
screenshot_format : int
Options: {0: ‘JPEG’, 1: ‘BMP’, 2: ‘PNG’, 3: ‘TIF’, 4: ‘DPX’, 5: ‘EXR’}
UserName: Output format
searchOrder : SearchOrder
shiftFocusToTimelineOnJump : bool
If enabled, when jumping to a cue from the Cue List, move keyboard focus to the timeline. Otherwise, keep focus on the Cue List.
UserName: Shift focus to timeline on jump
stageSelection : List[int]
stickyState : str
tooltipOption : int
Options: {0: ‘Only When F1 Pressed’, 1: ‘After 1 Second’, 2: ‘After 2 Seconds’, 3: ‘After 3 Seconds’}
UserName: Tooltips
waveformMode : WaveformMode
Variables
EightBit : Final[DisplayValueAs] = DisplayValueAs.EightBit
FifteenFrames : Final[TimeStep] = TimeStep.FifteenFrames
FifteenSeconds : Final[TimeStep] = TimeStep.FifteenSeconds
FiveFrames : Final[TimeStep] = TimeStep.FiveFrames
FiveSeconds : Final[TimeStep] = TimeStep.FiveSeconds
GuiState : Final[TimeStep] = TimeStep.GuiState
Max : Final[TimeStep] = TimeStep.Max
Normalised : Final[DisplayValueAs] = DisplayValueAs.Normalised
OneFrame : Final[TimeStep] = TimeStep.OneFrame
OneSecond : Final[TimeStep] = TimeStep.OneSecond
Percentage : Final[DisplayValueAs] = DisplayValueAs.Percentage
TenFrames : Final[TimeStep] = TimeStep.TenFrames
TwoSeconds : Final[TimeStep] = TimeStep.TwoSeconds
Methods
addRename(self, rename: str)
brightnessDisplayOption(self) -> DisplayValueAs
clearCurrentStageSelection(self)
colourDisplayOption(self) -> DisplayValueAs
expand(self, groupLayerID: int, expanded: bool)
getCurrentActiveVisualiserCamera(self) -> Camera
getCurrentStageSelection(self) -> List[Object]
isExpanded(self, groupLayerID: int) -> bool
isZoomLevelEnabled(self, ts: int) -> bool
Check if a zoom level is enabled
lastSeen(self, noteUid: int) -> DateStamp
loudnessDisplayOption(self) -> DisplayValueAs
markSeen(self, noteUid: int, timestamp: DateStamp | FilesystemDateStamp)
onObjectRemovedFromStage(self, removedObjects: List[Object])
outputMovieExtension(self) -> str
screenShotExtension(self) -> str
screenShotTextureFormat(self) -> ExtendedTextureFormat
setCurrentStageSelection(self, stageSelection: List[Object])
toggleZoomLevel(self, ts: int)
Toggle a zoom level on/off