common.h File Reference

C++ wrapper for the sACN init/deinit functions. More...

#include "etcpal/cpp/error.h"
#include "etcpal/cpp/log.h"
#include "etcpal/cpp/uuid.h"
#include "sacn/common.h"

Go to the source code of this file.

Classes
class	sacn::NotifyHandler
	A base class for a class that receives common notification callbacks from sACN. More...
struct	sacn::LibrarySettings
	Settings for the sACN library beyond the sacn::Init overrides. More...

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

Typedefs
using	sacn::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	sacn::McastMode {   kEnabledOnAllInterfaces ,   kDisabledOnAllInterfaces }
	Determines whether multicast traffic is allowed through all interfaces or none.

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

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

Detailed Description

C++ wrapper for the sACN init/deinit functions.