Navigation
API > API/Plugins > API/Plugins/DMXProtocol
Implements the Protocol Module, that enables specific Protocol implementations.
For use in Engine, see comments in DMXPortManager.h For protocol development, see comments in IDMXProtocol.h
| Name | FDMXProtocolModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolModule.h |
| Include Path | #include "DMXProtocolModule.h" |
Syntax
class FDMXProtocolModule : public IModuleInterface
Implements Interfaces
Classes
| Name | Remarks |
|---|---|
| FDMXOnRequestProtocolBlocklistEvent | Event broadcast so other Plugins can block specific protocols from registering. |
| FDMXOnRequestProtocolRegistrationEvent | Event Broadcast when protocols need to register with the Protocol Module. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DefaultProtocolArtNetName | const FName | DMXProtocolModule.h | |
| DefaultProtocolSACNName | const FName | DMXProtocolModule.h | |
| OnRequestProtocolBlocklistEvent | FDMXOnRequestProtocolBlocklistEvent | DMXProtocolModule.h | |
| OnRequestProtocolRegistrationEvent | FDMXOnRequestProtocolRegistrationEvent | DMXProtocolModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DMXProtocolFactories | TMap< FName, IDMXProtocolFactory * > | DMXProtocolModule.h | ||
| DMXProtocols | TMap< FName, IDMXProtocolPtr > | DMXProtocolModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual IDMXProtocolPtr GetProtocol
(
const FName InProtocolName |
If protocol exists return the pointer otherwise it create a new protocol first and then return the pointer. | DMXProtocolModule.h | |
const TMap< FName, IDMXProtocolFactory * > & GetProtocolFactories() |
Get the reference to all protocol factories map | DMXProtocolModule.h | |
| Get the reference to all protocols map | DMXProtocolModule.h | ||
void RegisterProtocol
(
const FName& ProtocolName, |
DMXProtocolModule.h | ||
void UnregisterProtocol
(
const FName& ProtocolName |
DMXProtocolModule.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ShutdownModule() |
DMXProtocolModule.h | ||
virtual void StartupModule() |
DMXProtocolModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FDMXProtocolModule & Get() |
Get the instance of this module. | DMXProtocolModule.h | |
static FDMXOnRequestProtocolBlocklistEvent & GetOnRequestProtocolBlocklist() |
DMXProtocolModule.h | ||
static FDMXOnRequestProtocolRegistrationEvent & GetOnRequestProtocolRegistration() |
DMXProtocolModule.h |