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

Detailed information for a group reconfiguration. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  ReconfigurationStatus_t {
  rsUndefined = 0 , rsOk = 1 , rsNoJson = -1 , rsInvalidConfiguration = -2 ,
  rsInvalidJson = -3 , rsAudioInputFailure = -4 , rsAudioOutputFailure = -5 , rsDoesNotExist = -6 ,
  rsAudioInputInUse = -7 , rsAudioDisabledForGroup = -8 , rsGroupIsNotAudio = -9
}
 Reconfiguration status. 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.
 
ReconfigurationStatus_t status
 The creation status.
 
- 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 reconfiguration.

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

Definition at line 10031 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ ReconfigurationStatus_t

Reconfiguration status.

Enumerator
rsUndefined 

Undefined.

rsOk 

Reconfiguration OK.

rsNoJson 

Configuration JSON is empty.

rsInvalidConfiguration 

Invalid configuration.

rsInvalidJson 

Invalid JSON.

rsAudioInputFailure 

Audio input failure.

rsAudioOutputFailure 

Audio input failure.

rsDoesNotExist 

Group does not exist.

rsAudioInputInUse 

Audio input device is in use (group is transmitting)

rsAudioDisabledForGroup 

Audio disabled for audio group.

rsGroupIsNotAudio 

Group is not an audio group.

Definition at line 10039 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ GroupReconfigurationDetail()

AppConfigurationObjects::GroupReconfigurationDetail::GroupReconfigurationDetail ( )
inline

Definition at line 10081 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::GroupReconfigurationDetail::clear ( )
inline

Definition at line 10086 of file ConfigurationObjects.h.

Member Data Documentation

◆ id

std::string AppConfigurationObjects::GroupReconfigurationDetail::id

ID of the group.

Definition at line 10076 of file ConfigurationObjects.h.

◆ status

ReconfigurationStatus_t AppConfigurationObjects::GroupReconfigurationDetail::status

The creation status.

Definition at line 10079 of file ConfigurationObjects.h.


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