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

#include <source.h>

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

	Settings (etcpal::Uuid new_cid, std::string new_name)
	Create a Source Settings instance by passing the required members explicitly.

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

Public Attributes
etcpal::Uuid	cid
	The source's CID.

std::string	name
	The source's name, a UTF-8 encoded string.

size_t	universe_count_max {kSacnSourceInfiniteUniverses}
	The maximum number of universes this source will send to when using dynamic memory.

bool	manually_process_source {false}
	If false (default), this source will be added to a background thread that will send sACN updates at a maximum rate of every 23 ms.

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

int	keep_alive_interval {kSacnSourceKeepAliveIntervalDefault}
	The interval at which the source will send NULL start code keep-alive packets during transmission suppression, in milliseconds.

int	pap_keep_alive_interval {kSacnSourcePapKeepAliveIntervalDefault}
	The interval at which the source will send per-address priority keep-alive packets during transmission suppression, in milliseconds.

Detailed Description

A set of configuration settings that a source needs to initialize.

Constructor & Destructor Documentation

sacn::Source::Settings::Settings	(	etcpal::Uuid	new_cid,
		std::string	new_name )

inline

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

Optional members can be modified directly in the struct.

bool sacn::Source::Settings::manually_process_source {false}

If false (default), this source will be added to a background thread that will send sACN updates at a maximum rate of every 23 ms.

If true, the source will not be added to the thread and the application must call ProcessManual() at its maximum DMX rate, typically 23 ms.

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