Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::EnginePolicyInternals Class Reference

Internal Engage Engine settings. 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

WatchdogSettings watchdog
 [Optional] Settings for the Engine's watchdog.
 
int housekeeperIntervalMs
 [Optional, Default: 1000] Interval at which to run the housekeeper thread.
 
int maxTxSecs
 [Optional, Default: 30] The default duration the engageBeginGroupTx and engageBeginGroupTxAdvanced function will transmit for.
 
int maxRxSecs
 
int logTaskQueueStatsIntervalMs
 
bool enableLazySpeakerClosure
 
int uriStreamingIntervalMs
 [Optional, Default: 60] The packet framing interval for audio streaming from a URI.
 
RallypointCluster::ConnectionStrategy_t rpClusterStrategy
 [Optional, Default: csRoundRobin] Specifies the default RP cluster connection strategy to be followed. See ConnectionStrategy_t for all strategy types
 
int rpClusterRolloverSecs
 [Optional, Default: 10] Seconds between switching to a new target in a RP cluster
 
int rtpExpirationCheckIntervalMs
 [Optional, Default: 250] Interval at which to check for RTP expiration.
 
int rpConnectionTimeoutSecs
 [Optional, Default: 5] Connection timeout in seconds to RP
 
int stickyTidHangSecs
 [Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.
 
int delayedMicrophoneClosureSecs
 [Optional, Default: 15] The number of seconds to cache an open microphone before actually closing it.
 
TuningSettings tuning
 [Optional] Low-level tuning
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Internal Engage Engine settings.

These settings are used to configure internal parameters.

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

Example:

{
"disableWatchdog": false,
"housekeeperIntervalMs": 1000,
"maxTxSecs": 30,
"maxRxSecs": 0,
"watchdogHangDetectionMs": 2000,
"watchdogIntervalMs": 5000
}
See also
engageInitialize, ConfigurationObjects::EnginePolicy

Definition at line 6805 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EnginePolicyInternals()

AppConfigurationObjects::EnginePolicyInternals::EnginePolicyInternals ( )
inline

Definition at line 6850 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EnginePolicyInternals::clear ( )
inline

Definition at line 6855 of file ConfigurationObjects.h.

Member Data Documentation

◆ delayedMicrophoneClosureSecs

int AppConfigurationObjects::EnginePolicyInternals::delayedMicrophoneClosureSecs

[Optional, Default: 15] The number of seconds to cache an open microphone before actually closing it.

Definition at line 6845 of file ConfigurationObjects.h.

◆ enableLazySpeakerClosure

bool AppConfigurationObjects::EnginePolicyInternals::enableLazySpeakerClosure

Definition at line 6824 of file ConfigurationObjects.h.

◆ housekeeperIntervalMs

int AppConfigurationObjects::EnginePolicyInternals::housekeeperIntervalMs

[Optional, Default: 1000] Interval at which to run the housekeeper thread.

Definition at line 6815 of file ConfigurationObjects.h.

◆ logTaskQueueStatsIntervalMs

int AppConfigurationObjects::EnginePolicyInternals::logTaskQueueStatsIntervalMs

Definition at line 6822 of file ConfigurationObjects.h.

◆ maxRxSecs

int AppConfigurationObjects::EnginePolicyInternals::maxRxSecs

Definition at line 6820 of file ConfigurationObjects.h.

◆ maxTxSecs

int AppConfigurationObjects::EnginePolicyInternals::maxTxSecs

[Optional, Default: 30] The default duration the engageBeginGroupTx and engageBeginGroupTxAdvanced function will transmit for.

Definition at line 6818 of file ConfigurationObjects.h.

◆ rpClusterRolloverSecs

int AppConfigurationObjects::EnginePolicyInternals::rpClusterRolloverSecs

[Optional, Default: 10] Seconds between switching to a new target in a RP cluster

Definition at line 6833 of file ConfigurationObjects.h.

◆ rpClusterStrategy

RallypointCluster::ConnectionStrategy_t AppConfigurationObjects::EnginePolicyInternals::rpClusterStrategy

[Optional, Default: csRoundRobin] Specifies the default RP cluster connection strategy to be followed. See ConnectionStrategy_t for all strategy types

Definition at line 6830 of file ConfigurationObjects.h.

◆ rpConnectionTimeoutSecs

int AppConfigurationObjects::EnginePolicyInternals::rpConnectionTimeoutSecs

[Optional, Default: 5] Connection timeout in seconds to RP

Definition at line 6839 of file ConfigurationObjects.h.

◆ rtpExpirationCheckIntervalMs

int AppConfigurationObjects::EnginePolicyInternals::rtpExpirationCheckIntervalMs

[Optional, Default: 250] Interval at which to check for RTP expiration.

Definition at line 6836 of file ConfigurationObjects.h.

◆ stickyTidHangSecs

int AppConfigurationObjects::EnginePolicyInternals::stickyTidHangSecs

[Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.

Definition at line 6842 of file ConfigurationObjects.h.

◆ tuning

TuningSettings AppConfigurationObjects::EnginePolicyInternals::tuning

[Optional] Low-level tuning

Definition at line 6848 of file ConfigurationObjects.h.

◆ uriStreamingIntervalMs

int AppConfigurationObjects::EnginePolicyInternals::uriStreamingIntervalMs

[Optional, Default: 60] The packet framing interval for audio streaming from a URI.

Definition at line 6827 of file ConfigurationObjects.h.

◆ watchdog

WatchdogSettings AppConfigurationObjects::EnginePolicyInternals::watchdog

[Optional] Settings for the Engine's watchdog.

Definition at line 6812 of file ConfigurationObjects.h.


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