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

Detailed information for a group transmit. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  TxStatus_t {
  txsUndefined = 0 , txsTxStarted = 1 , txsTxEnded = 2 , txsNotAnAudioGroup = -1 ,
  txsNotJoined = -2 , txsNotConnected = -3 , txsAlreadyTransmitting = -4 , txsInvalidParams = -5 ,
  txsPriorityTooLow = -6 , txsRxActiveOnNonFdx = -7 , txsCannotSubscribeToInput = -8 , txsInvalidId = -9 ,
  txsTxEndedWithFailure = -10 , txsOthersActive = -11
}
 TxStatus. More...
 

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 id
 ID of the group.
 
TxStatus_t status
 The TX status.
 
int localPriority
 Local TX priority (optional)
 
int remotePriority
 Remote TX priority (optional)
 
long nonFdxMsHangRemaining
 Milliseconds of hang time remaining on a non-FDX group (optional)
 
uint32_t txId
 Transmission ID (optional)
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Detailed information for a group transmit.

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

Definition at line 9537 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ TxStatus_t

TxStatus.

Enumerator
txsUndefined 

Undefined.

txsTxStarted 

TX has started.

txsTxEnded 

TX has ended.

txsNotAnAudioGroup 

This is not an audio group.

txsNotJoined 

Group has not been joined.

txsNotConnected 

Group has not been connected.

txsAlreadyTransmitting 

Group is already transmitting.

txsInvalidParams 

Invalid TX JSON parameters.

txsPriorityTooLow 

TX priority is too low.

See also
remotePriority
remotePriority
txsRxActiveOnNonFdx 

RX active on a non-FDX configuration.

See also
nonFdxMsHangRemaining
txsCannotSubscribeToInput 

Cannot subscribe to the input.

txsInvalidId 

Invalid ID.

txsTxEndedWithFailure 

TX has ended with a failure.

txsOthersActive 

One or more other entities are or will soon be actively transmitting.

Definition at line 9545 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ GroupTxDetail()

AppConfigurationObjects::GroupTxDetail::GroupTxDetail ( )
inline

Definition at line 9608 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::GroupTxDetail::clear ( )
inline

Definition at line 9613 of file ConfigurationObjects.h.

Member Data Documentation

◆ id

std::string AppConfigurationObjects::GroupTxDetail::id

ID of the group.

Definition at line 9591 of file ConfigurationObjects.h.

◆ localPriority

int AppConfigurationObjects::GroupTxDetail::localPriority

Local TX priority (optional)

Definition at line 9597 of file ConfigurationObjects.h.

◆ nonFdxMsHangRemaining

long AppConfigurationObjects::GroupTxDetail::nonFdxMsHangRemaining

Milliseconds of hang time remaining on a non-FDX group (optional)

Definition at line 9603 of file ConfigurationObjects.h.

◆ remotePriority

int AppConfigurationObjects::GroupTxDetail::remotePriority

Remote TX priority (optional)

Definition at line 9600 of file ConfigurationObjects.h.

◆ status

TxStatus_t AppConfigurationObjects::GroupTxDetail::status

The TX status.

Definition at line 9594 of file ConfigurationObjects.h.

◆ txId

uint32_t AppConfigurationObjects::GroupTxDetail::txId

Transmission ID (optional)

Definition at line 9606 of file ConfigurationObjects.h.


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