Experiment

@neurosity/sdk

---

@neurosity/sdk / Experiment

Type Alias: Experiment

Experiment = object

Defined in: types/experiment.ts:10

Properties

deviceId

deviceId: string

Defined in: types/experiment.ts:11

---

durationMs?

optional durationMs: number

Defined in: types/experiment.ts:25

Recording-only: planned duration in ms.

---

id

id: string

Defined in: types/experiment.ts:12

---

kind?

optional kind: SessionKind

Defined in: types/experiment.ts:21

Session kind; defaults to training for pre-dual-mode docs.

---

labels

labels: string[]

Defined in: types/experiment.ts:13

---

name

name: string

Defined in: types/experiment.ts:14

---

notes?

optional notes: string

Defined in: types/experiment.ts:19

Free-form notes.

---

protocol?

optional protocol: TrainingProtocol

Defined in: types/experiment.ts:23

Training-only: which classifier protocol.

---

recordingId?

optional recordingId: string

Defined in: types/experiment.ts:31

Recording-only: resulting memory/recording id once complete.

---

recordingStartedAt?

optional recordingStartedAt: number

Defined in: types/experiment.ts:29

Recording-only: epoch ms the recording actually started.

---

recordingState?

optional recordingState: RecordingState

Defined in: types/experiment.ts:27

Recording-only: lifecycle state.

---

timestamp

timestamp: number

Defined in: types/experiment.ts:15

---

totalTrials

totalTrials: number

Defined in: types/experiment.ts:16

---

userId

userId: string

Defined in: types/experiment.ts:17