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

# FeedScene

See also: [Feed Guide](/plugins/guides/feed)

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

## Properties

#### **activeRegions** : _List\[[ActiveScreenRegion](/python-api/docs/activescreenregion#activescreenregion)\]_

#### **excludeMode** : _int_

_Options: {0: ‘Exclude’, 1: ‘Include’}_

#### **excludedMaps** : _List\[[Projection](/python-api/docs/projection#projection)\]_

#### **feedRects** : _List\[[FeedRect](/python-api/docs/feedrect#feedrect)\]_

#### **headConfigs** : _List\[[FeedHeadConfig](/python-api/docs/feedheadconfig#feedheadconfig)\]_

## Methods

#### **add**(self, r: _[FeedRect](/python-api/docs/feedrect#feedrect)_)

#### **addHeadConfig**(self, feedHeadConfig: _[FeedHeadConfig](/python-api/docs/feedheadconfig#feedheadconfig)_)

#### **ensureHeadConfig**(self, iHead: _int_, resolution: _[Int2](/python-api/docs/int2#int2) | [Vec2](/python-api/docs/vec2#vec2)_) -> _[FeedHeadConfig](/python-api/docs/feedheadconfig#feedheadconfig)_

#### **getUsedHeads**(self) -> _List\[int\]_

#### **importRectsFromTable**(self, table: _[Table](/python-api/docs/table#table)_, clearImportedDisplays: _bool_)

#### **insertHeadConfig**(self, feedHeadConfig: _[FeedHeadConfig](/python-api/docs/feedheadconfig#feedheadconfig)_, idx: _int_)

Insert a feed head configuration at a specific index in the feed scene.

**Parameters**:

-   feedHeadConfig: The feed head config to add to this feed scene.
-   idx: Position at which to insert the configuration.

#### **isPrimaryMachine**(self, machine: _[Machine](/python-api/docs/machine#machine)_) -> _bool_

#### **remove**(self, r: _[FeedRect](/python-api/docs/feedrect#feedrect)_)

#### **removeHeadConfig**(self, i: _int_)

#### **renderOverlays**(self, localMat: _[Mat](/python-api/docs/mat#mat)_, headFilter: _int_)

## Static Methods

#### **copySelectedHeadConfigs**(destination: _[FeedScene](/python-api/docs/feedscene#feedscene)_)

Copies feed head configuration that are selected to a given feed scene.

**Parameters**:

-   destination: The feed scene to copy to.

#### **currentMachines**() -> _List\[[Machine](/python-api/docs/machine#machine)\]_

#### **exportRectsAsTable**(rects: _List\[Any\]_, path: _str_) -> _[Table](/python-api/docs/table#table)_

#### **moveSelectedHeadConfigs**(destination: _[FeedScene](/python-api/docs/feedscene#feedscene)_)

Moves feed head configuration that are selected to a given feed scene.

**Parameters**:

-   destination: The feed scene to move to.