Navigation
API > API/Plugins > API/Plugins/DMXProtocol
Inheritance Hierarchy
- IModuleInterface
- FDMXProtocolModule
References
| Module | DMXProtocol |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolModule.h |
| Include | #include "DMXProtocolModule.h" |
Syntax
class FDMXProtocolModule : public IModuleInterface
Remarks
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
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FDMXProtocolModule & | Get () |
Get the instance of this module. |
  |
FDMXOnRequestProtocolBlocklistEvent & | ||
  |
FDMXOnRequestProtocolRegistrationEvent & | ||
  |
IDMXProtocolPtr | GetProtocol
(
const FName InProtocolName |
If protocol exists return the pointer otherwise it create a new protocol first and then return the pointer. |
  |
const TMap< FName, IDMXProtocolFactory * > & | Get the reference to all protocol factories map | |
  |
const TMap< FName, IDMXProtocolPtr > & | GetProtocols () |
Get the reference to all protocols map |
 |
void | UnregisterProtocol
(
const FName& ProtocolName |
Overridden from IModuleInterface
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called before the module is unloaded, right before the module object is destroyed. | |
  |
void | Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
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 | Description |
|---|---|
| DefaultProtocolArtNetName | |
| DefaultProtocolSACNName | |
| OnRequestProtocolBlocklistEvent | |
| OnRequestProtocolRegistrationEvent |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | RegisterProtocol
(
const FName& ProtocolName, |
Please use the OnRequestProtocolRegistration event instead. |