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

#include <receiver.h>

Public Member Functions
	Settings ()=default

	Settings (uint16_t new_universe_id)
	Create a Receiver 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}

unsigned int	flags {0}

sacn_ip_support_t	ip_supported {kSacnIpV4AndIpV6}

Detailed Description

A set of configuration settings that a 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 Receiver Settings instance by passing the required members explicitly.

Instantiates 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 Reciever Settings instance contains valid data for sACN operation.

Field Documentation

◆ flags

unsigned int flags {0}

A set of option flags. See the C API's "sACN receiver flags".

◆ 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 receiver will support.

◆ source_count_max

int source_count_max {SACN_RECEIVER_INFINITE_SOURCES}

The maximum number of sources this universe will listen to. May be SACN_RECEIVER_INFINITE_SOURCES. 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.

◆ universe_id

uint16_t universe_id {0}

The sACN universe number the receiver is listening to.

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

include/sacn/cpp/receiver.h

Public Member Functions

Data Fields