A set of configuration settings that a merge receiver needs to initialize. More...

#include <merge_receiver.h>

Public Member Functions
	Settings ()=default

	Settings (uint16_t new_universe_id)
	Create a MergeReceiver Settings instance by passing the required members explicitly.

bool	IsValid () const

Data Fields
uint16_t	universe_id {0}

SacnRecvUniverseSubrange	footprint {1, DMX_ADDRESS_COUNT}

int	source_count_max {SACN_RECEIVER_INFINITE_SOURCES}

bool	use_pap {true}

sacn_ip_support_t	ip_supported {kSacnIpV4AndIpV6}

Detailed Description

A set of configuration settings that a merge receiver needs to initialize.

Constructor & Destructor Documentation

◆ Settings() [1/2]

Settings ( )

default

Create an empty, invalid data structure by default.

◆ Settings() [2/2]

Settings ( uint16_t new_universe_id )

inline

Create a MergeReceiver Settings instance by passing the required members explicitly.

Instantiates merge receiver settings based on a universe ID. This constructor is not marked explicit on purpose so that a Settings instance can be implicitly constructed from a universe number.

Optional members can be modified directly in the struct.

Member Function Documentation

◆ IsValid()

bool IsValid ( ) const

inline

Determine whether a MergeReciever Settings instance contains valid data for sACN operation.

Field Documentation

◆ footprint

SacnRecvUniverseSubrange footprint {1, DMX_ADDRESS_COUNT}

The footprint within the universe to monitor. TODO: Currently unimplemented and thus ignored.

◆ ip_supported

sacn_ip_support_t ip_supported {kSacnIpV4AndIpV6}

What IP networking the merge receiver will support.

◆ source_count_max

int source_count_max {SACN_RECEIVER_INFINITE_SOURCES}

The maximum number of sources this universe will listen to when using dynamic memory.

◆ universe_id

uint16_t universe_id {0}

The sACN universe number the merge receiver is listening to.

◆ use_pap

bool use_pap {true}

If true, this allows per-address priorities (if any are received) to be fed into the merger. If false, received per-address priorities are ignored, and only universe priorities are used in the merger. Keep in mind that this setting will be ignored if SACN_ETC_PRIORITY_EXTENSION = 0, in which case per-address priorities are ignored.

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

include/sacn/cpp/merge_receiver.h

Public Member Functions

Data Fields