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

Optional audio streaming from a URI for engageBeginGroupTxAdvanced. 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

std::string uri
 URI for the file.
 
int repeatCount
 [Optional, Default: 0] Number of times to repeat
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Optional audio streaming from a URI for engageBeginGroupTxAdvanced.

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

Example JSON:

TODO: Completed class properties

See also
engageBeginGroupTxAdvanced, Application-configurable TX flags

Definition at line 1167 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ TxAudioUri()

AppConfigurationObjects::TxAudioUri::TxAudioUri ( )
inline

Definition at line 1179 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::TxAudioUri::clear ( )
inline

Definition at line 1184 of file ConfigurationObjects.h.

◆ initForDocumenting()

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

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1190 of file ConfigurationObjects.h.

Member Data Documentation

◆ repeatCount

int AppConfigurationObjects::TxAudioUri::repeatCount

[Optional, Default: 0] Number of times to repeat

Definition at line 1177 of file ConfigurationObjects.h.

◆ uri

std::string AppConfigurationObjects::TxAudioUri::uri

URI for the file.

Definition at line 1174 of file ConfigurationObjects.h.


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