Navigation
API > API/Plugins > API/Plugins/ElectraBase
| Name | FMediaEvent |
| Type | class |
| Header File | /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Core/MediaEventSignal.h |
| Include Path | #include "Core/MediaEventSignal.h" |
Syntax
class FMediaEvent : private TMediaNoncopyable< FMediaEvent >
Inheritance Hierarchy
- TMediaNoncopyable → FMediaEvent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaEvent() |
Core/MediaEventSignal.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMediaEvent() |
Core/MediaEventSignal.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Event | FEvent * | Core/MediaEventSignal.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsSignaled() |
Returns state of the signal. | Core/MediaEventSignal.h | |
void Reset() |
Clears the signal. Threads will now wait again until the signal is set once more. | Core/MediaEventSignal.h | |
void Signal() |
Signals the event to be set. If already set, this does nothing. | Core/MediaEventSignal.h | |
void Wait() |
Waits for the event signal to get set. If already set, this function returns immediately. | Core/MediaEventSignal.h | |
void WaitAndReset () |
Waits for the event signal to get set and clears it immediately. | Core/MediaEventSignal.h | |
bool WaitTimeout
(
int64 MicroSeconds |
Waits for the event signal to get set within the given time limit. | Core/MediaEventSignal.h | |
bool WaitTimeoutAndReset
(
int64 MicroSeconds |
Waits for the event signal to get set within the given time limit and clears it immediately. | Core/MediaEventSignal.h |