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

#include <merge_receiver.h>

Public Member Functions
	Settings ()=default
	Create an empty, invalid data structure by default.

	Settings (uint16_t new_universe_id)
	Instantiates merge receiver settings based on a universe ID.

bool	IsValid () const
	Determine whether a MergeReciever Settings instance contains valid data for sACN operation.

Public Attributes
uint16_t	universe_id {0}
	The sACN universe number the merge receiver is listening to.

SacnRecvUniverseSubrange	footprint {1, SACN_MERGE_RECEIVER_MAX_SLOTS}
	The footprint within the universe to monitor.

int	source_count_max {kSacnReceiverInfiniteSources}
	The maximum number of sources this universe will listen to when using dynamic memory.

bool	use_pap {true}
	If true, this allows per-address priorities (if any are received) to be fed into the merger.

sacn_ip_support_t	ip_supported {kSacnIpV4AndIpV6}
	What IP networking the merge receiver will support.

Detailed Description

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

Constructor & Destructor Documentation

◆ Settings()

sacn::MergeReceiver::Settings::Settings ( uint16_t new_universe_id )

inline

Instantiates merge receiver settings based on a universe ID.

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

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 Data Documentation

◆ footprint

SacnRecvUniverseSubrange sacn::MergeReceiver::Settings::footprint {1, SACN_MERGE_RECEIVER_MAX_SLOTS}

The footprint within the universe to monitor.

TODO: Currently unimplemented and thus ignored.

◆ use_pap

bool sacn::MergeReceiver::Settings::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