Navigation
API > API/Plugins > API/Plugins/RivermaxCore
Inheritance Hierarchy
- IRivermaxSample
- IRivermaxVideoSample
References
| Module | RivermaxCore |
| Header | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxCore/Source/RivermaxCore/Public/IRivermaxInputStream.h |
| Include | #include "IRivermaxInputStream.h" |
Syntax
class IRivermaxSample
Remarks
All types of streams write into corresponding sample types. All sample types should inherit from this class so it can be correctly cast and identified.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
std::atomic< ESampleState > | SampleState | State of this sample. |
 |
std::atomic< ESampleType > | SampleType | Type of the sample. |
 |
FCriticalSection | StateChangeCriticalSecion | Critical section used when manipulating the received/skipped/rendered and other states in this or the inheriting classes. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
ESampleState | Gets reception state of this sample. | |
  |
void | SetReceptionState
(
ESampleState State |
Sets the state of the reception for this sample. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
ESampleState | ||
 |
ESampleType | Enum that identifies the type of this sample such as Video or Audio so that it can be handled accordingly. |