FDMXOutputPort

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

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FDMXPort

FDMXOutputPort

References

Module

DMXProtocol

Header

/Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXOutputPort.h

Include

#include "IO/DMXOutputPort.h"

Syntax

class FDMXOutputPort : public FDMXPort

Remarks

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

Use SendDMXFragment method to send DMX.

To loopback outputs refer to DMXRawListener and DMXTickedUniverseListener.

Can only be constructed via DMXPortManger, see FDMXPortManager::CreateOutputPort and FDMXPortManager::CreateOutputPortFromConfig

Variables

Name Description

Protected variable

FDMXOutputPortC...

 

CommunicationDeterminator

Helper to determine how dmx should be communicated (loopback, send)

Protected variable

FString

 

DestinationAddress

The Destination Address to send to, can be irrelevant, e.g. for art-net broadcast

Protected variable

TSharedPtr< IDM...

 

DMXSender

The DMX sender, or nullptr if not registered

Protected variable

int32

 

Priority

Priority on which packets are being sent

Destructors

Name Description

Public function Virtual

~FDMXOutputPort()

Functions

Name Description

Public function

void

 

ClearBuffers()

Clears all buffers

Protected function Static

FDMXOutputPo...

 

CreateFromConfig

(
    FDMXOutputPortConfig& OutputPortCo...
)

Creates an output port tied to a specific config.

Public function

bool

 

GameThreadGetDMXSignal

(
    int32 LocalUniverseID,
    FDMXSignalSharedPtr& OutDMXSignal,
    bool bEvenIfNotLoopbackToEngine
)

Game-Thread only: Gets the last signal received in specified local universe.

Public function Const

const FStrin...

 

GetDestinationAddress()

Returns the Destination Address

Protected function

void

 

OnSetReceiveDMXEnabled

(
    bool bEnabled
)

Called to set if DMX should be enabled

Protected function

void

 

OnSetSendDMXEnabled

(
    bool bEnabled
)

Called to set if DMX should be enabled

Public function

void

 

SendDMX

(
    int32 LocalUniverseID,
    const TMap< int32, uint8 >& Channe...
)

Sends DMX over the port

Public function

void

 

UpdateFromConfig

(
    FDMXOutputPortConfig& OutputPortCo...
)

Updates the Port to use the config of the OutputPortConfig

Overridden from FDMXPort

Name Description

Protected function Virtual

void

 

AddRawInput

(
    TSharedRef< FDMXRawListener > RawIn...
)

Adds a Input that receives all raw signals received on this port.

Public function Virtual Const

const FGuid ...

 

GetPortGuid()

Returns the Guid of the Port

Public function Virtual Const

bool

 

IsRegistered()

Returns true if the port is successfully registered with its protocol

Protected function Virtual

bool

 

Register()

Registers the port with its protocol. Returns true if successfully registered

Protected function Virtual

void

 

RemoveRawInput

(
    TSharedRef< FDMXRawListener > RawIn...
)

Removes the raw Input from the port.

Protected function Virtual

void

 

Unregister()

Unregisteres the port if it was registered with its protocol

Deprecated Functions

Name Description

Public function

bool

 

GameThreadGetDMXSignalFromRemoteUniverse

(
    FDMXSignalSharedPtr& OutDMXSignal,
    int32 RemoteUniverseID,
    bool bEvenIfNotLoopbackToEngine
)

Use GameThreadGetDMXSignal instead. GameThreadGetDMXSignalFromRemoteUniverse only exists to support deprecated blueprint nodes.

Public function

void

 

SendDMXToRemoteUniverse

(
    const TMap< int32, uint8 >& Channe...,
    int32 RemoteUniverse
)

Use SenDMX instead. SendDMXToRemoteUniverse 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