20#ifndef ConfigurationObjects_h
21#define ConfigurationObjects_h
24#include "EngageConstants.h"
33#include <nlohmann/json.hpp>
36 #pragma GCC diagnostic push
37 #pragma GCC diagnostic ignored "-Wunused-function"
40#if !defined(ENGAGE_IGNORE_COMPILER_UNUSED_WARNING)
42 #define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING __attribute__((unused))
44 #define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING
50#if defined(RTS_CORE_BUILD)
51namespace ConfigurationObjects
53namespace AppConfigurationObjects
56 static const char *ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT =
"_attached";
150 } DataSeriesValueType_t;
164 bloodOxygenation = 5,
166 taskEffectiveness = 7
167 } HumanBiometricsTypes_t;
171 static FILE *_internalFileOpener(
const char *fn,
const char *mode)
176 fp = fopen(fn, mode);
178 if(fopen_s(&fp, fn, mode) != 0)
187 #define JSON_SERIALIZED_CLASS(_cn) \
189 static void to_json(nlohmann::json& j, const _cn& p); \
190 static void from_json(const nlohmann::json& j, _cn& p);
192 #define IMPLEMENT_JSON_DOCUMENTATION(_cn) \
194 static void document(const char *path = nullptr) \
197 example.initForDocumenting(); \
198 std::string theJson = example.serialize(3); \
199 std::cout << "------------------------------------------------" << std::endl \
200 << #_cn << std::endl \
201 << theJson << std::endl \
202 << "------------------------------------------------" << std::endl; \
204 if(path != nullptr && path[0] != 0) \
206 std::string fn = path; \
209 fn.append(".json"); \
211 FILE *fp = _internalFileOpener(fn.c_str(), "wt");\
215 fputs(theJson.c_str(), fp); \
220 std::cout << "ERROR: Cannot write to " << fn << std::endl; \
224 static const char *className() \
229 #define IMPLEMENT_JSON_SERIALIZATION() \
231 bool deserialize(const char *s) \
235 if(s != nullptr && s[0] != 0) \
237 from_json(nlohmann::json::parse(s), *this); \
251 std::string serialize(const int indent = -1) \
257 return j.dump(indent); \
261 return std::string("{}"); \
265 #define IMPLEMENT_WRAPPED_JSON_SERIALIZATION(_cn) \
267 std::string serializeWrapped(const int indent = -1) \
276 firstChar[0] = #_cn[0]; \
278 firstChar[0] = tolower(firstChar[0]); \
280 rc.append(firstChar); \
281 rc.append((#_cn) + 1); \
283 rc.append(j.dump(indent)); \
290 return std::string("{}"); \
294 #define TOJSON_IMPL(__var) \
297 #define FROMJSON_IMPL_SIMPLE(__var) \
298 getOptional(#__var, p.__var, j)
300 #define FROMJSON_IMPL(__var, __type, __default) \
301 getOptional<__type>(#__var, p.__var, j, __default)
303 #define TOJSON_BASE_IMPL() \
304 to_json(j, (ConfigurationObjectBase&)p)
306 #define FROMJSON_BASE_IMPL() \
307 from_json(j, (ConfigurationObjectBase&)p);
311 static std::string EMPTY_STRING;
314 static void getOptional(
const char *name, T& v,
const nlohmann::json& j, T def)
320 j.at(name).get_to(v);
334 static void getOptional(
const char *name, T& v,
const nlohmann::json& j)
340 j.at(name).get_to(v);
349 static void getOptionalWithIndicator(
const char *name, T& v,
const nlohmann::json& j, T def,
bool *wasFound)
355 j.at(name).get_to(v);
372 static void getOptionalWithIndicator(
const char *name, T& v,
const nlohmann::json& j,
bool *wasFound)
378 j.at(name).get_to(v);
397 _documenting =
false;
404 virtual void initForDocumenting()
409 virtual std::string toString()
411 return std::string(
"");
414 inline virtual bool isDocumenting()
const
419 nlohmann::json _attached;
429 if(p._attached !=
nullptr)
431 j[ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT] = p._attached;
438 static void from_json(
const nlohmann::json& j, ConfigurationObjectBase& p)
442 if(j.contains(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT))
444 p._attached = j.at(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT);
453 JSON_SERIALIZED_CLASS(KvPair)
462 IMPLEMENT_JSON_SERIALIZATION()
463 IMPLEMENT_JSON_DOCUMENTATION(
KvPair)
484 static void to_json(nlohmann::json& j,
const KvPair& p)
491 static void from_json(
const nlohmann::json& j, KvPair& p)
494 getOptional<std::string>(
"key", p.key, j, EMPTY_STRING);
495 getOptional<std::string>(
"tags", p.value, j, EMPTY_STRING);
499 JSON_SERIALIZED_CLASS(TuningSettings)
502 IMPLEMENT_JSON_SERIALIZATION()
546 maxPooledRtpObjects = 0;
547 maxActiveRtpObjects = 0;
550 maxPooledBlobObjects = 0;
551 maxActiveBlobObjects = 0;
553 maxPooledBufferMb = 0;
554 maxPooledBufferObjects = 0;
555 maxActiveBufferObjects = 0;
557 maxActiveRtpProcessors = 0;
560 virtual void initForDocumenting()
566 static void to_json(nlohmann::json& j,
const TuningSettings& p)
569 TOJSON_IMPL(maxPooledRtpMb),
570 TOJSON_IMPL(maxPooledRtpObjects),
571 TOJSON_IMPL(maxActiveRtpObjects),
573 TOJSON_IMPL(maxPooledBlobMb),
574 TOJSON_IMPL(maxPooledBlobObjects),
575 TOJSON_IMPL(maxActiveBlobObjects),
577 TOJSON_IMPL(maxPooledBufferMb),
578 TOJSON_IMPL(maxPooledBufferObjects),
579 TOJSON_IMPL(maxActiveBufferObjects),
581 TOJSON_IMPL(maxActiveRtpProcessors)
584 static void from_json(
const nlohmann::json& j, TuningSettings& p)
587 FROMJSON_IMPL(maxPooledRtpMb, uint32_t, 0);
588 FROMJSON_IMPL(maxPooledRtpObjects, uint32_t, 0);
589 FROMJSON_IMPL(maxActiveRtpObjects, uint32_t, 0);
591 FROMJSON_IMPL(maxPooledBlobMb, uint32_t, 0);
592 FROMJSON_IMPL(maxPooledBlobObjects, uint32_t, 0);
593 FROMJSON_IMPL(maxActiveBlobObjects, uint32_t, 0);
595 FROMJSON_IMPL(maxPooledBufferMb, uint32_t, 0);
596 FROMJSON_IMPL(maxPooledBufferObjects, uint32_t, 0);
597 FROMJSON_IMPL(maxActiveBufferObjects, uint32_t, 0);
599 FROMJSON_IMPL(maxActiveRtpProcessors, uint32_t, 0);
604 JSON_SERIALIZED_CLASS(FipsCryptoSettings)
607 IMPLEMENT_JSON_SERIALIZATION()
640 virtual void initForDocumenting()
646 static void to_json(nlohmann::json& j,
const FipsCryptoSettings& p)
649 TOJSON_IMPL(enabled),
656 static void from_json(
const nlohmann::json& j, FipsCryptoSettings& p)
659 FROMJSON_IMPL_SIMPLE(enabled);
660 FROMJSON_IMPL_SIMPLE(path);
661 FROMJSON_IMPL_SIMPLE(debug);
662 FROMJSON_IMPL_SIMPLE(curves);
663 FROMJSON_IMPL_SIMPLE(ciphers);
668 JSON_SERIALIZED_CLASS(WatchdogSettings)
671 IMPLEMENT_JSON_SERIALIZATION()
699 hangDetectionMs = 2000;
701 slowExecutionThresholdMs = 100;
704 virtual void initForDocumenting()
710 static void to_json(nlohmann::json& j,
const WatchdogSettings& p)
713 TOJSON_IMPL(enabled),
714 TOJSON_IMPL(intervalMs),
715 TOJSON_IMPL(hangDetectionMs),
716 TOJSON_IMPL(abortOnHang),
717 TOJSON_IMPL(slowExecutionThresholdMs)
720 static void from_json(
const nlohmann::json& j, WatchdogSettings& p)
723 getOptional<bool>(
"enabled", p.enabled, j,
true);
724 getOptional<int>(
"intervalMs", p.intervalMs, j, 5000);
725 getOptional<int>(
"hangDetectionMs", p.hangDetectionMs, j, 2000);
726 getOptional<bool>(
"abortOnHang", p.abortOnHang, j,
true);
727 getOptional<int>(
"slowExecutionThresholdMs", p.slowExecutionThresholdMs, j, 100);
732 JSON_SERIALIZED_CLASS(FileRecordingRequest)
735 IMPLEMENT_JSON_SERIALIZATION()
740 std::string fileName;
755 virtual void initForDocumenting()
758 id =
"1-2-3-4-5-6-7-8-9";
759 fileName =
"/tmp/test.wav";
768 TOJSON_IMPL(fileName),
772 static void from_json(
const nlohmann::json& j, FileRecordingRequest& p)
775 j.at(
"id").get_to(p.id);
776 j.at(
"fileName").get_to(p.fileName);
777 getOptional<uint32_t>(
"maxMs", p.maxMs, j, 60000);
782 JSON_SERIALIZED_CLASS(Feature)
785 IMPLEMENT_JSON_SERIALIZATION()
786 IMPLEMENT_JSON_DOCUMENTATION(
Feature)
791 std::string description;
792 std::string comments;
811 virtual void initForDocumenting()
814 id =
"{af9540d1-3e86-4fa6-8b80-e26daecb61ab}";
815 name =
"A sample feature";
816 description =
"This is an example of a feature";
817 comments =
"These are comments for this feature";
823 static void to_json(nlohmann::json& j,
const Feature& p)
828 TOJSON_IMPL(description),
829 TOJSON_IMPL(comments),
834 static void from_json(
const nlohmann::json& j, Feature& p)
837 j.at(
"id").get_to(p.id);
838 getOptional(
"name", p.name, j);
839 getOptional(
"description", p.description, j);
840 getOptional(
"comments", p.comments, j);
841 getOptional(
"count", p.count, j, 0);
849 JSON_SERIALIZED_CLASS(Featureset)
852 IMPLEMENT_JSON_SERIALIZATION()
856 std::string signature;
858 std::vector<Feature> features;
868 lockToDeviceId =
false;
872 virtual void initForDocumenting()
875 signature =
"c39df3f36c6444e686e47e70fc45cf91e6ed2d8de62d4a1e89f507d567ff48aaabb1a70e54b44377b46fc4a1a2e319e5b77e4abffc444db98f8eb55d709aad5f";
876 lockToDeviceId =
false;
880 static void to_json(nlohmann::json& j,
const Featureset& p)
883 TOJSON_IMPL(signature),
884 TOJSON_IMPL(lockToDeviceId),
885 TOJSON_IMPL(features)
888 static void from_json(
const nlohmann::json& j, Featureset& p)
891 getOptional(
"signature", p.signature, j);
892 getOptional<bool>(
"lockToDeviceId", p.lockToDeviceId, j,
false);
893 getOptional<std::vector<Feature>>(
"features", p.features, j);
898 JSON_SERIALIZED_CLASS(Agc)
909 IMPLEMENT_JSON_SERIALIZATION()
910 IMPLEMENT_JSON_DOCUMENTATION(
Agc)
941 compressionGainDb = 25;
942 enableLimiter =
false;
947 static void to_json(nlohmann::json& j,
const Agc& p)
950 TOJSON_IMPL(enabled),
951 TOJSON_IMPL(minLevel),
952 TOJSON_IMPL(maxLevel),
953 TOJSON_IMPL(compressionGainDb),
954 TOJSON_IMPL(enableLimiter),
955 TOJSON_IMPL(targetLevelDb)
958 static void from_json(
const nlohmann::json& j, Agc& p)
961 getOptional<bool>(
"enabled", p.enabled, j,
false);
962 getOptional<int>(
"minLevel", p.minLevel, j, 0);
963 getOptional<int>(
"maxLevel", p.maxLevel, j, 255);
964 getOptional<int>(
"compressionGainDb", p.compressionGainDb, j, 25);
965 getOptional<bool>(
"enableLimiter", p.enableLimiter, j,
false);
966 getOptional<int>(
"targetLevelDb", p.targetLevelDb, j, 3);
971 JSON_SERIALIZED_CLASS(RtpPayloadTypeTranslation)
982 IMPLEMENT_JSON_SERIALIZATION()
1003 bool matches(
const RtpPayloadTypeTranslation& other)
1005 return ( (external == other.external) && (engage == other.engage) );
1009 static void to_json(nlohmann::json& j,
const RtpPayloadTypeTranslation& p)
1012 TOJSON_IMPL(external),
1016 static void from_json(
const nlohmann::json& j, RtpPayloadTypeTranslation& p)
1019 getOptional<uint16_t>(
"external", p.external, j);
1020 getOptional<uint16_t>(
"engage", p.engage, j);
1024 JSON_SERIALIZED_CLASS(NetworkInterfaceDevice)
1027 IMPLEMENT_JSON_SERIALIZATION()
1032 std::string friendlyName;
1033 std::string description;
1035 std::string address;
1038 bool supportsMulticast;
1039 std::string hardwareAddress;
1049 friendlyName.clear();
1050 description.clear();
1055 supportsMulticast =
false;
1056 hardwareAddress.clear();
1059 virtual void initForDocumenting()
1063 friendlyName =
"Wi-Fi";
1064 description =
"A wi-fi adapter";
1066 address =
"127.0.0.1";
1069 supportsMulticast =
false;
1070 hardwareAddress =
"DE:AD:BE:EF:01:02:03";
1078 TOJSON_IMPL(friendlyName),
1079 TOJSON_IMPL(description),
1080 TOJSON_IMPL(family),
1081 TOJSON_IMPL(address),
1082 TOJSON_IMPL(available),
1083 TOJSON_IMPL(isLoopback),
1084 TOJSON_IMPL(supportsMulticast),
1085 TOJSON_IMPL(hardwareAddress)
1088 static void from_json(
const nlohmann::json& j, NetworkInterfaceDevice& p)
1091 getOptional(
"name", p.name, j);
1092 getOptional(
"friendlyName", p.friendlyName, j);
1093 getOptional(
"description", p.description, j);
1094 getOptional(
"family", p.family, j, -1);
1095 getOptional(
"address", p.address, j);
1096 getOptional(
"available", p.available, j,
false);
1097 getOptional(
"isLoopback", p.isLoopback, j,
false);
1098 getOptional(
"supportsMulticast", p.supportsMulticast, j,
false);
1099 getOptional(
"hardwareAddress", p.hardwareAddress, j);
1103 JSON_SERIALIZED_CLASS(ListOfNetworkInterfaceDevice)
1106 IMPLEMENT_JSON_SERIALIZATION()
1110 std::vector<NetworkInterfaceDevice> list;
1129 static void from_json(
const nlohmann::json& j, ListOfNetworkInterfaceDevice& p)
1132 getOptional<std::vector<NetworkInterfaceDevice>>(
"list", p.list, j);
1137 JSON_SERIALIZED_CLASS(RtpHeader)
1148 IMPLEMENT_JSON_SERIALIZATION()
1182 virtual void initForDocumenting()
1193 static void to_json(nlohmann::json& j,
const RtpHeader& p)
1199 TOJSON_IMPL(marker),
1206 static void from_json(
const nlohmann::json& j, RtpHeader& p)
1209 getOptional<int>(
"pt", p.pt, j, -1);
1210 getOptional<bool>(
"marker", p.marker, j,
false);
1211 getOptional<uint16_t>(
"seq", p.seq, j, 0);
1212 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
1213 getOptional<uint32_t>(
"ts", p.ts, j, 0);
1217 JSON_SERIALIZED_CLASS(BlobInfo)
1228 IMPLEMENT_JSON_SERIALIZATION()
1229 IMPLEMENT_JSON_DOCUMENTATION(
BlobInfo)
1244 bptJsonTextUtf8 = 2,
1250 bptEngageBinaryHumanBiometrics = 4,
1253 bptAppMimeMessage = 5,
1256 bptEngageInternal = 42
1291 payloadType = PayloadType_t::bptUndefined;
1296 virtual void initForDocumenting()
1299 rtpHeader.initForDocumenting();
1303 static void to_json(nlohmann::json& j,
const BlobInfo& p)
1307 TOJSON_IMPL(source),
1308 TOJSON_IMPL(target),
1309 TOJSON_IMPL(rtpHeader),
1310 TOJSON_IMPL(payloadType),
1312 TOJSON_IMPL(txnTimeoutSecs)
1315 static void from_json(
const nlohmann::json& j, BlobInfo& p)
1318 getOptional<size_t>(
"size", p.size, j, 0);
1319 getOptional<std::string>(
"source", p.source, j, EMPTY_STRING);
1320 getOptional<std::string>(
"target", p.target, j, EMPTY_STRING);
1321 getOptional<RtpHeader>(
"rtpHeader", p.rtpHeader, j);
1322 getOptional<BlobInfo::PayloadType_t>(
"payloadType", p.payloadType, j, BlobInfo::PayloadType_t::bptUndefined);
1323 getOptional<std::string>(
"txnId", p.txnId, j, EMPTY_STRING);
1324 getOptional<int>(
"txnTimeoutSecs", p.txnTimeoutSecs, j, 0);
1329 JSON_SERIALIZED_CLASS(TxAudioUri)
1343 IMPLEMENT_JSON_SERIALIZATION()
1364 virtual void initForDocumenting()
1369 static void to_json(nlohmann::json& j,
const TxAudioUri& p)
1373 TOJSON_IMPL(repeatCount)
1376 static void from_json(
const nlohmann::json& j, TxAudioUri& p)
1379 getOptional<std::string>(
"uri", p.uri, j, EMPTY_STRING);
1380 getOptional<int>(
"repeatCount", p.repeatCount, j, 0);
1385 JSON_SERIALIZED_CLASS(AdvancedTxParams)
1399 IMPLEMENT_JSON_SERIALIZATION()
1444 includeNodeId =
false;
1449 aliasSpecializer = 0;
1450 receiverRxMuteForAliasSpecializer =
false;
1453 virtual void initForDocumenting()
1458 static void to_json(nlohmann::json& j,
const AdvancedTxParams& p)
1462 TOJSON_IMPL(priority),
1463 TOJSON_IMPL(subchannelTag),
1464 TOJSON_IMPL(includeNodeId),
1468 TOJSON_IMPL(audioUri),
1469 TOJSON_IMPL(aliasSpecializer),
1470 TOJSON_IMPL(receiverRxMuteForAliasSpecializer)
1473 static void from_json(
const nlohmann::json& j, AdvancedTxParams& p)
1476 getOptional<uint16_t>(
"flags", p.flags, j, 0);
1477 getOptional<uint8_t>(
"priority", p.priority, j, 0);
1478 getOptional<uint16_t>(
"subchannelTag", p.subchannelTag, j, 0);
1479 getOptional<bool>(
"includeNodeId", p.includeNodeId, j,
false);
1480 getOptional<std::string>(
"alias", p.alias, j, EMPTY_STRING);
1481 getOptional<bool>(
"muted", p.muted, j,
false);
1482 getOptional<uint32_t>(
"txId", p.txId, j, 0);
1483 getOptional<TxAudioUri>(
"audioUri", p.audioUri, j);
1484 getOptional<uint16_t>(
"aliasSpecializer", p.aliasSpecializer, j, 0);
1485 getOptional<bool>(
"receiverRxMuteForAliasSpecializer", p.receiverRxMuteForAliasSpecializer, j,
false);
1489 JSON_SERIALIZED_CLASS(Identity)
1503 IMPLEMENT_JSON_SERIALIZATION()
1504 IMPLEMENT_JSON_DOCUMENTATION(
Identity)
1534 displayName.clear();
1538 virtual void initForDocumenting()
1543 static void to_json(nlohmann::json& j,
const Identity& p)
1546 TOJSON_IMPL(nodeId),
1547 TOJSON_IMPL(userId),
1548 TOJSON_IMPL(displayName),
1552 static void from_json(
const nlohmann::json& j, Identity& p)
1555 getOptional<std::string>(
"nodeId", p.nodeId, j);
1556 getOptional<std::string>(
"userId", p.userId, j);
1557 getOptional<std::string>(
"displayName", p.displayName, j);
1558 getOptional<std::string>(
"avatar", p.avatar, j);
1563 JSON_SERIALIZED_CLASS(Location)
1577 IMPLEMENT_JSON_SERIALIZATION()
1578 IMPLEMENT_JSON_DOCUMENTATION(
Location)
1581 constexpr static double INVALID_LOCATION_VALUE = -999.999;
1609 latitude = INVALID_LOCATION_VALUE;
1610 longitude = INVALID_LOCATION_VALUE;
1611 altitude = INVALID_LOCATION_VALUE;
1612 direction = INVALID_LOCATION_VALUE;
1613 speed = INVALID_LOCATION_VALUE;
1616 virtual void initForDocumenting()
1622 longitude = 456.789;
1629 static void to_json(nlohmann::json& j,
const Location& p)
1631 if(p.latitude != Location::INVALID_LOCATION_VALUE && p.longitude != Location::INVALID_LOCATION_VALUE)
1634 TOJSON_IMPL(latitude),
1635 TOJSON_IMPL(longitude),
1638 if(p.ts != 0) j[
"ts"] = p.ts;
1639 if(p.altitude != Location::INVALID_LOCATION_VALUE) j[
"altitude"] = p.altitude;
1640 if(p.speed != Location::INVALID_LOCATION_VALUE) j[
"speed"] = p.speed;
1641 if(p.direction != Location::INVALID_LOCATION_VALUE) j[
"direction"] = p.direction;
1644 static void from_json(
const nlohmann::json& j, Location& p)
1647 getOptional<uint32_t>(
"ts", p.ts, j, 0);
1648 j.at(
"latitude").get_to(p.latitude);
1649 j.at(
"longitude").get_to(p.longitude);
1650 getOptional<double>(
"altitude", p.altitude, j, Location::INVALID_LOCATION_VALUE);
1651 getOptional<double>(
"direction", p.direction, j, Location::INVALID_LOCATION_VALUE);
1652 getOptional<double>(
"speed", p.speed, j, Location::INVALID_LOCATION_VALUE);
1656 JSON_SERIALIZED_CLASS(Power)
1668 IMPLEMENT_JSON_SERIALIZATION()
1669 IMPLEMENT_JSON_DOCUMENTATION(
Power)
1715 virtual void initForDocumenting()
1720 static void to_json(nlohmann::json& j,
const Power& p)
1722 if(p.source != 0 && p.state != 0 && p.level != 0)
1725 TOJSON_IMPL(source),
1731 static void from_json(
const nlohmann::json& j, Power& p)
1734 getOptional<int>(
"source", p.source, j, 0);
1735 getOptional<int>(
"state", p.state, j, 0);
1736 getOptional<int>(
"level", p.level, j, 0);
1741 JSON_SERIALIZED_CLASS(Connectivity)
1753 IMPLEMENT_JSON_SERIALIZATION()
1790 virtual void initForDocumenting()
1800 static void to_json(nlohmann::json& j,
const Connectivity& p)
1806 TOJSON_IMPL(strength),
1811 static void from_json(
const nlohmann::json& j, Connectivity& p)
1814 getOptional<int>(
"type", p.type, j, 0);
1815 getOptional<int>(
"strength", p.strength, j, 0);
1816 getOptional<int>(
"rating", p.rating, j, 0);
1821 JSON_SERIALIZED_CLASS(PresenceDescriptorGroupItem)
1833 IMPLEMENT_JSON_SERIALIZATION()
1858 virtual void initForDocumenting()
1860 groupId =
"{123-456}";
1866 static void to_json(nlohmann::json& j,
const PresenceDescriptorGroupItem& p)
1869 TOJSON_IMPL(groupId),
1874 static void from_json(
const nlohmann::json& j, PresenceDescriptorGroupItem& p)
1877 getOptional<std::string>(
"groupId", p.groupId, j);
1878 getOptional<std::string>(
"alias", p.alias, j);
1879 getOptional<uint16_t>(
"status", p.status, j);
1884 JSON_SERIALIZED_CLASS(PresenceDescriptor)
1896 IMPLEMENT_JSON_SERIALIZATION()
1974 groupAliases.clear();
1977 announceOnReceive =
false;
1978 connectivity.clear();
1982 virtual void initForDocumenting()
1989 identity.initForDocumenting();
1990 comment =
"This is a comment";
1993 PresenceDescriptorGroupItem gi;
1994 gi.initForDocumenting();
1995 groupAliases.push_back(gi);
1997 location.initForDocumenting();
1999 announceOnReceive =
true;
2000 connectivity.initForDocumenting();
2001 power.initForDocumenting();
2005 static void to_json(nlohmann::json& j,
const PresenceDescriptor& p)
2009 TOJSON_IMPL(nextUpdate),
2010 TOJSON_IMPL(identity),
2011 TOJSON_IMPL(comment),
2012 TOJSON_IMPL(disposition),
2013 TOJSON_IMPL(groupAliases),
2014 TOJSON_IMPL(location),
2015 TOJSON_IMPL(custom),
2016 TOJSON_IMPL(announceOnReceive),
2017 TOJSON_IMPL(connectivity),
2021 if(!p.comment.empty()) j[
"comment"] = p.comment;
2022 if(!p.custom.empty()) j[
"custom"] = p.custom;
2029 static void from_json(
const nlohmann::json& j, PresenceDescriptor& p)
2032 getOptional<bool>(
"self", p.self, j);
2033 getOptional<uint32_t>(
"ts", p.ts, j);
2034 getOptional<uint32_t>(
"nextUpdate", p.nextUpdate, j);
2035 getOptional<Identity>(
"identity", p.identity, j);
2036 getOptional<std::string>(
"comment", p.comment, j);
2037 getOptional<uint32_t>(
"disposition", p.disposition, j);
2038 getOptional<std::vector<PresenceDescriptorGroupItem>>(
"groupAliases", p.groupAliases, j);
2039 getOptional<Location>(
"location", p.location, j);
2040 getOptional<std::string>(
"custom", p.custom, j);
2041 getOptional<bool>(
"announceOnReceive", p.announceOnReceive, j);
2042 getOptional<Connectivity>(
"connectivity", p.connectivity, j);
2043 getOptional<Power>(
"power", p.power, j);
2084 } AddressResolutionPolicy_t;
2087 JSON_SERIALIZED_CLASS(NetworkTxOptions)
2101 IMPLEMENT_JSON_SERIALIZATION()
2126 virtual void initForDocumenting()
2131 static void to_json(nlohmann::json& j,
const NetworkTxOptions& p)
2134 TOJSON_IMPL(priority),
2138 static void from_json(
const nlohmann::json& j, NetworkTxOptions& p)
2141 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
2142 getOptional<int>(
"ttl", p.ttl, j, 1);
2147 JSON_SERIALIZED_CLASS(TcpNetworkTxOptions)
2157 IMPLEMENT_JSON_SERIALIZATION()
2172 virtual void initForDocumenting()
2180 TOJSON_IMPL(priority),
2184 static void from_json(
const nlohmann::json& j, TcpNetworkTxOptions& p)
2187 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
2188 getOptional<int>(
"ttl", p.ttl, j, -1);
2204 JSON_SERIALIZED_CLASS(NetworkAddress)
2217 IMPLEMENT_JSON_SERIALIZATION()
2238 bool matches(
const NetworkAddress& other)
2240 if(address.compare(other.address) != 0)
2245 if(port != other.port)
2254 static void to_json(nlohmann::json& j,
const NetworkAddress& p)
2257 TOJSON_IMPL(address),
2261 static void from_json(
const nlohmann::json& j, NetworkAddress& p)
2264 getOptional<std::string>(
"address", p.address, j);
2265 getOptional<int>(
"port", p.port, j);
2270 JSON_SERIALIZED_CLASS(NetworkAddressRxTx)
2283 IMPLEMENT_JSON_SERIALIZATION()
2305 static void to_json(nlohmann::json& j,
const NetworkAddressRxTx& p)
2312 static void from_json(
const nlohmann::json& j, NetworkAddressRxTx& p)
2315 getOptional<NetworkAddress>(
"rx", p.rx, j);
2316 getOptional<NetworkAddress>(
"tx", p.tx, j);
2327 } GroupRestrictionAccessPolicyType_t;
2329 static bool isValidGroupRestrictionAccessPolicyType(GroupRestrictionAccessPolicyType_t t)
2331 return (t == GroupRestrictionAccessPolicyType_t::graptPermissive ||
2332 t == GroupRestrictionAccessPolicyType_t::graptStrict );
2346 } RestrictionType_t;
2348 static bool isValidRestrictionType(RestrictionType_t t)
2350 return (t == RestrictionType_t::rtUndefined ||
2351 t == RestrictionType_t::rtWhitelist ||
2352 t == RestrictionType_t::rtBlacklist );
2378 } RestrictionElementType_t;
2380 static bool isValidRestrictionElementType(RestrictionElementType_t t)
2382 return (t == RestrictionElementType_t::retGroupId ||
2383 t == RestrictionElementType_t::retGroupIdPattern ||
2384 t == RestrictionElementType_t::retGenericAccessTagPattern ||
2385 t == RestrictionElementType_t::retCertificateSerialNumberPattern ||
2386 t == RestrictionElementType_t::retCertificateFingerprintPattern ||
2387 t == RestrictionElementType_t::retCertificateSubjectPattern ||
2388 t == RestrictionElementType_t::retCertificateIssuerPattern);
2393 JSON_SERIALIZED_CLASS(NetworkAddressRestrictionList)
2406 IMPLEMENT_JSON_SERIALIZATION()
2423 type = RestrictionType_t::rtUndefined;
2428 static void to_json(nlohmann::json& j,
const NetworkAddressRestrictionList& p)
2432 TOJSON_IMPL(elements)
2435 static void from_json(
const nlohmann::json& j, NetworkAddressRestrictionList& p)
2438 getOptional<RestrictionType_t>(
"type", p.type, j, RestrictionType_t::rtUndefined);
2439 getOptional<std::vector<NetworkAddressRxTx>>(
"elements", p.elements, j);
2443 JSON_SERIALIZED_CLASS(StringRestrictionList)
2456 IMPLEMENT_JSON_SERIALIZATION()
2471 type = RestrictionType_t::rtUndefined;
2472 elementsType = RestrictionElementType_t::retGroupId;
2482 static void to_json(nlohmann::json& j,
const StringRestrictionList& p)
2486 TOJSON_IMPL(elementsType),
2487 TOJSON_IMPL(elements)
2490 static void from_json(
const nlohmann::json& j, StringRestrictionList& p)
2493 getOptional<RestrictionType_t>(
"type", p.type, j, RestrictionType_t::rtUndefined);
2494 getOptional<RestrictionElementType_t>(
"elementsType", p.elementsType, j, RestrictionElementType_t::retGroupId);
2495 getOptional<std::vector<std::string>>(
"elements", p.elements, j);
2500 JSON_SERIALIZED_CLASS(PacketCapturer)
2511 IMPLEMENT_JSON_SERIALIZATION()
2517 std::string filePrefix;
2535 TOJSON_IMPL(enabled),
2537 TOJSON_IMPL(filePrefix)
2540 static void from_json(
const nlohmann::json& j, PacketCapturer& p)
2543 getOptional<bool>(
"enabled", p.enabled, j,
false);
2544 getOptional<uint32_t>(
"maxMb", p.maxMb, j, 10);
2545 getOptional<std::string>(
"filePrefix", p.filePrefix, j, EMPTY_STRING);
2550 JSON_SERIALIZED_CLASS(TransportImpairment)
2561 IMPLEMENT_JSON_SERIALIZATION()
2565 int applicationPercentage;
2576 applicationPercentage = 0;
2585 TOJSON_IMPL(applicationPercentage),
2586 TOJSON_IMPL(jitterMs),
2587 TOJSON_IMPL(lossPercentage)
2590 static void from_json(
const nlohmann::json& j, TransportImpairment& p)
2593 getOptional<int>(
"applicationPercentage", p.applicationPercentage, j, 0);
2594 getOptional<int>(
"jitterMs", p.jitterMs, j, 0);
2595 getOptional<int>(
"lossPercentage", p.lossPercentage, j, 0);
2599 JSON_SERIALIZED_CLASS(NsmNetworking)
2610 IMPLEMENT_JSON_SERIALIZATION()
2614 std::string interfaceName;
2621 std::string cryptoPassword;
2630 interfaceName.clear();
2635 rxImpairment.clear();
2636 txImpairment.clear();
2637 cryptoPassword.clear();
2641 static void to_json(nlohmann::json& j,
const NsmNetworking& p)
2644 TOJSON_IMPL(interfaceName),
2645 TOJSON_IMPL(address),
2648 TOJSON_IMPL(txOversend),
2649 TOJSON_IMPL(rxImpairment),
2650 TOJSON_IMPL(txImpairment),
2651 TOJSON_IMPL(cryptoPassword)
2654 static void from_json(
const nlohmann::json& j, NsmNetworking& p)
2657 getOptional(
"interfaceName", p.interfaceName, j, EMPTY_STRING);
2658 getOptional<NetworkAddress>(
"address", p.address, j);
2659 getOptional<int>(
"ttl", p.ttl, j, 1);
2660 getOptional<int>(
"tos", p.tos, j, 56);
2661 getOptional<int>(
"txOversend", p.txOversend, j, 0);
2662 getOptional<TransportImpairment>(
"rxImpairment", p.rxImpairment, j);
2663 getOptional<TransportImpairment>(
"txImpairment", p.txImpairment, j);
2664 getOptional(
"cryptoPassword", p.cryptoPassword, j, EMPTY_STRING);
2669 JSON_SERIALIZED_CLASS(NsmConfiguration)
2680 IMPLEMENT_JSON_SERIALIZATION()
2688 std::vector<std::string> resources;
2692 int transitionSecsFactor;
2702 favorUptime =
false;
2705 tokenStart = 1000000;
2708 transitionSecsFactor = 3;
2716 TOJSON_IMPL(favorUptime),
2717 TOJSON_IMPL(networking),
2718 TOJSON_IMPL(resources),
2719 TOJSON_IMPL(tokenStart),
2720 TOJSON_IMPL(tokenEnd),
2721 TOJSON_IMPL(intervalSecs),
2722 TOJSON_IMPL(transitionSecsFactor)
2725 static void from_json(
const nlohmann::json& j, NsmConfiguration& p)
2728 getOptional(
"id", p.id, j);
2729 getOptional<bool>(
"favorUptime", p.favorUptime, j,
false);
2730 getOptional<NsmNetworking>(
"networking", p.networking, j);
2731 getOptional<std::vector<std::string>>(
"resources", p.resources, j);
2732 getOptional<int>(
"tokenStart", p.tokenStart, j, 1000000);
2733 getOptional<int>(
"tokenEnd", p.tokenEnd, j, 2000000);
2734 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 1);
2735 getOptional<int>(
"transitionSecsFactor", p.transitionSecsFactor, j, 3);
2740 JSON_SERIALIZED_CLASS(Rallypoint)
2750 IMPLEMENT_JSON_SERIALIZATION()
2826 certificate.clear();
2827 certificateKey.clear();
2828 caCertificates.clear();
2830 transactionTimeoutMs = 5000;
2831 disableMessageSigning =
false;
2832 connectionTimeoutSecs = 5;
2833 tcpTxOptions.clear();
2836 bool matches(
const Rallypoint& other)
2838 if(!host.matches(other.host))
2843 if(certificate.compare(other.certificate) != 0)
2848 if(certificateKey.compare(other.certificateKey) != 0)
2853 if(verifyPeer != other.verifyPeer)
2858 if(allowSelfSignedCertificate != other.allowSelfSignedCertificate)
2863 if(caCertificates.size() != other.caCertificates.size())
2868 for(
size_t x = 0; x < caCertificates.size(); x++)
2872 for(
size_t y = 0; y < other.caCertificates.size(); y++)
2874 if(caCertificates[x].compare(other.caCertificates[y]) == 0)
2887 if(transactionTimeoutMs != other.transactionTimeoutMs)
2892 if(disableMessageSigning != other.disableMessageSigning)
2901 static void to_json(nlohmann::json& j,
const Rallypoint& p)
2905 TOJSON_IMPL(certificate),
2906 TOJSON_IMPL(certificateKey),
2907 TOJSON_IMPL(verifyPeer),
2908 TOJSON_IMPL(allowSelfSignedCertificate),
2909 TOJSON_IMPL(caCertificates),
2910 TOJSON_IMPL(transactionTimeoutMs),
2911 TOJSON_IMPL(disableMessageSigning),
2912 TOJSON_IMPL(connectionTimeoutSecs),
2913 TOJSON_IMPL(tcpTxOptions)
2917 static void from_json(
const nlohmann::json& j, Rallypoint& p)
2920 j.at(
"host").get_to(p.host);
2921 getOptional(
"certificate", p.certificate, j);
2922 getOptional(
"certificateKey", p.certificateKey, j);
2923 getOptional<bool>(
"verifyPeer", p.verifyPeer, j,
true);
2924 getOptional<bool>(
"allowSelfSignedCertificate", p.allowSelfSignedCertificate, j,
false);
2925 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
2926 getOptional<int>(
"transactionTimeoutMs", p.transactionTimeoutMs, j, 5000);
2927 getOptional<bool>(
"disableMessageSigning", p.disableMessageSigning, j,
false);
2928 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 5);
2929 getOptional<TcpNetworkTxOptions>(
"tcpTxOptions", p.tcpTxOptions, j);
2933 JSON_SERIALIZED_CLASS(RallypointCluster)
2946 IMPLEMENT_JSON_SERIALIZATION()
2962 } ConnectionStrategy_t;
2983 connectionStrategy = csRoundRobin;
2984 rallypoints.clear();
2986 connectionTimeoutSecs = 5;
2990 static void to_json(nlohmann::json& j,
const RallypointCluster& p)
2993 TOJSON_IMPL(connectionStrategy),
2994 TOJSON_IMPL(rallypoints),
2995 TOJSON_IMPL(rolloverSecs),
2996 TOJSON_IMPL(connectionTimeoutSecs)
2999 static void from_json(
const nlohmann::json& j, RallypointCluster& p)
3002 getOptional<RallypointCluster::ConnectionStrategy_t>(
"connectionStrategy", p.connectionStrategy, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
3003 getOptional<std::vector<Rallypoint>>(
"rallypoints", p.rallypoints, j);
3004 getOptional<int>(
"rolloverSecs", p.rolloverSecs, j, 10);
3005 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 5);
3010 JSON_SERIALIZED_CLASS(NetworkDeviceDescriptor)
3022 IMPLEMENT_JSON_SERIALIZATION()
3063 manufacturer.clear();
3066 serialNumber.clear();
3071 virtual std::string toString()
3075 snprintf(buff,
sizeof(buff),
"deviceId=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, type=%s, extra=%s",
3078 manufacturer.c_str(),
3081 serialNumber.c_str(),
3085 return std::string(buff);
3089 static void to_json(nlohmann::json& j,
const NetworkDeviceDescriptor& p)
3092 TOJSON_IMPL(deviceId),
3094 TOJSON_IMPL(manufacturer),
3096 TOJSON_IMPL(hardwareId),
3097 TOJSON_IMPL(serialNumber),
3102 static void from_json(
const nlohmann::json& j, NetworkDeviceDescriptor& p)
3105 getOptional<int>(
"deviceId", p.deviceId, j, 0);
3106 getOptional(
"name", p.name, j);
3107 getOptional(
"manufacturer", p.manufacturer, j);
3108 getOptional(
"model", p.model, j);
3109 getOptional(
"hardwareId", p.hardwareId, j);
3110 getOptional(
"serialNumber", p.serialNumber, j);
3111 getOptional(
"type", p.type, j);
3112 getOptional(
"extra", p.extra, j);
3116 JSON_SERIALIZED_CLASS(AudioGate)
3127 IMPLEMENT_JSON_SERIALIZATION()
3166 static void to_json(nlohmann::json& j,
const AudioGate& p)
3169 TOJSON_IMPL(enabled),
3170 TOJSON_IMPL(useVad),
3171 TOJSON_IMPL(hangMs),
3172 TOJSON_IMPL(windowMin),
3173 TOJSON_IMPL(windowMax),
3174 TOJSON_IMPL(coefficient)
3177 static void from_json(
const nlohmann::json& j, AudioGate& p)
3180 getOptional<bool>(
"enabled", p.enabled, j,
false);
3181 getOptional<bool>(
"useVad", p.useVad, j,
false);
3182 getOptional<uint32_t>(
"hangMs", p.hangMs, j, 1500);
3183 getOptional<uint32_t>(
"windowMin", p.windowMin, j, 25);
3184 getOptional<uint32_t>(
"windowMax", p.windowMax, j, 125);
3185 getOptional<double>(
"coefficient", p.coefficient, j, 1.75);
3189 JSON_SERIALIZED_CLASS(TxAudio)
3204 IMPLEMENT_JSON_SERIALIZATION()
3205 IMPLEMENT_JSON_DOCUMENTATION(
TxAudio)
3441 encoder = TxAudio::TxCodec_t::ctUnknown;
3442 encoderName.clear();
3448 extensionSendInterval = 10;
3449 initialHeaderBurst = 5;
3450 trailingHeaderBurst = 5;
3451 startTxNotifications = 5;
3452 customRtpPayloadType = -1;
3454 resetRtpOnTx =
true;
3455 enableSmoothing =
true;
3457 smoothedHangTimeMs = 0;
3461 static void to_json(nlohmann::json& j,
const TxAudio& p)
3464 TOJSON_IMPL(enabled),
3465 TOJSON_IMPL(encoder),
3466 TOJSON_IMPL(encoderName),
3467 TOJSON_IMPL(framingMs),
3468 TOJSON_IMPL(blockCount),
3470 TOJSON_IMPL(noHdrExt),
3471 TOJSON_IMPL(maxTxSecs),
3472 TOJSON_IMPL(extensionSendInterval),
3473 TOJSON_IMPL(initialHeaderBurst),
3474 TOJSON_IMPL(trailingHeaderBurst),
3475 TOJSON_IMPL(startTxNotifications),
3476 TOJSON_IMPL(customRtpPayloadType),
3477 TOJSON_IMPL(resetRtpOnTx),
3478 TOJSON_IMPL(enableSmoothing),
3480 TOJSON_IMPL(smoothedHangTimeMs)
3485 static void from_json(
const nlohmann::json& j, TxAudio& p)
3488 getOptional<bool>(
"enabled", p.enabled, j,
true);
3489 getOptional<TxAudio::TxCodec_t>(
"encoder", p.encoder, j, TxAudio::TxCodec_t::ctOpus8000);
3490 getOptional<std::string>(
"encoderName", p.encoderName, j, EMPTY_STRING);
3491 getOptional(
"framingMs", p.framingMs, j, 60);
3492 getOptional(
"blockCount", p.blockCount, j, 0);
3493 getOptional(
"fdx", p.fdx, j,
false);
3494 getOptional(
"noHdrExt", p.noHdrExt, j,
false);
3495 getOptional(
"maxTxSecs", p.maxTxSecs, j, 0);
3496 getOptional(
"extensionSendInterval", p.extensionSendInterval, j, 10);
3497 getOptional(
"initialHeaderBurst", p.initialHeaderBurst, j, 5);
3498 getOptional(
"trailingHeaderBurst", p.trailingHeaderBurst, j, 5);
3499 getOptional(
"startTxNotifications", p.startTxNotifications, j, 5);
3500 getOptional(
"customRtpPayloadType", p.customRtpPayloadType, j, -1);
3501 getOptional(
"resetRtpOnTx", p.resetRtpOnTx, j,
true);
3502 getOptional(
"enableSmoothing", p.enableSmoothing, j,
true);
3503 getOptional(
"dtx", p.dtx, j,
false);
3504 getOptional(
"smoothedHangTimeMs", p.smoothedHangTimeMs, j, 0);
3510 JSON_SERIALIZED_CLASS(AudioDeviceDescriptor)
3522 IMPLEMENT_JSON_SERIALIZATION()
3616 direction = dirUnknown;
3617 boostPercentage = 0;
3622 manufacturer.clear();
3625 serialNumber.clear();
3631 virtual std::string toString()
3635 snprintf(buff,
sizeof(buff),
"deviceId=%d, samplingRate=%d, channels=%d, direction=%d, boostPercentage=%d, isAdad=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, isDefault=%d, type=%s, present=%d, extra=%s",
3643 manufacturer.c_str(),
3646 serialNumber.c_str(),
3652 return std::string(buff);
3656 static void to_json(nlohmann::json& j,
const AudioDeviceDescriptor& p)
3659 TOJSON_IMPL(deviceId),
3660 TOJSON_IMPL(samplingRate),
3661 TOJSON_IMPL(channels),
3662 TOJSON_IMPL(direction),
3663 TOJSON_IMPL(boostPercentage),
3664 TOJSON_IMPL(isAdad),
3666 TOJSON_IMPL(manufacturer),
3668 TOJSON_IMPL(hardwareId),
3669 TOJSON_IMPL(serialNumber),
3670 TOJSON_IMPL(isDefault),
3673 TOJSON_IMPL(isPresent)
3676 static void from_json(
const nlohmann::json& j, AudioDeviceDescriptor& p)
3679 getOptional<int>(
"deviceId", p.deviceId, j, 0);
3680 getOptional<int>(
"samplingRate", p.samplingRate, j, 0);
3681 getOptional<int>(
"channels", p.channels, j, 0);
3682 getOptional<AudioDeviceDescriptor::Direction_t>(
"direction", p.direction, j,
3683 AudioDeviceDescriptor::Direction_t::dirUnknown);
3684 getOptional<int>(
"boostPercentage", p.boostPercentage, j, 0);
3686 getOptional<bool>(
"isAdad", p.isAdad, j,
false);
3687 getOptional(
"name", p.name, j);
3688 getOptional(
"manufacturer", p.manufacturer, j);
3689 getOptional(
"model", p.model, j);
3690 getOptional(
"hardwareId", p.hardwareId, j);
3691 getOptional(
"serialNumber", p.serialNumber, j);
3692 getOptional(
"isDefault", p.isDefault, j);
3693 getOptional(
"type", p.type, j);
3694 getOptional(
"extra", p.extra, j);
3695 getOptional<bool>(
"isPresent", p.isPresent, j,
false);
3699 JSON_SERIALIZED_CLASS(ListOfAudioDeviceDescriptor)
3702 IMPLEMENT_JSON_SERIALIZATION()
3706 std::vector<AudioDeviceDescriptor> list;
3725 static void from_json(
const nlohmann::json& j, ListOfAudioDeviceDescriptor& p)
3728 getOptional<std::vector<AudioDeviceDescriptor>>(
"list", p.list, j);
3732 JSON_SERIALIZED_CLASS(Audio)
3742 IMPLEMENT_JSON_SERIALIZATION()
3743 IMPLEMENT_JSON_DOCUMENTATION(
Audio)
3782 outputLevelLeft = 100;
3783 outputLevelRight = 100;
3784 outputMuted =
false;
3788 static void to_json(nlohmann::json& j,
const Audio& p)
3791 TOJSON_IMPL(enabled),
3792 TOJSON_IMPL(inputId),
3793 TOJSON_IMPL(inputGain),
3794 TOJSON_IMPL(outputId),
3795 TOJSON_IMPL(outputLevelLeft),
3796 TOJSON_IMPL(outputLevelRight),
3797 TOJSON_IMPL(outputMuted)
3800 static void from_json(
const nlohmann::json& j, Audio& p)
3803 getOptional<bool>(
"enabled", p.enabled, j,
true);
3804 getOptional<int>(
"inputId", p.inputId, j, 0);
3805 getOptional<int>(
"inputGain", p.inputGain, j, 0);
3806 getOptional<int>(
"outputId", p.outputId, j, 0);
3807 getOptional<int>(
"outputGain", p.outputGain, j, 0);
3808 getOptional<int>(
"outputLevelLeft", p.outputLevelLeft, j, 100);
3809 getOptional<int>(
"outputLevelRight", p.outputLevelRight, j, 100);
3810 getOptional<bool>(
"outputMuted", p.outputMuted, j,
false);
3814 JSON_SERIALIZED_CLASS(TalkerInformation)
3826 IMPLEMENT_JSON_SERIALIZATION()
3842 matSsrcGenerated = 2
3843 } ManufacturedAliasType_t;
3888 aliasSpecializer = 0;
3890 manufacturedAliasType = ManufacturedAliasType_t::matNone;
3895 static void to_json(nlohmann::json& j,
const TalkerInformation& p)
3899 TOJSON_IMPL(nodeId),
3900 TOJSON_IMPL(rxFlags),
3901 TOJSON_IMPL(txPriority),
3903 TOJSON_IMPL(duplicateCount),
3904 TOJSON_IMPL(aliasSpecializer),
3905 TOJSON_IMPL(rxMuted),
3906 TOJSON_IMPL(manufacturedAliasType),
3910 static void from_json(
const nlohmann::json& j, TalkerInformation& p)
3913 getOptional<std::string>(
"alias", p.alias, j, EMPTY_STRING);
3914 getOptional<std::string>(
"nodeId", p.nodeId, j, EMPTY_STRING);
3915 getOptional<uint16_t>(
"rxFlags", p.rxFlags, j, 0);
3916 getOptional<int>(
"txPriority", p.txPriority, j, 0);
3917 getOptional<uint32_t>(
"txId", p.txId, j, 0);
3918 getOptional<int>(
"duplicateCount", p.duplicateCount, j, 0);
3919 getOptional<uint16_t>(
"aliasSpecializer", p.aliasSpecializer, j, 0);
3920 getOptional<bool>(
"rxMuted", p.rxMuted, j,
false);
3921 getOptional<TalkerInformation::ManufacturedAliasType_t>(
"manufacturedAliasType", p.manufacturedAliasType, j, TalkerInformation::ManufacturedAliasType_t::matNone);
3922 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
3926 JSON_SERIALIZED_CLASS(GroupTalkers)
3940 IMPLEMENT_JSON_SERIALIZATION()
3945 std::vector<TalkerInformation>
list;
3958 static void to_json(nlohmann::json& j,
const GroupTalkers& p)
3964 static void from_json(
const nlohmann::json& j, GroupTalkers& p)
3967 getOptional<std::vector<TalkerInformation>>(
"list", p.list, j);
3971 JSON_SERIALIZED_CLASS(Presence)
3983 IMPLEMENT_JSON_SERIALIZATION()
3984 IMPLEMENT_JSON_DOCUMENTATION(
Presence)
4029 minIntervalSecs = 5;
4033 static void to_json(nlohmann::json& j,
const Presence& p)
4036 TOJSON_IMPL(format),
4037 TOJSON_IMPL(intervalSecs),
4038 TOJSON_IMPL(listenOnly),
4039 TOJSON_IMPL(minIntervalSecs)
4042 static void from_json(
const nlohmann::json& j, Presence& p)
4045 getOptional<Presence::Format_t>(
"format", p.format, j, Presence::Format_t::pfEngage);
4046 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 30);
4047 getOptional<bool>(
"listenOnly", p.listenOnly, j,
false);
4048 getOptional<int>(
"minIntervalSecs", p.minIntervalSecs, j, 5);
4053 JSON_SERIALIZED_CLASS(Advertising)
4065 IMPLEMENT_JSON_SERIALIZATION()
4087 alwaysAdvertise =
false;
4091 static void to_json(nlohmann::json& j,
const Advertising& p)
4094 TOJSON_IMPL(enabled),
4095 TOJSON_IMPL(intervalMs),
4096 TOJSON_IMPL(alwaysAdvertise)
4099 static void from_json(
const nlohmann::json& j, Advertising& p)
4102 getOptional(
"enabled", p.enabled, j,
false);
4103 getOptional<int>(
"intervalMs", p.intervalMs, j, 20000);
4104 getOptional<bool>(
"alwaysAdvertise", p.alwaysAdvertise, j,
false);
4108 JSON_SERIALIZED_CLASS(GroupPriorityTranslation)
4120 IMPLEMENT_JSON_SERIALIZATION()
4146 static void to_json(nlohmann::json& j,
const GroupPriorityTranslation& p)
4151 TOJSON_IMPL(priority)
4154 static void from_json(
const nlohmann::json& j, GroupPriorityTranslation& p)
4157 j.at(
"rx").get_to(p.rx);
4158 j.at(
"tx").get_to(p.tx);
4159 FROMJSON_IMPL(priority,
int, 0);
4163 JSON_SERIALIZED_CLASS(GroupTimeline)
4177 IMPLEMENT_JSON_SERIALIZATION()
4196 maxAudioTimeMs = 30000;
4201 static void to_json(nlohmann::json& j,
const GroupTimeline& p)
4204 TOJSON_IMPL(enabled),
4205 TOJSON_IMPL(maxAudioTimeMs),
4206 TOJSON_IMPL(recordAudio)
4209 static void from_json(
const nlohmann::json& j, GroupTimeline& p)
4212 getOptional(
"enabled", p.enabled, j,
true);
4213 getOptional<int>(
"maxAudioTimeMs", p.maxAudioTimeMs, j, 30000);
4214 getOptional(
"recordAudio", p.recordAudio, j,
true);
4317 IMPLEMENT_JSON_SERIALIZATION()
4339 static void to_json(nlohmann::json& j,
const GroupAppTransport& p)
4342 TOJSON_IMPL(enabled),
4346 static void from_json(
const nlohmann::json& j, GroupAppTransport& p)
4349 getOptional<bool>(
"enabled", p.enabled, j,
false);
4350 getOptional<std::string>(
"id", p.id, j);
4354 JSON_SERIALIZED_CLASS(RtpProfile)
4366 IMPLEMENT_JSON_SERIALIZATION()
4384 jmReleaseOnTxEnd = 2
4447 jitterMaxMs = 10000;
4449 jitterMaxFactor = 8;
4450 jitterTrimPercentage = 10;
4451 jitterUnderrunReductionThresholdMs = 1500;
4452 jitterUnderrunReductionAger = 100;
4453 latePacketSequenceRange = 5;
4454 latePacketTimestampRangeMs = 2000;
4455 inboundProcessorInactivityMs = 500;
4456 jitterForceTrimAtMs = 0;
4457 rtcpPresenceTimeoutMs = 45000;
4458 jitterMaxExceededClipPerc = 10;
4459 jitterMaxExceededClipHangMs = 1500;
4460 zombieLifetimeMs = 15000;
4461 jitterMaxTrimMs = 250;
4462 signalledInboundProcessorInactivityMs = (inboundProcessorInactivityMs * 4);
4466 static void to_json(nlohmann::json& j,
const RtpProfile& p)
4470 TOJSON_IMPL(jitterMaxMs),
4471 TOJSON_IMPL(inboundProcessorInactivityMs),
4472 TOJSON_IMPL(jitterMinMs),
4473 TOJSON_IMPL(jitterMaxFactor),
4474 TOJSON_IMPL(jitterTrimPercentage),
4475 TOJSON_IMPL(jitterUnderrunReductionThresholdMs),
4476 TOJSON_IMPL(jitterUnderrunReductionAger),
4477 TOJSON_IMPL(latePacketSequenceRange),
4478 TOJSON_IMPL(latePacketTimestampRangeMs),
4479 TOJSON_IMPL(inboundProcessorInactivityMs),
4480 TOJSON_IMPL(jitterForceTrimAtMs),
4481 TOJSON_IMPL(jitterMaxExceededClipPerc),
4482 TOJSON_IMPL(jitterMaxExceededClipHangMs),
4483 TOJSON_IMPL(zombieLifetimeMs),
4484 TOJSON_IMPL(jitterMaxTrimMs),
4485 TOJSON_IMPL(signalledInboundProcessorInactivityMs)
4488 static void from_json(
const nlohmann::json& j, RtpProfile& p)
4491 FROMJSON_IMPL(mode, RtpProfile::JitterMode_t, RtpProfile::JitterMode_t::jmStandard);
4492 FROMJSON_IMPL(jitterMaxMs,
int, 10000);
4493 FROMJSON_IMPL(jitterMinMs,
int, 20);
4494 FROMJSON_IMPL(jitterMaxFactor,
int, 8);
4495 FROMJSON_IMPL(jitterTrimPercentage,
int, 10);
4496 FROMJSON_IMPL(jitterUnderrunReductionThresholdMs,
int, 1500);
4497 FROMJSON_IMPL(jitterUnderrunReductionAger,
int, 100);
4498 FROMJSON_IMPL(latePacketSequenceRange,
int, 5);
4499 FROMJSON_IMPL(latePacketTimestampRangeMs,
int, 2000);
4500 FROMJSON_IMPL(inboundProcessorInactivityMs,
int, 500);
4501 FROMJSON_IMPL(jitterForceTrimAtMs,
int, 0);
4502 FROMJSON_IMPL(rtcpPresenceTimeoutMs,
int, 45000);
4503 FROMJSON_IMPL(jitterMaxExceededClipPerc,
int, 10);
4504 FROMJSON_IMPL(jitterMaxExceededClipHangMs,
int, 1500);
4505 FROMJSON_IMPL(zombieLifetimeMs,
int, 15000);
4506 FROMJSON_IMPL(jitterMaxTrimMs,
int, 250);
4507 FROMJSON_IMPL(signalledInboundProcessorInactivityMs,
int, (p.inboundProcessorInactivityMs * 4));
4511 JSON_SERIALIZED_CLASS(Tls)
4523 IMPLEMENT_JSON_SERIALIZATION()
4524 IMPLEMENT_JSON_DOCUMENTATION(
Tls)
4554 allowSelfSignedCertificates =
false;
4555 caCertificates.clear();
4556 subjectRestrictions.clear();
4557 issuerRestrictions.clear();
4562 static void to_json(nlohmann::json& j,
const Tls& p)
4565 TOJSON_IMPL(verifyPeers),
4566 TOJSON_IMPL(allowSelfSignedCertificates),
4567 TOJSON_IMPL(caCertificates),
4568 TOJSON_IMPL(subjectRestrictions),
4569 TOJSON_IMPL(issuerRestrictions),
4570 TOJSON_IMPL(crlSerials)
4573 static void from_json(
const nlohmann::json& j, Tls& p)
4576 getOptional<bool>(
"verifyPeers", p.verifyPeers, j,
true);
4577 getOptional<bool>(
"allowSelfSignedCertificates", p.allowSelfSignedCertificates, j,
false);
4578 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
4579 getOptional<StringRestrictionList>(
"subjectRestrictions", p.subjectRestrictions, j);
4580 getOptional<StringRestrictionList>(
"issuerRestrictions", p.issuerRestrictions, j);
4581 getOptional<std::vector<std::string>>(
"crlSerials", p.crlSerials, j);
4585 JSON_SERIALIZED_CLASS(RangerPackets)
4599 IMPLEMENT_JSON_SERIALIZATION()
4620 virtual void initForDocumenting()
4625 static void to_json(nlohmann::json& j,
const RangerPackets& p)
4628 TOJSON_IMPL(hangTimerSecs),
4632 static void from_json(
const nlohmann::json& j, RangerPackets& p)
4635 getOptional<int>(
"hangTimerSecs", p.hangTimerSecs, j, 11);
4636 getOptional<int>(
"count", p.count, j, 5);
4640 JSON_SERIALIZED_CLASS(Source)
4654 IMPLEMENT_JSON_SERIALIZATION()
4655 IMPLEMENT_JSON_DOCUMENTATION(
Source)
4662 uint8_t _internal_binary_nodeId[ENGAGE_MAX_NODE_ID_SIZE];
4668 uint8_t _internal_binary_alias[ENGAGE_MAX_ALIAS_SIZE];
4678 memset(_internal_binary_nodeId, 0,
sizeof(_internal_binary_nodeId));
4681 memset(_internal_binary_alias, 0,
sizeof(_internal_binary_alias));
4684 virtual void initForDocumenting()
4689 static void to_json(nlohmann::json& j,
const Source& p)
4692 TOJSON_IMPL(nodeId),
4696 static void from_json(
const nlohmann::json& j, Source& p)
4699 FROMJSON_IMPL_SIMPLE(nodeId);
4700 FROMJSON_IMPL_SIMPLE(alias);
4704 JSON_SERIALIZED_CLASS(Group)
4717 IMPLEMENT_JSON_SERIALIZATION()
4718 IMPLEMENT_JSON_DOCUMENTATION(
Group)
4745 bomPayloadTransformation = 1,
4748 bomAnonymousMixing = 2,
4751 bomLanguageTranslation = 3
4758 iagpAnonymousAlias = 0,
4762 } InboundAliasGenerationPolicy_t;
4938 interfaceName.clear();
4944 cryptoPassword.clear();
4948 rallypoints.clear();
4949 rallypointCluster.clear();
4954 blockAdvertising =
false;
4960 enableMulticastFailover =
false;
4961 multicastFailoverSecs = 10;
4963 rtcpPresenceRx.clear();
4965 presenceGroupAffinities.clear();
4966 disablePacketEvents =
false;
4968 rfc4733RtpPayloadId = 0;
4969 inboundRtpPayloadTypeTranslations.clear();
4970 priorityTranslation.clear();
4972 stickyTidHangSecs = 10;
4973 anonymousAlias.clear();
4976 appTransport.clear();
4977 allowLoopback =
false;
4980 rangerPackets.clear();
4982 _wasDeserialized_rtpProfile =
false;
4984 txImpairment.clear();
4985 rxImpairment.clear();
4987 specializerAffinities.clear();
4991 ignoreSources.clear();
4993 languageCode.clear();
5000 inboundAliasGenerationPolicy = iagpAnonymousAlias;
5003 ignoreAudioTraffic =
false;
5007 static void to_json(nlohmann::json& j,
const Group& p)
5014 TOJSON_IMPL(spokenName),
5015 TOJSON_IMPL(interfaceName),
5018 TOJSON_IMPL(txOptions),
5019 TOJSON_IMPL(txAudio),
5020 TOJSON_IMPL(presence),
5021 TOJSON_IMPL(cryptoPassword),
5030 TOJSON_IMPL(timeline),
5031 TOJSON_IMPL(blockAdvertising),
5032 TOJSON_IMPL(source),
5033 TOJSON_IMPL(maxRxSecs),
5034 TOJSON_IMPL(enableMulticastFailover),
5035 TOJSON_IMPL(multicastFailoverSecs),
5036 TOJSON_IMPL(rtcpPresenceRx),
5037 TOJSON_IMPL(presenceGroupAffinities),
5038 TOJSON_IMPL(disablePacketEvents),
5039 TOJSON_IMPL(rfc4733RtpPayloadId),
5040 TOJSON_IMPL(inboundRtpPayloadTypeTranslations),
5041 TOJSON_IMPL(priorityTranslation),
5042 TOJSON_IMPL(stickyTidHangSecs),
5043 TOJSON_IMPL(anonymousAlias),
5044 TOJSON_IMPL(lbCrypto),
5045 TOJSON_IMPL(appTransport),
5046 TOJSON_IMPL(allowLoopback),
5047 TOJSON_IMPL(rangerPackets),
5049 TOJSON_IMPL(txImpairment),
5050 TOJSON_IMPL(rxImpairment),
5052 TOJSON_IMPL(specializerAffinities),
5054 TOJSON_IMPL(securityLevel),
5056 TOJSON_IMPL(ignoreSources),
5058 TOJSON_IMPL(languageCode),
5059 TOJSON_IMPL(synVoice),
5061 TOJSON_IMPL(rxCapture),
5062 TOJSON_IMPL(txCapture),
5064 TOJSON_IMPL(blobRtpPayloadType),
5066 TOJSON_IMPL(inboundAliasGenerationPolicy),
5068 TOJSON_IMPL(gateIn),
5070 TOJSON_IMPL(ignoreAudioTraffic)
5076 if(p._wasDeserialized_rtpProfile || p.isDocumenting())
5078 j[
"rtpProfile"] = p.rtpProfile;
5081 if(p.isDocumenting())
5083 j[
"rallypointCluster"] = p.rallypointCluster;
5084 j[
"rallypoints"] = p.rallypoints;
5089 if(!p.rallypointCluster.rallypoints.empty())
5091 j[
"rallypointCluster"] = p.rallypointCluster;
5093 else if(!p.rallypoints.empty())
5095 j[
"rallypoints"] = p.rallypoints;
5099 static void from_json(
const nlohmann::json& j, Group& p)
5102 j.at(
"type").get_to(p.type);
5103 getOptional<Group::BridgingOpMode_t>(
"bom", p.bom, j, Group::BridgingOpMode_t::bomRaw);
5104 j.at(
"id").get_to(p.id);
5105 getOptional<std::string>(
"name", p.name, j);
5106 getOptional<std::string>(
"spokenName", p.spokenName, j);
5107 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
5108 getOptional<NetworkAddress>(
"rx", p.rx, j);
5109 getOptional<NetworkAddress>(
"tx", p.tx, j);
5110 getOptional<NetworkTxOptions>(
"txOptions", p.txOptions, j);
5111 getOptional<std::string>(
"cryptoPassword", p.cryptoPassword, j);
5112 getOptional<std::string>(
"alias", p.alias, j);
5113 getOptional<TxAudio>(
"txAudio", p.txAudio, j);
5114 getOptional<Presence>(
"presence", p.presence, j);
5115 getOptional<std::vector<Rallypoint>>(
"rallypoints", p.rallypoints, j);
5116 getOptional<RallypointCluster>(
"rallypointCluster", p.rallypointCluster, j);
5117 getOptional<Audio>(
"audio", p.audio, j);
5118 getOptional<GroupTimeline>(
"timeline", p.timeline, j);
5119 getOptional<bool>(
"blockAdvertising", p.blockAdvertising, j,
false);
5120 getOptional<std::string>(
"source", p.source, j);
5121 getOptional<int>(
"maxRxSecs", p.maxRxSecs, j, 0);
5122 getOptional<bool>(
"enableMulticastFailover", p.enableMulticastFailover, j,
false);
5123 getOptional<int>(
"multicastFailoverSecs", p.multicastFailoverSecs, j, 10);
5124 getOptional<NetworkAddress>(
"rtcpPresenceRx", p.rtcpPresenceRx, j);
5125 getOptional<std::vector<std::string>>(
"presenceGroupAffinities", p.presenceGroupAffinities, j);
5126 getOptional<bool>(
"disablePacketEvents", p.disablePacketEvents, j,
false);
5127 getOptional<int>(
"rfc4733RtpPayloadId", p.rfc4733RtpPayloadId, j, 0);
5128 getOptional<std::vector<RtpPayloadTypeTranslation>>(
"inboundRtpPayloadTypeTranslations", p.inboundRtpPayloadTypeTranslations, j);
5129 getOptional<GroupPriorityTranslation>(
"priorityTranslation", p.priorityTranslation, j);
5130 getOptional<int>(
"stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
5131 getOptional<std::string>(
"anonymousAlias", p.anonymousAlias, j);
5132 getOptional<bool>(
"lbCrypto", p.lbCrypto, j,
false);
5133 getOptional<GroupAppTransport>(
"appTransport", p.appTransport, j);
5134 getOptional<bool>(
"allowLoopback", p.allowLoopback, j,
false);
5135 getOptionalWithIndicator<RtpProfile>(
"rtpProfile", p.rtpProfile, j, &p._wasDeserialized_rtpProfile);
5136 getOptional<RangerPackets>(
"rangerPackets", p.rangerPackets, j);
5137 getOptional<TransportImpairment>(
"txImpairment", p.txImpairment, j);
5138 getOptional<TransportImpairment>(
"rxImpairment", p.rxImpairment, j);
5139 getOptional<std::vector<uint16_t>>(
"specializerAffinities", p.specializerAffinities, j);
5140 getOptional<uint32_t>(
"securityLevel", p.securityLevel, j, 0);
5141 getOptional<std::vector<Source>>(
"ignoreSources", p.ignoreSources, j);
5142 getOptional<std::string>(
"languageCode", p.languageCode, j);
5143 getOptional<std::string>(
"synVoice", p.synVoice, j);
5145 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
5146 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
5150 getOptional<Group::InboundAliasGenerationPolicy_t>(
"inboundAliasGenerationPolicy", p.inboundAliasGenerationPolicy, j, Group::InboundAliasGenerationPolicy_t::iagpAnonymousAlias);
5152 getOptional<AudioGate>(
"gateIn", p.gateIn, j);
5154 getOptional<bool>(
"ignoreAudioTraffic", p.ignoreAudioTraffic, j,
false);
5156 FROMJSON_BASE_IMPL();
5161 JSON_SERIALIZED_CLASS(Mission)
5164 IMPLEMENT_JSON_SERIALIZATION()
5165 IMPLEMENT_JSON_DOCUMENTATION(
Mission)
5170 std::vector<Group> groups;
5171 std::chrono::system_clock::time_point begins;
5172 std::chrono::system_clock::time_point ends;
5173 std::string certStoreId;
5174 int multicastFailoverPolicy;
5182 certStoreId.clear();
5183 multicastFailoverPolicy = 0;
5188 static void to_json(nlohmann::json& j,
const Mission& p)
5193 TOJSON_IMPL(groups),
5194 TOJSON_IMPL(certStoreId),
5195 TOJSON_IMPL(multicastFailoverPolicy),
5196 TOJSON_IMPL(rallypoint)
5200 static void from_json(
const nlohmann::json& j, Mission& p)
5203 j.at(
"id").get_to(p.id);
5204 j.at(
"name").get_to(p.name);
5209 j.at(
"groups").get_to(p.groups);
5216 FROMJSON_IMPL(certStoreId, std::string, EMPTY_STRING);
5217 FROMJSON_IMPL(multicastFailoverPolicy,
int, 0);
5218 getOptional<Rallypoint>(
"rallypoint", p.rallypoint, j);
5222 JSON_SERIALIZED_CLASS(LicenseDescriptor)
5234 IMPLEMENT_JSON_SERIALIZATION()
5243 static const int STATUS_OK = 0;
5244 static const int ERR_NULL_ENTITLEMENT_KEY = -1;
5245 static const int ERR_NULL_LICENSE_KEY = -2;
5246 static const int ERR_INVALID_LICENSE_KEY_LEN = -3;
5247 static const int ERR_LICENSE_KEY_VERIFICATION_FAILURE = -4;
5248 static const int ERR_ACTIVATION_CODE_VERIFICATION_FAILURE = -5;
5249 static const int ERR_INVALID_EXPIRATION_DATE = -6;
5250 static const int ERR_GENERAL_FAILURE = -7;
5251 static const int ERR_NOT_INITIALIZED = -8;
5252 static const int ERR_REQUIRES_ACTIVATION = -9;
5253 static const int ERR_LICENSE_NOT_SUITED_FOR_ACTIVATION = -10;
5261 static const uint8_t LIC_CARGO_FLAG_LIMIT_TO_FEATURES = 0x01;
5325 entitlement.clear();
5327 activationCode.clear();
5330 expiresFormatted.clear();
5335 status = ERR_NOT_INITIALIZED;
5336 manufacturerId.clear();
5340 static void to_json(nlohmann::json& j,
const LicenseDescriptor& p)
5344 {
"entitlement",
"*entitlement*"},
5346 TOJSON_IMPL(activationCode),
5348 TOJSON_IMPL(expires),
5349 TOJSON_IMPL(expiresFormatted),
5351 TOJSON_IMPL(deviceId),
5352 TOJSON_IMPL(status),
5354 {
"manufacturerId",
"*manufacturerId*"},
5356 TOJSON_IMPL(cargoFlags)
5360 static void from_json(
const nlohmann::json& j, LicenseDescriptor& p)
5363 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
5364 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
5365 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
5366 FROMJSON_IMPL(type,
int, 0);
5367 FROMJSON_IMPL(expires, time_t, 0);
5368 FROMJSON_IMPL(expiresFormatted, std::string, EMPTY_STRING);
5369 FROMJSON_IMPL(flags, uint32_t, 0);
5370 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
5371 FROMJSON_IMPL(status,
int, LicenseDescriptor::ERR_NOT_INITIALIZED);
5372 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
5373 FROMJSON_IMPL(cargo, std::string, EMPTY_STRING);
5374 FROMJSON_IMPL(cargoFlags, uint8_t, 0);
5379 JSON_SERIALIZED_CLASS(EngineNetworkingRpUdpStreaming)
5393 IMPLEMENT_JSON_SERIALIZATION()
5421 keepaliveIntervalSecs = 15;
5422 priority = TxPriority_t::priVoice;
5426 virtual void initForDocumenting()
5431 static void to_json(nlohmann::json& j,
const EngineNetworkingRpUdpStreaming& p)
5434 TOJSON_IMPL(enabled),
5436 TOJSON_IMPL(keepaliveIntervalSecs),
5437 TOJSON_IMPL(priority),
5441 static void from_json(
const nlohmann::json& j, EngineNetworkingRpUdpStreaming& p)
5444 getOptional<bool>(
"enabled", p.enabled, j,
false);
5445 getOptional<int>(
"port", p.port, j, 0);
5446 getOptional<int>(
"keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
5447 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
5448 getOptional<int>(
"ttl", p.ttl, j, 64);
5452 JSON_SERIALIZED_CLASS(EnginePolicyNetworking)
5463 IMPLEMENT_JSON_SERIALIZATION()
5499 multicastRejoinSecs = 8;
5500 rallypointRtTestIntervalMs = 60000;
5501 logRtpJitterBufferStats =
false;
5502 preventMulticastFailover =
false;
5503 addressResolutionPolicy = AddressResolutionPolicy_t::arpIpv6ThenIpv4;
5505 rpUdpStreaming.clear();
5510 static void to_json(nlohmann::json& j,
const EnginePolicyNetworking& p)
5513 TOJSON_IMPL(defaultNic),
5514 TOJSON_IMPL(multicastRejoinSecs),
5516 TOJSON_IMPL(rallypointRtTestIntervalMs),
5517 TOJSON_IMPL(logRtpJitterBufferStats),
5518 TOJSON_IMPL(preventMulticastFailover),
5520 TOJSON_IMPL(rpUdpStreaming),
5521 TOJSON_IMPL(rtpProfile),
5522 TOJSON_IMPL(addressResolutionPolicy)
5525 static void from_json(
const nlohmann::json& j, EnginePolicyNetworking& p)
5528 FROMJSON_IMPL(defaultNic, std::string, EMPTY_STRING);
5529 FROMJSON_IMPL(multicastRejoinSecs,
int, 8);
5530 FROMJSON_IMPL(rallypointRtTestIntervalMs,
int, 60000);
5531 FROMJSON_IMPL(logRtpJitterBufferStats,
bool,
false);
5532 FROMJSON_IMPL(preventMulticastFailover,
bool,
false);
5534 getOptional<EngineNetworkingRpUdpStreaming>(
"rpUdpStreaming", p.rpUdpStreaming, j);
5535 getOptional<RtpProfile>(
"rtpProfile", p.rtpProfile, j);
5536 getOptional<AddressResolutionPolicy_t>(
"addressResolutionPolicy", p.addressResolutionPolicy, j, AddressResolutionPolicy_t::arpIpv6ThenIpv4);
5540 JSON_SERIALIZED_CLASS(Aec)
5552 IMPLEMENT_JSON_SERIALIZATION()
5553 IMPLEMENT_JSON_DOCUMENTATION(
Aec)
5608 static void to_json(nlohmann::json& j,
const Aec& p)
5611 TOJSON_IMPL(enabled),
5613 TOJSON_IMPL(speakerTailMs),
5617 static void from_json(
const nlohmann::json& j, Aec& p)
5620 FROMJSON_IMPL(enabled,
bool,
false);
5621 FROMJSON_IMPL(mode, Aec::Mode_t, Aec::Mode_t::aecmDefault);
5622 FROMJSON_IMPL(speakerTailMs,
int, 60);
5623 FROMJSON_IMPL(cng,
bool,
true);
5627 JSON_SERIALIZED_CLASS(Vad)
5639 IMPLEMENT_JSON_SERIALIZATION()
5640 IMPLEMENT_JSON_DOCUMENTATION(
Vad)
5660 vamVeryAggressive = 3
5681 static void to_json(nlohmann::json& j,
const Vad& p)
5684 TOJSON_IMPL(enabled),
5688 static void from_json(
const nlohmann::json& j, Vad& p)
5691 FROMJSON_IMPL(enabled,
bool,
false);
5692 FROMJSON_IMPL(mode, Vad::Mode_t, Vad::Mode_t::vamDefault);
5696 JSON_SERIALIZED_CLASS(Bridge)
5708 IMPLEMENT_JSON_SERIALIZATION()
5709 IMPLEMENT_JSON_DOCUMENTATION(
Bridge)
5738 static void to_json(nlohmann::json& j,
const Bridge& p)
5743 TOJSON_IMPL(groups),
5744 TOJSON_IMPL(enabled)
5747 static void from_json(
const nlohmann::json& j, Bridge& p)
5750 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
5751 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
5752 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
5753 FROMJSON_IMPL(enabled,
bool,
true);
5757 JSON_SERIALIZED_CLASS(AndroidAudio)
5769 IMPLEMENT_JSON_SERIALIZATION()
5773 constexpr static int INVALID_SESSION_ID = -9999;
5834 performanceMode = 12;
5838 sessionId = AndroidAudio::INVALID_SESSION_ID;
5843 static void to_json(nlohmann::json& j,
const AndroidAudio& p)
5847 TOJSON_IMPL(sharingMode),
5848 TOJSON_IMPL(performanceMode),
5850 TOJSON_IMPL(contentType),
5851 TOJSON_IMPL(inputPreset),
5852 TOJSON_IMPL(sessionId),
5853 TOJSON_IMPL(engineMode)
5856 static void from_json(
const nlohmann::json& j, AndroidAudio& p)
5859 FROMJSON_IMPL(api,
int, 0);
5860 FROMJSON_IMPL(sharingMode,
int, 0);
5861 FROMJSON_IMPL(performanceMode,
int, 12);
5862 FROMJSON_IMPL(usage,
int, 2);
5863 FROMJSON_IMPL(contentType,
int, 1);
5864 FROMJSON_IMPL(inputPreset,
int, 7);
5865 FROMJSON_IMPL(sessionId,
int, AndroidAudio::INVALID_SESSION_ID);
5866 FROMJSON_IMPL(engineMode,
int, 0);
5870 JSON_SERIALIZED_CLASS(EnginePolicyAudio)
5882 IMPLEMENT_JSON_SERIALIZATION()
5937 hardwareEnabled =
true;
5938 internalRate = 16000;
5939 internalChannels = 2;
5946 denoiseInput =
false;
5947 denoiseOutput =
false;
5948 saveInputPcm =
false;
5949 saveOutputPcm =
false;
5953 static void to_json(nlohmann::json& j,
const EnginePolicyAudio& p)
5956 TOJSON_IMPL(enabled),
5957 TOJSON_IMPL(hardwareEnabled),
5958 TOJSON_IMPL(internalRate),
5959 TOJSON_IMPL(internalChannels),
5960 TOJSON_IMPL(muteTxOnTx),
5963 TOJSON_IMPL(android),
5964 TOJSON_IMPL(inputAgc),
5965 TOJSON_IMPL(outputAgc),
5966 TOJSON_IMPL(denoiseInput),
5967 TOJSON_IMPL(denoiseOutput),
5968 TOJSON_IMPL(saveInputPcm),
5969 TOJSON_IMPL(saveOutputPcm)
5972 static void from_json(
const nlohmann::json& j, EnginePolicyAudio& p)
5975 getOptional<bool>(
"enabled", p.enabled, j,
true);
5976 getOptional<bool>(
"hardwareEnabled", p.hardwareEnabled, j,
true);
5977 FROMJSON_IMPL(internalRate,
int, 16000);
5978 FROMJSON_IMPL(internalChannels,
int, 2);
5980 FROMJSON_IMPL(muteTxOnTx,
bool,
false);
5981 getOptional<Aec>(
"aec", p.aec, j);
5982 getOptional<Vad>(
"vad", p.vad, j);
5983 getOptional<AndroidAudio>(
"android", p.android, j);
5984 getOptional<Agc>(
"inputAgc", p.inputAgc, j);
5985 getOptional<Agc>(
"outputAgc", p.outputAgc, j);
5986 FROMJSON_IMPL(denoiseInput,
bool,
false);
5987 FROMJSON_IMPL(denoiseOutput,
bool,
false);
5988 FROMJSON_IMPL(saveInputPcm,
bool,
false);
5989 FROMJSON_IMPL(saveOutputPcm,
bool,
false);
5993 JSON_SERIALIZED_CLASS(SecurityCertificate)
6005 IMPLEMENT_JSON_SERIALIZATION()
6027 certificate.clear();
6032 static void to_json(nlohmann::json& j,
const SecurityCertificate& p)
6035 TOJSON_IMPL(certificate),
6039 static void from_json(
const nlohmann::json& j, SecurityCertificate& p)
6042 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6043 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
6048 JSON_SERIALIZED_CLASS(EnginePolicySecurity)
6061 IMPLEMENT_JSON_SERIALIZATION()
6094 certificate.clear();
6095 caCertificates.clear();
6099 static void to_json(nlohmann::json& j,
const EnginePolicySecurity& p)
6102 TOJSON_IMPL(certificate),
6103 TOJSON_IMPL(caCertificates)
6106 static void from_json(
const nlohmann::json& j, EnginePolicySecurity& p)
6109 getOptional(
"certificate", p.certificate, j);
6110 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
6114 JSON_SERIALIZED_CLASS(EnginePolicyLogging)
6126 IMPLEMENT_JSON_SERIALIZATION()
6159 enableSyslog =
false;
6163 static void to_json(nlohmann::json& j,
const EnginePolicyLogging& p)
6166 TOJSON_IMPL(maxLevel),
6167 TOJSON_IMPL(enableSyslog)
6170 static void from_json(
const nlohmann::json& j, EnginePolicyLogging& p)
6173 getOptional(
"maxLevel", p.maxLevel, j, 4);
6174 getOptional(
"enableSyslog", p.enableSyslog, j);
6179 JSON_SERIALIZED_CLASS(EnginePolicyDatabase)
6182 IMPLEMENT_JSON_SERIALIZATION()
6193 DatabaseType_t type;
6194 std::string fixedFileName;
6195 bool forceMaintenance;
6205 type = DatabaseType_t::dbtFixedMemory;
6206 fixedFileName.clear();
6207 forceMaintenance =
false;
6208 reclaimSpace =
false;
6216 TOJSON_IMPL(fixedFileName),
6217 TOJSON_IMPL(forceMaintenance),
6218 TOJSON_IMPL(reclaimSpace)
6221 static void from_json(
const nlohmann::json& j, EnginePolicyDatabase& p)
6224 FROMJSON_IMPL(type, EnginePolicyDatabase::DatabaseType_t, EnginePolicyDatabase::DatabaseType_t::dbtFixedMemory);
6225 FROMJSON_IMPL(fixedFileName, std::string, EMPTY_STRING);
6226 FROMJSON_IMPL(forceMaintenance,
bool,
false);
6227 FROMJSON_IMPL(reclaimSpace,
bool,
false);
6232 JSON_SERIALIZED_CLASS(SecureSignature)
6242 IMPLEMENT_JSON_SERIALIZATION()
6263 certificate.clear();
6269 static void to_json(nlohmann::json& j,
const SecureSignature& p)
6272 TOJSON_IMPL(certificate),
6274 TOJSON_IMPL(signature)
6277 static void from_json(
const nlohmann::json& j, SecureSignature& p)
6280 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6282 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
6286 JSON_SERIALIZED_CLASS(NamedAudioDevice)
6289 IMPLEMENT_JSON_SERIALIZATION()
6294 std::string manufacturer;
6297 std::string serialNumber;
6310 manufacturer.clear();
6313 serialNumber.clear();
6324 TOJSON_IMPL(manufacturer),
6327 TOJSON_IMPL(serialNumber),
6330 TOJSON_IMPL(isDefault),
6333 static void from_json(
const nlohmann::json& j, NamedAudioDevice& p)
6336 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
6337 getOptional<std::string>(
"manufacturer", p.manufacturer, j, EMPTY_STRING);
6338 getOptional<std::string>(
"model", p.model, j, EMPTY_STRING);
6339 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
6340 getOptional<std::string>(
"serialNumber", p.serialNumber, j, EMPTY_STRING);
6341 getOptional<std::string>(
"type", p.type, j, EMPTY_STRING);
6342 getOptional<std::string>(
"extra", p.extra, j, EMPTY_STRING);
6343 getOptional<bool>(
"isDefault", p.isDefault, j,
false);
6348 JSON_SERIALIZED_CLASS(EnginePolicyNamedAudioDevices)
6351 IMPLEMENT_JSON_SERIALIZATION()
6355 std::vector<NamedAudioDevice> inputs;
6356 std::vector<NamedAudioDevice> outputs;
6373 TOJSON_IMPL(inputs),
6374 TOJSON_IMPL(outputs)
6377 static void from_json(
const nlohmann::json& j, EnginePolicyNamedAudioDevices& p)
6380 getOptional<std::vector<NamedAudioDevice>>(
"inputs", p.inputs, j);
6381 getOptional<std::vector<NamedAudioDevice>>(
"outputs", p.outputs, j);
6385 JSON_SERIALIZED_CLASS(Licensing)
6399 IMPLEMENT_JSON_SERIALIZATION()
6426 entitlement.clear();
6428 activationCode.clear();
6430 manufacturerId.clear();
6434 static void to_json(nlohmann::json& j,
const Licensing& p)
6437 TOJSON_IMPL(entitlement),
6439 TOJSON_IMPL(activationCode),
6440 TOJSON_IMPL(deviceId),
6441 TOJSON_IMPL(manufacturerId)
6444 static void from_json(
const nlohmann::json& j, Licensing& p)
6447 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
6448 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
6449 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
6450 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
6451 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
6455 JSON_SERIALIZED_CLASS(DiscoveryMagellan)
6467 IMPLEMENT_JSON_SERIALIZATION()
6492 interfaceName.clear();
6498 static void to_json(nlohmann::json& j,
const DiscoveryMagellan& p)
6501 TOJSON_IMPL(enabled),
6502 TOJSON_IMPL(interfaceName),
6503 TOJSON_IMPL(security),
6507 static void from_json(
const nlohmann::json& j, DiscoveryMagellan& p)
6510 getOptional(
"enabled", p.enabled, j,
false);
6511 getOptional<Tls>(
"tls", p.tls, j);
6512 getOptional<SecurityCertificate>(
"security", p.security, j);
6513 FROMJSON_IMPL(interfaceName, std::string, EMPTY_STRING);
6517 JSON_SERIALIZED_CLASS(DiscoverySsdp)
6529 IMPLEMENT_JSON_SERIALIZATION()
6560 interfaceName.clear();
6562 searchTerms.clear();
6563 ageTimeoutMs = 30000;
6564 advertising.clear();
6568 static void to_json(nlohmann::json& j,
const DiscoverySsdp& p)
6571 TOJSON_IMPL(enabled),
6572 TOJSON_IMPL(interfaceName),
6573 TOJSON_IMPL(address),
6574 TOJSON_IMPL(searchTerms),
6575 TOJSON_IMPL(ageTimeoutMs),
6576 TOJSON_IMPL(advertising)
6579 static void from_json(
const nlohmann::json& j, DiscoverySsdp& p)
6582 getOptional(
"enabled", p.enabled, j,
false);
6583 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
6585 getOptional<NetworkAddress>(
"address", p.address, j);
6586 if(p.address.address.empty())
6588 p.address.address =
"255.255.255.255";
6590 if(p.address.port <= 0)
6592 p.address.port = 1900;
6595 getOptional<std::vector<std::string>>(
"searchTerms", p.searchTerms, j);
6596 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
6597 getOptional<Advertising>(
"advertising", p.advertising, j);
6601 JSON_SERIALIZED_CLASS(DiscoverySap)
6613 IMPLEMENT_JSON_SERIALIZATION()
6640 interfaceName.clear();
6642 ageTimeoutMs = 30000;
6643 advertising.clear();
6647 static void to_json(nlohmann::json& j,
const DiscoverySap& p)
6650 TOJSON_IMPL(enabled),
6651 TOJSON_IMPL(interfaceName),
6652 TOJSON_IMPL(address),
6653 TOJSON_IMPL(ageTimeoutMs),
6654 TOJSON_IMPL(advertising)
6657 static void from_json(
const nlohmann::json& j, DiscoverySap& p)
6660 getOptional(
"enabled", p.enabled, j,
false);
6661 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
6662 getOptional<NetworkAddress>(
"address", p.address, j);
6663 if(p.address.address.empty())
6665 p.address.address =
"224.2.127.254";
6667 if(p.address.port <= 0)
6669 p.address.port = 9875;
6672 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
6673 getOptional<Advertising>(
"advertising", p.advertising, j);
6677 JSON_SERIALIZED_CLASS(DiscoveryCistech)
6691 IMPLEMENT_JSON_SERIALIZATION()
6696 std::string interfaceName;
6708 interfaceName.clear();
6710 ageTimeoutMs = 30000;
6717 TOJSON_IMPL(enabled),
6718 TOJSON_IMPL(interfaceName),
6719 TOJSON_IMPL(address),
6720 TOJSON_IMPL(ageTimeoutMs)
6723 static void from_json(
const nlohmann::json& j, DiscoveryCistech& p)
6726 getOptional(
"enabled", p.enabled, j,
false);
6727 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
6728 getOptional<NetworkAddress>(
"address", p.address, j);
6729 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
6734 JSON_SERIALIZED_CLASS(DiscoveryTrellisware)
6746 IMPLEMENT_JSON_SERIALIZATION()
6769 static void to_json(nlohmann::json& j,
const DiscoveryTrellisware& p)
6772 TOJSON_IMPL(enabled),
6773 TOJSON_IMPL(security)
6776 static void from_json(
const nlohmann::json& j, DiscoveryTrellisware& p)
6779 getOptional(
"enabled", p.enabled, j,
false);
6780 getOptional<SecurityCertificate>(
"security", p.security, j);
6784 JSON_SERIALIZED_CLASS(DiscoveryConfiguration)
6796 IMPLEMENT_JSON_SERIALIZATION()
6829 static void to_json(nlohmann::json& j,
const DiscoveryConfiguration& p)
6832 TOJSON_IMPL(magellan),
6835 TOJSON_IMPL(cistech),
6836 TOJSON_IMPL(trellisware)
6839 static void from_json(
const nlohmann::json& j, DiscoveryConfiguration& p)
6842 getOptional<DiscoveryMagellan>(
"magellan", p.magellan, j);
6843 getOptional<DiscoverySsdp>(
"ssdp", p.ssdp, j);
6844 getOptional<DiscoverySap>(
"sap", p.sap, j);
6845 getOptional<DiscoveryCistech>(
"cistech", p.cistech, j);
6846 getOptional<DiscoveryTrellisware>(
"trellisware", p.trellisware, j);
6851 JSON_SERIALIZED_CLASS(EnginePolicyInternals)
6865 IMPLEMENT_JSON_SERIALIZATION()
6880 int logTaskQueueStatsIntervalMs;
6882 bool enableLazySpeakerClosure;
6916 housekeeperIntervalMs = 1000;
6917 logTaskQueueStatsIntervalMs = 0;
6920 enableLazySpeakerClosure =
false;
6921 rpClusterStrategy = RallypointCluster::ConnectionStrategy_t::csRoundRobin;
6922 rpClusterRolloverSecs = 10;
6923 rtpExpirationCheckIntervalMs = 250;
6924 rpConnectionTimeoutSecs = 5;
6925 stickyTidHangSecs = 10;
6926 uriStreamingIntervalMs = 60;
6927 delayedMicrophoneClosureSecs = 15;
6932 static void to_json(nlohmann::json& j,
const EnginePolicyInternals& p)
6935 TOJSON_IMPL(watchdog),
6936 TOJSON_IMPL(housekeeperIntervalMs),
6937 TOJSON_IMPL(logTaskQueueStatsIntervalMs),
6938 TOJSON_IMPL(maxTxSecs),
6939 TOJSON_IMPL(maxRxSecs),
6940 TOJSON_IMPL(enableLazySpeakerClosure),
6941 TOJSON_IMPL(rpClusterStrategy),
6942 TOJSON_IMPL(rpClusterRolloverSecs),
6943 TOJSON_IMPL(rtpExpirationCheckIntervalMs),
6944 TOJSON_IMPL(rpConnectionTimeoutSecs),
6945 TOJSON_IMPL(stickyTidHangSecs),
6946 TOJSON_IMPL(uriStreamingIntervalMs),
6947 TOJSON_IMPL(delayedMicrophoneClosureSecs),
6951 static void from_json(
const nlohmann::json& j, EnginePolicyInternals& p)
6954 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
6955 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
6956 getOptional<int>(
"logTaskQueueStatsIntervalMs", p.logTaskQueueStatsIntervalMs, j, 0);
6957 getOptional<int>(
"maxTxSecs", p.maxTxSecs, j, 30);
6958 getOptional<int>(
"maxRxSecs", p.maxRxSecs, j, 0);
6959 getOptional<bool>(
"enableLazySpeakerClosure", p.enableLazySpeakerClosure, j,
false);
6960 getOptional<RallypointCluster::ConnectionStrategy_t>(
"rpClusterStrategy", p.rpClusterStrategy, j, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
6961 getOptional<int>(
"rpClusterRolloverSecs", p.rpClusterRolloverSecs, j, 10);
6962 getOptional<int>(
"rtpExpirationCheckIntervalMs", p.rtpExpirationCheckIntervalMs, j, 250);
6963 getOptional<int>(
"rpConnectionTimeoutSecs", p.rpConnectionTimeoutSecs, j, 5);
6964 getOptional<int>(
"stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
6965 getOptional<int>(
"uriStreamingIntervalMs", p.uriStreamingIntervalMs, j, 60);
6966 getOptional<int>(
"delayedMicrophoneClosureSecs", p.delayedMicrophoneClosureSecs, j, 15);
6967 getOptional<TuningSettings>(
"tuning", p.tuning, j);
6971 JSON_SERIALIZED_CLASS(EnginePolicyTimelines)
6985 IMPLEMENT_JSON_SERIALIZATION()
7047 storageRoot.clear();
7048 maxStorageMb = 1024;
7049 maxMemMb = maxStorageMb;
7050 maxAudioEventMemMb = maxMemMb;
7051 maxDiskMb = maxStorageMb;
7052 maxEventAgeSecs = (86400 * 30);
7053 groomingIntervalSecs = (60 * 30);
7055 autosaveIntervalSecs = 5;
7057 disableSigningAndVerification =
false;
7062 static void to_json(nlohmann::json& j,
const EnginePolicyTimelines& p)
7065 TOJSON_IMPL(enabled),
7066 TOJSON_IMPL(storageRoot),
7067 TOJSON_IMPL(maxMemMb),
7068 TOJSON_IMPL(maxAudioEventMemMb),
7069 TOJSON_IMPL(maxDiskMb),
7070 TOJSON_IMPL(maxEventAgeSecs),
7071 TOJSON_IMPL(maxEvents),
7072 TOJSON_IMPL(groomingIntervalSecs),
7073 TOJSON_IMPL(autosaveIntervalSecs),
7074 TOJSON_IMPL(security),
7075 TOJSON_IMPL(disableSigningAndVerification),
7076 TOJSON_IMPL(ephemeral)
7079 static void from_json(
const nlohmann::json& j, EnginePolicyTimelines& p)
7082 getOptional<bool>(
"enabled", p.enabled, j,
true);
7083 getOptional<std::string>(
"storageRoot", p.storageRoot, j, EMPTY_STRING);
7085 getOptional<int>(
"maxStorageMb", p.maxStorageMb, j, 1024);
7086 getOptional<int>(
"maxMemMb", p.maxMemMb, j, p.maxStorageMb);
7087 getOptional<int>(
"maxAudioEventMemMb", p.maxAudioEventMemMb, j, p.maxMemMb);
7088 getOptional<int>(
"maxDiskMb", p.maxDiskMb, j, p.maxStorageMb);
7089 getOptional<long>(
"maxEventAgeSecs", p.maxEventAgeSecs, j, (86400 * 30));
7090 getOptional<long>(
"groomingIntervalSecs", p.groomingIntervalSecs, j, (60 * 30));
7091 getOptional<long>(
"autosaveIntervalSecs", p.autosaveIntervalSecs, j, 5);
7092 getOptional<int>(
"maxEvents", p.maxEvents, j, 1000);
7093 getOptional<SecurityCertificate>(
"security", p.security, j);
7094 getOptional<bool>(
"disableSigningAndVerification", p.disableSigningAndVerification, j,
false);
7095 getOptional<bool>(
"ephemeral", p.ephemeral, j,
false);
7100 JSON_SERIALIZED_CLASS(RtpMapEntry)
7112 IMPLEMENT_JSON_SERIALIZATION()
7134 rtpPayloadType = -1;
7138 static void to_json(nlohmann::json& j,
const RtpMapEntry& p)
7142 TOJSON_IMPL(engageType),
7143 TOJSON_IMPL(rtpPayloadType)
7146 static void from_json(
const nlohmann::json& j, RtpMapEntry& p)
7149 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
7150 getOptional<int>(
"engageType", p.engageType, j, -1);
7151 getOptional<int>(
"rtpPayloadType", p.rtpPayloadType, j, -1);
7155 JSON_SERIALIZED_CLASS(ExternalModule)
7167 IMPLEMENT_JSON_SERIALIZATION()
7189 configuration.clear();
7193 static void to_json(nlohmann::json& j,
const ExternalModule& p)
7200 if(!p.configuration.empty())
7202 j[
"configuration"] = p.configuration;
7205 static void from_json(
const nlohmann::json& j, ExternalModule& p)
7208 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
7209 getOptional<std::string>(
"file", p.file, j, EMPTY_STRING);
7213 p.configuration = j.at(
"configuration");
7217 p.configuration.clear();
7223 JSON_SERIALIZED_CLASS(ExternalCodecDescriptor)
7235 IMPLEMENT_JSON_SERIALIZATION()
7258 rtpPayloadType = -1;
7261 rtpTsMultiplier = 0;
7265 static void to_json(nlohmann::json& j,
const ExternalCodecDescriptor& p)
7268 TOJSON_IMPL(rtpPayloadType),
7269 TOJSON_IMPL(samplingRate),
7270 TOJSON_IMPL(channels),
7271 TOJSON_IMPL(rtpTsMultiplier)
7274 static void from_json(
const nlohmann::json& j, ExternalCodecDescriptor& p)
7278 getOptional<int>(
"rtpPayloadType", p.rtpPayloadType, j, -1);
7279 getOptional<int>(
"samplingRate", p.samplingRate, j, -1);
7280 getOptional<int>(
"channels", p.channels, j, -1);
7281 getOptional<int>(
"rtpTsMultiplier", p.rtpTsMultiplier, j, -1);
7285 JSON_SERIALIZED_CLASS(EngineStatusReportConfiguration)
7297 IMPLEMENT_JSON_SERIALIZATION()
7329 includeMemoryDetail =
false;
7330 includeTaskQueueDetail =
false;
7335 static void to_json(nlohmann::json& j,
const EngineStatusReportConfiguration& p)
7338 TOJSON_IMPL(fileName),
7339 TOJSON_IMPL(intervalSecs),
7340 TOJSON_IMPL(enabled),
7341 TOJSON_IMPL(includeMemoryDetail),
7342 TOJSON_IMPL(includeTaskQueueDetail),
7346 static void from_json(
const nlohmann::json& j, EngineStatusReportConfiguration& p)
7349 getOptional<std::string>(
"fileName", p.fileName, j);
7350 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
7351 getOptional<bool>(
"enabled", p.enabled, j,
false);
7352 getOptional<std::string>(
"runCmd", p.runCmd, j);
7353 getOptional<bool>(
"includeMemoryDetail", p.includeMemoryDetail, j,
false);
7354 getOptional<bool>(
"includeTaskQueueDetail", p.includeTaskQueueDetail, j,
false);
7358 JSON_SERIALIZED_CLASS(EnginePolicy)
7372 IMPLEMENT_JSON_SERIALIZATION()
7429 dataDirectory.clear();
7440 namedAudioDevices.clear();
7441 externalCodecs.clear();
7443 statusReport.clear();
7447 static void to_json(nlohmann::json& j,
const EnginePolicy& p)
7450 TOJSON_IMPL(dataDirectory),
7451 TOJSON_IMPL(licensing),
7452 TOJSON_IMPL(security),
7453 TOJSON_IMPL(networking),
7455 TOJSON_IMPL(discovery),
7456 TOJSON_IMPL(logging),
7457 TOJSON_IMPL(internals),
7458 TOJSON_IMPL(timelines),
7459 TOJSON_IMPL(database),
7460 TOJSON_IMPL(featureset),
7461 TOJSON_IMPL(namedAudioDevices),
7462 TOJSON_IMPL(externalCodecs),
7463 TOJSON_IMPL(rtpMap),
7464 TOJSON_IMPL(statusReport)
7467 static void from_json(
const nlohmann::json& j, EnginePolicy& p)
7470 FROMJSON_IMPL_SIMPLE(dataDirectory);
7471 FROMJSON_IMPL_SIMPLE(licensing);
7472 FROMJSON_IMPL_SIMPLE(security);
7473 FROMJSON_IMPL_SIMPLE(networking);
7474 FROMJSON_IMPL_SIMPLE(audio);
7475 FROMJSON_IMPL_SIMPLE(discovery);
7476 FROMJSON_IMPL_SIMPLE(logging);
7477 FROMJSON_IMPL_SIMPLE(internals);
7478 FROMJSON_IMPL_SIMPLE(timelines);
7479 FROMJSON_IMPL_SIMPLE(database);
7480 FROMJSON_IMPL_SIMPLE(featureset);
7481 FROMJSON_IMPL_SIMPLE(namedAudioDevices);
7482 FROMJSON_IMPL_SIMPLE(externalCodecs);
7483 FROMJSON_IMPL_SIMPLE(rtpMap);
7484 FROMJSON_IMPL_SIMPLE(statusReport);
7489 JSON_SERIALIZED_CLASS(TalkgroupAsset)
7501 IMPLEMENT_JSON_SERIALIZATION()
7524 static void to_json(nlohmann::json& j,
const TalkgroupAsset& p)
7527 TOJSON_IMPL(nodeId),
7531 static void from_json(
const nlohmann::json& j, TalkgroupAsset& p)
7534 getOptional<std::string>(
"nodeId", p.nodeId, j);
7535 getOptional<Group>(
"group", p.group, j);
7539 JSON_SERIALIZED_CLASS(EngageDiscoveredGroup)
7549 IMPLEMENT_JSON_SERIALIZATION()
7579 static void to_json(nlohmann::json& j,
const EngageDiscoveredGroup& p)
7588 static void from_json(
const nlohmann::json& j, EngageDiscoveredGroup& p)
7591 getOptional<std::string>(
"id", p.id, j);
7592 getOptional<int>(
"type", p.type, j, 0);
7593 getOptional<NetworkAddress>(
"rx", p.rx, j);
7594 getOptional<NetworkAddress>(
"tx", p.tx, j);
7598 JSON_SERIALIZED_CLASS(RallypointPeer)
7610 IMPLEMENT_JSON_SERIALIZATION()
7642 certificate.clear();
7643 connectionTimeoutSecs = 0;
7644 forceIsMeshLeaf =
false;
7648 static void to_json(nlohmann::json& j,
const RallypointPeer& p)
7652 TOJSON_IMPL(enabled),
7654 TOJSON_IMPL(certificate),
7655 TOJSON_IMPL(connectionTimeoutSecs),
7656 TOJSON_IMPL(forceIsMeshLeaf)
7659 static void from_json(
const nlohmann::json& j, RallypointPeer& p)
7662 j.at(
"id").get_to(p.id);
7663 getOptional<bool>(
"enabled", p.enabled, j,
true);
7664 getOptional<NetworkAddress>(
"host", p.host, j);
7665 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
7666 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
7667 getOptional<bool>(
"forceIsMeshLeaf", p.forceIsMeshLeaf, j,
false);
7671 JSON_SERIALIZED_CLASS(RallypointServerLimits)
7683 IMPLEMENT_JSON_SERIALIZATION()
7741 maxMulticastReflectors = 0;
7742 maxRegisteredStreams = 0;
7744 maxRxPacketsPerSec = 0;
7745 maxTxPacketsPerSec = 0;
7746 maxRxBytesPerSec = 0;
7747 maxTxBytesPerSec = 0;
7749 maxInboundBacklog = 64;
7750 lowPriorityQueueThreshold = 64;
7751 normalPriorityQueueThreshold = 256;
7752 denyNewConnectionCpuThreshold = 75;
7753 warnAtCpuThreshold = 65;
7757 static void to_json(nlohmann::json& j,
const RallypointServerLimits& p)
7760 TOJSON_IMPL(maxClients),
7761 TOJSON_IMPL(maxPeers),
7762 TOJSON_IMPL(maxMulticastReflectors),
7763 TOJSON_IMPL(maxRegisteredStreams),
7764 TOJSON_IMPL(maxStreamPaths),
7765 TOJSON_IMPL(maxRxPacketsPerSec),
7766 TOJSON_IMPL(maxTxPacketsPerSec),
7767 TOJSON_IMPL(maxRxBytesPerSec),
7768 TOJSON_IMPL(maxTxBytesPerSec),
7769 TOJSON_IMPL(maxQOpsPerSec),
7770 TOJSON_IMPL(maxInboundBacklog),
7771 TOJSON_IMPL(lowPriorityQueueThreshold),
7772 TOJSON_IMPL(normalPriorityQueueThreshold),
7773 TOJSON_IMPL(denyNewConnectionCpuThreshold),
7774 TOJSON_IMPL(warnAtCpuThreshold)
7777 static void from_json(
const nlohmann::json& j, RallypointServerLimits& p)
7780 getOptional<uint32_t>(
"maxClients", p.maxClients, j, 0);
7781 getOptional<uint32_t>(
"maxPeers", p.maxPeers, j, 0);
7782 getOptional<uint32_t>(
"maxMulticastReflectors", p.maxMulticastReflectors, j, 0);
7783 getOptional<uint32_t>(
"maxRegisteredStreams", p.maxRegisteredStreams, j, 0);
7784 getOptional<uint32_t>(
"maxStreamPaths", p.maxStreamPaths, j, 0);
7785 getOptional<uint32_t>(
"maxRxPacketsPerSec", p.maxRxPacketsPerSec, j, 0);
7786 getOptional<uint32_t>(
"maxTxPacketsPerSec", p.maxTxPacketsPerSec, j, 0);
7787 getOptional<uint32_t>(
"maxRxBytesPerSec", p.maxRxBytesPerSec, j, 0);
7788 getOptional<uint32_t>(
"maxTxBytesPerSec", p.maxTxBytesPerSec, j, 0);
7789 getOptional<uint32_t>(
"maxQOpsPerSec", p.maxQOpsPerSec, j, 0);
7790 getOptional<uint32_t>(
"maxInboundBacklog", p.maxInboundBacklog, j, 64);
7791 getOptional<uint32_t>(
"lowPriorityQueueThreshold", p.lowPriorityQueueThreshold, j, 64);
7792 getOptional<uint32_t>(
"normalPriorityQueueThreshold", p.normalPriorityQueueThreshold, j, 256);
7793 getOptional<uint32_t>(
"denyNewConnectionCpuThreshold", p.denyNewConnectionCpuThreshold, j, 75);
7794 getOptional<uint32_t>(
"warnAtCpuThreshold", p.warnAtCpuThreshold, j, 65);
7798 JSON_SERIALIZED_CLASS(RallypointServerStatusReportConfiguration)
7810 IMPLEMENT_JSON_SERIALIZATION()
7845 includeLinks =
false;
7846 includePeerLinkDetails =
false;
7847 includeClientLinkDetails =
false;
7852 static void to_json(nlohmann::json& j,
const RallypointServerStatusReportConfiguration& p)
7855 TOJSON_IMPL(fileName),
7856 TOJSON_IMPL(intervalSecs),
7857 TOJSON_IMPL(enabled),
7858 TOJSON_IMPL(includeLinks),
7859 TOJSON_IMPL(includePeerLinkDetails),
7860 TOJSON_IMPL(includeClientLinkDetails),
7864 static void from_json(
const nlohmann::json& j, RallypointServerStatusReportConfiguration& p)
7867 getOptional<std::string>(
"fileName", p.fileName, j);
7868 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
7869 getOptional<bool>(
"enabled", p.enabled, j,
false);
7870 getOptional<bool>(
"includeLinks", p.includeLinks, j,
false);
7871 getOptional<bool>(
"includePeerLinkDetails", p.includePeerLinkDetails, j,
false);
7872 getOptional<bool>(
"includeClientLinkDetails", p.includeClientLinkDetails, j,
false);
7873 getOptional<std::string>(
"runCmd", p.runCmd, j);
7877 JSON_SERIALIZED_CLASS(RallypointServerLinkGraph)
7880 IMPLEMENT_JSON_SERIALIZATION()
7923 includeDigraphEnclosure =
true;
7924 includeClients =
false;
7925 coreRpStyling =
"[shape=hexagon color=firebrick style=filled]";
7926 leafRpStyling =
"[shape=box color=gray style=filled]";
7927 clientStyling.clear();
7932 static void to_json(nlohmann::json& j,
const RallypointServerLinkGraph& p)
7935 TOJSON_IMPL(fileName),
7936 TOJSON_IMPL(minRefreshSecs),
7937 TOJSON_IMPL(enabled),
7938 TOJSON_IMPL(includeDigraphEnclosure),
7939 TOJSON_IMPL(includeClients),
7940 TOJSON_IMPL(coreRpStyling),
7941 TOJSON_IMPL(leafRpStyling),
7942 TOJSON_IMPL(clientStyling),
7946 static void from_json(
const nlohmann::json& j, RallypointServerLinkGraph& p)
7949 getOptional<std::string>(
"fileName", p.fileName, j);
7950 getOptional<int>(
"minRefreshSecs", p.minRefreshSecs, j, 5);
7951 getOptional<bool>(
"enabled", p.enabled, j,
false);
7952 getOptional<bool>(
"includeDigraphEnclosure", p.includeDigraphEnclosure, j,
true);
7953 getOptional<bool>(
"includeClients", p.includeClients, j,
false);
7954 getOptional<std::string>(
"coreRpStyling", p.coreRpStyling, j,
"[shape=hexagon color=firebrick style=filled]");
7955 getOptional<std::string>(
"leafRpStyling", p.leafRpStyling, j,
"[shape=box color=gray style=filled]");
7956 getOptional<std::string>(
"clientStyling", p.clientStyling, j);
7957 getOptional<std::string>(
"runCmd", p.runCmd, j);
7962 JSON_SERIALIZED_CLASS(RallypointServerRouteMap)
7965 IMPLEMENT_JSON_SERIALIZATION()
7994 static void to_json(nlohmann::json& j,
const RallypointServerRouteMap& p)
7997 TOJSON_IMPL(fileName),
7998 TOJSON_IMPL(minRefreshSecs),
7999 TOJSON_IMPL(enabled),
8003 static void from_json(
const nlohmann::json& j, RallypointServerRouteMap& p)
8006 getOptional<std::string>(
"fileName", p.fileName, j);
8007 getOptional<int>(
"minRefreshSecs", p.minRefreshSecs, j, 5);
8008 getOptional<bool>(
"enabled", p.enabled, j,
false);
8009 getOptional<std::string>(
"runCmd", p.runCmd, j);
8014 JSON_SERIALIZED_CLASS(ExternalHealthCheckResponder)
8026 IMPLEMENT_JSON_SERIALIZATION()
8045 immediateClose =
true;
8049 static void to_json(nlohmann::json& j,
const ExternalHealthCheckResponder& p)
8052 TOJSON_IMPL(listenPort),
8053 TOJSON_IMPL(immediateClose)
8056 static void from_json(
const nlohmann::json& j, ExternalHealthCheckResponder& p)
8059 getOptional<int>(
"listenPort", p.listenPort, j, 0);
8060 getOptional<bool>(
"immediateClose", p.immediateClose, j,
true);
8065 JSON_SERIALIZED_CLASS(PeeringConfiguration)
8075 IMPLEMENT_JSON_SERIALIZATION()
8105 static void to_json(nlohmann::json& j,
const PeeringConfiguration& p)
8109 TOJSON_IMPL(version),
8110 TOJSON_IMPL(comments),
8114 static void from_json(
const nlohmann::json& j, PeeringConfiguration& p)
8117 getOptional<std::string>(
"id", p.id, j);
8118 getOptional<int>(
"version", p.version, j, 0);
8119 getOptional<std::string>(
"comments", p.comments, j);
8120 getOptional<std::vector<RallypointPeer>>(
"peers", p.peers, j);
8124 JSON_SERIALIZED_CLASS(IgmpSnooping)
8134 IMPLEMENT_JSON_SERIALIZATION()
8157 queryIntervalMs = 125000;
8158 subscriptionTimeoutMs = 0;
8162 static void to_json(nlohmann::json& j,
const IgmpSnooping& p)
8165 TOJSON_IMPL(enabled),
8166 TOJSON_IMPL(queryIntervalMs),
8167 TOJSON_IMPL(subscriptionTimeoutMs)
8170 static void from_json(
const nlohmann::json& j, IgmpSnooping& p)
8173 getOptional<bool>(
"enabled", p.enabled, j);
8174 getOptional<int>(
"queryIntervalMs", p.queryIntervalMs, j, 125000);
8175 getOptional<int>(
"subscriptionTimeoutMs", p.subscriptionTimeoutMs, j, 0);
8180 JSON_SERIALIZED_CLASS(RallypointReflector)
8189 IMPLEMENT_JSON_SERIALIZATION()
8204 } DirectionRestriction_t;
8236 multicastInterfaceName.clear();
8237 additionalTx.clear();
8238 directionRestriction = drNone;
8242 static void to_json(nlohmann::json& j,
const RallypointReflector& p)
8248 TOJSON_IMPL(multicastInterfaceName),
8249 TOJSON_IMPL(additionalTx),
8250 TOJSON_IMPL(directionRestriction)
8253 static void from_json(
const nlohmann::json& j, RallypointReflector& p)
8256 j.at(
"id").get_to(p.id);
8257 j.at(
"rx").get_to(p.rx);
8258 j.at(
"tx").get_to(p.tx);
8259 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
8260 getOptional<std::vector<NetworkAddress>>(
"additionalTx", p.additionalTx, j);
8261 getOptional<RallypointReflector::DirectionRestriction_t>(
"directionRestriction", p.directionRestriction, j, RallypointReflector::DirectionRestriction_t::drNone);
8266 JSON_SERIALIZED_CLASS(RallypointUdpStreamingIpvX)
8275 IMPLEMENT_JSON_SERIALIZATION()
8297 static void to_json(nlohmann::json& j,
const RallypointUdpStreamingIpvX& p)
8300 TOJSON_IMPL(enabled),
8301 TOJSON_IMPL(external)
8304 static void from_json(
const nlohmann::json& j, RallypointUdpStreamingIpvX& p)
8307 getOptional<bool>(
"enabled", p.enabled, j,
true);
8308 getOptional<NetworkAddress>(
"external", p.external, j);
8312 JSON_SERIALIZED_CLASS(RallypointUdpStreaming)
8321 IMPLEMENT_JSON_SERIALIZATION()
8332 ctSharedKeyAes256FullIv = 1,
8335 ctSharedKeyAes256IdxIv = 2,
8338 ctSharedKeyChaCha20FullIv = 3,
8341 ctSharedKeyChaCha20IdxIv = 4
8377 cryptoType = CryptoType_t::ctSharedKeyAes256FullIv;
8381 keepaliveIntervalSecs = 15;
8382 priority = TxPriority_t::priVoice;
8387 static void to_json(nlohmann::json& j,
const RallypointUdpStreaming& p)
8390 TOJSON_IMPL(enabled),
8391 TOJSON_IMPL(cryptoType),
8392 TOJSON_IMPL(listenPort),
8393 TOJSON_IMPL(keepaliveIntervalSecs),
8396 TOJSON_IMPL(priority),
8400 static void from_json(
const nlohmann::json& j, RallypointUdpStreaming& p)
8403 getOptional<bool>(
"enabled", p.enabled, j,
true);
8404 getOptional<RallypointUdpStreaming::CryptoType_t>(
"cryptoType", p.cryptoType, j, RallypointUdpStreaming::CryptoType_t::ctSharedKeyAes256FullIv);
8405 getOptional<int>(
"listenPort", p.listenPort, j, 7444);
8406 getOptional<int>(
"keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
8407 getOptional<RallypointUdpStreamingIpvX>(
"ipv4", p.ipv4, j);
8408 getOptional<RallypointUdpStreamingIpvX>(
"ipv6", p.ipv6, j);
8409 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
8410 getOptional<int>(
"ttl", p.ttl, j, 64);
8414 JSON_SERIALIZED_CLASS(RallypointRpRtTimingBehavior)
8423 IMPLEMENT_JSON_SERIALIZATION()
8468 static void to_json(nlohmann::json& j,
const RallypointRpRtTimingBehavior& p)
8471 TOJSON_IMPL(behavior),
8472 TOJSON_IMPL(atOrAboveMs),
8476 static void from_json(
const nlohmann::json& j, RallypointRpRtTimingBehavior& p)
8479 getOptional<RallypointRpRtTimingBehavior::BehaviorType_t>(
"behavior", p.behavior, j, RallypointRpRtTimingBehavior::BehaviorType_t::btNone);
8480 getOptional<uint32_t>(
"atOrAboveMs", p.atOrAboveMs, j, 0);
8481 getOptional<std::string>(
"runCmd", p.runCmd, j);
8486 JSON_SERIALIZED_CLASS(RallypointWebsocketSettings)
8495 IMPLEMENT_JSON_SERIALIZATION()
8520 certificate.clear();
8521 requireClientCertificate =
false;
8525 static void to_json(nlohmann::json& j,
const RallypointWebsocketSettings& p)
8528 TOJSON_IMPL(enabled),
8529 TOJSON_IMPL(listenPort),
8530 TOJSON_IMPL(certificate),
8531 TOJSON_IMPL(requireClientCertificate)
8534 static void from_json(
const nlohmann::json& j, RallypointWebsocketSettings& p)
8537 getOptional<bool>(
"enabled", p.enabled, j,
false);
8538 getOptional<int>(
"listenPort", p.listenPort, j, 8443);
8539 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
8540 getOptional<bool>(
"requireClientCertificate", p.requireClientCertificate, j,
false);
8546 JSON_SERIALIZED_CLASS(RallypointAdvertisingSettings)
8555 IMPLEMENT_JSON_SERIALIZATION()
8586 serviceName =
"_rallypoint._tcp.local.";
8587 interfaceName.clear();
8593 static void to_json(nlohmann::json& j,
const RallypointAdvertisingSettings& p)
8596 TOJSON_IMPL(enabled),
8597 TOJSON_IMPL(hostName),
8598 TOJSON_IMPL(serviceName),
8599 TOJSON_IMPL(interfaceName),
8604 static void from_json(
const nlohmann::json& j, RallypointAdvertisingSettings& p)
8607 getOptional<bool>(
"enabled", p.enabled, j,
false);
8608 getOptional<std::string>(
"hostName", p.hostName, j);
8609 getOptional<std::string>(
"serviceName", p.serviceName, j,
"_rallypoint._tcp.local.");
8610 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
8612 getOptional<int>(
"port", p.port, j, 0);
8613 getOptional<int>(
"ttl", p.ttl, j, 60);
8618 JSON_SERIALIZED_CLASS(RallypointExtendedGroupRestriction)
8627 IMPLEMENT_JSON_SERIALIZATION()
8645 restrictions.clear();
8649 static void to_json(nlohmann::json& j,
const RallypointExtendedGroupRestriction& p)
8653 TOJSON_IMPL(restrictions)
8656 static void from_json(
const nlohmann::json& j, RallypointExtendedGroupRestriction& p)
8659 getOptional<std::string>(
"id", p.id, j);
8660 getOptional<std::vector<StringRestrictionList>>(
"restrictions", p.restrictions, j);
8665 JSON_SERIALIZED_CLASS(RallypointServer)
8676 IMPLEMENT_JSON_SERIALIZATION()
8859 interfaceName.clear();
8860 certificate.clear();
8861 allowMulticastForwarding =
false;
8862 peeringConfiguration.clear();
8863 peeringConfigurationFileName.clear();
8864 peeringConfigurationFileCommand.clear();
8865 peeringConfigurationFileCheckSecs = 60;
8867 statusReport.clear();
8870 externalHealthCheckResponder.clear();
8871 allowPeerForwarding =
false;
8872 multicastInterfaceName.clear();
8875 forwardDiscoveredGroups =
false;
8876 forwardMulticastAddressing =
false;
8878 disableMessageSigning =
false;
8879 multicastRestrictions.clear();
8880 igmpSnooping.clear();
8881 staticReflectors.clear();
8882 tcpTxOptions.clear();
8883 multicastTxOptions.clear();
8884 certStoreFileName.clear();
8885 certStorePasswordHex.clear();
8886 groupRestrictions.clear();
8887 configurationCheckSignalName =
"rts.7b392d1.${id}";
8890 udpStreaming.clear();
8892 normalTaskQueueBias = 0;
8893 enableLeafReflectionReverseSubscription =
false;
8894 disableLoopDetection =
false;
8895 maxSecurityLevel = 0;
8897 maxOutboundPeerConnectionIntervalDeltaSecs = 15;
8898 peerRtTestIntervalMs = 60000;
8899 peerRtBehaviors.clear();
8902 advertising.clear();
8903 extendedGroupRestrictions.clear();
8904 groupRestrictionAccessPolicyType = GroupRestrictionAccessPolicyType_t::graptPermissive;
8905 ipFamily = IpFamilyType_t::ifIpUnspec;
8909 extraMeshes.clear();
8914 static void to_json(nlohmann::json& j,
const RallypointServer& p)
8917 TOJSON_IMPL(fipsCrypto),
8918 TOJSON_IMPL(watchdog),
8920 TOJSON_IMPL(listenPort),
8921 TOJSON_IMPL(interfaceName),
8922 TOJSON_IMPL(certificate),
8923 TOJSON_IMPL(allowMulticastForwarding),
8925 TOJSON_IMPL(peeringConfigurationFileName),
8926 TOJSON_IMPL(peeringConfigurationFileCommand),
8927 TOJSON_IMPL(peeringConfigurationFileCheckSecs),
8928 TOJSON_IMPL(ioPools),
8929 TOJSON_IMPL(statusReport),
8930 TOJSON_IMPL(limits),
8931 TOJSON_IMPL(linkGraph),
8932 TOJSON_IMPL(externalHealthCheckResponder),
8933 TOJSON_IMPL(allowPeerForwarding),
8934 TOJSON_IMPL(multicastInterfaceName),
8936 TOJSON_IMPL(discovery),
8937 TOJSON_IMPL(forwardDiscoveredGroups),
8938 TOJSON_IMPL(forwardMulticastAddressing),
8939 TOJSON_IMPL(isMeshLeaf),
8940 TOJSON_IMPL(disableMessageSigning),
8941 TOJSON_IMPL(multicastRestrictions),
8942 TOJSON_IMPL(igmpSnooping),
8943 TOJSON_IMPL(staticReflectors),
8944 TOJSON_IMPL(tcpTxOptions),
8945 TOJSON_IMPL(multicastTxOptions),
8946 TOJSON_IMPL(certStoreFileName),
8947 TOJSON_IMPL(certStorePasswordHex),
8948 TOJSON_IMPL(groupRestrictions),
8949 TOJSON_IMPL(configurationCheckSignalName),
8950 TOJSON_IMPL(featureset),
8951 TOJSON_IMPL(licensing),
8952 TOJSON_IMPL(udpStreaming),
8953 TOJSON_IMPL(sysFlags),
8954 TOJSON_IMPL(normalTaskQueueBias),
8955 TOJSON_IMPL(enableLeafReflectionReverseSubscription),
8956 TOJSON_IMPL(disableLoopDetection),
8957 TOJSON_IMPL(maxSecurityLevel),
8958 TOJSON_IMPL(routeMap),
8959 TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
8960 TOJSON_IMPL(peerRtTestIntervalMs),
8961 TOJSON_IMPL(peerRtBehaviors),
8962 TOJSON_IMPL(websocket),
8964 TOJSON_IMPL(advertising),
8965 TOJSON_IMPL(extendedGroupRestrictions),
8966 TOJSON_IMPL(groupRestrictionAccessPolicyType),
8967 TOJSON_IMPL(ipFamily),
8968 TOJSON_IMPL(rxCapture),
8969 TOJSON_IMPL(txCapture),
8970 TOJSON_IMPL(meshName),
8971 TOJSON_IMPL(extraMeshes),
8975 static void from_json(
const nlohmann::json& j, RallypointServer& p)
8978 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
8979 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
8980 getOptional<std::string>(
"id", p.id, j);
8981 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
8982 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
8983 getOptional<int>(
"listenPort", p.listenPort, j, 7443);
8984 getOptional<bool>(
"allowMulticastForwarding", p.allowMulticastForwarding, j,
false);
8986 getOptional<std::string>(
"peeringConfigurationFileName", p.peeringConfigurationFileName, j);
8987 getOptional<std::string>(
"peeringConfigurationFileCommand", p.peeringConfigurationFileCommand, j);
8988 getOptional<int>(
"peeringConfigurationFileCheckSecs", p.peeringConfigurationFileCheckSecs, j, 60);
8989 getOptional<int>(
"ioPools", p.ioPools, j, -1);
8990 getOptional<RallypointServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
8991 getOptional<RallypointServerLimits>(
"limits", p.limits, j);
8992 getOptional<RallypointServerLinkGraph>(
"linkGraph", p.linkGraph, j);
8993 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
8994 getOptional<bool>(
"allowPeerForwarding", p.allowPeerForwarding, j,
false);
8995 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
8996 getOptional<Tls>(
"tls", p.tls, j);
8997 getOptional<DiscoveryConfiguration>(
"discovery", p.discovery, j);
8998 getOptional<bool>(
"forwardDiscoveredGroups", p.forwardDiscoveredGroups, j,
false);
8999 getOptional<bool>(
"forwardMulticastAddressing", p.forwardMulticastAddressing, j,
false);
9000 getOptional<bool>(
"isMeshLeaf", p.isMeshLeaf, j,
false);
9001 getOptional<bool>(
"disableMessageSigning", p.disableMessageSigning, j,
false);
9002 getOptional<NetworkAddressRestrictionList>(
"multicastRestrictions", p.multicastRestrictions, j);
9003 getOptional<IgmpSnooping>(
"igmpSnooping", p.igmpSnooping, j);
9004 getOptional<std::vector<RallypointReflector>>(
"staticReflectors", p.staticReflectors, j);
9005 getOptional<TcpNetworkTxOptions>(
"tcpTxOptions", p.tcpTxOptions, j);
9006 getOptional<NetworkTxOptions>(
"multicastTxOptions", p.multicastTxOptions, j);
9007 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
9008 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
9009 getOptional<StringRestrictionList>(
"groupRestrictions", p.groupRestrictions, j);
9010 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.7b392d1.${id}");
9011 getOptional<Licensing>(
"licensing", p.licensing, j);
9012 getOptional<Featureset>(
"featureset", p.featureset, j);
9013 getOptional<RallypointUdpStreaming>(
"udpStreaming", p.udpStreaming, j);
9014 getOptional<uint32_t>(
"sysFlags", p.sysFlags, j, 0);
9015 getOptional<uint32_t>(
"normalTaskQueueBias", p.normalTaskQueueBias, j, 0);
9016 getOptional<bool>(
"enableLeafReflectionReverseSubscription", p.enableLeafReflectionReverseSubscription, j,
false);
9017 getOptional<bool>(
"disableLoopDetection", p.disableLoopDetection, j,
false);
9018 getOptional<uint32_t>(
"maxSecurityLevel", p.maxSecurityLevel, j, 0);
9019 getOptional<RallypointServerRouteMap>(
"routeMap", p.routeMap, j);
9020 getOptional<uint32_t>(
"maxOutboundPeerConnectionIntervalDeltaSecs", p.maxOutboundPeerConnectionIntervalDeltaSecs, j, 15);
9021 getOptional<int>(
"peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
9022 getOptional<std::vector<RallypointRpRtTimingBehavior>>(
"peerRtBehaviors", p.peerRtBehaviors, j);
9023 getOptional<RallypointWebsocketSettings>(
"websocket", p.websocket, j);
9024 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
9025 getOptional<RallypointAdvertisingSettings>(
"advertising", p.advertising, j);
9026 getOptional<std::vector<RallypointExtendedGroupRestriction>>(
"extendedGroupRestrictions", p.extendedGroupRestrictions, j);
9027 getOptional<GroupRestrictionAccessPolicyType_t>(
"groupRestrictionAccessPolicyType", p.groupRestrictionAccessPolicyType, j, GroupRestrictionAccessPolicyType_t::graptPermissive);
9028 getOptional<IpFamilyType_t>(
"ipFamily", p.ipFamily, j, IpFamilyType_t::ifIpUnspec);
9029 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
9030 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
9031 getOptional<std::string>(
"meshName", p.meshName, j);
9032 getOptional<std::vector<std::string>>(
"extraMeshes", p.extraMeshes, j);
9033 getOptional<TuningSettings>(
"tuning", p.tuning, j);
9037 JSON_SERIALIZED_CLASS(PlatformDiscoveredService)
9049 IMPLEMENT_JSON_SERIALIZATION()
9084 configurationVersion = 0;
9088 static void to_json(nlohmann::json& j,
const PlatformDiscoveredService& p)
9094 TOJSON_IMPL(address),
9096 TOJSON_IMPL(configurationVersion)
9099 static void from_json(
const nlohmann::json& j, PlatformDiscoveredService& p)
9102 getOptional<std::string>(
"id", p.id, j);
9103 getOptional<std::string>(
"type", p.type, j);
9104 getOptional<std::string>(
"name", p.name, j);
9105 getOptional<NetworkAddress>(
"address", p.address, j);
9106 getOptional<std::string>(
"uri", p.uri, j);
9107 getOptional<uint32_t>(
"configurationVersion", p.configurationVersion, j, 0);
9147 IMPLEMENT_JSON_SERIALIZATION()
9193 mostRecentFirst =
true;
9194 startedOnOrAfter = 0;
9195 endedOnOrBefore = 0;
9198 onlyCommitted =
true;
9206 static void to_json(nlohmann::json& j,
const TimelineQueryParameters& p)
9209 TOJSON_IMPL(maxCount),
9210 TOJSON_IMPL(mostRecentFirst),
9211 TOJSON_IMPL(startedOnOrAfter),
9212 TOJSON_IMPL(endedOnOrBefore),
9213 TOJSON_IMPL(onlyDirection),
9214 TOJSON_IMPL(onlyType),
9215 TOJSON_IMPL(onlyCommitted),
9216 TOJSON_IMPL(onlyAlias),
9217 TOJSON_IMPL(onlyNodeId),
9218 TOJSON_IMPL(onlyTxId),
9222 static void from_json(
const nlohmann::json& j, TimelineQueryParameters& p)
9225 getOptional<long>(
"maxCount", p.maxCount, j, 50);
9226 getOptional<bool>(
"mostRecentFirst", p.mostRecentFirst, j,
false);
9227 getOptional<uint64_t>(
"startedOnOrAfter", p.startedOnOrAfter, j, 0);
9228 getOptional<uint64_t>(
"endedOnOrBefore", p.endedOnOrBefore, j, 0);
9229 getOptional<int>(
"onlyDirection", p.onlyDirection, j, 0);
9230 getOptional<int>(
"onlyType", p.onlyType, j, 0);
9231 getOptional<bool>(
"onlyCommitted", p.onlyCommitted, j,
true);
9232 getOptional<std::string>(
"onlyAlias", p.onlyAlias, j, EMPTY_STRING);
9233 getOptional<std::string>(
"onlyNodeId", p.onlyNodeId, j, EMPTY_STRING);
9234 getOptional<int>(
"onlyTxId", p.onlyTxId, j, 0);
9235 getOptional<std::string>(
"sql", p.sql, j, EMPTY_STRING);
9239 JSON_SERIALIZED_CLASS(CertStoreCertificate)
9248 IMPLEMENT_JSON_SERIALIZATION()
9275 certificatePem.clear();
9276 privateKeyPem.clear();
9277 internalData =
nullptr;
9282 static void to_json(nlohmann::json& j,
const CertStoreCertificate& p)
9286 TOJSON_IMPL(certificatePem),
9287 TOJSON_IMPL(privateKeyPem),
9291 static void from_json(
const nlohmann::json& j, CertStoreCertificate& p)
9294 j.at(
"id").get_to(p.id);
9295 j.at(
"certificatePem").get_to(p.certificatePem);
9296 getOptional<std::string>(
"privateKeyPem", p.privateKeyPem, j, EMPTY_STRING);
9297 getOptional<std::string>(
"tags", p.tags, j, EMPTY_STRING);
9301 JSON_SERIALIZED_CLASS(CertStore)
9310 IMPLEMENT_JSON_SERIALIZATION()
9331 certificates.clear();
9336 static void to_json(nlohmann::json& j,
const CertStore& p)
9340 TOJSON_IMPL(certificates),
9344 static void from_json(
const nlohmann::json& j, CertStore& p)
9347 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
9348 getOptional<std::vector<CertStoreCertificate>>(
"certificates", p.certificates, j);
9349 getOptional<std::vector<KvPair>>(
"kvp", p.kvp, j);
9353 JSON_SERIALIZED_CLASS(CertStoreCertificateElement)
9362 IMPLEMENT_JSON_SERIALIZATION()
9386 hasPrivateKey =
false;
9391 static void to_json(nlohmann::json& j,
const CertStoreCertificateElement& p)
9395 TOJSON_IMPL(hasPrivateKey),
9399 if(!p.certificatePem.empty())
9401 j[
"certificatePem"] = p.certificatePem;
9404 static void from_json(
const nlohmann::json& j, CertStoreCertificateElement& p)
9407 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
9408 getOptional<bool>(
"hasPrivateKey", p.hasPrivateKey, j,
false);
9409 getOptional<std::string>(
"certificatePem", p.certificatePem, j, EMPTY_STRING);
9410 getOptional<std::string>(
"tags", p.tags, j, EMPTY_STRING);
9414 JSON_SERIALIZED_CLASS(CertStoreDescriptor)
9423 IMPLEMENT_JSON_SERIALIZATION()
9456 certificates.clear();
9461 static void to_json(nlohmann::json& j,
const CertStoreDescriptor& p)
9465 TOJSON_IMPL(fileName),
9466 TOJSON_IMPL(version),
9468 TOJSON_IMPL(certificates),
9472 static void from_json(
const nlohmann::json& j, CertStoreDescriptor& p)
9475 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
9476 getOptional<std::string>(
"fileName", p.fileName, j, EMPTY_STRING);
9477 getOptional<int>(
"version", p.version, j, 0);
9478 getOptional<int>(
"flags", p.flags, j, 0);
9479 getOptional<std::vector<CertStoreCertificateElement>>(
"certificates", p.certificates, j);
9480 getOptional<std::vector<KvPair>>(
"kvp", p.kvp, j);
9484 JSON_SERIALIZED_CLASS(CertificateSubjectElement)
9493 IMPLEMENT_JSON_SERIALIZATION()
9515 static void to_json(nlohmann::json& j,
const CertificateSubjectElement& p)
9522 static void from_json(
const nlohmann::json& j, CertificateSubjectElement& p)
9525 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
9526 getOptional<std::string>(
"value", p.value, j, EMPTY_STRING);
9531 JSON_SERIALIZED_CLASS(CertificateDescriptor)
9540 IMPLEMENT_JSON_SERIALIZATION()
9591 fingerprint.clear();
9592 subjectElements.clear();
9593 certificatePem.clear();
9594 publicKeyPem.clear();
9598 static void to_json(nlohmann::json& j,
const CertificateDescriptor& p)
9601 TOJSON_IMPL(subject),
9602 TOJSON_IMPL(issuer),
9603 TOJSON_IMPL(selfSigned),
9604 TOJSON_IMPL(version),
9605 TOJSON_IMPL(notBefore),
9606 TOJSON_IMPL(notAfter),
9607 TOJSON_IMPL(serial),
9608 TOJSON_IMPL(fingerprint),
9609 TOJSON_IMPL(subjectElements),
9610 TOJSON_IMPL(certificatePem),
9611 TOJSON_IMPL(publicKeyPem)
9614 static void from_json(
const nlohmann::json& j, CertificateDescriptor& p)
9617 getOptional<std::string>(
"subject", p.subject, j, EMPTY_STRING);
9618 getOptional<std::string>(
"issuer", p.issuer, j, EMPTY_STRING);
9619 getOptional<bool>(
"selfSigned", p.selfSigned, j,
false);
9620 getOptional<int>(
"version", p.version, j, 0);
9621 getOptional<std::string>(
"notBefore", p.notBefore, j, EMPTY_STRING);
9622 getOptional<std::string>(
"notAfter", p.notAfter, j, EMPTY_STRING);
9623 getOptional<std::string>(
"serial", p.serial, j, EMPTY_STRING);
9624 getOptional<std::string>(
"fingerprint", p.fingerprint, j, EMPTY_STRING);
9625 getOptional<std::string>(
"certificatePem", p.certificatePem, j, EMPTY_STRING);
9626 getOptional<std::string>(
"publicKeyPem", p.publicKeyPem, j, EMPTY_STRING);
9627 getOptional<std::vector<CertificateSubjectElement>>(
"subjectElements", p.subjectElements, j);
9632 JSON_SERIALIZED_CLASS(RiffDescriptor)
9644 IMPLEMENT_JSON_SERIALIZATION()
9685 certDescriptor.clear();
9690 static void to_json(nlohmann::json& j,
const RiffDescriptor& p)
9694 TOJSON_IMPL(verified),
9695 TOJSON_IMPL(channels),
9696 TOJSON_IMPL(sampleCount),
9698 TOJSON_IMPL(certPem),
9699 TOJSON_IMPL(certDescriptor),
9700 TOJSON_IMPL(signature)
9704 static void from_json(
const nlohmann::json& j, RiffDescriptor& p)
9707 FROMJSON_IMPL(file, std::string, EMPTY_STRING);
9708 FROMJSON_IMPL(verified,
bool,
false);
9709 FROMJSON_IMPL(channels,
int, 0);
9710 FROMJSON_IMPL(sampleCount,
int, 0);
9711 FROMJSON_IMPL(meta, std::string, EMPTY_STRING);
9712 FROMJSON_IMPL(certPem, std::string, EMPTY_STRING);
9713 getOptional<CertificateDescriptor>(
"certDescriptor", p.certDescriptor, j);
9714 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
9719 JSON_SERIALIZED_CLASS(BridgeCreationDetail)
9728 IMPLEMENT_JSON_SERIALIZATION()
9746 csAlreadyExists = -3,
9749 csInvalidConfiguration = -4,
9755 csInsufficientGroups = -6,
9758 csTooManyGroups = -7,
9761 csDuplicateGroup = -8,
9764 csLocalLoopDetected = -9,
9781 status = csUndefined;
9785 static void to_json(nlohmann::json& j,
const BridgeCreationDetail& p)
9792 static void from_json(
const nlohmann::json& j, BridgeCreationDetail& p)
9795 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
9796 getOptional<BridgeCreationDetail::CreationStatus_t>(
"status", p.status, j, BridgeCreationDetail::CreationStatus_t::csUndefined);
9799 JSON_SERIALIZED_CLASS(GroupConnectionDetail)
9808 IMPLEMENT_JSON_SERIALIZATION()
9820 ctDirectDatagram = 1,
9849 connectionType = ctUndefined;
9856 static void to_json(nlohmann::json& j,
const GroupConnectionDetail& p)
9860 TOJSON_IMPL(connectionType),
9862 TOJSON_IMPL(asFailover),
9868 j[
"asFailover"] = p.asFailover;
9871 static void from_json(
const nlohmann::json& j, GroupConnectionDetail& p)
9874 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
9875 getOptional<GroupConnectionDetail::ConnectionType_t>(
"connectionType", p.connectionType, j, GroupConnectionDetail::ConnectionType_t::ctUndefined);
9876 getOptional<std::string>(
"peer", p.peer, j, EMPTY_STRING);
9877 getOptional<bool>(
"asFailover", p.asFailover, j,
false);
9878 getOptional<std::string>(
"reason", p.reason, j, EMPTY_STRING);
9882 JSON_SERIALIZED_CLASS(GroupTxDetail)
9891 IMPLEMENT_JSON_SERIALIZATION()
9909 txsNotAnAudioGroup = -1,
9915 txsNotConnected = -3,
9918 txsAlreadyTransmitting = -4,
9921 txsInvalidParams = -5,
9924 txsPriorityTooLow = -6,
9927 txsRxActiveOnNonFdx = -7,
9930 txsCannotSubscribeToInput = -8,
9936 txsTxEndedWithFailure = -10,
9965 status = txsUndefined;
9968 nonFdxMsHangRemaining = 0;
9973 static void to_json(nlohmann::json& j,
const GroupTxDetail& p)
9977 TOJSON_IMPL(status),
9978 TOJSON_IMPL(localPriority),
9983 if(p.status == GroupTxDetail::TxStatus_t::txsPriorityTooLow)
9985 j[
"remotePriority"] = p.remotePriority;
9987 else if(p.status == GroupTxDetail::TxStatus_t::txsRxActiveOnNonFdx)
9989 j[
"nonFdxMsHangRemaining"] = p.nonFdxMsHangRemaining;
9992 static void from_json(
const nlohmann::json& j, GroupTxDetail& p)
9995 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
9996 getOptional<GroupTxDetail::TxStatus_t>(
"status", p.status, j, GroupTxDetail::TxStatus_t::txsUndefined);
9997 getOptional<int>(
"localPriority", p.localPriority, j, 0);
9998 getOptional<int>(
"remotePriority", p.remotePriority, j, 0);
9999 getOptional<long>(
"nonFdxMsHangRemaining", p.nonFdxMsHangRemaining, j, 0);
10000 getOptional<uint32_t>(
"txId", p.txId, j, 0);
10004 JSON_SERIALIZED_CLASS(GroupCreationDetail)
10013 IMPLEMENT_JSON_SERIALIZATION()
10031 csConflictingRpListAndCluster = -2,
10034 csAlreadyExists = -3,
10037 csInvalidConfiguration = -4,
10040 csInvalidJson = -5,
10043 csCryptoFailure = -6,
10046 csAudioInputFailure = -7,
10049 csAudioOutputFailure = -8,
10052 csUnsupportedAudioEncoder = -9,
10058 csInvalidTransport = -11,
10059 } CreationStatus_t;
10075 status = csUndefined;
10079 static void to_json(nlohmann::json& j,
const GroupCreationDetail& p)
10081 j = nlohmann::json{
10083 TOJSON_IMPL(status)
10086 static void from_json(
const nlohmann::json& j, GroupCreationDetail& p)
10089 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10090 getOptional<GroupCreationDetail::CreationStatus_t>(
"status", p.status, j, GroupCreationDetail::CreationStatus_t::csUndefined);
10095 JSON_SERIALIZED_CLASS(GroupReconfigurationDetail)
10104 IMPLEMENT_JSON_SERIALIZATION()
10122 rsInvalidConfiguration = -2,
10125 rsInvalidJson = -3,
10128 rsAudioInputFailure = -4,
10131 rsAudioOutputFailure = -5,
10134 rsDoesNotExist = -6,
10137 rsAudioInputInUse = -7,
10140 rsAudioDisabledForGroup = -8,
10143 rsGroupIsNotAudio = -9
10144 } ReconfigurationStatus_t;
10160 status = rsUndefined;
10164 static void to_json(nlohmann::json& j,
const GroupReconfigurationDetail& p)
10166 j = nlohmann::json{
10168 TOJSON_IMPL(status)
10171 static void from_json(
const nlohmann::json& j, GroupReconfigurationDetail& p)
10174 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10175 getOptional<GroupReconfigurationDetail::ReconfigurationStatus_t>(
"status", p.status, j, GroupReconfigurationDetail::ReconfigurationStatus_t::rsUndefined);
10180 JSON_SERIALIZED_CLASS(GroupHealthReport)
10189 IMPLEMENT_JSON_SERIALIZATION()
10195 uint64_t lastErrorTs;
10196 uint64_t decryptionErrors;
10197 uint64_t encryptionErrors;
10198 uint64_t unsupportDecoderErrors;
10199 uint64_t decoderFailures;
10200 uint64_t decoderStartFailures;
10201 uint64_t inboundRtpPacketAllocationFailures;
10202 uint64_t inboundRtpPacketLoadFailures;
10203 uint64_t latePacketsDiscarded;
10204 uint64_t jitterBufferInsertionFailures;
10205 uint64_t presenceDeserializationFailures;
10206 uint64_t notRtpErrors;
10207 uint64_t generalErrors;
10208 uint64_t inboundRtpProcessorAllocationFailures;
10219 decryptionErrors = 0;
10220 encryptionErrors = 0;
10221 unsupportDecoderErrors = 0;
10222 decoderFailures = 0;
10223 decoderStartFailures = 0;
10224 inboundRtpPacketAllocationFailures = 0;
10225 inboundRtpPacketLoadFailures = 0;
10226 latePacketsDiscarded = 0;
10227 jitterBufferInsertionFailures = 0;
10228 presenceDeserializationFailures = 0;
10231 inboundRtpProcessorAllocationFailures = 0;
10237 j = nlohmann::json{
10239 TOJSON_IMPL(lastErrorTs),
10240 TOJSON_IMPL(decryptionErrors),
10241 TOJSON_IMPL(encryptionErrors),
10242 TOJSON_IMPL(unsupportDecoderErrors),
10243 TOJSON_IMPL(decoderFailures),
10244 TOJSON_IMPL(decoderStartFailures),
10245 TOJSON_IMPL(inboundRtpPacketAllocationFailures),
10246 TOJSON_IMPL(inboundRtpPacketLoadFailures),
10247 TOJSON_IMPL(latePacketsDiscarded),
10248 TOJSON_IMPL(jitterBufferInsertionFailures),
10249 TOJSON_IMPL(presenceDeserializationFailures),
10250 TOJSON_IMPL(notRtpErrors),
10251 TOJSON_IMPL(generalErrors),
10252 TOJSON_IMPL(inboundRtpProcessorAllocationFailures)
10255 static void from_json(
const nlohmann::json& j, GroupHealthReport& p)
10258 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10259 getOptional<uint64_t>(
"lastErrorTs", p.lastErrorTs, j, 0);
10260 getOptional<uint64_t>(
"decryptionErrors", p.decryptionErrors, j, 0);
10261 getOptional<uint64_t>(
"encryptionErrors", p.encryptionErrors, j, 0);
10262 getOptional<uint64_t>(
"unsupportDecoderErrors", p.unsupportDecoderErrors, j, 0);
10263 getOptional<uint64_t>(
"decoderFailures", p.decoderFailures, j, 0);
10264 getOptional<uint64_t>(
"decoderStartFailures", p.decoderStartFailures, j, 0);
10265 getOptional<uint64_t>(
"inboundRtpPacketAllocationFailures", p.inboundRtpPacketAllocationFailures, j, 0);
10266 getOptional<uint64_t>(
"inboundRtpPacketLoadFailures", p.inboundRtpPacketLoadFailures, j, 0);
10267 getOptional<uint64_t>(
"latePacketsDiscarded", p.latePacketsDiscarded, j, 0);
10268 getOptional<uint64_t>(
"jitterBufferInsertionFailures", p.jitterBufferInsertionFailures, j, 0);
10269 getOptional<uint64_t>(
"presenceDeserializationFailures", p.presenceDeserializationFailures, j, 0);
10270 getOptional<uint64_t>(
"notRtpErrors", p.notRtpErrors, j, 0);
10271 getOptional<uint64_t>(
"generalErrors", p.generalErrors, j, 0);
10272 getOptional<uint64_t>(
"inboundRtpProcessorAllocationFailures", p.inboundRtpProcessorAllocationFailures, j, 0);
10276 JSON_SERIALIZED_CLASS(InboundProcessorStats)
10285 IMPLEMENT_JSON_SERIALIZATION()
10292 uint64_t minRtpSamplesInQueue;
10293 uint64_t maxRtpSamplesInQueue;
10294 uint64_t totalSamplesTrimmed;
10295 uint64_t underruns;
10297 uint64_t samplesInQueue;
10298 uint64_t totalPacketsReceived;
10299 uint64_t totalPacketsLost;
10300 uint64_t totalPacketsDiscarded;
10311 minRtpSamplesInQueue = 0;
10312 maxRtpSamplesInQueue = 0;
10313 totalSamplesTrimmed = 0;
10316 samplesInQueue = 0;
10317 totalPacketsReceived = 0;
10318 totalPacketsLost = 0;
10319 totalPacketsDiscarded = 0;
10325 j = nlohmann::json{
10327 TOJSON_IMPL(jitter),
10328 TOJSON_IMPL(minRtpSamplesInQueue),
10329 TOJSON_IMPL(maxRtpSamplesInQueue),
10330 TOJSON_IMPL(totalSamplesTrimmed),
10331 TOJSON_IMPL(underruns),
10332 TOJSON_IMPL(overruns),
10333 TOJSON_IMPL(samplesInQueue),
10334 TOJSON_IMPL(totalPacketsReceived),
10335 TOJSON_IMPL(totalPacketsLost),
10336 TOJSON_IMPL(totalPacketsDiscarded)
10339 static void from_json(
const nlohmann::json& j, InboundProcessorStats& p)
10342 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
10343 getOptional<double>(
"jitter", p.jitter, j, 0.0);
10344 getOptional<uint64_t>(
"minRtpSamplesInQueue", p.minRtpSamplesInQueue, j, 0);
10345 getOptional<uint64_t>(
"maxRtpSamplesInQueue", p.maxRtpSamplesInQueue, j, 0);
10346 getOptional<uint64_t>(
"totalSamplesTrimmed", p.totalSamplesTrimmed, j, 0);
10347 getOptional<uint64_t>(
"underruns", p.underruns, j, 0);
10348 getOptional<uint64_t>(
"overruns", p.overruns, j, 0);
10349 getOptional<uint64_t>(
"samplesInQueue", p.samplesInQueue, j, 0);
10350 getOptional<uint64_t>(
"totalPacketsReceived", p.totalPacketsReceived, j, 0);
10351 getOptional<uint64_t>(
"totalPacketsLost", p.totalPacketsLost, j, 0);
10352 getOptional<uint64_t>(
"totalPacketsDiscarded", p.totalPacketsDiscarded, j, 0);
10356 JSON_SERIALIZED_CLASS(TrafficCounter)
10365 IMPLEMENT_JSON_SERIALIZATION()
10389 j = nlohmann::json{
10390 TOJSON_IMPL(packets),
10391 TOJSON_IMPL(bytes),
10392 TOJSON_IMPL(errors)
10395 static void from_json(
const nlohmann::json& j, TrafficCounter& p)
10398 getOptional<uint64_t>(
"packets", p.packets, j, 0);
10399 getOptional<uint64_t>(
"bytes", p.bytes, j, 0);
10400 getOptional<uint64_t>(
"errors", p.errors, j, 0);
10404 JSON_SERIALIZED_CLASS(GroupStats)
10413 IMPLEMENT_JSON_SERIALIZATION()
10414 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(
GroupStats)
10437 static void to_json(nlohmann::json& j,
const GroupStats& p)
10439 j = nlohmann::json{
10442 TOJSON_IMPL(rxTraffic),
10443 TOJSON_IMPL(txTraffic)
10446 static void from_json(
const nlohmann::json& j, GroupStats& p)
10449 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10451 getOptional<TrafficCounter>(
"rxTraffic", p.rxTraffic, j);
10452 getOptional<TrafficCounter>(
"txTraffic", p.txTraffic, j);
10456 JSON_SERIALIZED_CLASS(RallypointConnectionDetail)
10465 IMPLEMENT_JSON_SERIALIZATION()
10492 internalId.clear();
10495 msToNextConnectionAttempt = 0;
10496 serverProcessingMs = -1.0f;
10500 static void to_json(nlohmann::json& j,
const RallypointConnectionDetail& p)
10502 j = nlohmann::json{
10503 TOJSON_IMPL(internalId),
10508 if(p.msToNextConnectionAttempt > 0)
10510 j[
"msToNextConnectionAttempt"] = p.msToNextConnectionAttempt;
10513 if(p.serverProcessingMs >= 0.0)
10515 j[
"serverProcessingMs"] = p.serverProcessingMs;
10518 static void from_json(
const nlohmann::json& j, RallypointConnectionDetail& p)
10521 getOptional<std::string>(
"internalId", p.internalId, j, EMPTY_STRING);
10522 getOptional<std::string>(
"host", p.host, j, EMPTY_STRING);
10523 getOptional<int>(
"port", p.port, j, 0);
10524 getOptional<uint64_t>(
"msToNextConnectionAttempt", p.msToNextConnectionAttempt, j, 0);
10525 getOptional<float>(
"serverProcessingMs", p.serverProcessingMs, j, -1.0);
10529 JSON_SERIALIZED_CLASS(TranslationSession)
10541 IMPLEMENT_JSON_SERIALIZATION()
10571 static void to_json(nlohmann::json& j,
const TranslationSession& p)
10573 j = nlohmann::json{
10576 TOJSON_IMPL(groups),
10577 TOJSON_IMPL(enabled)
10580 static void from_json(
const nlohmann::json& j, TranslationSession& p)
10583 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
10584 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
10585 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
10586 FROMJSON_IMPL(enabled,
bool,
true);
10590 JSON_SERIALIZED_CLASS(TranslationConfiguration)
10602 IMPLEMENT_JSON_SERIALIZATION()
10624 static void to_json(nlohmann::json& j,
const TranslationConfiguration& p)
10626 j = nlohmann::json{
10627 TOJSON_IMPL(sessions),
10628 TOJSON_IMPL(groups)
10631 static void from_json(
const nlohmann::json& j, TranslationConfiguration& p)
10634 getOptional<std::vector<TranslationSession>>(
"sessions", p.sessions, j);
10635 getOptional<std::vector<Group>>(
"groups", p.groups, j);
10639 JSON_SERIALIZED_CLASS(LingoServerStatusReportConfiguration)
10651 IMPLEMENT_JSON_SERIALIZATION()
10686 includeGroupDetail =
false;
10687 includeSessionDetail =
false;
10688 includeSessionGroupDetail =
false;
10693 static void to_json(nlohmann::json& j,
const LingoServerStatusReportConfiguration& p)
10695 j = nlohmann::json{
10696 TOJSON_IMPL(fileName),
10697 TOJSON_IMPL(intervalSecs),
10698 TOJSON_IMPL(enabled),
10699 TOJSON_IMPL(includeGroupDetail),
10700 TOJSON_IMPL(includeSessionDetail),
10701 TOJSON_IMPL(includeSessionGroupDetail),
10702 TOJSON_IMPL(runCmd)
10705 static void from_json(
const nlohmann::json& j, LingoServerStatusReportConfiguration& p)
10708 getOptional<std::string>(
"fileName", p.fileName, j);
10709 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
10710 getOptional<bool>(
"enabled", p.enabled, j,
false);
10711 getOptional<std::string>(
"runCmd", p.runCmd, j);
10712 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
10713 getOptional<bool>(
"includeSessionDetail", p.includeSessionDetail, j,
false);
10714 getOptional<bool>(
"includeSessionGroupDetail", p.includeSessionGroupDetail, j,
false);
10718 JSON_SERIALIZED_CLASS(LingoServerInternals)
10732 IMPLEMENT_JSON_SERIALIZATION()
10754 housekeeperIntervalMs = 1000;
10758 static void to_json(nlohmann::json& j,
const LingoServerInternals& p)
10760 j = nlohmann::json{
10761 TOJSON_IMPL(watchdog),
10762 TOJSON_IMPL(housekeeperIntervalMs),
10763 TOJSON_IMPL(tuning)
10766 static void from_json(
const nlohmann::json& j, LingoServerInternals& p)
10769 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
10770 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
10771 getOptional<TuningSettings>(
"tuning", p.tuning, j);
10775 JSON_SERIALIZED_CLASS(LingoServerConfiguration)
10786 IMPLEMENT_JSON_SERIALIZATION()
10843 serviceConfigurationFileCheckSecs = 60;
10844 lingoConfigurationFileName.clear();
10845 lingoConfigurationFileCommand.clear();
10846 lingoConfigurationFileCheckSecs = 60;
10847 statusReport.clear();
10848 externalHealthCheckResponder.clear();
10850 certStoreFileName.clear();
10851 certStorePasswordHex.clear();
10852 enginePolicy.clear();
10853 configurationCheckSignalName =
"rts.22f4ec3.${id}";
10854 fipsCrypto.clear();
10860 static void to_json(nlohmann::json& j,
const LingoServerConfiguration& p)
10862 j = nlohmann::json{
10864 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
10865 TOJSON_IMPL(lingoConfigurationFileName),
10866 TOJSON_IMPL(lingoConfigurationFileCommand),
10867 TOJSON_IMPL(lingoConfigurationFileCheckSecs),
10868 TOJSON_IMPL(statusReport),
10869 TOJSON_IMPL(externalHealthCheckResponder),
10870 TOJSON_IMPL(internals),
10871 TOJSON_IMPL(certStoreFileName),
10872 TOJSON_IMPL(certStorePasswordHex),
10873 TOJSON_IMPL(enginePolicy),
10874 TOJSON_IMPL(configurationCheckSignalName),
10875 TOJSON_IMPL(fipsCrypto),
10876 TOJSON_IMPL(proxy),
10880 static void from_json(
const nlohmann::json& j, LingoServerConfiguration& p)
10883 getOptional<std::string>(
"id", p.id, j);
10884 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
10885 getOptional<std::string>(
"lingoConfigurationFileName", p.lingoConfigurationFileName, j);
10886 getOptional<std::string>(
"lingoConfigurationFileCommand", p.lingoConfigurationFileCommand, j);
10887 getOptional<int>(
"lingoConfigurationFileCheckSecs", p.lingoConfigurationFileCheckSecs, j, 60);
10888 getOptional<LingoServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
10889 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
10890 getOptional<LingoServerInternals>(
"internals", p.internals, j);
10891 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
10892 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
10893 j.at(
"enginePolicy").get_to(p.enginePolicy);
10894 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.22f4ec3.${id}");
10895 getOptional<FipsCryptoSettings>(
"fipsCrypo", p.fipsCrypto, j);
10896 getOptional<NetworkAddress>(
"proxy", p.proxy, j);
10897 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
10902 JSON_SERIALIZED_CLASS(VoiceToVoiceSession)
10914 IMPLEMENT_JSON_SERIALIZATION()
10944 static void to_json(nlohmann::json& j,
const VoiceToVoiceSession& p)
10946 j = nlohmann::json{
10949 TOJSON_IMPL(groups),
10950 TOJSON_IMPL(enabled)
10953 static void from_json(
const nlohmann::json& j, VoiceToVoiceSession& p)
10956 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
10957 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
10958 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
10959 FROMJSON_IMPL(enabled,
bool,
true);
10963 JSON_SERIALIZED_CLASS(LingoConfiguration)
10975 IMPLEMENT_JSON_SERIALIZATION()
10992 voiceToVoiceSessions.clear();
10997 static void to_json(nlohmann::json& j,
const LingoConfiguration& p)
10999 j = nlohmann::json{
11000 TOJSON_IMPL(voiceToVoiceSessions),
11001 TOJSON_IMPL(groups)
11004 static void from_json(
const nlohmann::json& j, LingoConfiguration& p)
11007 getOptional<std::vector<VoiceToVoiceSession>>(
"voiceToVoiceSessions", p.voiceToVoiceSessions, j);
11008 getOptional<std::vector<Group>>(
"groups", p.groups, j);
11012 JSON_SERIALIZED_CLASS(BridgingConfiguration)
11024 IMPLEMENT_JSON_SERIALIZATION()
11046 static void to_json(nlohmann::json& j,
const BridgingConfiguration& p)
11048 j = nlohmann::json{
11049 TOJSON_IMPL(bridges),
11050 TOJSON_IMPL(groups)
11053 static void from_json(
const nlohmann::json& j, BridgingConfiguration& p)
11056 getOptional<std::vector<Bridge>>(
"bridges", p.bridges, j);
11057 getOptional<std::vector<Group>>(
"groups", p.groups, j);
11061 JSON_SERIALIZED_CLASS(BridgingServerStatusReportConfiguration)
11073 IMPLEMENT_JSON_SERIALIZATION()
11108 includeGroupDetail =
false;
11109 includeBridgeDetail =
false;
11110 includeBridgeGroupDetail =
false;
11115 static void to_json(nlohmann::json& j,
const BridgingServerStatusReportConfiguration& p)
11117 j = nlohmann::json{
11118 TOJSON_IMPL(fileName),
11119 TOJSON_IMPL(intervalSecs),
11120 TOJSON_IMPL(enabled),
11121 TOJSON_IMPL(includeGroupDetail),
11122 TOJSON_IMPL(includeBridgeDetail),
11123 TOJSON_IMPL(includeBridgeGroupDetail),
11124 TOJSON_IMPL(runCmd)
11127 static void from_json(
const nlohmann::json& j, BridgingServerStatusReportConfiguration& p)
11130 getOptional<std::string>(
"fileName", p.fileName, j);
11131 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
11132 getOptional<bool>(
"enabled", p.enabled, j,
false);
11133 getOptional<std::string>(
"runCmd", p.runCmd, j);
11134 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
11135 getOptional<bool>(
"includeBridgeDetail", p.includeBridgeDetail, j,
false);
11136 getOptional<bool>(
"includeBridgeGroupDetail", p.includeBridgeGroupDetail, j,
false);
11140 JSON_SERIALIZED_CLASS(BridgingServerInternals)
11154 IMPLEMENT_JSON_SERIALIZATION()
11176 housekeeperIntervalMs = 1000;
11180 static void to_json(nlohmann::json& j,
const BridgingServerInternals& p)
11182 j = nlohmann::json{
11183 TOJSON_IMPL(watchdog),
11184 TOJSON_IMPL(housekeeperIntervalMs),
11185 TOJSON_IMPL(tuning)
11188 static void from_json(
const nlohmann::json& j, BridgingServerInternals& p)
11191 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
11192 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
11193 getOptional<TuningSettings>(
"tuning", p.tuning, j);
11197 JSON_SERIALIZED_CLASS(BridgingServerConfiguration)
11208 IMPLEMENT_JSON_SERIALIZATION()
11219 omPayloadTransformation = 1,
11222 omAnonymousMixing = 2,
11225 omLanguageTranslation = 3
11282 serviceConfigurationFileCheckSecs = 60;
11283 bridgingConfigurationFileName.clear();
11284 bridgingConfigurationFileCommand.clear();
11285 bridgingConfigurationFileCheckSecs = 60;
11286 statusReport.clear();
11287 externalHealthCheckResponder.clear();
11289 certStoreFileName.clear();
11290 certStorePasswordHex.clear();
11291 enginePolicy.clear();
11292 configurationCheckSignalName =
"rts.6cc0651.${id}";
11293 fipsCrypto.clear();
11298 static void to_json(nlohmann::json& j,
const BridgingServerConfiguration& p)
11300 j = nlohmann::json{
11303 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
11304 TOJSON_IMPL(bridgingConfigurationFileName),
11305 TOJSON_IMPL(bridgingConfigurationFileCommand),
11306 TOJSON_IMPL(bridgingConfigurationFileCheckSecs),
11307 TOJSON_IMPL(statusReport),
11308 TOJSON_IMPL(externalHealthCheckResponder),
11309 TOJSON_IMPL(internals),
11310 TOJSON_IMPL(certStoreFileName),
11311 TOJSON_IMPL(certStorePasswordHex),
11312 TOJSON_IMPL(enginePolicy),
11313 TOJSON_IMPL(configurationCheckSignalName),
11314 TOJSON_IMPL(fipsCrypto),
11318 static void from_json(
const nlohmann::json& j, BridgingServerConfiguration& p)
11321 getOptional<std::string>(
"id", p.id, j);
11322 getOptional<BridgingServerConfiguration::OpMode_t>(
"mode", p.mode, j, BridgingServerConfiguration::OpMode_t::omRaw);
11323 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
11324 getOptional<std::string>(
"bridgingConfigurationFileName", p.bridgingConfigurationFileName, j);
11325 getOptional<std::string>(
"bridgingConfigurationFileCommand", p.bridgingConfigurationFileCommand, j);
11326 getOptional<int>(
"bridgingConfigurationFileCheckSecs", p.bridgingConfigurationFileCheckSecs, j, 60);
11327 getOptional<BridgingServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
11328 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
11329 getOptional<BridgingServerInternals>(
"internals", p.internals, j);
11330 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
11331 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
11332 j.at(
"enginePolicy").get_to(p.enginePolicy);
11333 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.6cc0651.${id}");
11334 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
11335 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
11340 JSON_SERIALIZED_CLASS(EarGroupsConfiguration)
11352 IMPLEMENT_JSON_SERIALIZATION()
11370 static void to_json(nlohmann::json& j,
const EarGroupsConfiguration& p)
11372 j = nlohmann::json{
11373 TOJSON_IMPL(groups)
11376 static void from_json(
const nlohmann::json& j, EarGroupsConfiguration& p)
11379 getOptional<std::vector<Group>>(
"groups", p.groups, j);
11383 JSON_SERIALIZED_CLASS(EarServerStatusReportConfiguration)
11395 IMPLEMENT_JSON_SERIALIZATION()
11424 includeGroupDetail =
false;
11429 static void to_json(nlohmann::json& j,
const EarServerStatusReportConfiguration& p)
11431 j = nlohmann::json{
11432 TOJSON_IMPL(fileName),
11433 TOJSON_IMPL(intervalSecs),
11434 TOJSON_IMPL(enabled),
11435 TOJSON_IMPL(includeGroupDetail),
11436 TOJSON_IMPL(runCmd)
11439 static void from_json(
const nlohmann::json& j, EarServerStatusReportConfiguration& p)
11442 getOptional<std::string>(
"fileName", p.fileName, j);
11443 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
11444 getOptional<bool>(
"enabled", p.enabled, j,
false);
11445 getOptional<std::string>(
"runCmd", p.runCmd, j);
11446 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
11450 JSON_SERIALIZED_CLASS(EarServerInternals)
11464 IMPLEMENT_JSON_SERIALIZATION()
11486 housekeeperIntervalMs = 1000;
11490 static void to_json(nlohmann::json& j,
const EarServerInternals& p)
11492 j = nlohmann::json{
11493 TOJSON_IMPL(watchdog),
11494 TOJSON_IMPL(housekeeperIntervalMs),
11495 TOJSON_IMPL(tuning)
11498 static void from_json(
const nlohmann::json& j, EarServerInternals& p)
11501 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
11502 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
11503 getOptional<TuningSettings>(
"tuning", p.tuning, j);
11507 JSON_SERIALIZED_CLASS(EarServerConfiguration)
11518 IMPLEMENT_JSON_SERIALIZATION()
11573 serviceConfigurationFileCheckSecs = 60;
11574 groupsConfigurationFileName.clear();
11575 groupsConfigurationFileCommand.clear();
11576 groupsConfigurationFileCheckSecs = 60;
11577 statusReport.clear();
11578 externalHealthCheckResponder.clear();
11580 certStoreFileName.clear();
11581 certStorePasswordHex.clear();
11582 enginePolicy.clear();
11583 configurationCheckSignalName =
"rts.9a164fa.${id}";
11584 fipsCrypto.clear();
11589 static void to_json(nlohmann::json& j,
const EarServerConfiguration& p)
11591 j = nlohmann::json{
11593 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
11594 TOJSON_IMPL(groupsConfigurationFileName),
11595 TOJSON_IMPL(groupsConfigurationFileCommand),
11596 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
11597 TOJSON_IMPL(statusReport),
11598 TOJSON_IMPL(externalHealthCheckResponder),
11599 TOJSON_IMPL(internals),
11600 TOJSON_IMPL(certStoreFileName),
11601 TOJSON_IMPL(certStorePasswordHex),
11602 TOJSON_IMPL(enginePolicy),
11603 TOJSON_IMPL(configurationCheckSignalName),
11604 TOJSON_IMPL(fipsCrypto),
11608 static void from_json(
const nlohmann::json& j, EarServerConfiguration& p)
11611 getOptional<std::string>(
"id", p.id, j);
11612 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
11613 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
11614 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
11615 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
11616 getOptional<EarServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
11617 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
11618 getOptional<EarServerInternals>(
"internals", p.internals, j);
11619 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
11620 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
11621 j.at(
"enginePolicy").get_to(p.enginePolicy);
11622 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
11623 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
11624 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
11628 JSON_SERIALIZED_CLASS(EngageSemGroupsConfiguration)
11640 IMPLEMENT_JSON_SERIALIZATION()
11658 static void to_json(nlohmann::json& j,
const EngageSemGroupsConfiguration& p)
11660 j = nlohmann::json{
11661 TOJSON_IMPL(groups)
11664 static void from_json(
const nlohmann::json& j, EngageSemGroupsConfiguration& p)
11667 getOptional<std::vector<Group>>(
"groups", p.groups, j);
11671 JSON_SERIALIZED_CLASS(EngageSemServerStatusReportConfiguration)
11683 IMPLEMENT_JSON_SERIALIZATION()
11712 includeGroupDetail =
false;
11717 static void to_json(nlohmann::json& j,
const EngageSemServerStatusReportConfiguration& p)
11719 j = nlohmann::json{
11720 TOJSON_IMPL(fileName),
11721 TOJSON_IMPL(intervalSecs),
11722 TOJSON_IMPL(enabled),
11723 TOJSON_IMPL(includeGroupDetail),
11724 TOJSON_IMPL(runCmd)
11727 static void from_json(
const nlohmann::json& j, EngageSemServerStatusReportConfiguration& p)
11730 getOptional<std::string>(
"fileName", p.fileName, j);
11731 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
11732 getOptional<bool>(
"enabled", p.enabled, j,
false);
11733 getOptional<std::string>(
"runCmd", p.runCmd, j);
11734 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
11738 JSON_SERIALIZED_CLASS(EngageSemServerInternals)
11752 IMPLEMENT_JSON_SERIALIZATION()
11774 housekeeperIntervalMs = 1000;
11778 static void to_json(nlohmann::json& j,
const EngageSemServerInternals& p)
11780 j = nlohmann::json{
11781 TOJSON_IMPL(watchdog),
11782 TOJSON_IMPL(housekeeperIntervalMs),
11783 TOJSON_IMPL(tuning)
11786 static void from_json(
const nlohmann::json& j, EngageSemServerInternals& p)
11789 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
11790 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
11791 getOptional<TuningSettings>(
"tuning", p.tuning, j);
11795 JSON_SERIALIZED_CLASS(EngageSemServerConfiguration)
11806 IMPLEMENT_JSON_SERIALIZATION()
11867 serviceConfigurationFileCheckSecs = 60;
11868 groupsConfigurationFileName.clear();
11869 groupsConfigurationFileCommand.clear();
11870 groupsConfigurationFileCheckSecs = 60;
11871 statusReport.clear();
11872 externalHealthCheckResponder.clear();
11874 certStoreFileName.clear();
11875 certStorePasswordHex.clear();
11876 enginePolicy.clear();
11877 configurationCheckSignalName =
"rts.9a164fa.${id}";
11878 fipsCrypto.clear();
11883 maxQueuingMs = 15000;
11889 static void to_json(nlohmann::json& j,
const EngageSemServerConfiguration& p)
11891 j = nlohmann::json{
11893 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
11894 TOJSON_IMPL(groupsConfigurationFileName),
11895 TOJSON_IMPL(groupsConfigurationFileCommand),
11896 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
11897 TOJSON_IMPL(statusReport),
11898 TOJSON_IMPL(externalHealthCheckResponder),
11899 TOJSON_IMPL(internals),
11900 TOJSON_IMPL(certStoreFileName),
11901 TOJSON_IMPL(certStorePasswordHex),
11902 TOJSON_IMPL(enginePolicy),
11903 TOJSON_IMPL(configurationCheckSignalName),
11904 TOJSON_IMPL(fipsCrypto),
11906 TOJSON_IMPL(maxQueueLen),
11907 TOJSON_IMPL(minQueuingMs),
11908 TOJSON_IMPL(maxQueuingMs),
11909 TOJSON_IMPL(minPriority),
11910 TOJSON_IMPL(maxPriority)
11913 static void from_json(
const nlohmann::json& j, EngageSemServerConfiguration& p)
11916 getOptional<std::string>(
"id", p.id, j);
11917 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
11918 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
11919 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
11920 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
11921 getOptional<EngageSemServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
11922 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
11923 getOptional<EngageSemServerInternals>(
"internals", p.internals, j);
11924 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
11925 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
11926 j.at(
"enginePolicy").get_to(p.enginePolicy);
11927 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
11928 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
11929 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
11930 getOptional<int>(
"maxQueueLen", p.maxQueueLen, j, 64);
11931 getOptional<int>(
"minQueuingMs", p.minQueuingMs, j, 0);
11932 getOptional<int>(
"maxQueuingMs", p.maxQueuingMs, j, 15000);
11933 getOptional<int>(
"minPriority", p.minPriority, j, 0);
11934 getOptional<int>(
"maxPriority", p.maxPriority, j, 255);
11938 JSON_SERIALIZED_CLASS(EngateGroup)
11950 IMPLEMENT_JSON_SERIALIZATION()
11955 uint32_t inputHangMs;
11956 uint32_t inputActivationPowerThreshold;
11957 uint32_t inputDeactivationPowerThreshold;
11969 inputActivationPowerThreshold = 700;
11970 inputDeactivationPowerThreshold = 125;
11974 static void to_json(nlohmann::json& j,
const EngateGroup& p)
11977 to_json(g,
static_cast<const Group&
>(p));
11979 j = nlohmann::json{
11980 TOJSON_IMPL(useVad),
11981 TOJSON_IMPL(inputHangMs),
11982 TOJSON_IMPL(inputActivationPowerThreshold),
11983 TOJSON_IMPL(inputDeactivationPowerThreshold)
11986 static void from_json(
const nlohmann::json& j, EngateGroup& p)
11989 from_json(j,
static_cast<Group&
>(p));
11990 getOptional<uint32_t>(
"inputHangMs", p.inputHangMs, j, 750);
11991 getOptional<uint32_t>(
"inputActivationPowerThreshold", p.inputActivationPowerThreshold, j, 700);
11992 getOptional<uint32_t>(
"inputDeactivationPowerThreshold", p.inputDeactivationPowerThreshold, j, 125);
11996 JSON_SERIALIZED_CLASS(EngateGroupsConfiguration)
12008 IMPLEMENT_JSON_SERIALIZATION()
12026 static void to_json(nlohmann::json& j,
const EngateGroupsConfiguration& p)
12028 j = nlohmann::json{
12029 TOJSON_IMPL(groups)
12032 static void from_json(
const nlohmann::json& j, EngateGroupsConfiguration& p)
12035 getOptional<std::vector<EngateGroup>>(
"groups", p.groups, j);
12039 JSON_SERIALIZED_CLASS(EngateServerStatusReportConfiguration)
12051 IMPLEMENT_JSON_SERIALIZATION()
12080 includeGroupDetail =
false;
12085 static void to_json(nlohmann::json& j,
const EngateServerStatusReportConfiguration& p)
12087 j = nlohmann::json{
12088 TOJSON_IMPL(fileName),
12089 TOJSON_IMPL(intervalSecs),
12090 TOJSON_IMPL(enabled),
12091 TOJSON_IMPL(includeGroupDetail),
12092 TOJSON_IMPL(runCmd)
12095 static void from_json(
const nlohmann::json& j, EngateServerStatusReportConfiguration& p)
12098 getOptional<std::string>(
"fileName", p.fileName, j);
12099 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
12100 getOptional<bool>(
"enabled", p.enabled, j,
false);
12101 getOptional<std::string>(
"runCmd", p.runCmd, j);
12102 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
12106 JSON_SERIALIZED_CLASS(EngateServerInternals)
12120 IMPLEMENT_JSON_SERIALIZATION()
12142 housekeeperIntervalMs = 1000;
12146 static void to_json(nlohmann::json& j,
const EngateServerInternals& p)
12148 j = nlohmann::json{
12149 TOJSON_IMPL(watchdog),
12150 TOJSON_IMPL(housekeeperIntervalMs),
12151 TOJSON_IMPL(tuning)
12154 static void from_json(
const nlohmann::json& j, EngateServerInternals& p)
12157 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
12158 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12159 getOptional<TuningSettings>(
"tuning", p.tuning, j);
12163 JSON_SERIALIZED_CLASS(EngateServerConfiguration)
12174 IMPLEMENT_JSON_SERIALIZATION()
12229 serviceConfigurationFileCheckSecs = 60;
12230 groupsConfigurationFileName.clear();
12231 groupsConfigurationFileCommand.clear();
12232 groupsConfigurationFileCheckSecs = 60;
12233 statusReport.clear();
12234 externalHealthCheckResponder.clear();
12236 certStoreFileName.clear();
12237 certStorePasswordHex.clear();
12238 enginePolicy.clear();
12239 configurationCheckSignalName =
"rts.9a164fa.${id}";
12240 fipsCrypto.clear();
12245 static void to_json(nlohmann::json& j,
const EngateServerConfiguration& p)
12247 j = nlohmann::json{
12249 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12250 TOJSON_IMPL(groupsConfigurationFileName),
12251 TOJSON_IMPL(groupsConfigurationFileCommand),
12252 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
12253 TOJSON_IMPL(statusReport),
12254 TOJSON_IMPL(externalHealthCheckResponder),
12255 TOJSON_IMPL(internals),
12256 TOJSON_IMPL(certStoreFileName),
12257 TOJSON_IMPL(certStorePasswordHex),
12258 TOJSON_IMPL(enginePolicy),
12259 TOJSON_IMPL(configurationCheckSignalName),
12260 TOJSON_IMPL(fipsCrypto),
12264 static void from_json(
const nlohmann::json& j, EngateServerConfiguration& p)
12267 getOptional<std::string>(
"id", p.id, j);
12268 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12269 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
12270 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
12271 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
12272 getOptional<EngateServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
12273 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12274 getOptional<EngateServerInternals>(
"internals", p.internals, j);
12275 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
12276 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
12277 j.at(
"enginePolicy").get_to(p.enginePolicy);
12278 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
12279 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
12280 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
12284 static inline void dumpExampleConfigurations(
const char *path)
12286 WatchdogSettings::document();
12287 FileRecordingRequest::document();
12288 Feature::document();
12289 Featureset::document();
12291 RtpPayloadTypeTranslation::document();
12292 NetworkInterfaceDevice::document();
12293 ListOfNetworkInterfaceDevice::document();
12294 RtpHeader::document();
12295 BlobInfo::document();
12296 TxAudioUri::document();
12297 AdvancedTxParams::document();
12298 Identity::document();
12299 Location::document();
12301 Connectivity::document();
12302 PresenceDescriptorGroupItem::document();
12303 PresenceDescriptor::document();
12304 NetworkTxOptions::document();
12305 TcpNetworkTxOptions::document();
12306 NetworkAddress::document();
12307 NetworkAddressRxTx::document();
12308 NetworkAddressRestrictionList::document();
12309 StringRestrictionList::document();
12310 Rallypoint::document();
12311 RallypointCluster::document();
12312 NetworkDeviceDescriptor::document();
12313 TxAudio::document();
12314 AudioDeviceDescriptor::document();
12315 ListOfAudioDeviceDescriptor::document();
12317 TalkerInformation::document();
12318 GroupTalkers::document();
12319 Presence::document();
12320 Advertising::document();
12321 GroupPriorityTranslation::document();
12322 GroupTimeline::document();
12323 GroupAppTransport::document();
12324 RtpProfile::document();
12326 Mission::document();
12327 LicenseDescriptor::document();
12328 EngineNetworkingRpUdpStreaming::document();
12329 EnginePolicyNetworking::document();
12332 Bridge::document();
12333 AndroidAudio::document();
12334 EnginePolicyAudio::document();
12335 SecurityCertificate::document();
12336 EnginePolicySecurity::document();
12337 EnginePolicyLogging::document();
12338 EnginePolicyDatabase::document();
12339 NamedAudioDevice::document();
12340 EnginePolicyNamedAudioDevices::document();
12341 Licensing::document();
12342 DiscoveryMagellan::document();
12343 DiscoverySsdp::document();
12344 DiscoverySap::document();
12345 DiscoveryCistech::document();
12346 DiscoveryTrellisware::document();
12347 DiscoveryConfiguration::document();
12348 EnginePolicyInternals::document();
12349 EnginePolicyTimelines::document();
12350 RtpMapEntry::document();
12351 ExternalModule::document();
12352 ExternalCodecDescriptor::document();
12353 EnginePolicy::document();
12354 TalkgroupAsset::document();
12355 EngageDiscoveredGroup::document();
12356 RallypointPeer::document();
12357 RallypointServerLimits::document();
12358 RallypointServerStatusReportConfiguration::document();
12359 RallypointServerLinkGraph::document();
12360 ExternalHealthCheckResponder::document();
12362 PeeringConfiguration::document();
12363 IgmpSnooping::document();
12364 RallypointReflector::document();
12365 RallypointUdpStreaming::document();
12366 RallypointServer::document();
12367 PlatformDiscoveredService::document();
12368 TimelineQueryParameters::document();
12369 CertStoreCertificate::document();
12370 CertStore::document();
12371 CertStoreCertificateElement::document();
12372 CertStoreDescriptor::document();
12373 CertificateDescriptor::document();
12374 BridgeCreationDetail::document();
12375 GroupConnectionDetail::document();
12376 GroupTxDetail::document();
12377 GroupCreationDetail::document();
12378 GroupReconfigurationDetail::document();
12379 GroupHealthReport::document();
12380 InboundProcessorStats::document();
12381 TrafficCounter::document();
12382 GroupStats::document();
12383 RallypointConnectionDetail::document();
12384 BridgingConfiguration::document();
12385 BridgingServerStatusReportConfiguration::document();
12386 BridgingServerInternals::document();
12387 BridgingServerConfiguration::document();
12388 EarGroupsConfiguration::document();
12389 EarServerStatusReportConfiguration::document();
12390 EarServerInternals::document();
12391 EarServerConfiguration::document();
12392 RangerPackets::document();
12393 TransportImpairment::document();
12395 EngageSemGroupsConfiguration::document();
12396 EngageSemServerStatusReportConfiguration::document();
12397 EngageSemServerInternals::document();
12398 EngageSemServerConfiguration::document();
12403 #pragma GCC diagnostic pop
TxPriority_t
Network Transmission Priority.
@ priBestEffort
best effort
AddressResolutionPolicy_t
Address family resolution policy.
@ arpIpv6ThenIpv4
IPv6 then IPv4.
@ arpIpv4ThenIpv6
IPv4 then IPv6.
#define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING
RestrictionElementType_t
Enum describing restriction element types.
@ retGenericAccessTagPattern
Elements are generic access tags regex patterns.
@ retGroupIdPattern
Elements are group ID regex patterns.
@ retGroupId
A literal group ID.
@ retCertificateIssuerPattern
Elements are X.509 certificate issuer regex patterns.
@ retCertificateSubjectPattern
Elements are X.509 certificate subject regex patterns.
@ retCertificateFingerprintPattern
Elements are X.509 certificate fingerprint regex patterns.
@ retCertificateSerialNumberPattern
Elements are X.509 certificate serial number regex patterns.
GroupRestrictionAccessPolicyType_t
Enum describing restriction types.
@ graptStrict
Registration for groups is NOT allowed by default - requires definitive access through something like...
@ graptPermissive
Registration for groups is allowed by default.
RestrictionType_t
Enum describing restriction types.
@ rtWhitelist
Elements are whitelisted.
@ rtBlacklist
Elements are blacklisted.
Configuration when using the engageBeginGroupTxAdvanced API.
TxAudioUri audioUri
[Optional] A URI to stream from instead of the audio input device
uint8_t priority
[Optional, Default: 0] Transmit priority between 0 (lowest) and 255 (highest).
bool receiverRxMuteForAliasSpecializer
[Optional, Default: false] Indicates that the aliasSpecializer must cause receivers to mute this tran...
uint16_t subchannelTag
[Optional, Default: 0] Defines a sub channel within a group. Audio will be opaque to all other client...
uint16_t aliasSpecializer
[Optional, Default: 0] Defines a numeric affinity value to be included in the transmission....
uint16_t flags
[Optional, Default: 0] Combination of the ENGAGE_TXFLAG_xxx flags
std::string alias
[Optional, Default: empty string] The Engage Engine should transmit the user's alias as part of the h...
bool includeNodeId
[Optional, Default: false] The Engage Engine should transmit the NodeId as part of the header extensi...
uint32_t txId
[Optional, Default: 0] Transmission ID
bool muted
[Optional, Default: false] While the microphone should be opened, captured audio should be ignored un...
Defines parameters for advertising of an entity such as a known, public, group.
int intervalMs
[Optional, Default: 20000] Interval at which the advertisement should be sent in milliseconds.
bool enabled
[Optional, Default: false] Enabled advertising
bool alwaysAdvertise
[Optional, Default: false] If true, the node will advertise the item even if it detects other nodes m...
Acoustic Echo Cancellation settings.
int speakerTailMs
[Optional, Default: 60] Milliseconds of speaker tail
bool cng
[Optional, Default: true] Enable comfort noise generation
bool enabled
[Optional, Default: false] Enable acoustic echo cancellation
Mode_t
Acoustic echo cancellation mode enum.
Mode_t mode
[Optional, Default: aecmDefault] Specifies AEC mode. See Mode_t for all modes
bool enabled
[Optional, Default: false] Enables automatic gain control.
int compressionGainDb
[Optional, Default: 25, Minimum = 0, Maximum = 125] Gain in db.
bool enableLimiter
[Optional, Default: false] Enables limiter to prevent overdrive.
int maxLevel
[Optional, Default: 255] Maximum level.
int minLevel
[Optional, Default: 0] Minimum level.
int targetLevelDb
[Optional, Default: 9] Target gain level if there is no compression gain.
Default audio settings for AndroidAudio.
int api
[Optional, Default 0] Android audio API version: 0=Unspecified, 1=AAudio, 2=OpenGLES
int sessionId
[Optional, Default INVALID_SESSION_ID] A session ID from the Android AudioManager
int contentType
[Optional, Default 1] Usage type: 1=Speech 2=Music 3=Movie 4=Sonification
int sharingMode
[Optional, Default 0] Sharing mode: 0=Exclusive, 1=Shared
int performanceMode
[Optional, Default 12] Performance mode: 10=None/Default, 11=PowerSaving, 12=LowLatency
int inputPreset
[Optional, Default 7] Input preset: 1=Generic 5=Camcorder 6=VoiceRecognition 7=VoiceCommunication 9=U...
int usage
[Optional, Default 2] Usage type: 1=Media 2=VoiceCommunication 3=VoiceCommunicationSignalling 4=Alarm...
int engineMode
[Optional, Default 0] 0=use legacy low-level APIs, 1=use high-level Android APIs
Custom Audio Device Configuration.
std::string type
Device type (if any)
int samplingRate
This is the rate that the device will process the PCM audio data at.
std::string name
Name of the device assigned by the platform.
bool isDefault
True if this is the default device for the direction above.
std::string serialNumber
Device serial number (if any)
int channels
Indicates the number of audio channels to process.
std::string hardwareId
Device hardware ID (if any)
std::string manufacturer
Device manufacturer (if any)
Direction_t
Audio Device Direction Enum.
@ dirOutput
This is an output only device.
@ dirInput
This is an input only device.
std::string model
Device mode (if any)
Direction_t direction
Audio direction the device supports.
std::string extra
Extra data provided by the platform (if any)
bool isPresent
True if the device is currently present on the system.
int boostPercentage
A percentage at which to gain/attenuate the audio.
bool isAdad
True if the device is an Application-Defined Audio Device.
int deviceId
[Read Only] Unique device identifier assigned by Engage Engine at time of device creation.
Description of an audio gate.
double coefficient
[Optional. Default: 1.75] Coefficient by which to multiply the current history average to determine t...
uint32_t hangMs
[Optional. Default: 1500] Hang timer in milliseconds
bool enabled
[Optional. Default: false] Enables the audio gate if true
uint32_t windowMin
[Optional. Default: 25] Number of 10ms history samples to gather before calculating the noise floor -...
bool useVad
[Optional. Default: false] Use voice activity detection rather than audio energy
uint32_t windowMax
[Optional. Default: 125] Maximum number of 10ms history samples - ignored if useVad is true
Used to configure the Audio properties for a group.
int outputLevelRight
[Optional, Default: 100] The percentage at which to set the right audio at.
bool outputMuted
[Optional, Default: false] Mutes output audio.
bool enabled
[Optional, Default: true] Audio is enabled
int inputId
[Optional, Default: first audio device] Id for the input audio device to use for this group.
int outputGain
[Optional, Default: 0] The percentage at which to gain the output audio.
int outputId
[Optional, Default: first audio device] Id for the output audio device to use for this group.
int inputGain
[Optional, Default: 0] The percentage at which to gain the input audio.
int outputLevelLeft
[Optional, Default: 100] The percentage at which to set the left audio at.
Describes the Blob data being sent used in the engageSendGroupBlob API.
size_t size
[Optional, Default : 0] Size of the payload
RtpHeader rtpHeader
Custom RTP header.
PayloadType_t payloadType
[Optional, Default: bptUndefined] The payload type to send in the blob
std::string target
[Optional, Default: empty string] The nodeId to which this message is targeted. If this is empty,...
std::string source
[Optional, Default: empty string] The nodeId of Engage Engine that sent the message....
int txnTimeoutSecs
[Optional, Default: 0] Number of seconds after which to time out delivery to the target node
PayloadType_t
Payload type. BlobInfo RTP supported Payload types.
std::string txnId
[Optional but required if txnTimeoutSecs is > 0]
Detailed information for a bridge creation.
CreationStatus_t
Creation status.
CreationStatus_t status
The creation status.
std::string id
ID of the bridge.
Bridging session settings.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the bridge
std::vector< Group > groups
Array of bridges in the configuration.
std::vector< Bridge > bridges
Array of bridges in the configuration.
Configuration for the bridging server.
std::string certStoreFileName
Path to the certificate store.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
OpMode_t mode
Specifies the operation mode (see OpMode_t).
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
BridgingServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string bridgingConfigurationFileCommand
Command-line to execute that returns a bridging configuration.
std::string bridgingConfigurationFileName
Name of a file containing the bridging configuration.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
OpMode_t
Enum describing the modes the briging service runs in.
BridgingServerInternals internals
Internal settings.
int bridgingConfigurationFileCheckSecs
Number of seconds between checks to see if the bridging configuration has been updated....
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string id
A unqiue identifier for the bridge server.
NsmConfiguration nsm
[Optional] Settings for NSM.
Internal bridging server settings.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
TuningSettings tuning
[Optional] Low-level tuning
WatchdogSettings watchdog
[Optional] Settings for the watchdog.
TODO: Configuration for the bridging server status report file.
bool includeBridgeGroupDetail
Description of a certstore certificate element.
std::string tags
Additional attributes.
bool hasPrivateKey
True if the certificate has a private key associated with it.
std::string certificatePem
PEM of the certificate.
Holds a certificate and (optionally) a private key in a certstore.
std::string tags
Additional tags.
std::string id
Id of the certificate.
std::string certificatePem
Certificate in PEM format.
void * internalData
Unserialized internal data.
std::string privateKeyPem
Private key in PEM format.
Description of a certstore.
std::string id
Certstore ID.
std::vector< CertStoreCertificateElement > certificates
Array of certificate elements.
std::string fileName
Name of the file the certstore resides in.
int flags
Flags set for the certstore.
int version
Version of the certstore.
std::vector< KvPair > kvp
Array of kv pairs.
std::vector< KvPair > kvp
[Optional] Array of KV pairs
std::vector< CertStoreCertificate > certificates
Array of certificates in this store.
std::string id
The ID of the certstore.
Description of a certificate.
std::vector< CertificateSubjectElement > subjectElements
Array of subject elements.
std::string serial
Serial #.
std::string publicKeyPem
PEM version of the public key.
bool selfSigned
Indicates whether the certificqte is self-signed.
std::string fingerprint
Fingerprint.
std::string notAfter
Validity date notAfter.
std::string subject
Subject.
std::string notBefore
Validity date notBefore.
std::string issuer
Issuer.
std::string certificatePem
PEM version of the certificate.
Description of a certificate subject element.
Connectivity Information used as part of the PresenceDescriptor.
int type
Is the type of connectivity the device has to the network.
int strength
Is the strength of the connection connection as reported by the OS - usually in dbm.
int rating
Is the quality of the network connection as reported by the OS - OS dependent.
Cistech Discovery settings.
Configuration for the Discovery features.
DiscoveryMagellan magellan
DiscoveryTrellisware trellisware
DiscoveryMagellan Discovery settings.
SecurityCertificate security
Tls tls
[Optional] Details concerning Transport Layer Security.
std::string interfaceName
[Optional, Default: default system interface] The network interface to bind to for discovery packets.
Session Announcement Discovery settings settings.
int ageTimeoutMs
[Optional, Default 30000] Number of milliseconds of no SAP announcment before the advertised entity i...
Advertising advertising
Parameters for advertising.
NetworkAddress address
[Optional, Default 224.2.127.254:9875] IP address and port.
bool enabled
[Optional, Default: false] Enables the Engage Engine to use SAP for asset discovery.
std::string interfaceName
[Optional, Default: default system interface] The network interface to bind to for discovery packets.
Simple Service Discovery Protocol settings.
bool enabled
[Optional, Default: false] Enables the Engage Engine to use SSDP for asset discovery.
std::vector< std::string > searchTerms
[Optional] An array of regex strings to be used to filter SSDP requests and responses.
int ageTimeoutMs
[Optional, Default 30000] Number of milliseconds of no SSDP announcment before the advertised entity ...
Advertising advertising
Parameters for advertising.
std::string interfaceName
[Optional, Default: default system interface] The network interface to bind to for discovery packets.
NetworkAddress address
[Optional, Default 255.255.255.255:1900] IP address and port.
Trellisware Discovery settings.
SecurityCertificate security
std::vector< Group > groups
Array of groups in the configuration.
Configuration for the ear server.
std::string id
A unqiue identifier for the EAR server.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NsmConfiguration nsm
[Optional] Settings for NSM.
EarServerInternals internals
Internal settings.
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
EarServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string certStoreFileName
Path to the certificate store.
std::string groupsConfigurationFileName
Name of a file containing the ear configuration.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
Internal ear server settings.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
WatchdogSettings watchdog
[Optional] Settings for the EAR's watchdog.
TuningSettings tuning
[Optional] Low-level tuning
TODO: Configuration for the ear server status report file.
NetworkAddress rx
Internal RX detail.
NetworkAddress tx
Internal TX detail.
std::string id
Internal ID.
Engage Semaphore configuration.
std::vector< Group > groups
Array of groups in the configuration.
Configuration for the EFC server.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EngageSemServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string id
A unqiue identifier for the EFC server.
std::string certStoreFileName
Path to the certificate store.
std::string groupsConfigurationFileName
Name of a file containing the EFC configuration.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
NsmConfiguration nsm
[Optional] Settings for NSM.
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
EngageSemServerInternals internals
Internal settings.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
Internal EFC server settings.
WatchdogSettings watchdog
[Optional] Settings for the EFC's watchdog.
TuningSettings tuning
[Optional] Low-level tuning
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
TODO: Configuration for the EFC server status report file.
std::vector< EngateGroup > groups
Array of groups in the configuration.
Configuration for the engate server.
EngateServerStatusReportConfiguration statusReport
Details for producing a status report.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string groupsConfigurationFileName
Name of a file containing the ear configuration.
EngateServerInternals internals
Internal settings.
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string certStoreFileName
Path to the certificate store.
NsmConfiguration nsm
[Optional] Settings for NSM.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string id
A unqiue identifier for the EAR server.
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
Internal engate server settings.
TuningSettings tuning
[Optional] Low-level tuning
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
WatchdogSettings watchdog
[Optional] Settings for the EAR's watchdog.
TODO: Configuration for the engate server status report file.
Configuration for RP UDP streaming.
TxPriority_t priority
[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based...
int keepaliveIntervalSecs
Optional, Default: 15] Seconds interval at which to send UDP keepalives to Rallypoints....
int ttl
[Optional, Default: 64] Time to live or hop limit is a mechanism that limits the lifespan or lifetime...
int port
[Optional, 0] The port to be used for Rallypoint UDP streaming. A value of 0 will result in an epheme...
bool enabled
[Optional, false] Enables UDP streaming if the RP supports it
Default audio settings for Engage Engine policy.
Vad vad
[Optional] Voice activity detection settings
Agc outputAgc
[Optional] Automatic Gain Control for audio outputs
bool saveOutputPcm
[Optional, Default: false] If true, input audio is written to a PCM file in the data directory
bool enabled
[Optional, Default: true] Enables audio processing
AndroidAudio android
[Optional] Android-specific audio settings
int internalRate
[Optional, Default: 16000] Internal sampling rate - 8000 or 16000
bool muteTxOnTx
[Optional, Default: false] Automatically mute TX when TX begins
Agc inputAgc
[Optional] Automatic Gain Control for audio inputs
bool hardwareEnabled
[Optional, Default: true] Enables local machine hardware audio
Aec aec
[Optional] Acoustic echo cancellation settings
bool denoiseInput
[Optional, Default: false] Denoise input
bool saveInputPcm
[Optional, Default: false] If true, input audio is written to a PCM file in the data directory
bool denoiseOutput
[Optional, Default: false] Denoise output
int internalChannels
[Optional, Default: 2] Internal audio channel count rate - 1 or 2
Provides Engage Engine policy configuration.
std::vector< ExternalModule > externalCodecs
Optional external codecs.
EnginePolicyNamedAudioDevices namedAudioDevices
Optional named audio devices (Linux only)
Featureset featureset
Optional feature set.
EnginePolicyDatabase database
Database settings.
EnginePolicyAudio audio
Audio settings.
std::string dataDirectory
Specifies the root of the physical path to store data.
Licensing licensing
Licensing settings.
EnginePolicyLogging logging
Logging settings.
DiscoveryConfiguration discovery
Discovery settings.
std::vector< RtpMapEntry > rtpMap
Optional RTP - overrides the default.
EngineStatusReportConfiguration statusReport
Optional statusReport - details for the status report.
EnginePolicyInternals internals
Internal settings.
EnginePolicySecurity security
Security settings.
EnginePolicyTimelines timelines
Timelines settings.
EnginePolicyNetworking networking
Security settings.
Internal Engage Engine settings.
TuningSettings tuning
[Optional] Low-level tuning
int stickyTidHangSecs
[Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.
int maxTxSecs
[Optional, Default: 30] The default duration the engageBeginGroupTx and engageBeginGroupTxAdvanced fu...
int rpConnectionTimeoutSecs
[Optional, Default: 5] Connection timeout in seconds to RP
WatchdogSettings watchdog
[Optional] Settings for the Engine's watchdog.
RallypointCluster::ConnectionStrategy_t rpClusterStrategy
[Optional, Default: csRoundRobin] Specifies the default RP cluster connection strategy to be followed...
int delayedMicrophoneClosureSecs
[Optional, Default: 15] The number of seconds to cache an open microphone before actually closing it.
int rtpExpirationCheckIntervalMs
[Optional, Default: 250] Interval at which to check for RTP expiration.
int rpClusterRolloverSecs
[Optional, Default: 10] Seconds between switching to a new target in a RP cluster
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
int uriStreamingIntervalMs
[Optional, Default: 60] The packet framing interval for audio streaming from a URI.
int maxLevel
[Optional, Default: 4, Range: 0-4] This is the maximum logging level to display in other words,...
EngineNetworkingRpUdpStreaming rpUdpStreaming
[Optional] Configuration for UDP streaming
std::string defaultNic
The default network interface card the Engage Engine should bind to.
RtpProfile rtpProfile
[Optional] Configuration for RTP profile
AddressResolutionPolicy_t addressResolutionPolicy
[Optional, Default 64] Address resolution policy
int multicastRejoinSecs
[Optional, Default: 8] Number of seconds elapsed between RX of multicast packets before an IGMP rejoi...
bool logRtpJitterBufferStats
[Optional, Default: false] If true, logs RTP jitter buffer statistics periodically
int rallypointRtTestIntervalMs
[Optional, Default: 60000] Milliseconds between sending Rallypoint round-trip test requests
bool preventMulticastFailover
[Optional, Default: false] Overrides/cancels group-level multicast failover if set to true
Default certificate to use for security operation in the Engage Engine.
SecurityCertificate certificate
The default certificate and private key for the Engine instance.
std::vector< std::string > caCertificates
[Optional] An array of CA certificates to be used for validation of far-end X.509 certificates
Engine Policy Timeline configuration.
long autosaveIntervalSecs
[Default 5] Interval at which events are to be saved from memory to disk (a slow operation)
int maxStorageMb
Specifies the maximum storage space to use.
bool enabled
[Optional, Default: true] Specifies if Time Lines are enabled by default.
int maxDiskMb
Specifies the maximum disk space to use - defaults to maxStorageMb.
SecurityCertificate security
The certificate to use for signing the recording.
int maxAudioEventMemMb
Specifies the maximum number of megabytes to allow for a single audio event's memory block - defaults...
long maxEventAgeSecs
Maximum age of an event after which it is to be erased.
int maxMemMb
Specifies the maximum memory to use - defaults to maxStorageMb.
std::string storageRoot
Specifies where the timeline recordings will be stored physically.
bool ephemeral
[Default false] If true, recordings are automatically purged when the Engine is shut down and/or rein...
bool disableSigningAndVerification
[Default false] If true, prevents signing of events - i.e. no anti-tanpering features will be availab...
int maxEvents
Maximum number of events to be retained.
long groomingIntervalSecs
Interval at which events are to be checked for age-based grooming.
TODO: Configuration for the translation server status report file.
bool includeTaskQueueDetail
Describes an external codec.
int samplingRate
Sampling rate.
int rtpPayloadType
RTP payload type.
int rtpTsMultiplier
RTP timestamp multiplier.
TODO: Configuration to enable external systems to use to check if the service is still running.
Base for a description of an external module.
std::string file
File spec.
nlohmann::json configuration
Optional free-form JSON configuration to be passed to the module.
bool debug
[Optional, Default false] If true, requests the crypto engine module to run in debugging mode.
bool enabled
[Optional, Default false] If true, requires FIPS140-2 crypto operation.
std::string curves
[Optional] Specifies the NIST-approved curves to be used for FIPS
std::string path
Path where the crypto engine module is located
std::string ciphers
[Optional] Specifies the NIST-approved ciphers to be used for FIPS
Configuration for the optional custom transport functionality for Group.
bool enabled
[Optional, Default: false] Enables custom feature.
std::string id
The id/name of the transport. This must match the id/name supplied when registering the app transport...
Detailed information for a group connection.
std::string id
ID of the group.
std::string peer
Peer information.
ConnectionType_t
Connection type.
bool asFailover
Indicates whether the connection is for purposes of failover.
ConnectionType_t connectionType
The connection type.
std::string reason
[Optional] Additional reason information
Detailed information for a group creation.
std::string id
ID of the group.
CreationStatus_t status
The creation status.
CreationStatus_t
Creation status.
Detailed information regarding a group's health.
GroupAppTransport appTransport
[Optional] Settings necessary if the group is transported via an application-supplied custom transpor...
std::string source
[Optional, Default: null] Indicates the source of this configuration - e.g. from the application or d...
Presence presence
Presence configuration (see Presence).
std::vector< uint16_t > specializerAffinities
List of specializer IDs that the local node has an affinity for/member of.
std::vector< Source > ignoreSources
[Optional] List of sources to ignore for this group
NetworkAddress rtcpPresenceRx
The network address for receiving RTCP presencing packets.
bool allowLoopback
[Optional, Default: false] Allows for processing of looped back packets - primarily meant for debuggi...
Type_t
Enum describing the group types.
NetworkAddress tx
The network address for transmitting network traffic to.
std::string alias
User alias to transmit as part of the realtime audio stream when using the engageBeginGroupTx API.
int stickyTidHangSecs
[Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.
TxAudio txAudio
Audio transmit options such as codec, framing size etc (see TxAudio).
int maxRxSecs
[Optional, Default: 0] Maximum number of seconds the Engine will receive for on this group.
PacketCapturer txCapture
Details for capture of transmitted packets
NetworkTxOptions txOptions
Transmit options for the group (see NetworkTxOptions).
std::string synVoice
Name of the synthesis voice to use for the group
TransportImpairment rxImpairment
[Optional] The RX impairment to apply
std::string languageCode
ISO 639-2 language code for the group
std::string cryptoPassword
Password to be used for encryption. Note that this is not the encryption key but, rather,...
std::vector< std::string > presenceGroupAffinities
List of presence group IDs with which this group has an affinity.
GroupTimeline timeline
Audio timeline is configuration.
GroupPriorityTranslation priorityTranslation
[Optional] Describe how traffic for this group on a different addressing scheme translates to priorit...
bool disablePacketEvents
[Optional, Default: false] Disable packet events.
bool blockAdvertising
[Optional, Default: false] Set this to true if you do not want the Engine to advertise this Group on ...
bool ignoreAudioTraffic
[Optional, Default: false] Indicates that the group should ignore traffic that is audio-related
std::string interfaceName
The name of the network interface to use for multicasting for this group. If not provided,...
bool _wasDeserialized_rtpProfile
[Internal - not serialized
bool enableMulticastFailover
[Optional, Default: false] Set this to true to enable failover to multicast operation if a Rallypoint...
std::string name
The human readable name for the group.
NetworkAddress rx
The network address for receiving network traffic on.
Type_t type
Specifies the group type (see Type_t).
uint16_t blobRtpPayloadType
[Optional, Default: ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE] The RTP payload type to be used for blobs s...
std::vector< Rallypoint > rallypoints
[DEPRECATED] List of Rallypoint (s) the Group should use to connect to a Rallypoint router....
BridgingOpMode_t bom
Specifies the bridging operation mode if applicable (see BridgingOpMode_t).
BridgingOpMode_t
Enum describing bridging operation mode types where applicable.
RtpProfile rtpProfile
[Optional] RTP profile the group
std::vector< RtpPayloadTypeTranslation > inboundRtpPayloadTypeTranslations
[Optional] A vector of translations from external entity RTP payload types to those used by Engage
int multicastFailoverSecs
[Optional, Default: 10] Specifies the number fo seconds to wait after Rallypoint connection failure t...
InboundAliasGenerationPolicy_t
Enum describing the alias generation policy.
RangerPackets rangerPackets
[Optional] Ranger packet options
int rfc4733RtpPayloadId
[Optional, Default: 0] The RTP payload ID by which to identify (RX and TX) payloads encoded according...
uint32_t securityLevel
[Optional, Default: 0] The security classification level of the group.
PacketCapturer rxCapture
Details for capture of received packets
std::string id
Unique identity for the group.
AudioGate gateIn
[Optional] Inbound gating of audio - only audio allowed through by the gate will be processed
RallypointCluster rallypointCluster
Cluster of one or more Rallypoints the group may use.
TransportImpairment txImpairment
[Optional] The TX impairment to apply
Audio audio
Sets audio properties like which audio device to use, audio gain etc (see Audio).
bool lbCrypto
[Optional, Default: false] Use low-bandwidth crypto
std::string spokenName
The group name as spoken - typically by a text-to-speech system
InboundAliasGenerationPolicy_t inboundAliasGenerationPolicy
[Optional, Default: iagpAnonymousAlias]
std::string anonymousAlias
[Optional] Alias to use for inbound streams that do not have an alias component
Details for priority transmission based on unique network addressing.
NetworkAddress tx
TX addressing.
int priority
Engage priority for RX & TX.
NetworkAddress rx
RX addressing.
Detailed information for a group reconfiguration.
ReconfigurationStatus_t status
The creation status.
std::string id
ID of the group.
ReconfigurationStatus_t
Reconfiguration status.
Detailed statistics for group.
List of TalkerInformation objects.
std::vector< TalkerInformation > list
List of TalkerInformation objects.
Configuration for Timeline functionality for Group.
bool enabled
[Optional, Default: true] Enables timeline feature.
int maxAudioTimeMs
[Optional, Default: 30000] Maximum audio block size to record in milliseconds.
Detailed information for a group transmit.
std::string id
ID of the group.
int remotePriority
Remote TX priority (optional)
long nonFdxMsHangRemaining
Milliseconds of hang time remaining on a non-FDX group (optional)
int localPriority
Local TX priority (optional)
uint32_t txId
Transmission ID (optional)
TxStatus_t status
The TX status.
std::string displayName
[Optional, Default: empty string] The display name to be used for the user.
std::string userId
[Optional, Default: empty string] The user ID to be used to represent the user.
std::string nodeId
[Optional, Default: Auto Generated] This is the Node ID to use to represent instance on the network.
std::string avatar
[Optional, Default: empty string] This is a application defined field used to indicate a users avatar...
Configuration for IGMP snooping.
int queryIntervalMs
[Optional, Default 125000] Interval between sending IGMP membership queries. If 0,...
int subscriptionTimeoutMs
[Optional, Default 0] Typically calculated according to RFC specifications. Set a value here to manua...
bool enabled
Enables IGMP. Default is false.
Detailed statistics for an inbound processor.
Helper class for serializing and deserializing the LicenseDescriptor JSON.
std::string entitlement
Entitlement key to use for the product.
std::string cargo
Reserved for internal use.
std::string manufacturerId
[Read only] Manufacturer ID.
std::string key
License Key to be used for the application.
uint8_t cargoFlags
Reserved for internal use.
int type
[Read only] 0 = unknown, 1 = perpetual, 2 = expires
std::string deviceId
[Read only] Unique device identifier generated by the Engine.
int status
The current licensing status.
time_t expires
[Read only] The time that the license key or activation code expires in Unix timestamp - Zulu/UTC.
std::string activationCode
If the key required activation, this is the activation code generated using the entitlement,...
std::string expiresFormatted
[Read only] The time that the license key or activation code expires formatted in ISO 8601 format,...
std::string deviceId
Device Identifier. See LicenseDescriptor::deviceId for details.
std::string manufacturerId
Manufacturer ID to use for the product. See LicenseDescriptor::manufacturerId for details.
std::string activationCode
Activation Code issued for the license key. See LicenseDescriptor::activationCode for details.
std::string key
License key. See LicenseDescriptor::key for details.
std::string entitlement
Entitlement key to use for the product. See LicenseDescriptor::entitlement for details.
std::vector< Group > groups
Array of groups in the configuration.
std::vector< VoiceToVoiceSession > voiceToVoiceSessions
Array of voiceToVoice sessions in the configuration.
Configuration for the linguistics server.
LingoServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string lingoConfigurationFileName
Name of a file containing the linguistics configuration.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
std::string id
A unqiue identifier for the linguistics server.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
NsmConfiguration nsm
[Optional] Settings for NSM.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string lingoConfigurationFileCommand
Command-line to execute that returns a linguistics configuration.
LingoServerInternals internals
Internal settings.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
int lingoConfigurationFileCheckSecs
Number of seconds between checks to see if the linguistics configuration has been updated....
std::string certStoreFileName
Path to the certificate store.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddress proxy
Address and port of the proxy.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
Internal translator server settings.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
WatchdogSettings watchdog
[Optional] Settings for the watchdog.
TuningSettings tuning
[Optional] Low-level tuning
TODO: Configuration for the translation server status report file.
bool includeSessionGroupDetail
bool includeSessionDetail
Location information used as part of the PresenceDescriptor.
double longitude
Its the longitudinal position using the Signed degrees format (DDD.dddd) format. Valid range is -180 ...
double altitude
[Optional, Default: INVALID_LOCATION_VALUE] The altitude above sea level in meters.
uint32_t ts
[Read Only: Unix timestamp - Zulu/UTC] Indicates the timestamp that the location was recorded.
double latitude
Its the latitude position using the using the Signed degrees format (DDD.dddd). Valid range is -90 to...
double direction
[Optional, Default: INVALID_LOCATION_VALUE] Direction the endpoint is traveling in degrees....
double speed
[Optional, Default: INVALID_LOCATION_VALUE] The speed the endpoint is traveling at in meters per seco...
std::string address
IP address.
NetworkAddressRestrictionList.
RestrictionType_t type
Type indicating how the elements are to be treated.
std::vector< NetworkAddressRxTx > elements
List of elements.
Custom Network Device Configuration.
std::string manufacturer
Device manufacturer (if any)
std::string model
Device mode (if any)
int deviceId
[Read Only] Unique device identifier assigned by Engage Engine at time of device creation.
std::string extra
Extra data provided by the platform (if any)
std::string type
Device type (if any)
std::string hardwareId
Device hardware ID (if any)
std::string serialNumber
Device serial number (if any)
std::string name
Name of the device assigned by the platform.
Network Transmit Options.
int ttl
[Optional, Default: 1] Time to live or hop limit is a mechanism that limits the lifespan or lifetime ...
TxPriority_t priority
[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based...
Description of a packet capturer.
Configuration for Rallypoint peers.
int version
TODO: A version number for the mesh configuration. Change this whenever you update your configuration...
std::string comments
Comments.
std::string id
An identifier useful for organizations that track different mesh configurations by ID.
std::vector< RallypointPeer > peers
List of Rallypoint peers to connect to.
Device Power Information used as part of the PresenceDescriptor.
int state
[Optional, Default: 0] Is the current state that the power system is in.
int source
[Optional, Default: 0] Is the source the power is being delivered from
int level
[Optional, Default: 0] Is the current level of the battery or power system as a percentage....
Group Alias used as part of the PresenceDescriptor.
uint16_t status
Status flags for the user's participation on the group.
std::string alias
User's alias for the group.
std::string groupId
Group Id the alias is associated with.
Represents an endpoints presence properties. Used in engageUpdatePresenceDescriptor API and PFN_ENGAG...
Power power
[Optional, Default: see Power] Device power information like charging state, battery level,...
std::string custom
[Optional, Default: empty string] Custom string application can use of presence descriptor....
bool self
[Read Only] Indicates that this presence declaration was generated by the Engage Engine the applicati...
uint32_t nextUpdate
[Read Only, Unix timestamp - Zulu/UTC] Indicates the next time the presence descriptor will be sent.
std::vector< PresenceDescriptorGroupItem > groupAliases
[Read Only] List of group items associated with this presence descriptor.
Identity identity
[Optional, Default see Identity] Endpoint's identity information.
bool announceOnReceive
[Read Only] Indicates that the Engine will announce its PresenceDescriptor in response to this messag...
uint32_t ts
[Read Only, Unix timestamp - Zulu/UTC] Indicates the timestamp that the message was originally sent.
std::string comment
[Optional] No defined limit on size but the total size of the serialized JSON object must fit inside ...
Connectivity connectivity
[Optional, Default: see Connectivity] Device connectivity information like wifi/cellular,...
uint32_t disposition
[Optional] Indicates the users disposition
Location location
[Optional, Default: see Location] Location information
Describes how the Presence is configured for a group of type Group::gtPresence in Group::Type_t.
Format_t format
Format to be used to represent presence information.
Format_t
Presence format types enum.
bool listenOnly
Instructs the Engage Engine to not transmit presence descriptor.
int minIntervalSecs
[Optional, Default: 5] The minimum interval to send at to prevent network flooding
int intervalSecs
[Optional, Default: 30] The interval in seconds at which to send the presence descriptor on the prese...
Defines settings for Rallypoint advertising.
std::string interfaceName
The multicast network interface for mDNS.
std::string serviceName
[Optional, Default "_rallypoint._tcp.local."] The service name
std::string hostName
[Optional] This Rallypoint's DNS-SD host name
int port
[Default: RP port] The multicast network interface for mDNS
bool enabled
[Default: false] Advertising is enabled
int ttl
[Default: 60] TTL for service TTL
int rolloverSecs
Seconds between switching to a new target.
ConnectionStrategy_t
Connection strategy enum.
int connectionTimeoutSecs
[Optional, Default: 0] Default connection timeout in seconds to any RP in the cluster
std::vector< Rallypoint > rallypoints
List of Rallypoints.
ConnectionStrategy_t connectionStrategy
[Optional, Default: csRoundRobin] Specifies the connection strategy to be followed....
Detailed information for a rallypoint connection.
std::string internalId
Id.
float serverProcessingMs
Server processing time in milliseconds - used for roundtrip reports.
uint64_t msToNextConnectionAttempt
Milliseconds until next connection attempt.
Defines settings for Rallypoint extended group restrictions.
std::vector< StringRestrictionList > restrictions
Restrictions.
int transactionTimeoutMs
[Optional, Default 5000] Number of milliseconds that a transaction may take before the link is consid...
bool allowSelfSignedCertificate
[Optional, Default false] Allows the Rallypoint to accept self-signed certificates from the far-end
std::vector< std::string > caCertificates
[Optional] A vector of certificates (raw content, file names, or certificate store elements) used to ...
std::string certificate
This is the X509 certificate to use for mutual authentication.
bool verifyPeer
[Optional, Default true] Indicates whether the connection peer is to be verified by checking the vali...
bool disableMessageSigning
[Optional, Default false] Indicates whether to forego ECSDA signing of control-plane messages.
NetworkAddress host
This is the host address for the Engine to connect to the RallyPoint service.
std::string certificateKey
This is the private key used to generate the X509 certificate.
int connectionTimeoutSecs
[Optional, Default: 5] Connection timeout in seconds to the RP
TcpNetworkTxOptions tcpTxOptions
[Optional] Tx options for the TCP link
SecurityCertificate certificate
Internal certificate detail.
std::string id
Internal ID.
bool forceIsMeshLeaf
Internal enablement setting.
int connectionTimeoutSecs
[Optional, Default: 0 - OS platform default] Connection timeout in seconds to the peer
NetworkAddress host
Internal host detail.
bool enabled
Internal enablement setting.
Definition of a static group for Rallypoints.
NetworkAddress rx
The network address for receiving network traffic on.
std::string id
Unique identity for the group.
std::vector< NetworkAddress > additionalTx
[Optional] Vector of additional TX addresses .
NetworkAddress tx
The network address for transmitting network traffic to.
DirectionRestriction_t directionRestriction
[Optional] Restriction of direction of traffic flow
DirectionRestriction_t
Enum describing direction(s) for the reflector.
std::string multicastInterfaceName
[Optional] The name of the NIC on which to send and receive multicast traffic.
Defines a behavior for a Rallypoint peer roundtrip time.
BehaviorType_t
Enum describing behavior types.
@ btReportWarn
Report at level warning.
@ btReportError
Report at level error.
@ btReportInfo
Report at level info.
BehaviorType_t behavior
Specifies the streaming mode type (see BehaviorType_t).
uint32_t atOrAboveMs
Network address for listening.
Configuration for the Rallypoint server.
uint32_t maxSecurityLevel
[Optional, Default 0] Sets the maximum item security level that can be registered with the RP
bool forwardDiscoveredGroups
Enables automatic forwarding of discovered multicast traffic to peer Rallypoints.
std::string interfaceName
Name of the NIC to bind to for listening for incoming TCP connections.
NetworkTxOptions multicastTxOptions
Tx options for multicast.
bool disableMessageSigning
Set to true to forgo DSA signing of messages. Doing so is is a security risk but can be useful on CPU...
SecurityCertificate certificate
X.509 certificate and private key that identifies the Rallypoint.
std::string multicastInterfaceName
The name of the NIC on which to send and receive multicast traffic.
StringRestrictionList groupRestrictions
Group IDs to be restricted (inclusive or exclusive)
std::string peeringConfigurationFileName
Name of a file containing a JSON array of Rallypoint peers to connect to.
uint32_t sysFlags
[Optional, Default 0] Internal system flags
int listenPort
TCP port to listen on. Default is 7443.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddressRestrictionList multicastRestrictions
Multicasts to be restricted (inclusive or exclusive)
uint32_t normalTaskQueueBias
[Optional, Default 0] Sets the queue's normal task bias
PacketCapturer txCapture
Details for capture of transmitted packets
std::vector< RallypointReflector > staticReflectors
Vector of static groups.
bool enableLeafReflectionReverseSubscription
If enabled, causes a mesh leaf to reverse-subscribe to a core node upon the core subscribing and a re...
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
IpFamilyType_t ipFamily
[Optional, Default IpFamilyType_t::ifIp4] Address familiy to be used for listening
int peerRtTestIntervalMs
[Optional, Default: 60000] Milliseconds between sending round-trip test requests to peers
WatchdogSettings watchdog
[Optional] Settings for the Rallypoint's watchdog.
DiscoveryConfiguration discovery
Details discovery capabilities.
bool isMeshLeaf
Indicates whether this Rallypoint is part of a core mesh or hangs off the periphery as a leaf node.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
GroupRestrictionAccessPolicyType_t groupRestrictionAccessPolicyType
The policy employed to allow group registration.
Licensing licensing
Licensing settings.
PacketCapturer rxCapture
Details for capture of received packets
std::string meshName
[Optional] This Rallypoint's mesh name
uint32_t maxOutboundPeerConnectionIntervalDeltaSecs
[Optional, Default 15] Sets the delta value for the maximum number of seconds to delay when attemptin...
TuningSettings tuning
[Optional] Low-level tuning
RallypointAdvertisingSettings advertising
[Optional] Settings for advertising.
Featureset featureset
Optional feature set.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the Rallypoint's interaction with an external health-checker such as a load-balanc...
std::vector< RallypointExtendedGroupRestriction > extendedGroupRestrictions
Extended group restrictions.
int ioPools
Number of threading pools to create for network I/O. Default is -1 which creates 1 I/O pool per CPU c...
RallypointServerStatusReportConfiguration statusReport
Details for producing a status report.
IgmpSnooping igmpSnooping
IGMP snooping configuration.
RallypointServerLinkGraph linkGraph
Details for producing a Graphviz-compatible link graph.
RallypointServerLimits limits
Details for capacity limits and determining processing load.
PeeringConfiguration peeringConfiguration
Internal - not serialized.
std::vector< std::string > extraMeshes
[Optional] List of additional meshes that can be reached via this RP
bool allowMulticastForwarding
Allows traffic received on unicast links to be forwarded to the multicast network.
RallypointWebsocketSettings websocket
[Optional] Settings for websocket operation
std::string peeringConfigurationFileCommand
Command-line to execute that returns a JSON array of Rallypoint peers to connect to.
RallypointServerRouteMap routeMap
Details for producing a report containing the route map.
bool allowPeerForwarding
Set to true to allow forwarding of packets received from other Rallypoints to all other Rallypoints....
TcpNetworkTxOptions tcpTxOptions
Tx options for TCP.
RallypointUdpStreaming udpStreaming
Optional configuration for high-performance UDP streaming.
bool forwardMulticastAddressing
Enables forwarding of multicast addressing to peer Rallypoints.
std::vector< RallypointRpRtTimingBehavior > peerRtBehaviors
[Optional] Array of behaviors for roundtrip times to peers
std::string id
A unqiue identifier for the Rallypoint.
NsmConfiguration nsm
[Optional] Settings for NSM.
bool disableLoopDetection
If true, turns off loop detection.
std::string certStoreFileName
Path to the certificate store.
int peeringConfigurationFileCheckSecs
Number of seconds between checks to see if the peering configuration has been updated....
Tls tls
Details concerning Transport Layer Security.
TODO: Configuration for Rallypoint limits.
uint32_t maxQOpsPerSec
Maximum number of queue operations per second (0 = unlimited)
uint32_t maxInboundBacklog
Maximum number of inbound backlog requests the Rallypoint will accept.
uint32_t normalPriorityQueueThreshold
Number of normal priority queue operations after which new connections will not be accepted.
uint32_t maxPeers
Maximum number of peers (0 = unlimited)
uint32_t maxTxBytesPerSec
Maximum number of bytes transmitted per second (0 = unlimited)
uint32_t maxTxPacketsPerSec
Maximum number of packets transmitted per second (0 = unlimited)
uint32_t maxRegisteredStreams
Maximum number of registered streams (0 = unlimited)
uint32_t maxClients
Maximum number of clients (0 = unlimited)
uint32_t maxMulticastReflectors
Maximum number of multicastReflectors (0 = unlimited)
uint32_t maxStreamPaths
Maximum number of bidirectional stream paths (0 = unlimited)
uint32_t lowPriorityQueueThreshold
Number of low priority queue operations after which new connections will not be accepted.
uint32_t maxRxBytesPerSec
Maximum number of bytes received per second (0 = unlimited)
uint32_t denyNewConnectionCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which new connections are denied.
uint32_t maxRxPacketsPerSec
Maximum number of packets received per second (0 = unlimited)
uint32_t warnAtCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which warnings are logged.
std::string leafRpStyling
std::string coreRpStyling
bool includeDigraphEnclosure
std::string clientStyling
TODO: Configuration for the Rallypoint status report file.
bool includePeerLinkDetails
bool includeClientLinkDetails
Streaming configuration for RP clients.
int listenPort
UDP port to listen on. Default is 7444.
TxPriority_t priority
[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based...
RallypointUdpStreamingIpvX ipv4
IPv4
bool enabled
[Optional, Default true] If true, enables UDP streaming unless turned off on a per-family basis.
CryptoType_t cryptoType
[Optional, Default ctSharedKeyAes256FullIv] The crypto method to be used
int ttl
[Optional, Default: 64] Time to live or hop limit.
CryptoType_t
Enum describing UDP streaming modes.
int keepaliveIntervalSecs
[Optional, Default: 15] Interval (seconds) at which to send UDP keepalives
RallypointUdpStreamingIpvX ipv6
IPv6.
Streaming configuration for RP clients.
bool enabled
[Optional, Default true] If true, enables UDP streaming for vX.
NetworkAddress external
Network address for external entities to transmit to. Defaults to the address of the local interface ...
Defines settings for Rallypoint websockets functionality.
int listenPort
Listen port (TCP). Default is 8443.
SecurityCertificate certificate
Certificate to be used for WebSockets.
bool enabled
[Default: false] Websocket is enabled
bool requireClientCertificate
[Default: false] Indicates whether the client is required to present a certificate
Options for Ranger packets.
int count
[Optional, Default: 5] Number of ranger packets to send when a new interval starts
int hangTimerSecs
[Optional, Default: -1] Number of seconds since last packet transmission before 'count' packets are s...
Helper class for serializing and deserializing the RiffDescriptor JSON.
CertificateDescriptor certDescriptor
[Optional] X.509 certificate parsed into a CertificateDescriptor object.
std::string meta
[Optional] Meta data associated with the file - typically a stringified JSON object.
bool verified
True if the ECDSA signature is verified.
int channels
Number of audio channels.
std::string signature
[Optional] ECDSA signature
std::string certPem
[Optional] X.509 certificate in PEM format used to sign the RIFF file.
int sampleCount
Number of audio samples.
std::string file
Name of the RIFF file.
std::string name
Name of the CODEC.
int engageType
An integer representing the codec type.
int rtpPayloadType
The RTP payload type identifier.
RtpPayloadTypeTranslation.
uint16_t engage
The payload type used by Engage.
uint16_t external
The payload type used by the external entity.
Configuration for the optional RtpProfile.
JitterMode_t
Jitter buffer mode.
int signalledInboundProcessorInactivityMs
[Optional, Default: inboundProcessorInactivityMs * 4] The number of milliseconds of RTP inactivity on...
int jitterUnderrunReductionAger
[Optional, Default: 100] Number of jitter buffer operations after which to reduce any underrun
int jitterMinMs
[Optional, Default: 100] Low-water mark for jitter buffers that are in a buffering state.
int jitterMaxFactor
[Optional, Default: 8] The factor by which to multiply the jitter buffer's active low-water to determ...
int inboundProcessorInactivityMs
[Optional, Default: 500] The number of milliseconds of RTP inactivity before heuristically determinin...
JitterMode_t mode
[Optional, Default: jmStandard] Specifies the operation mode (see JitterMode_t).
int jitterForceTrimAtMs
[Optional, Default: 0] Forces trimming of the jitter buffer if the queue length is greater (and not z...
int latePacketSequenceRange
[Optional, Default: 5] The delta in RTP sequence numbers in order to heuristically determine the star...
int jitterMaxExceededClipHangMs
[Optional, Default: 1500] Number of milliseconds for which the jitter buffer may exceed max before cl...
int jitterTrimPercentage
[Optional, Default: 10] The percentage of the overall jitter buffer sample count to trim when potenti...
int jitterMaxTrimMs
[Optional, Default: 250] Maximum number of milliseconds to be trimmed from a jitter buffer at any one...
int jitterMaxMs
[Optional, Default: 10000] Maximum number of milliseconds allowed in the queue
int latePacketTimestampRangeMs
[Optional, Default: 500] The delta in milliseconds in order to heuristically determine the start of a...
int jitterMaxExceededClipPerc
[Optional, Default: 10] Percentage by which maximum number of samples in the queue exceeded computed ...
int zombieLifetimeMs
[Optional, Default: 15000] The number of milliseconds that a "zombified" RTP processor is kept around...
int rtcpPresenceTimeoutMs
[Optional, Default: 45000] Timeout for RTCP presence.
int jitterUnderrunReductionThresholdMs
[Optional, Default: 1500] Number of milliseconds of error-free operations in a jitter buffer before t...
Configuration for a secure signature.
std::string signature
Contains the signature.
std::string certificate
Contains the PEM-formatted text of the certificate.
Configuration for a Security Certificate used in various configurations.
std::string key
As for above but for certificate's private key.
std::string certificate
Contains the PEM-formatted text of the certificate, OR, a reference to a PEM file denoted by "@file:/...
std::string alias
[Optional] An alias
std::string nodeId
[Optional] A node ID
RestrictionType_t type
Type indicating how the elements are to be treated.
std::vector< std::string > elements
List of elements.
RestrictionElementType_t elementsType
Type indicating what kind of data each element contains.
std::string nodeId
A unique identifier for the asset.
Group group
Details for the talkgroup.
Network Transmit Options for TCP.
Parameters for querying the group timeline.
bool onlyCommitted
Include only committed (not in-progress) events.
uint64_t startedOnOrAfter
Include events that started on or after this UNIX millisecond timestamp.
int onlyType
Include events for this type.
long maxCount
Maximum number of records to return.
uint64_t endedOnOrBefore
Include events that ended on or after this UNIX millisecond timestamp.
std::string sql
Ignore all other settings for SQL construction and use this query string instead.
bool mostRecentFirst
Sorted results with most recent timestamp first.
std::string onlyNodeId
Include events for this transmitter node ID.
int onlyDirection
Include events for this direction.
int onlyTxId
Include events for this transmission ID.
std::string onlyAlias
Include events for this transmitter alias.
TODO: Transport Security Layer (TLS) settings.
bool verifyPeers
[Optional, Default: true] When true, checks the far-end certificate validity and Engage-specific TLS ...
StringRestrictionList subjectRestrictions
[NOT USED AT THIS TIME]
std::vector< std::string > caCertificates
[Optional] Array of CA certificates (PEM or "@" file/certstore references) to be used to validate far...
StringRestrictionList issuerRestrictions
[NOT USED AT THIS TIME]
bool allowSelfSignedCertificates
[Optional, Default: false] When true, accepts far-end certificates that are self-signed.
std::vector< std::string > crlSerials
[Optional] Array of serial numbers certificates that have been revoked
Translation configuration.
std::vector< TranslationSession > sessions
Array of sessions in the configuration.
std::vector< Group > groups
Array of groups in the configuration.
Translation session settings.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the session
Description of a transport impairment.
uint32_t maxActiveBlobObjects
[Optional, Default 0 (no max)] Maximum number of blob objects allowed to be active
uint32_t maxActiveRtpProcessors
[Optional, Default 0 (no max)] Maximum number concurrent RTP processors
uint32_t maxPooledBufferMb
[Optional, Default 0 (no max)] Maximum number of buffer bytes allowed to be pooled
uint32_t maxActiveBufferObjects
[Optional, Default 0 (no max)] Maximum number of buffer objects allowed to be active
uint32_t maxPooledBufferObjects
[Optional, Default 0 (no max)] Maximum number of buffer objects allowed to be pooled
uint32_t maxPooledRtpObjects
[Optional, Default 0 (no max)] Maximum number of RTP objects allowed to be pooled
uint32_t maxPooledBlobMb
[Optional, Default 0 (no max)] Maximum number of blob bytes allowed to be pooled
uint32_t maxPooledRtpMb
[Optional, Default 0 (no max)] Maximum number of RTP bytes allowed to be pooled
uint32_t maxActiveRtpObjects
[Optional, Default 0 (no max)] Maximum number of RTP objects allowed to be active
uint32_t maxPooledBlobObjects
[Optional, Default 0 (no max)] Maximum number of blob objects allowed to be pooled
Configuration for the audio transmit properties for a group.
int startTxNotifications
[Optional, Default: 5] Number of start TX notifications to send when TX is about to begin.
int framingMs
[Optional, Default: 60] Audio sample framing size in milliseconds.
int maxTxSecs
[Optional, Default: 0] Maximum number of seconds the Engine will transmit for.
uint32_t internalKey
[INTERNAL] The Engine-assigned key for the codec
bool enabled
[Optional, Default: true] Audio transmission is enabled
bool fdx
[Optional, Default: false] Indicates if full duplex audio is supported.
int initialHeaderBurst
[Optional, Default: 5] Number of headers to send at the beginning of a talk burst.
bool resetRtpOnTx
[Optional, Default: true] Resets RTP counters on each new transmission.
bool dtx
[Optional, Default: false] Support discontinuous transmission on those CODECs that allow it
std::string encoderName
[Optional] The name of the external codec - overrides encoder
TxCodec_t encoder
[Optional, Default: ctOpus8000] Specifies the Codec Type to use for the transmission....
int blockCount
[Optional, Default: 0] If >0, derives framingMs based on the encoder's internal operation
int smoothedHangTimeMs
[Optional, Default: 0] Hang timer for ongoing TX - only applicable if enableSmoothing is true
int customRtpPayloadType
[Optional, Default: -1] The custom RTP payload type to use for transmission. A value of -1 causes the...
bool noHdrExt
[Optional, Default: false] Set to true whether to disable header extensions.
bool enableSmoothing
[Optional, Default: true] Smooth input audio
int trailingHeaderBurst
[Optional, Default: 5] Number of headers to send at the conclusion of a talk burst.
int extensionSendInterval
[Optional, Default: 10] The number of packets when to periodically send the header extension.
TxCodec_t
Codec Types enum.
Optional audio streaming from a URI for engageBeginGroupTxAdvanced.
std::string uri
URI for the file.
int repeatCount
[Optional, Default: 0] Number of times to repeat
Voice Activity Detection settings.
bool enabled
[Optional, Default: false] Enable VAD
Mode_t mode
[Optional, Default: vamDefault] Specifies VAD mode. See Mode_t for all modes
Voice to voice session settings.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the session
int intervalMs
[Optional, Default: 5000] Interval at which checks are made.
int hangDetectionMs
[Optional, Default: 2000] Number of milliseconds that must pass before a hang is assumed.
int slowExecutionThresholdMs
[Optional, Default: 100] Maximum number of milliseconds that a task may take before being considered ...
bool abortOnHang
[Optional, Default: true] If true, aborts the process if a hang is detected.
bool enabled
[Optional, Default: true] Enables/disables a watchdog.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * OID_RTS_PEM
Rally Tactical Systems' PEN as assigned by IANA.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * OID_RTS_CERT_SUBJ_ACCESS_TAGS
The link to the Rallypoint is down.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_SERIAL
The Rallypoint denied the registration request because the far-end's certificate serial number has be...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_SECURITY_CLASSIFICATION_LEVEL_TOO_HIGH
The Rallypoint has denied the registration because the registration is for a security level not allow...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_ON_BLACKLIST
The Rallypoint denied the registration request because the far-end does appears in blackist criteria.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_FINGERPRINT
The Rallypoint denied the registration request because the far-end's certificate fingerprint has been...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_ISSUER
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_GENERAL_DENIAL
The Rallypoint has denied the registration for no specific reason.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_ACCESS_TAG
The Rallypoint denied the registration request because the far-end's certificate does not have an acc...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_SUBJECT
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NOT_ALLOWED
The Rallypoint is not accepting registration for the group at this time.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_SUBJECT
The Rallypoint denied the registration request because the far-end's certificate subject has been exc...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_LINK
The link to the Rallypoint is down.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_SERIAL
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_FINGERPRINT
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_ISSUER
The Rallypoint denied the registration request because the far-end's certificate issuer has been excl...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_ACCESS_TAG
The Rallypoint denied the registration request because the far-end's certificate does not have an acc...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_UNREGISTERED
The group has been gracefully unregistered from the Rallypoint.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_REAON
No particular reason was provided.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NOT_ON_WHITELIST
The Rallypoint denied the registration request because the far-end does not appear in any whitelist c...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_DOMO
The source is Domo Tactical via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_CISTECH
The source is CISTECH via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_CORE
The source is a Magellan-capable entity.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_INTERNAL
Internal to Engage.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_TAIT
The source is Tait via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_TRELLISWARE
The source is Trellisware via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_SILVUS
The source is Silvus via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_VOCALITY
The source is Vocality via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_PERSISTENT
The source is Persistent Systems via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_KENWOOD
The source is Kenwood via Magellan discovery.
static const uint8_t ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE
The default RTP payload type Engage uses for RTP blob messaging.