sen::db::Input Class Reference

Allows you to access an existing recording in the file system. More...

#include <input.h>

Public Member Functions
	Input (std::filesystem::path path, CustomTypeRegistry &nativeTypes)
	~Input ()
const std::filesystem::path &	getPath () const noexcept
	The folder where this archive is stored.
const Summary &	getSummary () const noexcept
	Summary data of this archive.
const CustomTypeRegistry &	getTypes () const noexcept
	Types available in this archive.
DataCursor	begin ()
	Creates a cursor to the start of the runtime data.
AnnotationCursor	annotationsBegin ()
	Creates a cursor to the start of the annotations.
DataCursor	at (const KeyframeIndex &index)
	Creates a cursor located at a given keyframe.
DataCursor	makeCursor (const ObjectIndexDef &indexDef)
	Creates a cursor that only iterates over the data related to an object.
void	addAnnotation (TimeStamp time, const Type *type, std::vector< uint8_t > &&value)
	Adds an annotation. Does not change the file summary.
Span< const ObjectIndexDef >	getObjectIndexDefinitions ()
	The objects that have been indexed.
Span< const KeyframeIndex >	getAllKeyframeIndexes ()
	The keyframes that were indexed (if any).
std::optional< KeyframeIndex >	getKeyframeIndex (TimeStamp time)
	The closest keyframe to a given time.

Detailed Description

Allows you to access an existing recording in the file system.

Constructor & Destructor Documentation

Input()

sen::db::Input::Input	(	std::filesystem::path	path,
		CustomTypeRegistry &	nativeTypes )

~Input()

sen::db::Input::~Input

(

)

Member Function Documentation

getPath()

const std::filesystem::path & sen::db::Input::getPath ( ) const

nodiscardnoexcept

The folder where this archive is stored.

getSummary()

const Summary & sen::db::Input::getSummary ( ) const

nodiscardnoexcept

Summary data of this archive.

getTypes()

const CustomTypeRegistry & sen::db::Input::getTypes ( ) const

nodiscardnoexcept

Types available in this archive.

begin()

DataCursor sen::db::Input::begin ( )

nodiscard

Creates a cursor to the start of the runtime data.

annotationsBegin()

AnnotationCursor sen::db::Input::annotationsBegin ( )

nodiscard

Creates a cursor to the start of the annotations.

at()

DataCursor sen::db::Input::at ( const KeyframeIndex & index )

nodiscard

Creates a cursor located at a given keyframe.

makeCursor()

DataCursor sen::db::Input::makeCursor ( const ObjectIndexDef & indexDef )

nodiscard

Creates a cursor that only iterates over the data related to an object.

addAnnotation()

void sen::db::Input::addAnnotation	(	TimeStamp	time,
		const Type *	type,
		std::vector< uint8_t > &&	value )

Adds an annotation. Does not change the file summary.

getObjectIndexDefinitions()

Span< const ObjectIndexDef > sen::db::Input::getObjectIndexDefinitions ( )

nodiscard

The objects that have been indexed.

getAllKeyframeIndexes()

Span< const KeyframeIndex > sen::db::Input::getAllKeyframeIndexes ( )

nodiscard

The keyframes that were indexed (if any).

getKeyframeIndex()

std::optional< KeyframeIndex > sen::db::Input::getKeyframeIndex ( TimeStamp time )

nodiscard

The closest keyframe to a given time.

---

The documentation for this class was generated from the following file:

• input.h