AppConfigurationObjects::RtpProfile Class Reference

Configuration for the optional RtpProfile. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	JitterMode_t { jmStandard = 0 , jmLowLatency = 1 , jmReleaseOnTxEnd = 2 }
	Jitter buffer mode. 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
JitterMode_t	mode
	[Optional, Default: jmStandard] Specifies the operation mode (see JitterMode_t).
int	jitterMaxMs
	[Optional, Default: 10000] Maximum number of milliseconds allowed in the queue
int	jitterMinMs
	[Optional, Default: 100] Low-water mark for jitter buffers that are in a buffering state.
int	jitterMaxFactor
	[Optional, Default: 8] The factor by which to multiply the jitter buffer's active low-water to determine the high-water mark
int	latePacketSequenceRange
	[Optional, Default: 5] The delta in RTP sequence numbers in order to heuristically determine the start of a new talk spurt
int	latePacketTimestampRangeMs
	[Optional, Default: 500] The delta in milliseconds in order to heuristically determine the start of a new talk spurt
int	jitterTrimPercentage
	[Optional, Default: 10] The percentage of the overall jitter buffer sample count to trim when potential buffer overflow is encountered
int	jitterUnderrunReductionThresholdMs
	[Optional, Default: 1500] Number of milliseconds of error-free operations in a jitter buffer before the underrun counter begins reducing
int	jitterUnderrunReductionAger
	[Optional, Default: 100] Number of jitter buffer operations after which to reduce any underrun
int	jitterForceTrimAtMs
	[Optional, Default: 0] Forces trimming of the jitter buffer if the queue length is greater (and not zero)
int	jitterMaxTrimMs
	[Optional, Default: 250] Maximum number of milliseconds to be trimmed from a jitter buffer at any one point
int	jitterMaxExceededClipPerc
	[Optional, Default: 10] Percentage by which maximum number of samples in the queue exceeded computed max before large-scale clipping .
int	jitterMaxExceededClipHangMs
	[Optional, Default: 1500] Number of milliseconds for which the jitter buffer may exceed max before clipping is actually applied.
int	inboundProcessorInactivityMs
	[Optional, Default: 500] The number of milliseconds of RTP inactivity before heuristically determining the end of talk spurt
int	rtcpPresenceTimeoutMs
	[Optional, Default: 45000] Timeout for RTCP presence.
int	zombieLifetimeMs
	[Optional, Default: 15000] The number of milliseconds that a "zombified" RTP processor is kept around before being removed for good
int	signalledInboundProcessorInactivityMs
	[Optional, Default: inboundProcessorInactivityMs * 4] The number of milliseconds of RTP inactivity on an Engage-native/signalled (i.e. where end-of-tx is expected) stream before heuristically determining the end of talk spurt
Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

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

Detailed Description

Configuration for the optional RtpProfile.

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

Example:

See also

ConfigurationObjects::Group

Definition at line 4619 of file ConfigurationObjects.h.

Member Enumeration Documentation

JitterMode_t

enum AppConfigurationObjects::RtpProfile::JitterMode_t

Jitter buffer mode.

Operation mode for the jitter buffer.

Enumerator
jmStandard	Default.
jmLowLatency	Low latency.
jmReleaseOnTxEnd	The jitter buffer releases upon positive end of TX notification.

Definition at line 4630 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

RtpProfile()

AppConfigurationObjects::RtpProfile::RtpProfile ( )

inline

Definition at line 4694 of file ConfigurationObjects.h.

Member Function Documentation

clear()

void AppConfigurationObjects::RtpProfile::clear ( )

inline

Definition at line 4699 of file ConfigurationObjects.h.

Member Data Documentation

inboundProcessorInactivityMs

int AppConfigurationObjects::RtpProfile::inboundProcessorInactivityMs

[Optional, Default: 500] The number of milliseconds of RTP inactivity before heuristically determining the end of talk spurt

Definition at line 4682 of file ConfigurationObjects.h.

jitterForceTrimAtMs

int AppConfigurationObjects::RtpProfile::jitterForceTrimAtMs

[Optional, Default: 0] Forces trimming of the jitter buffer if the queue length is greater (and not zero)

Definition at line 4670 of file ConfigurationObjects.h.

