FDMXRawListener

Listen to all DMX data of a port.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FDMXRawListener

References

Module

DMXProtocol

Header

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

Include

#include "IO/DMXRawListener.h"

Syntax

class FDMXRawListener : public TSharedFromThis< FDMXRawListener >

Remarks

Listen to all DMX data of a port.

Thread-safe single producer single consumer: Single producer always is the DMX port. This is handled by the port internally. Do not use EnqueueSignal somewhere else to retain thread-safety. Single consumer is the user thread.

Needs frequent dequeuing. Stop needs to be called before the Input is released.

Constructors

Name Description

Public function

FDMXRawListener()

Public function

FDMXRawListener

Constructor

Destructors

Name Description

Public function Virtual

~FDMXRawListener()

Destructor

Functions

Name Description

Public function

void

 

ClearBuffer()

Thread-safe. Clears the raw buffer

Public function

bool

 

DequeueSignal

(
    void* Consumer,
    FDMXSignalSharedPtr& OutSignal,
    int32& OutLocalUniverseID
)

Thread safe single consumer. Tries to dequeues a signal from the raw listener.

Public function

void

 

EnqueueSignal

(
    void* Producer,
    const FDMXSignalSharedRef& Signal
)

Thread safe single producer.

Public function

void

 

Start()

Starts receiving the Input

Public function

void

 

Stop()

Stops receiving the Input