dspark::StateWriter Class Reference

Serializes key/value parameters into a versioned blob. More...

#include <StateBlob.h>

Public Member Functions
	StateWriter (uint32_t processorId, uint16_t processorVersion)
void	write (const char *key, float value)
	Writes a float parameter.
void	write (const char *key, int32_t value)
	Writes an integer parameter (enums, counts, modes).
void	write (const char *key, bool value)
	Writes a boolean parameter.
void	write (const char *key, const std::vector< uint8_t > &nested)
	Writes a nested blob (composite processors: bands, slots...).
std::vector< uint8_t >	blob () const
	Finalizes and returns the blob.

Detailed Description

Serializes key/value parameters into a versioned blob.

Definition at line 51 of file StateBlob.h.

Constructor & Destructor Documentation

StateWriter()

dspark::StateWriter::StateWriter ( uint32_t  processorId, uint16_t  processorVersion  )

inline

Parameters

processorId	FOURCC-style identity of the processor type.
processorVersion	Schema version of that processor's state.

Definition at line 58 of file StateBlob.h.

Member Function Documentation

blob()

std::vector< uint8_t > dspark::StateWriter::blob ( ) const

inline

Finalizes and returns the blob.

Definition at line 104 of file StateBlob.h.

write() [1/4]

void dspark::StateWriter::write ( const char *  key, bool  value  )

inline

Writes a boolean parameter.

Definition at line 84 of file StateBlob.h.

write() [2/4]

void dspark::StateWriter::write ( const char *  key, const std::vector< uint8_t > &  nested  )

inline

Writes a nested blob (composite processors: bands, slots...).

Definition at line 90 of file StateBlob.h.

write() [3/4]

void dspark::StateWriter::write ( const char *  key, float  value  )

inline

Writes a float parameter.

Definition at line 70 of file StateBlob.h.

write() [4/4]

void dspark::StateWriter::write ( const char *  key, int32_t  value  )

inline

Writes an integer parameter (enums, counts, modes).

Definition at line 78 of file StateBlob.h.

---

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

• Core/StateBlob.h