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

Streaming configuration for RP clients. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  CryptoType_t {
  ctUnknown = 0 , ctSharedKeyAes256FullIv = 1 , ctSharedKeyAes256IdxIv = 2 , ctSharedKeyChaCha20FullIv = 3 ,
  ctSharedKeyChaCha20IdxIv = 4
}
 Enum describing UDP streaming modes. 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

bool enabled
 [Optional, Default true] If true, enables UDP streaming unless turned off on a per-family basis.
 
CryptoType_t cryptoType
 [Optional, Default ctSharedKeyAes256FullIv] The crypto method to be used
 
int listenPort
 UDP port to listen on. Default is 7444.
 
RallypointUdpStreamingIpvX ipv4
 IPv4

 
RallypointUdpStreamingIpvX ipv6
 IPv6.
 
int keepaliveIntervalSecs
 [Optional, Default: 15] Interval (seconds) at which to send UDP keepalives
 
TxPriority_t priority
 [Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based on how their IP stack operates. It may or may not affect final packet marking.
 
int ttl
 [Optional, Default: 64] Time to live or hop limit.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Streaming configuration for RP clients.

Example:

Definition at line 8266 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ CryptoType_t

Enum describing UDP streaming modes.

Enumerator
ctUnknown 

Unknown.

ctSharedKeyAes256FullIv 

Shared-key, AES256 full IV.

ctSharedKeyAes256IdxIv 

Shared-key, AES256 indexed IV.

ctSharedKeyChaCha20FullIv 

Shared-key, ChaCha20 full IV.

ctSharedKeyChaCha20IdxIv 

Shared-key, ChaCha20 indexed IV.

Definition at line 8273 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ RallypointUdpStreaming()

AppConfigurationObjects::RallypointUdpStreaming::RallypointUdpStreaming ( )
inline

Definition at line 8316 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RallypointUdpStreaming::clear ( )
inline

Definition at line 8321 of file ConfigurationObjects.h.

Member Data Documentation

◆ cryptoType

CryptoType_t AppConfigurationObjects::RallypointUdpStreaming::cryptoType

[Optional, Default ctSharedKeyAes256FullIv] The crypto method to be used

Definition at line 8295 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::RallypointUdpStreaming::enabled

[Optional, Default true] If true, enables UDP streaming unless turned off on a per-family basis.

Definition at line 8292 of file ConfigurationObjects.h.

◆ ipv4

RallypointUdpStreamingIpvX AppConfigurationObjects::RallypointUdpStreaming::ipv4

IPv4

Definition at line 8301 of file ConfigurationObjects.h.

◆ ipv6

RallypointUdpStreamingIpvX AppConfigurationObjects::RallypointUdpStreaming::ipv6

IPv6.

Definition at line 8304 of file ConfigurationObjects.h.

◆ keepaliveIntervalSecs

int AppConfigurationObjects::RallypointUdpStreaming::keepaliveIntervalSecs

[Optional, Default: 15] Interval (seconds) at which to send UDP keepalives

Definition at line 8307 of file ConfigurationObjects.h.

◆ listenPort

int AppConfigurationObjects::RallypointUdpStreaming::listenPort

UDP port to listen on. Default is 7444.

Definition at line 8298 of file ConfigurationObjects.h.

◆ priority

TxPriority_t AppConfigurationObjects::RallypointUdpStreaming::priority

[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based on how their IP stack operates. It may or may not affect final packet marking.

Definition at line 8310 of file ConfigurationObjects.h.

◆ ttl

int AppConfigurationObjects::RallypointUdpStreaming::ttl

[Optional, Default: 64] Time to live or hop limit.

Definition at line 8313 of file ConfigurationObjects.h.


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