1. Epic GamesDeveloper
  3. FDMXInputPort

FDMXInputPort

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

Unreal Engine C++ API Reference > Plugins > DMXProtocol > IO

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual bool

CheckPriority ( const int32 InPriority
)

  
Public function void Clears all buffers
Protected function Static FDMXInputPortSharedRef

CreateFromConfig ( FDMXInputPortConfig& InputPortConfig
)

 Creates an output port tied to a specific config. Makes the config valid if it's invalid.
Public function Const const TMap< int32, FDMXSignalSharedPtr > & Gets all the last signal received. Game-Thread only
Public function bool

GameThreadGetDMXSignal ( int32 LocalUniverseID,
FDMXSignalSharedPtr& OutDMXSignal
)

 Gets the last signal received in specified local universe.
Public function bool

GameThreadGetDMXSignalFromRemoteUniverse ( FDMXSignalSharedPtr& OutDMXSignal,
int32 RemoteUniverseID,
bool bEvenIfNotLoopbackToEngine
)

 DEPRECATED 4.27. Gets the DMX signal from an extern (remote) Universe ID.
Public function void Injects a dmx signal into the game thread.
Protected function Virtual Const TStatId  
Protected function Virtual Const ETickableTickType  
Public function void

InputDMXSignal ( const FDMXSignalSharedRef& DMXSignal
)

 Thread-safe: Pushes a DMX Signal into the buffer
Public function Const bool Returns true if receive DMX is disabled
Protected function Virtual Const bool  
Public function Const FDMXInputPortConfig Creates a dmx input port config that corresponds to the port
Public function void

SetUseDefaultQueue ( bool bUse
)

 Sets if the port should listen to its default queue.
Public function void Single Producer thread-safe: Pushes a DMX Signal into the buffer (For protocol only)
Protected function Virtual void

Tick ( float DeltaTime
)

  
Public function void

UpdateFromConfig ( FDMXInputPortConfig& InOutInputPortConfig,
bool bForceUpdateRegistrationWithProtocol
)

 Updates the Port to use the config of the InputPortConfig. Makes the config valid if it's invalid.

Overridden from FDMXPort

  Type Name Description
Protected function Virtual void Adds a Raw Listener that receives all raw signals received on this port.
Public function Virtual Const const FGuid & Returns the Guid of the Port
Public function Virtual Const bool ~Begin DMXPort Interface declaration
Protected function Virtual bool Registers the port with its protocol. Returns true if successfully registered
Protected function Virtual void Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener.
Protected function Virtual void Unregisteres the port if it was registered with its protocol

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page