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

#include <source.h>

Public Member Functions
	Settings ()=default

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

bool	IsValid () const

Data Fields
etcpal::Uuid	cid

std::string	name

size_t	universe_count_max {SACN_SOURCE_INFINITE_UNIVERSES}

bool	manually_process_source {false}

sacn_ip_support_t	ip_supported {kSacnIpV4AndIpV6}

int	keep_alive_interval {SACN_SOURCE_KEEP_ALIVE_INTERVAL_DEFAULT}

Detailed Description

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

Constructor & Destructor Documentation

◆ Settings() [1/2]

Settings ( )

default

Create an empty, invalid data structure by default.

◆ Settings() [2/2]

Settings	(	const etcpal::Uuid &	new_cid,
		const 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.

Member Function Documentation

◆ IsValid()

bool IsValid ( ) const

inline

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

Field Documentation

◆ cid

etcpal::Uuid cid

The source's CID.

◆ ip_supported

sacn_ip_support_t ip_supported {kSacnIpV4AndIpV6}

What IP networking the source will support.

◆ keep_alive_interval

int keep_alive_interval {SACN_SOURCE_KEEP_ALIVE_INTERVAL_DEFAULT}

The interval at which the source will send keep-alive packets during transmission suppression, in milliseconds.

◆ manually_process_source

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. 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.

◆ name

std::string name

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

◆ universe_count_max

size_t universe_count_max {SACN_SOURCE_INFINITE_UNIVERSES}

The maximum number of universes this source will send to when using dynamic memory.

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

include/sacn/cpp/source.h

Public Member Functions

Data Fields