---
title: "PrivateState"
description: "API documentation for PrivateState"
url: https://developer.disguise.one/python-api/docs/privatestate/
---

# PrivateState

See also: [Utility Guide](/plugins/guides/utility)

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

## Properties

#### **activeVisualiserCamera** : _[Camera](/python-api/docs/camera#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](/python-api/docs/feedviewsettings#feedviewsettings)_

#### **gizmoCoordinateSpace** : _[CoordinateSpace](/python-api/docs/coordinatespace#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](/python-api/docs/timestep#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](/python-api/docs/manipulator3dtype#manipulator3dtype)_

#### **manipulatorWidgetPos** : _[Vec2](/python-api/docs/vec2#vec2)_

#### **measurementUnit** : _int_

_Options: {0: ‘Metric’, 1: ‘Imperial’}  
UserName: Measurement unit_

#### **networkWidgetPos** : _[Vec2](/python-api/docs/vec2#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](/python-api/docs/vec2#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](/python-api/docs/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](/python-api/docs/waveformmode#waveformmode)_

## Variables

#### **EightBit** : _Final\[[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)\]_ = DisplayValueAs.EightBit

#### **FifteenFrames** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.FifteenFrames

#### **FifteenSeconds** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.FifteenSeconds

#### **FiveFrames** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.FiveFrames

#### **FiveSeconds** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.FiveSeconds

#### **GuiState** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.GuiState

#### **Max** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.Max

#### **Normalised** : _Final\[[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)\]_ = DisplayValueAs.Normalised

#### **OneFrame** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.OneFrame

#### **OneSecond** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.OneSecond

#### **Percentage** : _Final\[[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)\]_ = DisplayValueAs.Percentage

#### **TenFrames** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.TenFrames

#### **TwoSeconds** : _Final\[[TimeStep](/python-api/docs/timestep#timestep)\]_ = TimeStep.TwoSeconds

## Methods

#### **addRename**(self, rename: _str_)

#### **brightnessDisplayOption**(self) -> _[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)_

#### **clearCurrentStageSelection**(self)

#### **colourDisplayOption**(self) -> _[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)_

#### **expand**(self, groupLayerID: _int_, expanded: _bool_)

#### **getCurrentActiveVisualiserCamera**(self) -> _[Camera](/python-api/docs/camera#camera)_

#### **getCurrentStageSelection**(self) -> _List\[[Object](/python-api/docs/object#object)\]_

#### **isExpanded**(self, groupLayerID: _int_) -> _bool_

#### **isZoomLevelEnabled**(self, ts: _int_) -> _bool_

Check if a zoom level is enabled

#### **lastSeen**(self, noteUid: _int_) -> _[DateStamp](/python-api/docs/datestamp#datestamp)_

#### **loudnessDisplayOption**(self) -> _[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)_

#### **markSeen**(self, noteUid: _int_, timestamp: _[DateStamp](/python-api/docs/datestamp#datestamp) | [FilesystemDateStamp](/python-api/docs/filesystemdatestamp#filesystemdatestamp)_)

#### **onObjectRemovedFromStage**(self, removedObjects: _List\[[Object](/python-api/docs/object#object)\]_)

#### **outputMovieExtension**(self) -> _str_

#### **screenShotExtension**(self) -> _str_

#### **screenShotTextureFormat**(self) -> _[ExtendedTextureFormat](/python-api/docs/extendedtextureformat#extendedtextureformat)_

#### **setCurrentStageSelection**(self, stageSelection: _List\[[Object](/python-api/docs/object#object)\]_)

#### **toggleZoomLevel**(self, ts: _int_)

Toggle a zoom level on/off

## Static Methods

#### **canMakeLargeMovies**() -> _bool_

#### **getValueRange**(displayValueAs: _[DisplayValueAs](/python-api/docs/displayvalueas#displayvalueas)_) -> _[ValueRange](/python-api/docs/valuerange#valuerange)_

#### **isOutputMovieResolutionSupported**(size: _[Vec2](/python-api/docs/vec2#vec2) | [Int2](/python-api/docs/int2#int2) | [Vec](/python-api/docs/vec#vec)_) -> _bool_

#### **privateState**() -> _[PrivateState](/python-api/docs/privatestate#privatestate)_