Engage Engine API  1.244.9084
Loading...
Searching...
No Matches
AppConfigurationObjects::AdvancedTxParams Class Reference

Configuration when using the engageBeginGroupTxAdvanced API. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

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

Public Attributes

uint16_t flags
 [Optional, Default: 0] Combination of the ENGAGE_TXFLAG_xxx flags
 
uint8_t priority
 [Optional, Default: 0] Transmit priority between 0 (lowest) and 255 (highest).
 
uint16_t subchannelTag
 [Optional, Default: 0] Defines a sub channel within a group. Audio will be opaque to all other clients on the same group not on the same sub channel.
 
bool includeNodeId
 [Optional, Default: false] The Engage Engine should transmit the NodeId as part of the header extension in the RTP packet.
 
std::string alias
 [Optional, Default: empty string] The Engage Engine should transmit the user's alias as part of the header extension in the RTP packet.
 
bool muted
 [Optional, Default: false] While the microphone should be opened, captured audio should be ignored until unmuted.
 
uint32_t txId
 [Optional, Default: 0] Transmission ID
 
TxAudioUri audioUri
 [Optional] A URI to stream from instead of the audio input device
 
uint16_t aliasSpecializer
 [Optional, Default: 0] Defines a numeric affinity value to be included in the transmission. If defined, 3 bytes of the transmitted alias will be truncated.
 
bool receiverRxMuteForAliasSpecializer
 [Optional, Default: false] Indicates that the aliasSpecializer must cause receivers to mute this transmission if they have an affinity for the specializer..
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Configuration when using the engageBeginGroupTxAdvanced API.

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

Example JSON:

{
"alias": "",
"flags": 0,
"includeNodeId": false,
"priority": 0,
"subchannelTag": 0
}

TODO: Completed class properties

See also
engageBeginGroupTxAdvanced, Application-configurable TX flags

Definition at line 1223 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ AdvancedTxParams()

AppConfigurationObjects::AdvancedTxParams::AdvancedTxParams ( )
inline

Definition at line 1260 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::AdvancedTxParams::clear ( )
inline

Definition at line 1265 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::AdvancedTxParams::initForDocumenting ( )
inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1279 of file ConfigurationObjects.h.

Member Data Documentation

◆ alias

std::string AppConfigurationObjects::AdvancedTxParams::alias

[Optional, Default: empty string] The Engage Engine should transmit the user's alias as part of the header extension in the RTP packet.

Definition at line 1243 of file ConfigurationObjects.h.

◆ aliasSpecializer

uint16_t AppConfigurationObjects::AdvancedTxParams::aliasSpecializer

[Optional, Default: 0] Defines a numeric affinity value to be included in the transmission. If defined, 3 bytes of the transmitted alias will be truncated.

Definition at line 1255 of file ConfigurationObjects.h.

◆ audioUri

TxAudioUri AppConfigurationObjects::AdvancedTxParams::audioUri

[Optional] A URI to stream from instead of the audio input device

Definition at line 1252 of file ConfigurationObjects.h.

◆ flags

uint16_t AppConfigurationObjects::AdvancedTxParams::flags

[Optional, Default: 0] Combination of the ENGAGE_TXFLAG_xxx flags

Definition at line 1231 of file ConfigurationObjects.h.

◆ includeNodeId

bool AppConfigurationObjects::AdvancedTxParams::includeNodeId

[Optional, Default: false] The Engage Engine should transmit the NodeId as part of the header extension in the RTP packet.

Definition at line 1240 of file ConfigurationObjects.h.

◆ muted

bool AppConfigurationObjects::AdvancedTxParams::muted

[Optional, Default: false] While the microphone should be opened, captured audio should be ignored until unmuted.

Definition at line 1246 of file ConfigurationObjects.h.

◆ priority

uint8_t AppConfigurationObjects::AdvancedTxParams::priority

[Optional, Default: 0] Transmit priority between 0 (lowest) and 255 (highest).

Definition at line 1234 of file ConfigurationObjects.h.

◆ receiverRxMuteForAliasSpecializer

bool AppConfigurationObjects::AdvancedTxParams::receiverRxMuteForAliasSpecializer

[Optional, Default: false] Indicates that the aliasSpecializer must cause receivers to mute this transmission if they have an affinity for the specializer..

Definition at line 1258 of file ConfigurationObjects.h.

◆ subchannelTag

uint16_t AppConfigurationObjects::AdvancedTxParams::subchannelTag

[Optional, Default: 0] Defines a sub channel within a group. Audio will be opaque to all other clients on the same group not on the same sub channel.

Definition at line 1237 of file ConfigurationObjects.h.

◆ txId

uint32_t AppConfigurationObjects::AdvancedTxParams::txId

[Optional, Default: 0] Transmission ID

Definition at line 1249 of file ConfigurationObjects.h.


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