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

# DmxScreen

See also: [Stage Guide](/plugins/guides/stage)

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

## Properties

#### **always\_show\_channels** : _int_

_Options: {0: ‘No’, 1: ‘Yes’}  
Category: Addressing  
UserName: Always show channels_

#### **amberCompensation** : _float_

Adjustment of amber component output

_Category: Output  
UserName: Amber Compensation_

#### **array** : _int_

The addressing order of the pixels - either Horizontal or Vertical

_UserName: Array_

#### **channels** : _List\[int\]_

Displays the DMX channel assignment in the visualiser

_UserName: Channels_

#### **fixtureType** : _[DmxFixtureType](/python-api/docs/dmxfixturetype#dmxfixturetype)_

DMX channel layout

_Category: Addressing  
UserName: DMX fixture type_

#### **iChannel** : _int_

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

_Category: Addressing  
UserName: Channel_

#### **luminance** : _float_

Light output (NITS); only affects visualiser

_Category: Appearance  
UserName: Brightness (NITS)_

#### **neutral\_white** : _[Colour](/python-api/docs/colour#colour)_

_Category: Addressing  
UserName: Neutral White_

#### **origin** : _int_

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

_UserName: Origin_

#### **personalities** : _List\[[SockpuppetPersonality](/python-api/docs/sockpuppetpersonality#sockpuppetpersonality)\]_

#### **status\_\_** : _int_

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

_Options: {0: ‘Mute’, 1: ‘Active’}  
Category: Addressing  
UserName: Status_

#### **table** : _[Table](/python-api/docs/table#table)_

DMX Screens only support comma-separated tables with 4 columns

#### **universe** : _int_

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

_Category: Addressing  
UserName: Universe_

#### **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

_UserName: Universe size_

#### **universe\_step** : _int_

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

_UserName: Universe step_

#### **whiteCompensation** : _float_

Adjustment of white component output

_Category: Output  
UserName: White Compensation_

## Methods

#### **assignString**(self, iArraySelect: _int_, channel: _int_, nFixtures: _int_, direction: _int_, highlightOnly: _bool_)

#### **channel**(self, iArray: _int_) -> _int_

#### **displayChannels**(self, onOff: _bool_)

#### **hasAmberChannel**(self) -> _bool_

#### **hasWhiteChannel**(self) -> _bool_

#### **iArraySelect**(self) -> _int_

#### **isTableMalformed**(self) -> _bool_