Navigation
API > API/Plugins > API/Plugins/DecoupledOutputProvider
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVCamOutputProviderBase
- UDecoupledOutputProvider
- UVCamPixelStreamingSession
References
| Module | DecoupledOutputProvider |
| Header | /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/DecoupledOutputProvider/Public/DecoupledOutputProvider.h |
| Include | #include "DecoupledOutputProvider.h" |
Syntax
UCLASS (Abstract, NotBlueprintable)
class UDecoupledOutputProvider : public UVCamOutputProviderBase
Remarks
A decoupled output provider only contains data and forwards all important events to an IOutputProviderLogic, which may or may not exist. This allows the data to be loaded on all platforms but perform no operations on unsupported platforms. This decoupling is important to avoid failing LoadPackage warnings during cooking.
Example: Pixel Streaming.
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddReferencedObjects
(
UObject* InThis, |
Overridden from UVCamOutputProviderBase
| Type | Name | Description | |
|---|---|---|---|
  |
void | Deinitialize () |
Called when the provider is being shutdown such as before changing level or on exit |
  |
void | Initialize () |
Called when the provider is brought online such as after instantiating or loading a component containing this provider Use Initialize for any setup logic that needs to survive between Start / Stop cycles such as spawning transient objects |
  |
void | OnActivate () |
Called when the provider is Activated |
  |
void | OnDeactivate () |
Called when the provider is Deactivated |
  |
void | If PreReapplyViewport returned EVCamViewportChangeReply::ApplyViewportChange, then this function is called after the UMG widget has been placed in the new target viewport. | |
  |
UE::VCamCore::EViewportChangeReply | Called a new target viewport has been set while outputting but before the viewport change is processed. | |
  |
TFuture< FVCamStringPromptResponse > | PromptClientForString
(
const FVCamStringPromptRequest& Request |
Request string input from the streaming client. Returns true if the request was handled. |
  |
void | Tick
(
const float DeltaTime |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally |
  |
void | PreEditChange
(
FEditPropertyChain& PropertyAboutToChange |
This alternate version of PreEditChange is called when properties inside structs are modified. |
  |
void | Handles reading, writing, and reference collecting using FArchive. |