pyvrs.record module

class pyvrs.record.VRSBlocks(get_func: Callable[[int], T], range_: range)

Bases: Sequence

A representation of a list of Record blocks (image, metadata, audio or custom). Accessing elements returns the type directly.

class pyvrs.record.VRSRecord(record: VRSRecord)

Bases: object

Represents a single VRS Record.

property audio_blocks: VRSBlocks

The list of audio blocks associated with this record.

property audio_specs: VRSBlocks

The list of audio block specs associated with this record.

property custom_block_specs: VRSBlocks

The list of custom block specs associated with this record.

property custom_blocks: VRSBlocks

The list of custom blocks associated with this record.

property format_version: int

The format version of this VRS record.

property image_blocks: VRSBlocks

The list of image blocks associated with this record.

property image_specs: VRSBlocks

The list of image block specs associated with this record.

property metadata_blocks: VRSBlocks

The list of metadata blocks associated with this record.

property n_audio_blocks: int

The number of audio blocks present in this VRS record.

property n_blocks_in_total: int

The total number of blocks on this record.

property n_custom_blocks: int

The number of custom blocks present in this VRS record.

property n_image_blocks: int

The number of image blocks present in this VRS record.

property n_metadata_blocks: int

The number of metadata blocks present in this VRS record.

property record_index: int

The absolute index of this VRS record in the VRS file.

property record_type: str

The type of this VRS record, e.g. ‘configuration’ or ‘data’.

property stream_id: str

A unique identifier for the type of device that recorded this record, along with an enumeration. E.g.: ‘1001-1’.

property timestamp: float

The timestamp associated with this record.