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

# Module

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

Subclasses: _[AnimateCamera](/python-api/docs/animatecamera#animatecamera)_, _[AnimateCamera2](/python-api/docs/animatecamera2#animatecamera2)_, _[AnimationModule](/python-api/docs/animationmodule#animationmodule)_, _[AudioModule](/python-api/docs/audiomodule#audiomodule)_, _[BitmapMoveModule](/python-api/docs/bitmapmovemodule#bitmapmovemodule)_, _[BugsModule](/python-api/docs/bugsmodule#bugsmodule)_, _[CameraControlModule](/python-api/docs/cameracontrolmodule#cameracontrolmodule)_, _[ComposeModule](/python-api/docs/composemodule#composemodule)_, _[ControlModule](/python-api/docs/controlmodule#controlmodule)_, _[DVIMatrixControlModule](/python-api/docs/dvimatrixcontrolmodule#dvimatrixcontrolmodule)_, _[DmxControlModule](/python-api/docs/dmxcontrolmodule#dmxcontrolmodule)_, _[DmxShareModule](/python-api/docs/dmxsharemodule#dmxsharemodule)_, _[ExpressionVariablesModule](/python-api/docs/expressionvariablesmodule#expressionvariablesmodule)_, _[FadeModule](/python-api/docs/fademodule#fademodule)_, _[GradientModule](/python-api/docs/gradientmodule#gradientmodule)_, _[HttpControlModule](/python-api/docs/httpcontrolmodule#httpcontrolmodule)_, _[IgnoreTimecodeModule](/python-api/docs/ignoretimecodemodule#ignoretimecodemodule)_, _[IndirectionControl](/python-api/docs/indirectioncontrol#indirectioncontrol)_, _[LookModule](/python-api/docs/lookmodule#lookmodule)_, _[MDCModule](/python-api/docs/mdcmodule#mdcmodule)_, _[MasterModule](/python-api/docs/mastermodule#mastermodule)_, _[MidiNoteModule](/python-api/docs/midinotemodule#midinotemodule)_, _[MtcModule](/python-api/docs/mtcmodule#mtcmodule)_, _[NotchModule](/python-api/docs/notchmodule#notchmodule)_, _[OpenModule](/python-api/docs/openmodule#openmodule)_, _[OscControlModule](/python-api/docs/osccontrolmodule#osccontrolmodule)_, _[PixelMapModule](/python-api/docs/pixelmapmodule#pixelmapmodule)_, _[PlayModeModule](/python-api/docs/playmodemodule#playmodemodule)_, _[PongModule](/python-api/docs/pongmodule#pongmodule)_, _[ProjectionAwareModule](/python-api/docs/projectionawaremodule#projectionawaremodule)_, _[ProjectorControlModule](/python-api/docs/projectorcontrolmodule#projectorcontrolmodule)_, _[Radar](/python-api/docs/radar#radar)_, _[RadarModule](/python-api/docs/radarmodule#radarmodule)_, _[ScanModule](/python-api/docs/scanmodule#scanmodule)_, _[SceneAnimationModule](/python-api/docs/sceneanimationmodule#sceneanimationmodule)_, _[ScreenPositionModule](/python-api/docs/screenpositionmodule#screenpositionmodule)_, _[ScrollModule](/python-api/docs/scrollmodule#scrollmodule)_, _[SpinBitmap](/python-api/docs/spinbitmap#spinbitmap)_, _[StageRenderModule](/python-api/docs/stagerendermodule#stagerendermodule)_, _[StrobeModule](/python-api/docs/strobemodule#strobemodule)_, _[SuperResolutionModule](/python-api/docs/superresolutionmodule#superresolutionmodule)_, _[Target2Module](/python-api/docs/target2module#target2module)_, _[TargetModule](/python-api/docs/targetmodule#targetmodule)_, _[TargetObjectModule](/python-api/docs/targetobjectmodule#targetobjectmodule)_, _[TestPatternModule](/python-api/docs/testpatternmodule#testpatternmodule)_, _[TextModule](/python-api/docs/textmodule#textmodule)_, _[TimecodeReadoutModule](/python-api/docs/timecodereadoutmodule#timecodereadoutmodule)_, _[TrackJumpModule](/python-api/docs/trackjumpmodule#trackjumpmodule)_, _[TrackModule](/python-api/docs/trackmodule#trackmodule)_, _[TrackingMarkerModule](/python-api/docs/trackingmarkermodule#trackingmarkermodule)_, _[TransportBrightnessLocalModule](/python-api/docs/transportbrightnesslocalmodule#transportbrightnesslocalmodule)_, _[TransportControlModule](/python-api/docs/transportcontrolmodule#transportcontrolmodule)_, _[TransportVolumeLocalModule](/python-api/docs/transportvolumelocalmodule#transportvolumelocalmodule)_, _[TriggerModule](/python-api/docs/triggermodule#triggermodule)_, _[TwoPoint5DModule](/python-api/docs/twopoint5dmodule#twopoint5dmodule)_, _[WebModule](/python-api/docs/webmodule#webmodule)_

## Properties

#### **allowOnLayerStack** : _bool_ _(Read-Only)_

Whether this module can be added to a layer stack.

#### **blendMode** : _int_

Controls how the module composites its output with layers below it

_Options: {0: ‘Over’, 1: ‘Alpha’, 2: ‘Add’, 3: ‘Multiply’, 4: ‘Mask’, 5: ‘Multiply-fade’, 6: ‘Multiply-alpha’, 7: ‘Premult-Alpha’, 8: ‘Screen’, 9: ‘Overlay’, 10: ‘Hard Light’, 11: ‘Soft Light’, 12: ‘Colour Burn’, 13: ‘Darken’, 14: ‘Lighten’, 15: ‘Difference’, 16: ‘Exclusion’, 17: ‘Colour Dodge’, 18: ‘Hard Mix’, 19: ‘Over-alpha’, 20: ‘Luma-Matte’, 21: ‘Inv-Luma-Matte’}  
Category: Default  
UserName: Blend mode_

#### **brightness** : _float_

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

_Category: Default  
UserName: Brightness_

#### **canvas** : _[DxTexture](/python-api/docs/dxtexture#dxtexture)_ _(Read-Only)_

#### **canvasSize** : _[Vec2](/python-api/docs/vec2#vec2)_ _(Read-Only)_

#### **colour** : _[Colour](/python-api/docs/colour#colour)_ _(Read-Only)_

#### **forceTint** : _[Colour](/python-api/docs/colour#colour)_

#### **isExternalControl** : _bool_ _(Read-Only)_

#### **isGraphical** : _bool_ _(Read-Only)_

#### **isInternalControl** : _bool_ _(Read-Only)_

#### **isRendering** : _bool_ _(Read-Only)_

#### **layer** : _[Layer](/python-api/docs/layer#layer)_ _(Read-Only)_

#### **mapping** : _[Projection](/python-api/docs/projection#projection)_

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

_Category: Default  
UserName: Mapping_

#### **moduleConfigObject** : _[ModuleConfig](/python-api/docs/moduleconfig#moduleconfig)_ _(Read-Only)_

#### **needsPreview** : _bool_ _(Read-Only)_

#### **ocioInputSpace** : _[OcioColourSpace](/python-api/docs/ociocolourspace#ociocolourspace)_ _(Read-Only)_

#### **ownCanvas** : _bool_ _(Read-Only)_

#### **palette** : _[DxTexture](/python-api/docs/dxtexture#dxtexture)_

Bitmap from which palette colours (tints) are read

_Category: Default  
UserName: Palette_

#### **playHead** : _[PlayHead](/python-api/docs/playhead#playhead)_ _(Read-Only)_

The PlayHead this module belongs to, which contains the state of the current track and all modules. This is valid after setup() is called on the Module

#### **tint** : _[Colour](/python-api/docs/colour#colour)_

_Category: Default  
UserName: Tint_

#### **xCol** : _float_

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

_Category: Default  
UserName: Colour X_

#### **yCol** : _float_

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

_Category: Default  
UserName: Colour Y_

## Methods

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

#### **getPersonality**(self) -> _[SockpuppetPersonality](/python-api/docs/sockpuppetpersonality#sockpuppetpersonality)_

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

#### **removeDisconnectedSequences**(self)

Removes all disconnected sequences. Requires the ‘enableDisconnectedSequencesRemoval’ option to be enabled.

#### **renderPreview**(self, drawRect: _[Rect](/python-api/docs/rect#rect)_, colour: _[Colour](/python-api/docs/colour#colour) | [Col](/python-api/docs/col#col) | [HDRColour](/python-api/docs/hdrcolour#hdrcolour)_, showAlpha: _bool_, inGuiColourSpace: _bool_)

#### **resourceDuration**(self, sequenceName: _str_) -> _float_

#### **resourceDurationDescription**(self, sequenceName: _str_) -> _str_

#### **sourceName**(self, i: _int_) -> _str_