disguise developers

Python API

Execute Python code in Designer sessions to control and query projects programmatically.

UnrealEngineSettings

Properties

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_workloads\unreal\<asset_name>\<asset_name>

UserName: nDisplay config file override

ddcPath : str

Extra command line arguments to launch the asset with.

UserName: Unreal DDC path

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.
Note: This setting is not used by RenderStream Local workloads.

UserName: Engine animation sync

enableUnrealWindow : bool

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

UserName: Enable Unreal window

loggingPreset : int

Controls Unreal log verbosity for RenderStream / nDisplay categories.
‘Off’ suppresses all logging except errors, for maximum performance.
‘Default’ is the standard logging level, including connection / cluster / failover diagnostics.
‘Verbose’ logs maximum detail including per-frame tracing and can reduce FPS on heavy scenes.
Workload must be restarted before this takes effect.

Options: {0: ‘Off’, 1: ‘Default’, 2: ‘Verbose’}
UserName: Workload logging

multiUserHost : str

Unreal multi-user server hostname.

UserName: Multi-user session host

multiUserSessionName : str

Unreal multi-user session name to connect to.

UserName: Multi-user session name

useMultiUserEdit : bool

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

UserName: Enable multi-user edit

Constructors

__init__(self)