FCPSDevice

API > API/Plugins > API/Plugins/CaptureManagerCPSClient

   
Name FCPSDevice
Type class
Header File /Engine/Plugins/VirtualProduction/CaptureManager/CaptureManagerCore/Source/CaptureManagerCPSClient/Public/CPSDevice.h
Include Path #include "CPSDevice.h"

Syntax

class FCPSDevice :  
    public UE::CaptureManager::FCaptureEventSource ,  
    public TSharedFromThis< FCPSDevice >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FCPSDevice ( FPrivateToken,
FString InDeviceIpAddress,
uint16 InDevicePort
)

   CPSDevice.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCPSDevice()

   CPSDevice.h  

Structs

Name Remarks
FEmpty  
FPrivateToken  

Typedefs

Name Type Remarks Include Path
FConnectionThread TQueueRunner< FEmpty >   CPSDevice.h

Constants

Name Type Remarks Include Path
ConnectInterval const float   CPSDevice.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsConnected std::atomic_bool   CPSDevice.h  
ConnectTimerHandle FCaptureTimerManager::FTimerHandle   CPSDevice.h  
ConnThread TUniquePtr< FConnectionThread >   CPSDevice.h  
ControlMessenger FControlMessenger   CPSDevice.h  
DeviceControlPort uint16   CPSDevice.h  
DeviceIpAddress FString   CPSDevice.h  
ExportClient TUniquePtr< FExportClient >   CPSDevice.h  
IdMap TMap< FTakeId, FExportClient::FTaskId >   CPSDevice.h  
Mutex FCriticalSection   CPSDevice.h  
TakeMetadata TMap< FTakeId, FGetTakeMetadataResponse::FTakeObject >   CPSDevice.h  
TimerManager TSharedRef< FCaptureTimerManager >   CPSDevice.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTakeMetadata ( FTakeId InId,
FGetTakeMetadataResponse::FTakeObject InTake
)

   CPSDevice.h  

void CancelAllExports()

   CPSDevice.h  

void CancelExport ( FTakeId InTakeId
)

   CPSDevice.h  

void FetchFileForTake ( FTakeId InTakeId,
TUniquePtr< FBaseStream > InStream,
const FString& InFileName
)

 Fetches the specified file for a single take. CPSDevice.h  

void FetchFiles ( TUniquePtr< FBaseStream > InStream,
TArray< FString > InFileNames
)

 Fetches the specified files for all takes. CPSDevice.h  
  CPSDevice.h  
  CPSDevice.h  

void FetchThumbnailForTake ( FTakeId InTakeId,
TUniquePtr< FBaseStream > InStream
)

 Fetches the thumbnail for a single take. CPSDevice.h  

void FetchThumbnails ( TUniquePtr< FBaseStream > InStream
)

 Fetches the thumbnails for all takes. CPSDevice.h  

FGetTakeMetadataResponse::FTakeObject GetTake ( FTakeId InId
)

   CPSDevice.h  

FTakeId GetTakeId ( const FString& InTakeName
)

   CPSDevice.h  

void InitiateConnect()

   CPSDevice.h  

bool IsConnected()

   CPSDevice.h  

void RemoveTakeMetadata ( FTakeId InId
)

   CPSDevice.h  

void StartExport ( FTakeId InTakeId,
TUniquePtr< FBaseStream > InStream
)

   CPSDevice.h  

TProtocolResult< void > StartRecording ( FString SlateName,
uint16 TakeNumber,
TOptional< FString > Subject,
TOptional< FString > Scenario,
TOptional< TArray< FString > > Tags
)

   CPSDevice.h  

void Stop()

   CPSDevice.h  

TProtocolResult< void > StopRecording()

   CPSDevice.h  

Public Virtual

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< FCaptureTimerManager > GetTimerManager()

   CPSDevice.h  

static TSharedPtr< FCPSDevice > MakeCPSDevice ( FString InDeviceIpAddress,
uint16 InDevicePort
)

   CPSDevice.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page