Describes the Blob data being sent used in the engageSendGroupBlob API. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	PayloadType_t { bptUndefined = 0 , bptAppTextUtf8 = 1 , bptJsonTextUtf8 = 2 , bptAppBinary = 3 , bptEngageBinaryHumanBiometrics = 4 , bptAppMimeMessage = 5 , bptEngageInternal = 42 }
	Payload type. BlobInfo RTP supported Payload types. More...

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
size_t	size
	[Optional, Default : 0] Size of the payload

std::string	source
	[Optional, Default: empty string] The nodeId of Engage Engine that sent the message. If this is empty the Blob info will be anonymous.

std::string	target
	[Optional, Default: empty string] The nodeId to which this message is targeted. If this is empty, the Blob will targeted at all endpoints.

PayloadType_t	payloadType
	[Optional, Default: bptUndefined] The payload type to send in the blob

RtpHeader	rtpHeader
	Custom RTP header.

std::string	txnId
	[Optional but required if txnTimeoutSecs is > 0]

int	txnTimeoutSecs
	[Optional, Default: 0] Number of seconds after which to time out delivery to the target node

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

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

Detailed Description

Describes the Blob data being sent used in the engageSendGroupBlob API.

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

Example JSON:

{
   "payloadType": 0,
   "rtpHeader": {
      "marker": false,
      "pt": 0,
      "seq": 123,
      "ssrc": 12345678,
      "ts": 87654321
   },
   "size": 0,
   "source": "",
   "target": ""
}

See also: engageSendGroupBlob

Definition at line 1168 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ PayloadType_t

enum AppConfigurationObjects::BlobInfo::PayloadType_t

Payload type. BlobInfo RTP supported Payload types.

Enumerator
bptUndefined	Unknown type.
bptAppTextUtf8	Plain UTF 8 text. This is typically used to send plain text messages.
bptJsonTextUtf8	JSON UFT 8 text. This is used to send JSON formatted messages.
bptAppBinary	Binary payload. Used to send binary data.
bptEngageBinaryHumanBiometrics	Biometrics payload. Used to send biometric series data. See WIKI post for more info
bptAppMimeMessage	The payload is MIME-encoded as per RFC 2045.
bptEngageInternal	The payload is internal to Engage.

Definition at line 1177 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ BlobInfo()

AppConfigurationObjects::BlobInfo::BlobInfo ( )

inline

Definition at line 1222 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::BlobInfo::clear ( )

inline

Definition at line 1227 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::BlobInfo::initForDocumenting ( )

inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1238 of file ConfigurationObjects.h.

Member Data Documentation

◆ payloadType

PayloadType_t AppConfigurationObjects::BlobInfo::payloadType

[Optional, Default: bptUndefined] The payload type to send in the blob

See also: PayloadType_t

Definition at line 1211 of file ConfigurationObjects.h.

◆ rtpHeader

RtpHeader AppConfigurationObjects::BlobInfo::rtpHeader

Custom RTP header.

Definition at line 1214 of file ConfigurationObjects.h.

◆ size

size_t AppConfigurationObjects::BlobInfo::size

[Optional, Default : 0] Size of the payload

Definition at line 1202 of file ConfigurationObjects.h.

◆ source

std::string AppConfigurationObjects::BlobInfo::source

[Optional, Default: empty string] The nodeId of Engage Engine that sent the message. If this is empty the Blob info will be anonymous.

Definition at line 1205 of file ConfigurationObjects.h.

◆ target

std::string AppConfigurationObjects::BlobInfo::target

[Optional, Default: empty string] The nodeId to which this message is targeted. If this is empty, the Blob will targeted at all endpoints.

Definition at line 1208 of file ConfigurationObjects.h.

◆ txnId

std::string AppConfigurationObjects::BlobInfo::txnId

[Optional but required if txnTimeoutSecs is > 0]

Definition at line 1217 of file ConfigurationObjects.h.

◆ txnTimeoutSecs

int AppConfigurationObjects::BlobInfo::txnTimeoutSecs

[Optional, Default: 0] Number of seconds after which to time out delivery to the target node

Definition at line 1220 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