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

# ShotRecorder

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

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

## Properties

#### **engaged** : _bool_

Click to engage/disengage recording

_UserName: Engaged_

#### **exportSettings** : _[ShotRecorderExportSettings](/python-api/docs/shotrecorderexportsettings#shotrecorderexportsettings)_

#### **parameters** : _[ParameterCollection](/python-api/docs/parametercollection#parametercollection)_

The parameter collection to record when the system is engaged

_UserName: Parameters_

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

#### **slate** : _str_

The name of the slate for the current shot

_UserName: Slate_

#### **take** : _int_

The number of the take for the current shot

_UserName: Take_

#### **takeScreenshot** : _bool_

Take a screenshot at the end of each recording

_UserName: Take screenshot_

#### **takeSnapshot** : _bool_

Take a project snapshot at the end of each recording

_UserName: Take snapshot_

#### **timecode** : _[TimecodeTransport](/python-api/docs/timecodetransport#timecodetransport)_

The timecode to record alongside parameters. Must be selected in a transport manager.

_UserName: Timecode_

## Methods

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

#### **exportSlate**(self, slatePath: _[Path](/python-api/docs/path#path) | str_) -> _bool_

#### **exportTake**(self, takePath: _[Path](/python-api/docs/path#path) | str_) -> _bool_

#### **resetTake**(self)

## Static Methods

#### **changeSlateForTake**(oldTakePath: _[Path](/python-api/docs/path#path) | str_, newSlateName: _str_) -> _[Path](/python-api/docs/path#path)_

#### **deleteTake**(takePath: _[Path](/python-api/docs/path#path) | str_)

#### **exportComparisonTableForSlate**(slate: _[Path](/python-api/docs/path#path) | str_) -> _bool_

#### **exportComparisonTableToCsv**(slates: _List\[[Path](/python-api/docs/path#path)\]_, singleSlate: _bool_) -> _bool_

#### **renameSlate**(oldSlatePath: _[Path](/python-api/docs/path#path) | str_, newSlateName: _str_) -> _[Path](/python-api/docs/path#path)_

#### **renameTake**(oldTakePath: _[Path](/python-api/docs/path#path) | str_, newTakeName: _str_) -> _[Path](/python-api/docs/path#path)_

#### **slateOrTakeExists**(path: _[Path](/python-api/docs/path#path) | str_) -> _bool_

#### **slates**() -> _List\[[Path](/python-api/docs/path#path)\]_

#### **takesforSlate**(slatePath: _[Path](/python-api/docs/path#path) | str_) -> _List\[[Path](/python-api/docs/path#path)\]_