DMX Input and Output

Query DMX universe information. Read and write DMX data. More...

Typedefs
typedef int(RCCALL *	TRCUniverseCount )(int)
typedef int(RCCALL *	TRCUniverseQuery )(int, unsigned int, char *, unsigned int, enum RCUniverseDirection *, unsigned int *)
typedef int(RCCALL *	TRCUniverseWrite )(int, unsigned int, unsigned int, const unsigned char *, unsigned int)
typedef int(RCCALL *	TRCUniverseRead )(int, unsigned int, unsigned int, unsigned char *, unsigned int)
typedef int(RCCALL *	TRCUniverseUpdate )(int, unsigned int)

Functions
int RCAPI	RCUniverseCount (int handle)
	Query universe count of device. More...
int RCAPI	RCUniverseQuery (int handle, unsigned int universeIndex, char *universeName, unsigned int maxLength, enum RCUniverseDirection *pUniverseDirection, unsigned int *pChannelCount)
	Query universe information. More...
int RCAPI	RCUniverseWrite (int handle, unsigned int universeIndex, unsigned int startChannel, const unsigned char *data, unsigned int count)
	Write to output universe. More...
int RCAPI	RCUniverseRead (int handle, unsigned int universeIndex, unsigned int startChannel, unsigned char *data, unsigned int count)
	Read from input universe. More...
int RCAPI	RCUniverseUpdate (int handle, unsigned int universeIndex)
	Flush Universe. More...

Detailed Description

Query DMX universe information. Read and write DMX data.

Typedef Documentation

typedef int(RCCALL * TRCUniverseCount)(int)

Function type definition for RCUniverseCount()

typedef int(RCCALL * TRCUniverseQuery)(int, unsigned int, char *, unsigned int, enum RCUniverseDirection *, unsigned int *)

Function type definition for RCUniverseQuery()

typedef int(RCCALL * TRCUniverseWrite)(int, unsigned int, unsigned int, const unsigned char *, unsigned int)

Function type definition for RCUniverseWrite()

typedef int(RCCALL * TRCUniverseRead)(int, unsigned int, unsigned int, unsigned char *, unsigned int)

Function type definition for RCUniverseRead()

typedef int(RCCALL * TRCUniverseUpdate)(int, unsigned int)

Function type definition for RCUniverseUpdate()

Function Documentation

int RCAPI RCUniverseCount

(

int

handle

)

Query universe count of device.

This function returns how many universes exist for the device specified by devicehandle.

Parameters

handle

Device handle as obtained by RCOpenDevice()

Returns

The number of universes present on the device. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.

int RCAPI RCUniverseQuery	(	int	handle,
		unsigned int	universeIndex,
		char *	universeName,
		unsigned int	maxLength,
		enum RCUniverseDirection *	pUniverseDirection,
		unsigned int *	pChannelCount
	)

Query universe information.

This function returns the universe name, if it is an input or an output and the channel count.

Parameters

handle	Device handle as obtained by RCOpenDevice()
universeIndex	Universe Index. Range is 0 to the number returned by RCUniverseCount() -1
universeName	Pointer to the buffer where the universe name will be copied
maxLength	Length of buffer passed in deviceLabel
pUniverseDirection	pointer to universe Direction variable will be set to either RCOutput or RCInput
pChannelCount	Pointer to Channel count. Will be set the the channel count of the universe

Returns

The number of characters written to universeName. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.

int RCAPI RCUniverseWrite	(	int	handle,
		unsigned int	universeIndex,
		unsigned int	startChannel,
		const unsigned char *	data,
		unsigned int	count
	)

Write to output universe.

Parameters

handle	Device handle as obtained by RCOpenDevice()
universeIndex	Universe Index. Range is 0 to the number returned by RCUniverseCount() -1
startChannel	First channel to write. startChannel 0 is the first DMX channel.
data	Pointer to dmx value buffer
count	Number of channels to write

Returns

RCOk on success. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.

int RCAPI RCUniverseRead	(	int	handle,
		unsigned int	universeIndex,
		unsigned int	startChannel,
		unsigned char *	data,
		unsigned int	count
	)

Read from input universe.

Parameters

handle	Device handle as obtained by RCOpenDevice()
universeIndex	Universe Index. Range is 0 to the number returned by RCUniverseCount() -1
startChannel	First channel to write. 0 is the first channel.
data	Pointer to dmx value buffer
count	Number of channels to read

Returns

RCOk on success. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.

int RCAPI RCUniverseUpdate	(	int	handle,
		unsigned int	universeIndex
	)

Flush Universe.

Parameters

handle	Device handle as obtained by RCOpenDevice()
universeIndex	Universe Index. Range is 0 to the number returned by RCUniverseCount() -1

Returns

RCOk on success. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.