Navigation
API > API/Plugins > API/Plugins/RemoteSession
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.
| Name | FRemoteSessionImageChannel |
| Type | class |
| Header File | /Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/Channels/RemoteSessionImageChannel.h |
| Include Path | #include "Channels/RemoteSessionImageChannel.h" |
Syntax
class FRemoteSessionImageChannel :
public IRemoteSessionChannel ,
private FRunnable
Inheritance Hierarchy
- FRunnable → FRemoteSessionImageChannel
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRemoteSessionImageChannel
(
ERemoteSessionChannelMode InRole, |
Channels/RemoteSessionImageChannel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FRemoteSessionImageChannel() |
Channels/RemoteSessionImageChannel.h |
Classes
| Name | Remarks |
|---|---|
| FImageSender | A helper object responsible to take the raw data, encode it to jpg and send it to the client for the RemoteSessionImageChannel |
Structs
| Name | Remarks |
|---|---|
| FImageData |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UTexture2D * GetHostScreen() |
Get the client Texture2D to display | Channels/RemoteSessionImageChannel.h | |
TSharedPtr< FRemoteSessionImageChannel::FImageSender, ESPMode::ThreadSafe > GetImageSender() |
Return the image sender connected to the clients | Channels/RemoteSessionImageChannel.h | |
void SetCompressQuality
(
int32 InQuality |
Set the jpg compression quality | Channels/RemoteSessionImageChannel.h | |
void SetFramebufferAsImageProvider () |
Sets up an image provider that mirrors the games framebuffer. | Channels/RemoteSessionImageChannel.h | |
void SetImageProvider
(
TSharedPtr< IRemoteSessionImageProvider > ImageProvider |
Set the ImageProvider that will produce the images that will be sent to the client | Channels/RemoteSessionImageChannel.h |
Overridden from IRemoteSessionChannel
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const TCHAR * GetType() |
Channels/RemoteSessionImageChannel.h | ||
virtual void Tick
(
const float InDeltaTime |
Tick this channel | Channels/RemoteSessionImageChannel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CreateTexture
(
const int32 InSlot, |
Creates a texture to receive images into | Channels/RemoteSessionImageChannel.h | |
void ExitBackgroundThread() |
Channels/RemoteSessionImageChannel.h | ||
void ProcessIncomingTextures() |
Decode the incoming images on a dedicated thread | Channels/RemoteSessionImageChannel.h | |
void ReceiveHostImage
(
IBackChannelPacket& Message |
Bound to receive incoming images | Channels/RemoteSessionImageChannel.h | |
void StartBackgroundThread() |
Channels/RemoteSessionImageChannel.h |
Overridden from FRunnable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 Run() |
Background thread for decoding incoming images | Channels/RemoteSessionImageChannel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR * StaticType() |
Begin IRemoteSessionChannel implementation | Channels/RemoteSessionImageChannel.h |