Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > VCamCore > UVCamOutputProviderBase

Light Theme

Dark Theme

UVCamOutputProviderBase

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVCamOutputProviderBase

	UVCamOutputComposure
	UVCamOutputMediaOutput
	UVCamOutputRemoteSession
	UVCamOutputViewport

References

Module	VCamCore
Header	/Engine/Plugins/Experimental/VirtualCamera/Source/VCamCore/Public/VCamOutputProviderBase.h
Include	#include "VCamOutputProviderBase.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Abstract, EditInlineNew)
class UVCamOutputProviderBase : public UObject

Variables

	Name	Description
bool	bInitialized
bool	bIsActive	If set, this output provider will execute every frame.
bool	bUseOverrideResolution	Override the default output resolution with a custom value -.
EVPWidgetDispla...	DisplayType
FIntPoint	OverrideResolution	When bUseOverrideResolution is set, use this custom resolution.
TSubclassOf< UU...	UMGClass	The UMG class to be rendered in this output provider.
UVPFullScreenUs...	UMGWidget

Constructors

	Name	Description
	UVCamOutputProviderBase()

Destructors

	Name	Description
	~UVCamOutputProviderBase()

Functions

	Name	Description
void	Activate()	Called when the provider is Activated.
void	CreateUMG()
void	Deactivate()	Called when the provider is Deactivated.
void	Deinitialize()	Called when the provider is being shutdown such as before changing level or on exit.
void	DestroyUMG()
void	DisplayUMG()
UVCamOutputP...	GetOtherOutputProviderByIndex ( int32 Index )
TWeakPtr< SW...	GetTargetInputWindow()
TSharedPtr< ...	GetTargetLevelViewport()
FLevelEditor...	GetTargetLevelViewportClient()
TSharedPtr< ...	GetTargetSceneViewport()
UVPFullScree...	GetUMGWidget()
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
bool	IsActive()	Returns if this output provider is currently active or not.
bool	IsInitialized()	Returns if this output provider has been initialized or not.
void	RestoreOutput()	Restore the output state from previous call to disable output.
void	SetActive ( const bool bInActive )	Called to turn on or off this output provider.
void	SetTargetCamera ( const UCineCameraComponent* In... )	Sets the TargetCamera parameter.
void	SetUMGClass ( const TSubclassOf< UUserWidget > In... )	Sets the UMG class to be rendered in this output provider.
void	SuspendOutput()	Temporarily disable the output. Caller must eventually call RestoreOutput.
void	Tick ( const float DeltaTime )

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss