AppConfigurationObjects::EngateGroup Class Reference

Engate configuration. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::Group.

Public Member Functions
void	clear ()
Public Member Functions inherited from AppConfigurationObjects::Group
void	clear ()
Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()
virtual std::string	toString ()
virtual bool	isDocumenting () const

Public Attributes
bool	useVad
uint32_t	inputHangMs
uint32_t	inputActivationPowerThreshold
uint32_t	inputDeactivationPowerThreshold
Public Attributes inherited from AppConfigurationObjects::Group
Type_t	type
	Specifies the group type (see Type_t).
BridgingOpMode_t	bom
	Specifies the bridging operation mode if applicable (see BridgingOpMode_t).
std::string	id
	Unique identity for the group.
std::string	name
	The human readable name for the group.
std::string	spokenName
	The group name as spoken - typically by a text-to-speech system
std::string	interfaceName
	The name of the network interface to use for multicasting for this group. If not provided, the Engine's default multicast NIC is used.
NetworkAddress	rx
	The network address for receiving network traffic on.
NetworkAddress	tx
	The network address for transmitting network traffic to.
NetworkTxOptions	txOptions
	Transmit options for the group (see NetworkTxOptions).
TxAudio	txAudio
	Audio transmit options such as codec, framing size etc (see TxAudio).
Presence	presence
	Presence configuration (see Presence).
std::string	cryptoPassword
	Password to be used for encryption. Note that this is not the encryption key but, rather, the hexidecimal representation of the baseline material to be used in a PBFDK2 algorithm for key derivation.
bool	lbCrypto
	[Optional, Default: false] Use low-bandwidth crypto
std::vector< Rallypoint >	rallypoints
	[DEPRECATED] List of Rallypoint (s) the Group should use to connect to a Rallypoint router. Use RallypointCluster instead.
RallypointCluster	rallypointCluster
	Cluster of one or more Rallypoints the group may use.
Audio	audio
	Sets audio properties like which audio device to use, audio gain etc (see Audio).
GroupTimeline	timeline
	Audio timeline is configuration.
std::string	alias
	User alias to transmit as part of the realtime audio stream when using the engageBeginGroupTx API.
bool	blockAdvertising
	[Optional, Default: false] Set this to true if you do not want the Engine to advertise this Group on the Presence group.
std::string	source
	[Optional, Default: null] Indicates the source of this configuration - e.g. from the application or discovered via Magellan
int	maxRxSecs
	[Optional, Default: 0] Maximum number of seconds the Engine will receive for on this group.
bool	enableMulticastFailover
	[Optional, Default: false] Set this to true to enable failover to multicast operation if a Rallypoint connection cannot be established.
int	multicastFailoverSecs
	[Optional, Default: 10] Specifies the number fo seconds to wait after Rallypoint connection failure to switch to multicast operation.
NetworkAddress	rtcpPresenceRx
	The network address for receiving RTCP presencing packets.
std::vector< std::string >	presenceGroupAffinities
	List of presence group IDs with which this group has an affinity.
bool	disablePacketEvents
	[Optional, Default: false] Disable packet events.
int	rfc4733RtpPayloadId
	[Optional, Default: 0] The RTP payload ID by which to identify (RX and TX) payloads encoded according to RFC 4733 (RFC 2833).
std::vector< RtpPayloadTypeTranslation >	inboundRtpPayloadTypeTranslations
	[Optional] A vector of translations from external entity RTP payload types to those used by Engage
GroupPriorityTranslation	priorityTranslation
	[Optional] Describe how traffic for this group on a different addressing scheme translates to priority for the group
int	stickyTidHangSecs
	[Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.
std::string	anonymousAlias
	[Optional] Alias to use for inbound streams that do not have an alias component
GroupAppTransport	appTransport
	[Optional] Settings necessary if the group is transported via an application-supplied custom transport
bool	allowLoopback
	[Optional, Default: false] Allows for processing of looped back packets - primarily meant for debugging
RtpProfile	rtpProfile
	[Optional] RTP profile the group
RangerPackets	rangerPackets
	[Optional] Ranger packet options
bool	_wasDeserialized_rtpProfile
	[Internal - not serialized
TransportImpairment	txImpairment
	[Optional] The TX impairment to apply
TransportImpairment	rxImpairment
	[Optional] The RX impairment to apply
std::vector< uint16_t >	specializerAffinities
	List of specializer IDs that the local node has an affinity for/member of.
uint32_t	securityLevel
	[Optional, Default: 0] The security classification level of the group.
std::vector< Source >	ignoreSources
	[Optional] List of sources to ignore for this group
std::string	languageCode
	ISO 639-2 language code for the group
std::string	synVoice
	Name of the synthesis voice to use for the group
PacketCapturer	rxCapture
	Details for capture of received packets
PacketCapturer	txCapture
	Details for capture of transmitted packets
uint16_t	blobRtpPayloadType
	[Optional, Default: ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE] The RTP payload type to be used for blobs sent over RTP (see BlobInfo)
InboundAliasGenerationPolicy_t	inboundAliasGenerationPolicy
	[Optional, Default: iagpAnonymousAlias]
AudioGate	gateIn
	[Optional] Inbound gating of audio - only audio allowed through by the gate will be processed
bool	ignoreAudioTraffic
	[Optional, Default: false] Indicates that the group should ignore traffic that is audio-related
Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Public Types inherited from AppConfigurationObjects::Group
enum	Type_t { gtUnknown = 0 , gtAudio = 1 , gtPresence = 2 , gtRaw = 3 }
	Enum describing the group types. More...
enum	BridgingOpMode_t { bomRaw = 0 , bomPayloadTransformation = 1 , bomAnonymousMixing = 2 , bomLanguageTranslation = 3 }
	Enum describing bridging operation mode types where applicable. More...
enum	InboundAliasGenerationPolicy_t { iagpAnonymousAlias = 0 , iagpSsrcInHex = 1 }
	Enum describing the alias generation policy. More...
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Engate configuration.

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

Example:

See also

TODO: ConfigurationObjects::EngateGroupsConfiguration

Definition at line 11948 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

EngateGroup()

AppConfigurationObjects::EngateGroup::EngateGroup ( )

inline

Definition at line 11959 of file ConfigurationObjects.h.

Member Function Documentation

clear()

void AppConfigurationObjects::EngateGroup::clear ( )

inline

Definition at line 11964 of file ConfigurationObjects.h.

Member Data Documentation

inputActivationPowerThreshold

uint32_t AppConfigurationObjects::EngateGroup::inputActivationPowerThreshold

Definition at line 11956 of file ConfigurationObjects.h.

inputDeactivationPowerThreshold

uint32_t AppConfigurationObjects::EngateGroup::inputDeactivationPowerThreshold

Definition at line 11957 of file ConfigurationObjects.h.

inputHangMs

uint32_t AppConfigurationObjects::EngateGroup::inputHangMs

Definition at line 11955 of file ConfigurationObjects.h.

useVad

bool AppConfigurationObjects::EngateGroup::useVad

Definition at line 11954 of file ConfigurationObjects.h.

---

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

• c/include/ConfigurationObjects.h