Helper class for serializing and deserializing the RiffDescriptor JSON. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()

virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
std::string	file
	Name of the RIFF file.

bool	verified
	True if the ECDSA signature is verified.

int	channels
	Number of audio channels.

int	sampleCount
	Number of audio samples.

std::string	meta
	[Optional] Meta data associated with the file - typically a stringified JSON object.

std::string	certPem
	[Optional] X.509 certificate in PEM format used to sign the RIFF file.

CertificateDescriptor	certDescriptor
	[Optional] X.509 certificate parsed into a CertificateDescriptor object.

std::string	signature
	[Optional] ECDSA signature

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Helper class for serializing and deserializing the RiffDescriptor JSON.

Helper C++ class to serialize and de-serialize RiffDescriptor JSON

Example:

See also: TODO: engageGetRiffDescriptor

Definition at line 10262 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ RiffDescriptor()

AppConfigurationObjects::RiffDescriptor::RiffDescriptor ( )

inline

Definition at line 10292 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RiffDescriptor::clear ( )

inline

Definition at line 10297 of file ConfigurationObjects.h.

Member Data Documentation

◆ certDescriptor

CertificateDescriptor AppConfigurationObjects::RiffDescriptor::certDescriptor

[Optional] X.509 certificate parsed into a CertificateDescriptor object.

Definition at line 10287 of file ConfigurationObjects.h.

◆ certPem

std::string AppConfigurationObjects::RiffDescriptor::certPem

[Optional] X.509 certificate in PEM format used to sign the RIFF file.

Definition at line 10284 of file ConfigurationObjects.h.

◆ channels

int AppConfigurationObjects::RiffDescriptor::channels

Number of audio channels.

Definition at line 10275 of file ConfigurationObjects.h.

◆ file

std::string AppConfigurationObjects::RiffDescriptor::file

Name of the RIFF file.

Definition at line 10269 of file ConfigurationObjects.h.

◆ meta

std::string AppConfigurationObjects::RiffDescriptor::meta

[Optional] Meta data associated with the file - typically a stringified JSON object.

Definition at line 10281 of file ConfigurationObjects.h.

◆ sampleCount

int AppConfigurationObjects::RiffDescriptor::sampleCount

Number of audio samples.

Definition at line 10278 of file ConfigurationObjects.h.

◆ signature

std::string AppConfigurationObjects::RiffDescriptor::signature

[Optional] ECDSA signature

Definition at line 10290 of file ConfigurationObjects.h.

◆ verified

bool AppConfigurationObjects::RiffDescriptor::verified

True if the ECDSA signature is verified.

Definition at line 10272 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members