Navigation
API > API/Plugins > API/Plugins/RivermaxSync
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- IDisplayClusterMediaOutputSynchronizationPolicyHandler
- FDisplayClusterMediaOutputSynchronizationPolicyEthernetBarrierBaseHandler
- FMediaOutputSynchronizationPolicyRivermaxHandler
References
| Module | RivermaxSync |
| Header | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxSync/Source/RivermaxSync/Public/MediaOutputSynchronizationPolicyRivermax.h |
| Include | #include "MediaOutputSynchronizationPolicyRivermax.h" |
Syntax
class FMediaOutputSynchronizationPolicyRivermaxHandler : public FDisplayClusterMediaOutputSynchronizationPolicyEthernetBarrierBaseHandler
Remarks
Synchronization logic handler class for UMediaOutputSynchronizationPolicyRivermax.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< uint8 > | BarrierData | Memory buffer used to contain data exchanged in the barrier |
 |
FMediaSyncBarrierData | BarrierDataStruct | Holds data provided to server by this node when joining the barrier |
 |
float | MarginMs | Synchronization margin (ms) |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
double | Returns amount of time before next synchronization point. | |
 |
void | HandleBarrierSync
(
FGenericBarrierSynchronizationDelegateData& BarrierSyncData |
Barrier callback containing data from each node to detect if cluster is out of sync. |
  |
bool | PickPtpBaseNodeAndData
(
const FGenericBarrierSynchronizationDelegateData& BarrierSyncData, |
Deterministically picks a node to base ptp offsets on other nodes from. |
Overridden from FDisplayClusterMediaOutputSynchronizationPolicyEthernetBarrierBaseHandler
| Type | Name | Description | |
|---|---|---|---|
  |
bool | InitializeBarrier
(
const FString& SyncInstanceId |
Initializes dynamic barrier on the primary node. |
  |
void | Synchronize () |
We do our own synchronization by looking at distance to alignment point. |
Overridden from IDisplayClusterMediaOutputSynchronizationPolicyHandler
| Type | Name | Description | |
|---|---|---|---|
   |
TSubclassOf< UDisplayClusterMediaOutputSynchronizationPolicy > | Returns the policy config class used to create this policy handler. | |
   |
bool | IsCaptureTypeSupported
(
UMediaCapture* MediaCapture |
Returns true if specified media capture type can be synchonized by the policy implementation |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FMediaSyncBarrierData | Holds data provided to server by each node when joining the barrier |
Typedefs
| Name | Description |
|---|---|
| Super |