Skip to content

recording

Models for data related to recordings.

PaginatedRecordingsResponse pydantic-model

Bases: PaginatedResponse

Paginated list of recordings.

Fields:

RecordingAnalysisSummary pydantic-model

Bases: BaseModel

Compact per-recording analysis summary (id + status + config name).

Fields:

RecordingHeader pydantic-model

Bases: BaseModel

Model with information that header reading functions should return.

Fields:

  • channels (list[ChannelOut])
  • length_ms (PositiveInt)
  • recording_start (datetime)

RecordingOut pydantic-model

Bases: RecordingUpdate, RecordingHeader

Recording information available to user.

Fields:

analyses pydantic-field

Per-recording analysis summaries (id, status, config name).

checksum = None pydantic-field

The SHA1/MD5 hash of the file. May be None. May contain a '-{number of parts}' of up to 4 digits of parts suffix. E.g., {checksum}-4 or {checksum}-0001

created_at pydantic-field

The date and time when the recording was created.

file_size_bytes pydantic-field

Size of the file in bytes

format pydantic-field

The format of the file, e.g., 'edf'.

id pydantic-field

The unique identifier of the recording.

missing_since = None pydantic-field

When a look for new files found the bucket file it was registered from gone from its key, or changed there; null while it is there. New analyses of a missing recording are refused.

owner_id = None pydantic-field

The member who added it. Only they, or the project's owner, may change or remove it; it passes to the project's owner when they leave the organization.

state pydantic-field

The state of the file, e.g., 'registered'.

study_id = None pydantic-field

ID of the parent study. Populated in flat project-level listings.

study_name = None pydantic-field

Name of the parent study. Populated in flat project-level listings.

RecordingUpdate pydantic-model

Bases: BaseModel

Updatable file fields.