Navigation
Unreal Engine C++ API Reference > Plugins > DMXProtocol > IO
Inheritance Hierarchy
- FSharedFromThisBase
- 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
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FDMXRawListener
(
TSharedRef< FDMXPort, ESPMode::ThreadSafe > InOwnerPort |
Constructor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ClearBuffer () |
Thread-safe. Clears the raw buffer |
 |
bool | DequeueSignal
(
void* Consumer, |
Thread safe single consumer. Tries to dequeues a signal from the raw listener. |
  |
void | EnqueueSignal
(
void* Producer, |
Thread safe single producer. |
 |
void | Start () |
Starts receiving the Input |
 |
void | Stop () |
Stops receiving the Input |