sacn Namespace Reference

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

Data Structures
class	DmxMerger
	An instance of sACN DMX Merger functionality; see Using the sACN DMX Merger API. More...
class	MergeReceiver
	An instance of sACN Merge Receiver functionality; see Using the sACN Merge Receiver API. 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

Functions
etcpal::Error	Init (const EtcPalLogParams *log_params=nullptr)
	Initialize the sACN library.
etcpal::Error	Init (const EtcPalLogParams *log_params, std::vector< SacnMcastInterface > &sys_netints)
	Initialize the sACN library.
etcpal::Error	Init (std::vector< SacnMcastInterface > &sys_netints)
	Initialize the sACN library.
etcpal::Error	Init (const etcpal::Logger &logger)
	Initialize the sACN library.
etcpal::Error	Init (const etcpal::Logger &logger, std::vector< SacnMcastInterface > &sys_netints)
	Initialize the sACN library.
void	Deinit ()
	Deinitialize the sACN library.
RemoteSourceHandle	GetRemoteSourceHandle (const etcpal::Uuid &source_cid)
	Converts a remote source CID to the corresponding handle, or SACN_REMOTE_SOURCE_INVALID 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 = SACN_REMOTE_SOURCE_INVALID

Detailed Description

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

Typedef Documentation

RemoteSourceHandle

using RemoteSourceHandle = sacn_remote_source_t

A source discovered on an sACN network that has a CID - used by Receiver and Merge Receiver.

Variable Documentation

kInvalidRemoteSourceHandle

RemoteSourceHandle kInvalidRemoteSourceHandle = SACN_REMOTE_SOURCE_INVALID

constexpr

An invalid RemoteSourceHandle value.