Provides Engage Engine policy configuration. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

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

virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
std::string	dataDirectory
	Specifies the root of the physical path to store data.

Licensing	licensing
	Licensing settings.

EnginePolicySecurity	security
	Security settings.

EnginePolicyNetworking	networking
	Security settings.

EnginePolicyAudio	audio
	Audio settings.

DiscoveryConfiguration	discovery
	Discovery settings.

EnginePolicyLogging	logging
	Logging settings.

EnginePolicyInternals	internals
	Internal settings.

EnginePolicyTimelines	timelines
	Timelines settings.

EnginePolicyDatabase	database
	Database settings.

Featureset	featureset
	Optional feature set.

EnginePolicyNamedAudioDevices	namedAudioDevices
	Optional named audio devices (Linux only)

std::vector< ExternalModule >	externalCodecs
	Optional external codecs.

std::vector< RtpMapEntry >	rtpMap
	Optional RTP - overrides the default.

EngineStatusReportConfiguration	statusReport
	Optional statusReport - details for the status report.

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

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

Detailed Description

Provides Engage Engine policy configuration.

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

Provided at Engage Engine initialization time to specify all the policy settings for the Engage Engine.

Example JSON:

{
   "audio": {
      "allowOutputOnTransmit": false,
      "microphoneQueueMs": 60,
      "outputChannels": 2,
      "outputGainPercentage": 0,
      "pcmMaxSamplesInQueue": 1000,
      "pcmMinPlatformSampleCount": 250,
      "pcmSamplingRate": 16000,
      "pcmSpeakerBuffers": 5,
      "speakerQueueMs": 250
   },
   "dataDirectory": "",
   "discovery": {
      "cistech": {
         "address": {
            "address": "",
            "port": 0
         },
         "ageTimeoutMs": 30000,
         "enabled": false,
         "interfaceName": ""
      },
      "sap": {
         "address": {
            "address": "",
            "port": 0
         },
         "advertising": {
            "alwaysAdvertise": false,
            "enabled": false,
            "intervalMs": 20000
         },
         "ageTimeoutMs": 30000,
         "enabled": false,
         "interfaceName": ""
      },
      "ssdp": {
         "address": {
            "address": "",
            "port": 0
         },
         "advertising": {
            "alwaysAdvertise": false,
            "enabled": false,
            "intervalMs": 20000
         },
         "ageTimeoutMs": 30000,
         "enabled": false,
         "interfaceName": "",
         "searchTerms": []
      },
      "trellisware": {
         "enabled": false
      }
   },
   "internals": {
      "disableWatchdog": false,
      "housekeeperIntervalMs": 1000,
      "maxTxSecs": 30,
      "maxRxSecs": 0,
      "watchdogHangDetectionMs": 2000,
      "watchdogIntervalMs": 5000
   },
   "licensing": {
      "activationCode": "",
      "deviceId": "",
      "entitlement": "",
      "key": ""
   },
   "logging": {
      "enableSyslog": false,
      "maxLevel": 4
   },
   "networking": {
      "defaultNic": "",
      "maxOutputQueuePackets": 100,
      "maxReconnectPauseMs": 5000,
      "multicastRejoinSecs": 8,
      "rallypointRtTestIntervalMs": 60000,
      "reconnectFailurePauseIncrementMs": 500,
      "rpLeafConnectTimeoutSecs": 10,
      "rtpInboundProcessorInactivityMs": 500,
      "rtpJitterMaxMs": 1000,
      "rtpJitterMinMs": 100,
      "rtpLatePacketSequenceRange": 5,
      "rtpLatePacketTimestampRangeMs": 2000,
      "sendFailurePauseMs": 1000
   },
   "security": {
      "certificate": {
         "certificate": "",
         "key": ""
      }
   },
   "timelines": {
      "enabled": true,
      "groomingIntervalSecs": 1800,
      "maxEventAgeSecs": 2592000,
      "maxEvents": 1000,
      "maxStorageMb": 128,
      "security": {
         "certificate": "",
         "key": ""
      },
      "storageRoot": ""
   }
}

See also: engageInitialize

Definition at line 7770 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EnginePolicy()

AppConfigurationObjects::EnginePolicy::EnginePolicy ( )

inline

Definition at line 7822 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EnginePolicy::clear ( )

inline

Definition at line 7827 of file ConfigurationObjects.h.

Member Data Documentation

◆ audio

EnginePolicyAudio AppConfigurationObjects::EnginePolicy::audio

Audio settings.

Definition at line 7790 of file ConfigurationObjects.h.

◆ database

EnginePolicyDatabase AppConfigurationObjects::EnginePolicy::database

Database settings.

Definition at line 7805 of file ConfigurationObjects.h.

◆ dataDirectory

std::string AppConfigurationObjects::EnginePolicy::dataDirectory

Specifies the root of the physical path to store data.

Definition at line 7778 of file ConfigurationObjects.h.

◆ discovery

DiscoveryConfiguration AppConfigurationObjects::EnginePolicy::discovery

Discovery settings.

Definition at line 7793 of file ConfigurationObjects.h.

◆ externalCodecs

std::vector<ExternalModule> AppConfigurationObjects::EnginePolicy::externalCodecs

Optional external codecs.

Definition at line 7814 of file ConfigurationObjects.h.

◆ featureset

Featureset AppConfigurationObjects::EnginePolicy::featureset

Optional feature set.

Definition at line 7808 of file ConfigurationObjects.h.

◆ internals

EnginePolicyInternals AppConfigurationObjects::EnginePolicy::internals

Internal settings.

Definition at line 7799 of file ConfigurationObjects.h.

◆ licensing

Licensing AppConfigurationObjects::EnginePolicy::licensing

Licensing settings.

Definition at line 7781 of file ConfigurationObjects.h.

◆ logging

EnginePolicyLogging AppConfigurationObjects::EnginePolicy::logging

Logging settings.

Definition at line 7796 of file ConfigurationObjects.h.

◆ namedAudioDevices

EnginePolicyNamedAudioDevices AppConfigurationObjects::EnginePolicy::namedAudioDevices

Optional named audio devices (Linux only)

Definition at line 7811 of file ConfigurationObjects.h.

◆ networking

EnginePolicyNetworking AppConfigurationObjects::EnginePolicy::networking

Security settings.

Definition at line 7787 of file ConfigurationObjects.h.

◆ rtpMap

std::vector<RtpMapEntry> AppConfigurationObjects::EnginePolicy::rtpMap

Optional RTP - overrides the default.

Definition at line 7817 of file ConfigurationObjects.h.

◆ security

EnginePolicySecurity AppConfigurationObjects::EnginePolicy::security

Security settings.

Definition at line 7784 of file ConfigurationObjects.h.

◆ statusReport

EngineStatusReportConfiguration AppConfigurationObjects::EnginePolicy::statusReport

Optional statusReport - details for the status report.

Definition at line 7820 of file ConfigurationObjects.h.

◆ timelines

EnginePolicyTimelines AppConfigurationObjects::EnginePolicy::timelines

Timelines settings.

Definition at line 7802 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members