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

A set of configuration information for a sACN source. More...

#include <source.h>

Public Attributes

EtcPalUuid cid
 The source's CID.
 
const char * name
 The source's name, a UTF-8 encoded string.
 
size_t universe_count_max
 The maximum number of universes this source will send to.
 
bool manually_process_source
 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.
 
sacn_ip_support_t ip_supported
 What IP networking the source will support.
 
int keep_alive_interval
 The interval at which the source will send keep-alive NULL start code packets during transmission suppression, in milliseconds.
 
int pap_keep_alive_interval
 The interval at which the source will send keep-alive per-address priority packets during transmission suppression, in milliseconds.
 

Detailed Description

A set of configuration information for a sACN source.

Member Data Documentation

◆ ip_supported

sacn_ip_support_t SacnSourceConfig::ip_supported

What IP networking the source will support.

The default is kSacnIpV4AndIpV6.

◆ keep_alive_interval

int SacnSourceConfig::keep_alive_interval

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

The default is kSacnSourceKeepAliveIntervalDefault.

◆ manually_process_source

bool SacnSourceConfig::manually_process_source

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 sacn_source_process_manual() such that all needed start codes are sent at its maximum DMX rate, typically 23 ms.

◆ pap_keep_alive_interval

int SacnSourceConfig::pap_keep_alive_interval

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

The default is kSacnSourcePapKeepAliveIntervalDefault.

◆ universe_count_max

size_t SacnSourceConfig::universe_count_max

The maximum number of universes this source will send to.

May be kSacnSourceInfiniteUniverses. This parameter is ignored when configured to use static memory – SACN_SOURCE_MAX_UNIVERSES_PER_SOURCE is used instead.


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