---
url: /api/kiln/classes/Recorder.md
---
[Kiln API](../../index.md) / [kiln](../index.md) / Recorder

# Class: Recorder

Records a session. Create it before Startup (before app.boot() or app.start()).

## Constructors

### Constructor

```ts
new Recorder(app, options?): Recorder;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `app` | [`App`](App.md) |
| `options` | [`RecorderOptions`](../interfaces/RecorderOptions.md) |

#### Returns

`Recorder`

## Properties

### checkEvery

```ts
readonly checkEvery: number;
```

***

### checkPrecision

```ts
readonly checkPrecision: number;
```

## Accessors

### frame

#### Get Signature

```ts
get frame(): number;
```

Frames recorded so far.

##### Returns

`number`

***

### recording

#### Get Signature

```ts
get recording(): boolean;
```

True until stop().

##### Returns

`boolean`

## Methods

### note()

```ts
note(kind, data): void;
```

Notes a side-channel event; it applies before the next frame, as it did live. Plugins call this.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `kind` | `string` |
| `data` | `unknown` |

#### Returns

`void`

***

### addNote()

```ts
addNote(text): void;
```

Adds a line to the recording's notes.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |

#### Returns

`void`

***

### take()

```ts
take(): Recording;
```

The recording so far. Recording continues.

#### Returns

[`Recording`](../interfaces/Recording.md)

***

### stop()

```ts
stop(): Recording;
```

Stops recording and returns the recording.

#### Returns

[`Recording`](../interfaces/Recording.md)