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

#include <receiver.h>

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

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

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

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

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

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

unsigned int	flags {0}
	A set of option flags.

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

Detailed Description

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

Constructor & Destructor Documentation

sacn::Receiver::Settings::Settings ( uint16_t new_universe_id )

inline

Instantiates receiver settings based on a universe ID.

Create a Receiver 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.

unsigned int sacn::Receiver::Settings::flags {0}

A set of option flags.

See the C API's "sACN receiver flags".

The footprint within the universe to monitor.

TODO: Currently unimplemented and thus ignored.

int sacn::Receiver::Settings::source_count_max {kSacnReceiverInfiniteSources}

The maximum number of sources this universe will listen to.

May be kSacnReceiverInfiniteSources. When configured to use static memory, this parameter is only used if it's less than SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE – otherwise SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE is used instead.

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