sacn Namespace Reference

A namespace which contains all C++ language definitions in the sACN library. More...

Classes
class	DmxMerger
	An instance of sACN DMX Merger functionality; see Using the sACN DMX Merger API. More...
struct	LibrarySettings
	Settings for the sACN library beyond the sacn::Init overrides. More...
class	MergeReceiver
	An instance of sACN Merge Receiver functionality; see Using the sACN Merge Receiver API. More...
class	NotifyHandler
	A base class for a class that receives common notification callbacks from sACN. More...
class	Receiver
	An instance of sACN Receiver functionality; see Using the sACN Receiver API. More...
class	Source
	An instance of sACN Source functionality; see Using the sACN Source API. More...
class	SourceDetector
	An instance of sACN Source Detector functionality. More...

Typedefs
using	RemoteSourceHandle = sacn_remote_source_t
	A source discovered on an sACN network that has a CID - used by Receiver and Merge Receiver.

Enumerations
enum class	McastMode {   kEnabledOnAllInterfaces ,   kDisabledOnAllInterfaces }
	Determines whether multicast traffic is allowed through all interfaces or none.

Functions
etcpal::Error	Init (sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (const EtcPalLogParams *log_params, sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (const EtcPalLogParams *log_params, McastMode mcast_mode, sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (const EtcPalLogParams *log_params, std::vector< SacnMcastInterface > &sys_netints, sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (std::vector< SacnMcastInterface > &sys_netints, sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (const etcpal::Logger &logger, McastMode mcast_mode=McastMode::kEnabledOnAllInterfaces, sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (const etcpal::Logger &logger, sacn_features_t features, const LibrarySettings &settings={})
	Initialize the sACN library.
etcpal::Error	Init (const etcpal::Logger &logger, std::vector< SacnMcastInterface > &sys_netints, sacn_features_t features=SACN_FEATURES_ALL, const LibrarySettings &settings={})
	Initialize the sACN library.
void	Deinit (sacn_features_t features=SACN_FEATURES_ALL)
	Deinitialize features of the sACN library.
RemoteSourceHandle	GetRemoteSourceHandle (const etcpal::Uuid &source_cid)
	Converts a remote source CID to the corresponding handle, or kSacnRemoteSourceInvalid if not found.
etcpal::Expected< etcpal::Uuid >	GetRemoteSourceCid (RemoteSourceHandle source_handle)
	Converts a remote source handle to the corresponding source CID.

Variables
constexpr RemoteSourceHandle	kInvalidRemoteSourceHandle = kSacnRemoteSourceInvalid
	An invalid RemoteSourceHandle value.
constexpr uint16_t	kMinimumUniverse = kSacnMinimumUniverse
	The lowest sACN universe number supported.
constexpr uint16_t	kMaximumUniverse = kSacnMaximumUniverse
	The highest sACN universe number supported.

Detailed Description

A namespace which contains all C++ language definitions in the sACN library.

Function Documentation

Deinit()

void sacn::Deinit ( sacn_features_t features = SACN_FEATURES_ALL )

inline

Deinitialize features of the sACN library.

Set sACN library feature(s) back to an uninitialized state if deinit is called as many times as init for a given feature. Calls to deinitialized sACN API functions will fail until sacn_init() is called again for their feature(s).

This function is not thread safe with respect to other sACN API functions. Make sure to join your threads that use the APIs before calling this.

Parameters

[in]

features

Mask of sACN features to deinitialize (defaults to all features).