1. Epic GamesDeveloper
  3. FRemoteSessionImageChannel

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).

Unreal Engine C++ API Reference > Plugins > RemoteSession > Channels

Inheritance Hierarchy

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

  Type Name Description
Protected variable FRunnableThread * BackgroundThread  
Protected variable TWeakPtr< IBackChannelConnection, ESPMode::ThreadSafe > Connection Underlying connection
Protected variable FCriticalSection DecodedImageMutex  
Protected variable TSharedPtr< TAtomic< int32 >, ESPMode::ThreadSafe > DecodedTextureIndex  
Protected variable UTexture2D *[2] DecodedTextures  
Protected variable FThreadSafeBool ExitRequested  
Protected variable bool HaveConfiguredImageProvider  
Protected variable TSharedPtr< IRemoteSessionImageProvider > ImageProvider  
Protected variable TSharedPtr< FImageSender, ESPMode::ThreadSafe > ImageSender Image sender used by the channel
Protected variable TArray< TUniquePtr< FImageData > > IncomingDecodedImages  
Protected variable TArray< TUniquePtr< FImageData > > IncomingEncodedImages  
Protected variable FCriticalSection IncomingImageMutex  
Protected variable int32 LastDecodedImageIndex Last processed decode image
Protected variable int32 LastIncomingImageIndex Last processed incoming image
Protected variable FDelegateHandle MessageCallbackHandle So we can manage callback lifetimes properly
Protected variable FRemoteSessionImageReceiveStats ReceiveStats  
Protected variable ERemoteSessionChannelMode Role Our role
Protected variable FEvent * ScreenshotEvent  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

CreateTexture ( const int32 InSlot,
const int32 InWidth,
const int32 InHeight
)

 Creates a texture to receive images into
Protected function void  
Public function Const UTexture2D * Get the client Texture2D to display
Public function TSharedPtr< FRemoteSessionImageChannel::FImageSender, ESPMode::ThreadSafe > Return the image sender connected to the clients
Protected function void Decode the incoming images on a dedicated thread
Protected function void Bound to receive incoming images
Public function void

SetCompressQuality ( int32 InQuality
)

 Set the jpg compression quality
Public function void Sets up an image provider that mirrors the games framebuffer.
Public function void Set the ImageProvider that will produce the images that will be sent to the client
Protected function void  
Public function Static const TCHAR * Begin IRemoteSessionChannel implementation

Overridden from IRemoteSessionChannel

  Type Name Description
Public function Virtual Const const TCHAR *

GetType ()

  
Public function Virtual void

Tick ( const float InDeltaTime
)

 Tick this channel

Overridden from FRunnable

  Type Name Description
Protected function Virtual uint32

Run ()

 Background thread for decoding incoming images

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page