A set of configuration settings for a new universe on a source. More...

#include <source.h>

Public Member Functions
	UniverseSettings ()=default

	UniverseSettings (uint16_t universe_id)
	Create a Universe Settings instance by passing the required members explicitly.

bool	IsValid () const

Data Fields
uint16_t	universe {0}

uint8_t	priority {100}

bool	send_preview {false}

bool	send_unicast_only {false}

const std::vector< etcpal::IpAddr >	unicast_destinations

uint16_t	sync_universe {0}

Detailed Description

A set of configuration settings for a new universe on a source.

Constructor & Destructor Documentation

◆ UniverseSettings() [1/2]

UniverseSettings ( )

default

Create an empty, invalid data structure by default.

◆ UniverseSettings() [2/2]

UniverseSettings ( uint16_t universe_id )

inline

Create a Universe 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 Universe Settings instance contains valid data for sACN operation.

Field Documentation

◆ priority

uint8_t priority {100}

The sACN universe priority that is sent in each packet. This is only allowed to be from 0 - 200. Defaults to

◆ send_preview

bool send_preview {false}

If true, this sACN source will send preview data. Defaults to false.

◆ send_unicast_only

bool send_unicast_only {false}

If true, this sACN source will only send unicast traffic on this universe. Defaults to false.

◆ sync_universe

uint16_t sync_universe {0}

If non-zero, this is the synchronization universe used to synchronize the sACN output. Defaults to 0. TODO: At this time, synchronization is not supported by this library.

◆ unicast_destinations

const std::vector<etcpal::IpAddr> unicast_destinations

The initial set of unicast destinations for this universe. This can be changed further by using Source::AddUnicastDestination() and Source::RemoveUnicastDestination().

◆ universe

uint16_t universe {0}

The universe number. At this time, only values from 1 - 63999 are accepted. You cannot have a source send more than one stream of levels to a single universe.

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

include/sacn/cpp/source.h

Public Member Functions

Data Fields