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 > RemoteSession > Channels > FRemoteSessionImageChannel

Light Theme

Dark Theme

FRemoteSessionImageChannel

A channel that takes an image (created by an [IRemoteSessionImageProvider](API\Plugins\RemoteSession\Channels\IRemoteSessionImageProvider)), then sends it to the client (with a FRemoteSessionImageSender).

Windows

MacOS

Linux

Inheritance Hierarchy

IRemoteSessionChannel

FRunnable

FRemoteSessionImageChannel

References

Module	RemoteSession
Header	/Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/Channels/RemoteSessionImageChannel.h
Include	#include "Channels/RemoteSessionImageChannel.h"

Syntax

class FRemoteSessionImageChannel :
public IRemoteSessionChannel,
private FRunnable

Remarks

A channel that takes an image (created by an IRemoteSessionImageProvider), then sends it to the client (with a FRemoteSessionImageSender). On the client images are decoded into a double-buffered texture that can be accessed via GetHostScreen.

Variables

	Name	Description
FRunnableThread...	BackgroundThread
TWeakPtr< FBack...	Connection	Underlying connection
FCriticalSectio...	DecodedImageMutex
TSharedPtr< TAt...	DecodedTextureIndex
UTexture2D *...	DecodedTextures
FThreadSafeBool	ExitRequested
TSharedPtr< IRe...	ImageProvider
TSharedPtr< FIm...	ImageSender	Image sender used by the channel
TArray< TUnique...	IncomingDecodedImages
TArray< TUnique...	IncomingEncodedImages
FCriticalSectio...	IncomingImageMutex
int32	LastDecodedImageIndex	Last processed decode image
int32	LastIncomingImageIndex	Last processed incoming image
FDelegateHandle	MessageCallbackHandle	So we can manage callback lifetimes properly
ERemoteSessionC...	Role	Our role
FEvent *	ScreenshotEvent

Constructors

	Name	Description
	FRemoteSessionImageChannel ( ERemoteSessionChannelMode InRole, TSharedPtr< FBackChannelOSCConnecti... )

Destructors

	Name	Description
	~FRemoteSessionImageChannel()

Functions

	Name	Description
void	CreateTexture ( const int32 InSlot, const int32 InWidth, const int32 InHeight )	Creates a texture to receive images into
void	ExitBackgroundThread()
UTexture2D &...	GetHostScreen()	Get the client Texture2D to display
TSharedPtr< ...	GetImageSender()	Return the image sender connected to the clients
void	ProcessIncomingTextures()	Decode the incoming images on a dedicated thread
void	ReceiveHostImage ( FBackChannelOSCMessage& Message, FBackChannelOSCDispatch& Dispatch )	Bound to receive incoming images
void	SetCompressQuality ( int32 InQuality )	Set the jpg compression quality
void	SetImageProvider ( TSharedPtr< IRemoteSessionImageProv... )	Set the ImageProvider that will produce the images that will be sent to the client
void	StartBackgroundThread()
const TCHAR ...	StaticType()	Begin IRemoteSessionChannel implementation

Overridden from IRemoteSessionChannel

		Name	Description
	const TCHAR ...	GetType()
	void	Tick ( const float InDeltaTime )	Tick this channel

Overridden from FRunnable

		Name	Description
	uint32	Run()	Background thread for decoding incoming images

Classes

	Name	Description
	FImageData
	FImageSender	A helper object responsible to take the raw data, encode it to jpg and send it to the client for the RemoteSessionImageChannel

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

Take our survey

Dismiss