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

Light Theme

Dark Theme

FRemoteSessionFrameBufferImageProvider

Use the FrameGrabber on the host to provide an image to the image channel.

Windows

MacOS

Linux

Inheritance Hierarchy

IRemoteSessionImageProvider

FRemoteSessionFrameBufferImageProvider

References

Module	RemoteSession
Header	/Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/ImageProviders/RemoteSessionFrameBufferImageProvider.h
Include	#include "ImageProviders/RemoteSessionFrameBufferImageProvider.h"

Syntax

class FRemoteSessionFrameBufferImageProvider : public IRemoteSessionImageProvider

Remarks

Use the FrameGrabber on the host to provide an image to the image channel.

Variables

	Name	Description
FRemoteSesstion...	CaptureStats
TSharedPtr< FFr...	FrameGrabber
TWeakPtr< FRemo...	ImageSender
double	LastSentImageTime	Time we last sent an image
TSharedPtr< FTh...	NumDecodingTasks
TWeakPtr< FScen...	SceneViewport	Holds a reference to the scene viewport
TWeakPtr< SWind...	SceneViewportWindow	Holds a reference to the SceneViewport SWindow
bool	ViewportResized	Shows that the viewport was just resized

Constructors

	Name	Description
	FRemoteSessionFrameBufferImageProvider ( TSharedPtr< FRemoteSessionImageChan... )

Destructors

	Name	Description
	~FRemoteSessionFrameBufferImageProvider()

Functions

	Name	Description
void	CreateFrameGrabber ( TSharedRef< FSceneViewport > Viewpo... )	Safely create the frame grabber
void	OnViewportResized ( FVector2D NewSize )	Signals that the viewport was resized
void	OnWindowClosedEvent ( const TSharedRef< SWindow >& )	When the window is destroyed
void	ReleaseFrameGrabber()	Release the FrameGrabber
void	SetCaptureFrameRate ( int32 InFramerate )	Specifies the framerate at
void	SetCaptureViewport ( TSharedRef< FSceneViewport > Viewpo... )	Specifies which viewport to capture

Overridden from IRemoteSessionImageProvider

		Name	Description
	void	Tick ( const float InDeltaTime )	Tick this channel

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

Take our survey

Dismiss