sACN  HEAD (unstable)
Implementation of ANSI E1.31 (Streaming ACN)
View other versions:
Loading...
Searching...
No Matches
SacnRecvUniverseData Struct Reference

A complete description of newly received universe data within the configured footprint. More...

#include <receiver.h>

Public Attributes

uint16_t universe_id
 The sACN Universe identifier.
 
uint8_t priority
 The priority of the sACN data.
 
bool preview
 Whether the Preview_Data bit is set for the sACN data.
 
bool is_sampling
 True if this data is part of a sampling period, false otherwise.
 
uint16_t sync_universe
 The sync universe (TODO NOTE: sync is not fully implemented in the library).
 
uint8_t sequence
 The sequence number field directly from the packet.
 
uint8_t options
 The options field directly from the packet.
 
uint8_t start_code
 The start code of the DMX data.
 
SacnRecvUniverseSubrange slot_range
 The range of slots represented by this data (the intersection of the received data with the configured footprint).
 
const uint8_t * values
 Pointer to the slot values at the location indicated by slot_range.
 

Detailed Description

A complete description of newly received universe data within the configured footprint.

Member Data Documentation

◆ is_sampling

bool SacnRecvUniverseData::is_sampling

True if this data is part of a sampling period, false otherwise.

This could be false even if the receiver is in a sampling period. This is because not all sources need to be included in the sampling period triggered by a networking reset. Use this to determine whether or not this data can be safely treated as part of the current merge result for the universe.

◆ preview

bool SacnRecvUniverseData::preview

Whether the Preview_Data bit is set for the sACN data.

From E1.31: "Indicates that the data in this packet is intended for use in visualization or media server preview applications and shall not be used to generate live output."

◆ priority

uint8_t SacnRecvUniverseData::priority

The priority of the sACN data.

Valid range is 0-200, inclusive.

◆ universe_id

uint16_t SacnRecvUniverseData::universe_id

The sACN Universe identifier.

Valid range is 1-63999, inclusive.


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