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

Light Theme

Dark Theme

FDMXInputPort

Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity from the game.

Windows

MacOS

Linux

Inheritance Hierarchy

FDMXPort

FTickableGameObject

FDMXInputPort

References

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

Syntax

class FDMXInputPort :
public FDMXPort,
public FTickableGameObject

Remarks

Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity from the game.

To input DMX into your objects, refer to DMXRawListener and DMXTickedUniverseListener.

Can only be constructed via DMXPortManger, see FDMXPortManager::CreateInputPort and FDMXPortManager::CreateInputPortFromConfig

Variables

		Name	Description
	bool	bReceiveDMXEnabled	According to DMXProtcolSettings, true if DMX should be received

Destructors

	Name	Description
	~FDMXInputPort()

Functions

	Name	Description
void	ClearBuffers()	Clears all buffers
FDMXInputPor...	CreateFromConfig ( FDMXInputPortConfig& InputPortConf... )	Creates an output port tied to a specific config. Makes the config valid if it's invalid.
const TMap< ...	GameThreadGetAllDMXSignals()	Gets all the last signal received. Game-Thread only
bool	GameThreadGetDMXSignal ( int32 LocalUniverseID, FDMXSignalSharedPtr& OutDMXSignal )	Gets the last signal received in specified local universe.
void	GameThreadInjectDMXSignal ( const FDMXSignalSharedRef& DMXSign... )	Injects a dmx signal into the game thread.
bool	IsReceiveDMXEnabled()	Returns true if receive DMX is disabled
void	OnSetReceiveDMXEnabled ( bool bEnabled )	Called to set if receive DMX should be enabled
void	SetUseDefaultQueue ( bool bUse )	Sets if the port should listen to its default queue.
void	SingleProducerInputDMXSignal ( const FDMXSignalSharedRef& DMXSign... )	Single Producer thread-safe: Pushes a DMX Signal into the buffer (For protocol only)
void	UpdateFromConfig ( FDMXInputPortConfig& InputPortConf... )	Updates the Port to use the config of the InputPortConfig. Makes the config valid if it's invalid.

Overridden from FDMXPort

	Name	Description
void	AddRawInput ( TSharedRef< FDMXRawListener > InRaw... )	Adds a Raw Input that receives all raw signals received on this port.
const FGuid ...	GetPortGuid()	Returns the Guid of the Port
bool	IsRegistered()	Returns true if the port is successfully registered with its protocol
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

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
ETickableTic...	GetTickableTickType()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Deprecated Functions

		Name	Description
	bool	GameThreadGetDMXSignalFromRemoteUniverse ( FDMXSignalSharedPtr& OutDMXSignal, int32 RemoteUniverseID, bool bEvenIfNotLoopbackToEngine )	Use GameThreadGetDMXSignal instead. GameThreadGetDMXSignalFromRemoteUniverse only exists to support deprecated blueprint nodes.

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

Take our survey

Dismiss