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

# ScreenPositionReceiver

See also: [Devices Guide](/plugins/guides/devices)

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

## Properties

#### **axes** : _List\[[ScreenPositionAxis](/python-api/docs/screenpositionaxis#screenpositionaxis)\]_

_Category: Axes  
UserName: Axes_

#### **drivers** : _List\[[ScreenPositionDriver](/python-api/docs/screenpositiondriver#screenpositiondriver)\]_

_Category: Drivers  
UserName: Drivers_

#### **engaged** : _bool_

#### **expressions** : _List\[[ScreenAxisExpression](/python-api/docs/screenaxisexpression#screenaxisexpression)\]_

_Category: Expressions  
UserName: Expressions_

#### **frameOfReference** : _[AnimationAxisSettings](/python-api/docs/animationaxissettings#animationaxissettings)_

_UserName: Stage Geometry_

#### **movementThreshold** : _float_

Minimum change needed before updating output value. Helps when data has unwanted movement when intended to be static. 0 means no threshold (disabled)

_Category: Prediction  
UserName: Movement threshold_

#### **positionSamples** : _int_

Number of position samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

_Category: Filter  
UserName: Number of Position Samples_

#### **prediction** : _float_

Compensate for time latency between received data and projector output. Use 0 to disable.

_Category: Filter  
UserName: Bias/ Prediction (ms)_

#### **predictionEnabled** : _int_

When switched on, prediction uses the ‘bias’ property to predict tracked positions at a future time

_Options: {0: ‘Off’, 1: ‘On’}  
Category: Prediction  
UserName: Prediction Override Enabled_

#### **smoothingFactor** : _float_

Smoothing Factor (%). Higher values will smooth the data more but will increase latency and therefore the need for prediction. Conversely, for lower values.

_Category: Prediction  
UserName: Smoothing Factor_

#### **status** : _int_

Controls all show machines’ status  
Independent editors are always disengaged  
Director-locked editors follow this setting

_Options: {0: ‘Disengaged’, 1: ‘Engaged’}  
UserName: Director status_

#### **timeSamples** : _int_

Number of time samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

_Category: Filter  
UserName: Number of Time Samples_

## Methods

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

#### **clearAxes**(self)

#### **createAxes**(self)