Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DMXProtocol > IO > FDMXPort

Light Theme

Dark Theme

FDMXPort

Base class for a higher level abstraction of a DMX input or output.

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FDMXPort

	FDMXInputPort
	FDMXOutputPort

References

Module	DMXProtocol
Header	/Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXPort.h
Include	#include "IO/DMXPort.h"

Syntax

class FDMXPort : public TSharedFromThis< FDMXPort, ESPMode::ThreadSafe >

Remarks

Base class for a higher level abstraction of a DMX input or output. Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity.

Variables

	Name	Description
EDMXCommunicati...	CommunicationType	The communication type of this port
FString	DeviceAddress	The address of the device that handles communication, e.g. the network interface for art-net
int32	ExternUniverseStart	The start address this being transposed to.
int32	LocalUniverseStart	The Local Start Universe
int32	NumUniverses	Number of Universes
FSimpleMulticas...	OnPortUpdated	Broadcast when the port is updated
FString	PortName	Variables that need be initialized from derived classes.
IDMXProtocolPtr	Protocol	The protocol of this port

Constructors

	Name	Description
	FDMXPort()	Protected default constructor, child classes need to take care of member initialization

Destructors

	Name	Description
	~FDMXPort()	~End DMXPort Interface declaration

Functions

	Name	Description
void	AddRawInput ( TSharedRef< FDMXRawListener > InRaw... )	Adds a Input that receives all raw signals received on this port.
int32	ConvertExternToLocalUniverseID ( int32 ExternUniverseID )	Converts an extern Universe ID to a local Universe ID
int32	ConvertLocalToExternUniverseID ( int32 LocalUniverseID )	Converts a local Universe ID to an extern Universe ID
EDMXCommunic...	GetCommunicationType()
const FStrin...	GetDeviceAddress()
int32	GetExternUniverseEnd()
int32	GetExternUniverseOffset()	Returns the offset of the extern universe. LocalUniverse == ExternUniverse - ExternUniverseOffset
int32	GetExternUniverseStart()
int32	GetLocalUniverseEnd()
int32	GetLocalUniverseStart()
const FGuid ...	GetPortGuid()	Returns the Guid of the Port
const FStrin...	GetPortName()
const IDMXPr...	GetProtocol()
bool	IsExternUniverseInPortRange ( int32 Universe )	Returns true if the Extern Universe is in this Port's Universe range
bool	IsLocalUniverseInPortRange ( int32 Universe )	Returns true if the Intern Universe is in this Port's Universe range
bool	IsRegistered()	~Begin DMXPort Interface declaration
bool	IsValidPortSlow()	Tests whether the port is valid
bool	Register()	Registers the port with its protocol. Returns true if successfully registered
void	RemoveRawInput ( TSharedRef< FDMXRawListener > RawIn... )	Removes the raw Input from the port.
void	Unregister()	Unregisteres the port if it was registered with its protocol

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss