sen::db::Annotation Class Reference

Represents an annotation which can be added to a recording. More...

#include <annotation.h>

Public Member Functions
	~Annotation ()=default
const ConstTypeHandle &	getType () const noexcept
	The data type of the annotation value.
Span< const uint8_t >	getValueAsBuffer () const noexcept
	The annotation content, as a buffer.
const Var &	getValueAsVariant () const
	The annotation content, as a variant. Contents of the variant are obtained by interpreting the buffer as the type of the annotation.

Friends
class	Input

Detailed Description

Represents an annotation which can be added to a recording.

Constructor & Destructor Documentation

~Annotation()

sen::db::Annotation::~Annotation ( )

default

Member Function Documentation

getType()

const ConstTypeHandle & sen::db::Annotation::getType ( ) const

nodiscardnoexcept

The data type of the annotation value.

getValueAsBuffer()

Span< const uint8_t > sen::db::Annotation::getValueAsBuffer ( ) const

nodiscardnoexcept

The annotation content, as a buffer.

getValueAsVariant()

const Var & sen::db::Annotation::getValueAsVariant ( ) const

nodiscard

The annotation content, as a variant. Contents of the variant are obtained by interpreting the buffer as the type of the annotation.

Friends And Related Symbol Documentation

Input

friend class Input

friend

---

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

• annotation.h