midi_ci::PropertyRequestHeader Struct Reference

A struct containing data members that correspond to common fields in a property request header. More...

#include <juce_CIPropertyDelegate.h>

Public Member Functions
var	toVarCondensed () const
	Converts a PropertyRequestHeader to a JSON object suitable for use as a MIDI-CI message header after conversion to 7-bit ASCII.

Static Public Member Functions
static PropertyRequestHeader	parseCondensed (const var &)
	Converts a JSON object to a PropertyRequestHeader.

Public Attributes
String	resource
String	resId
Encoding	mutualEncoding = Encoding::ascii
String	mediaType = "application/json"
bool	setPartial = false
std::optional< Pagination >	pagination
std::map< Identifier, var >	extended

Detailed Description

A struct containing data members that correspond to common fields in a property request header.

Check the Property Exchange specification to find the meaning of the different fields.

Member Function Documentation

parseCondensed()

static PropertyRequestHeader midi_ci::PropertyRequestHeader::parseCondensed ( const var & )

static

Converts a JSON object to a PropertyRequestHeader.

Unspecified fields will use their default values.

Referenced by midi_ci::PropertyExchangeResult::getHeaderAsRequestHeader().

toVarCondensed()

var midi_ci::PropertyRequestHeader::toVarCondensed

(

)

const

Converts a PropertyRequestHeader to a JSON object suitable for use as a MIDI-CI message header after conversion to 7-bit ASCII.

Member Data Documentation

resource

String midi_ci::PropertyRequestHeader::resource

resId

String midi_ci::PropertyRequestHeader::resId

mutualEncoding

Encoding midi_ci::PropertyRequestHeader::mutualEncoding = Encoding::ascii

mediaType

String midi_ci::PropertyRequestHeader::mediaType = "application/json"

setPartial

bool midi_ci::PropertyRequestHeader::setPartial = false

pagination

std::optional<Pagination> midi_ci::PropertyRequestHeader::pagination

extended

std::map<Identifier, var> midi_ci::PropertyRequestHeader::extended

---

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

• juce_CIPropertyDelegate.h