Navigation
API > API/Plugins > API/Plugins/RemoteSession
Use the FrameGrabber on the host to provide an image to the image channel.
| Name | FRemoteSessionFrameBufferImageProvider |
| Type | class |
| Header File | /Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/ImageProviders/RemoteSessionFrameBufferImageProvider.h |
| Include Path | #include "ImageProviders/RemoteSessionFrameBufferImageProvider.h" |
Syntax
class FRemoteSessionFrameBufferImageProvider : public IRemoteSessionImageProvider
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRemoteSessionFrameBufferImageProvider
(
TSharedPtr< FRemoteSessionImageChannel::FImageSender, ESPMode::ThreadSafe > ImageSender |
ImageProviders/RemoteSessionFrameBufferImageProvider.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FRemoteSessionFrameBufferImageProvider() |
ImageProviders/RemoteSessionFrameBufferImageProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnViewportResized
(
FVector2D NewSize |
Signals that the viewport was resized | ImageProviders/RemoteSessionFrameBufferImageProvider.h | |
void SetCaptureFrameRate
(
int32 InFramerate |
Specifies the framerate at | ImageProviders/RemoteSessionFrameBufferImageProvider.h | |
void SetCaptureViewport
(
TSharedRef< FSceneViewport > Viewport |
Specifies which viewport to capture | ImageProviders/RemoteSessionFrameBufferImageProvider.h |
Overridden from IRemoteSessionImageProvider
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Tick
(
const float InDeltaTime |
Tick this channel | ImageProviders/RemoteSessionFrameBufferImageProvider.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CreateFrameGrabber
(
TSharedRef< FSceneViewport > Viewport |
Safely create the frame grabber | ImageProviders/RemoteSessionFrameBufferImageProvider.h | |
void OnWindowClosedEvent
(
const TSharedRef< SWindow >& |
When the window is destroyed | ImageProviders/RemoteSessionFrameBufferImageProvider.h | |
void ReleaseFrameGrabber() |
Release the FrameGrabber | ImageProviders/RemoteSessionFrameBufferImageProvider.h |