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 > Interfaces > IDMXProtocol

Light Theme

Dark Theme

IDMXProtocol

Generic protocol interface, it should be inherited by all protocol implementations.

Windows

MacOS

Linux

Inheritance Hierarchy

IDMXProtocolBase

IDMXProtocolRDM

IDMXProtocol

References

Module	DMXProtocol
Header	/Engine/Plugins/Experimental/DigitalMultiplex/DMXProtocol/Source/DMXProtocol/Public/Interfaces/IDMXProtocol.h
Include	#include "Interfaces/IDMXProtocol.h"

Syntax

class IDMXProtocol :
public IDMXProtocolBase,
public IDMXProtocolRDM

Remarks

Generic protocol interface, it should be inherited by all protocol implementations.

Functions

	Name	Description
TSharedPtr< ...	AddUniverse ( const FJsonObject& InSettings )	Add universe to the manager
void	CollectUniverses ( const TArray< FDMXUniverse >& Univ... )	Collects the universes related to a UniverseManger Entity and add them to the protocol to be used for communication.
IDMXProtocol...	Get ( const FName& ProtocolName )	If protocol exists return the pointer otherwise it create a new protocol first and then return the pointer.
uint16	GetFinalSendUniverseID ( uint16 InUniverseID )	Gets the final protocol universe ID to send This is implemented protocol-specific offset
FName	GetFirstProtocolName()
uint16	GetMaxUniverses()	Get maximum supported universes in protocol
uint16	GetMinUniverseID()	Get minimum supported universe ID for protocol
FOnUniverseI...	GetOnUniverseInputUpdate()
const TMap< ...	GetProtocolFactories()
const FName ...	GetProtocolName()	Get the Protocol Name
const TArray...	GetProtocolNames()
const TMap< ...	GetProtocols()
TSharedPtr< ...	GetSenderInterface()	Get the Protocol Sender Interface Sender interface holds the functionality to queue and physically send the DMX buffer
TSharedPtr< ...	GetSettings()	Get the protocol settings
TSharedPtr< ...	GetUniverseById ( uint32 InUniverseId )	Getting Universe from the Protocol Universe Manager.
uint32	GetUniversesNum()	Get current amount of universes in the Map
bool	IsEnabled()	Whether protocol enabled
void	RemoveAllUniverses()	Remove all universes from protocol manager
bool	RemoveUniverseById ( uint32 InUniverseId )	Remove Universe from the Protocol Universe Manager.
EDMXSendResu...	SendDMXFragment ( uint16 UniverseID, const IDMXFragmentMap& DMXFragment )	Sets the DMX fragment for a particular universe
EDMXSendResu...	SendDMXFragmentCreate ( uint16 UniverseID, const IDMXFragmentMap& DMXFragment )	Sets the DMX fragment for a particular universe Create protocol Universe if it does not exist

Classes

	Name	Description
	FOnUniverseInputUpdateEvent	Called on input universe. Parameters represent: Protocol Name, UniverseID and Buffer

Constants

Name	Description
OnNetworkInterfaceChanged	IDMXProtocol.h static declarations

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

Take our survey

Dismiss