dmx_merger.h File Reference

sACN DMX Merger API definitions More...

Go to the source code of this file.

Data Structures
struct	SacnDmxMergerConfig
struct	SacnDmxMergerSource

Macros
#define	SACN_DMX_MERGER_INVALID   -1
#define	SACN_DMX_MERGER_SOURCE_INVALID   ((sacn_dmx_merger_source_t)-1)
#define	SACN_DMX_MERGER_CONFIG_INIT
	An initializer for an SacnDmxMergerConfig struct.
#define	SACN_DMX_MERGER_SOURCE_IS_VALID(owners_array, slot_index)    (owners_array[slot_index] != SACN_DMX_MERGER_SOURCE_INVALID)
	Utility to see if a slot owner is valid.

Typedefs
typedef int	sacn_dmx_merger_t
typedef uint16_t	sacn_dmx_merger_source_t
typedef struct SacnDmxMergerConfig	SacnDmxMergerConfig
typedef struct SacnDmxMergerSource	SacnDmxMergerSource

Functions
etcpal_error_t	sacn_dmx_merger_create (const SacnDmxMergerConfig *config, sacn_dmx_merger_t *handle)
	Create a new merger instance.
etcpal_error_t	sacn_dmx_merger_destroy (sacn_dmx_merger_t handle)
	Destroy a merger instance.
etcpal_error_t	sacn_dmx_merger_add_source (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t *source_id)
	Adds a new source to the merger.
etcpal_error_t	sacn_dmx_merger_remove_source (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source)
	Removes a source from the merger.
const SacnDmxMergerSource *	sacn_dmx_merger_get_source (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source)
	Gets a read-only view of the source data.
etcpal_error_t	sacn_dmx_merger_update_levels (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source, const uint8_t *new_levels, size_t new_levels_count)
	Updates a source's levels and recalculates outputs.
etcpal_error_t	sacn_dmx_merger_update_pap (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source, const uint8_t *pap, size_t pap_count)
	Updates a source's per-address priorities (PAP) and recalculates outputs.
etcpal_error_t	sacn_dmx_merger_update_universe_priority (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source, uint8_t universe_priority)
	Updates a source's universe priority and recalculates outputs.
etcpal_error_t	sacn_dmx_merger_remove_pap (sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source)
	Removes the per-address priority (PAP) data from the source and recalculate outputs.

Detailed Description

sACN DMX Merger API definitions

Functions and definitions for the sACN DMX Merger API are contained in this header.