Contains talker information used in providing a list in GroupTalkers. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	ManufacturedAliasType_t { matNone = 0 , matAnonymous = 1 , matSsrcGenerated = 2 }
	Manufactured alias type If an alias is "manufactured" then the alias is not a real user but is instead a system-generated alias. 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	alias
	The user alias to represent as a "talker".

std::string	nodeId
	The nodeId the talker is originating from.

uint16_t	rxFlags
	Flags associated with a talker's transmission.

int	txPriority
	Priority associated with a talker's transmission.

uint32_t	txId
	Transmission ID associated with a talker's transmission.

int	duplicateCount
	Number of duplicates detected.

uint16_t	aliasSpecializer
	The numeric specializer (if any) associated with the alias.

bool	rxMuted
	Indicates if RX is muted for this talker.

uint32_t	ssrc
	The RTS SSRC associated with a talker's transmission.

ManufacturedAliasType_t	manufacturedAliasType
	The method used to "manufacture" the alias.

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Contains talker information used in providing a list in GroupTalkers.

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

Example:

{
   "alias": "",
   "nodeId": ""
}

See also: GroupTalkers

Definition at line 3766 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ ManufacturedAliasType_t

enum AppConfigurationObjects::TalkerInformation::ManufacturedAliasType_t

Manufactured alias type If an alias is "manufactured" then the alias is not a real user but is instead a system-generated alias.

Enumerator
matNone	Not manufactured.
matAnonymous	The anonymous alias specified in the group configuration was used.
matSsrcGenerated	The alias was manufactured using the RTP stream's SSRC value in hex - in the format "SSRCxxxxxxxx".

Definition at line 3775 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ TalkerInformation()

AppConfigurationObjects::TalkerInformation::TalkerInformation ( )

inline

Definition at line 3817 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::TalkerInformation::clear ( )

inline

Definition at line 3822 of file ConfigurationObjects.h.

Member Data Documentation

◆ alias

std::string AppConfigurationObjects::TalkerInformation::alias

The user alias to represent as a "talker".

Definition at line 3788 of file ConfigurationObjects.h.

◆ aliasSpecializer

uint16_t AppConfigurationObjects::TalkerInformation::aliasSpecializer

The numeric specializer (if any) associated with the alias.

Definition at line 3806 of file ConfigurationObjects.h.

◆ duplicateCount

int AppConfigurationObjects::TalkerInformation::duplicateCount

Number of duplicates detected.

Definition at line 3803 of file ConfigurationObjects.h.

◆ manufacturedAliasType

ManufacturedAliasType_t AppConfigurationObjects::TalkerInformation::manufacturedAliasType

The method used to "manufacture" the alias.

Definition at line 3815 of file ConfigurationObjects.h.

◆ nodeId

std::string AppConfigurationObjects::TalkerInformation::nodeId

The nodeId the talker is originating from.

Definition at line 3791 of file ConfigurationObjects.h.

◆ rxFlags

uint16_t AppConfigurationObjects::TalkerInformation::rxFlags

Flags associated with a talker's transmission.

Definition at line 3794 of file ConfigurationObjects.h.

◆ rxMuted

bool AppConfigurationObjects::TalkerInformation::rxMuted

Indicates if RX is muted for this talker.

Definition at line 3809 of file ConfigurationObjects.h.

◆ ssrc

uint32_t AppConfigurationObjects::TalkerInformation::ssrc

The RTS SSRC associated with a talker's transmission.

Definition at line 3812 of file ConfigurationObjects.h.

◆ txId

uint32_t AppConfigurationObjects::TalkerInformation::txId

Transmission ID associated with a talker's transmission.

Definition at line 3800 of file ConfigurationObjects.h.

◆ txPriority

int AppConfigurationObjects::TalkerInformation::txPriority

Priority associated with a talker's transmission.

Definition at line 3797 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members