jitterMaxExceededClipHangMs

int AppConfigurationObjects::RtpProfile::jitterMaxExceededClipHangMs

[Optional, Default: 1500] Number of milliseconds for which the jitter buffer may exceed max before clipping is actually applied.

Definition at line 4679 of file ConfigurationObjects.h.

jitterMaxExceededClipPerc

int AppConfigurationObjects::RtpProfile::jitterMaxExceededClipPerc

[Optional, Default: 10] Percentage by which maximum number of samples in the queue exceeded computed max before large-scale clipping .

Definition at line 4676 of file ConfigurationObjects.h.

jitterMaxFactor

int AppConfigurationObjects::RtpProfile::jitterMaxFactor

[Optional, Default: 8] The factor by which to multiply the jitter buffer's active low-water to determine the high-water mark

Definition at line 4652 of file ConfigurationObjects.h.

jitterMaxMs

int AppConfigurationObjects::RtpProfile::jitterMaxMs

[Optional, Default: 10000] Maximum number of milliseconds allowed in the queue

Definition at line 4646 of file ConfigurationObjects.h.

jitterMaxTrimMs

int AppConfigurationObjects::RtpProfile::jitterMaxTrimMs

[Optional, Default: 250] Maximum number of milliseconds to be trimmed from a jitter buffer at any one point

Definition at line 4673 of file ConfigurationObjects.h.

jitterMinMs

int AppConfigurationObjects::RtpProfile::jitterMinMs

[Optional, Default: 100] Low-water mark for jitter buffers that are in a buffering state.

Definition at line 4649 of file ConfigurationObjects.h.

jitterTrimPercentage

int AppConfigurationObjects::RtpProfile::jitterTrimPercentage

[Optional, Default: 10] The percentage of the overall jitter buffer sample count to trim when potential buffer overflow is encountered

Definition at line 4661 of file ConfigurationObjects.h.

jitterUnderrunReductionAger

int AppConfigurationObjects::RtpProfile::jitterUnderrunReductionAger

[Optional, Default: 100] Number of jitter buffer operations after which to reduce any underrun

Definition at line 4667 of file ConfigurationObjects.h.

jitterUnderrunReductionThresholdMs

int AppConfigurationObjects::RtpProfile::jitterUnderrunReductionThresholdMs

[Optional, Default: 1500] Number of milliseconds of error-free operations in a jitter buffer before the underrun counter begins reducing

Definition at line 4664 of file ConfigurationObjects.h.

latePacketSequenceRange

int AppConfigurationObjects::RtpProfile::latePacketSequenceRange

[Optional, Default: 5] The delta in RTP sequence numbers in order to heuristically determine the start of a new talk spurt

Definition at line 4655 of file ConfigurationObjects.h.

latePacketTimestampRangeMs

int AppConfigurationObjects::RtpProfile::latePacketTimestampRangeMs

[Optional, Default: 500] The delta in milliseconds in order to heuristically determine the start of a new talk spurt

Definition at line 4658 of file ConfigurationObjects.h.

mode

JitterMode_t AppConfigurationObjects::RtpProfile::mode

[Optional, Default: jmStandard] Specifies the operation mode (see JitterMode_t).

Definition at line 4643 of file ConfigurationObjects.h.

rtcpPresenceTimeoutMs

int AppConfigurationObjects::RtpProfile::rtcpPresenceTimeoutMs

[Optional, Default: 45000] Timeout for RTCP presence.

Definition at line 4685 of file ConfigurationObjects.h.

signalledInboundProcessorInactivityMs

int AppConfigurationObjects::RtpProfile::signalledInboundProcessorInactivityMs

[Optional, Default: inboundProcessorInactivityMs * 4] The number of milliseconds of RTP inactivity on an Engage-native/signalled (i.e. where end-of-tx is expected) stream before heuristically determining the end of talk spurt

Definition at line 4692 of file ConfigurationObjects.h.

zombieLifetimeMs

int AppConfigurationObjects::RtpProfile::zombieLifetimeMs

[Optional, Default: 15000] The number of milliseconds that a "zombified" RTP processor is kept around before being removed for good

Definition at line 4688 of file ConfigurationObjects.h.

---

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

• c/include/ConfigurationObjects.h