Navigation
API > API/Plugins > API/Plugins/CPSLiveLinkDevice
| Name | FCPSDevice |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/CaptureManager/CaptureManagerDevices/Source/CPSLiveLinkDevice/Public/Protocol/CPSDevice.h |
| Include Path | #include "Protocol/CPSDevice.h" |
Syntax
class FCPSDevice :
public UE::CaptureManager::FCaptureEventSource ,
public TSharedFromThis< FCPSDevice >
Inheritance Hierarchy
- detail::FCaptureEventSourceBase → FCaptureEventSource → FCPSDevice
- FSharedFromThisBase → TSharedFromThis → FCPSDevice
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCPSDevice
(
FPrivateToken, |
Protocol/CPSDevice.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FCPSDevice() |
Protocol/CPSDevice.h |
Structs
| Name | Remarks |
|---|---|
| FEmpty | |
| FPrivateToken |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FConnectionThread | TQueueRunner< FEmpty > | Protocol/CPSDevice.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ConnectInterval | const float | Protocol/CPSDevice.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsConnected | std::atomic_bool | Protocol/CPSDevice.h | ||
| ConnectTimerHandle | FCaptureTimerManager::FTimerHandle | Protocol/CPSDevice.h | ||
| ConnThread | TUniquePtr< FConnectionThread > | Protocol/CPSDevice.h | ||
| ControlMessenger | FControlMessenger | Protocol/CPSDevice.h | ||
| DeviceControlPort | uint16 | Protocol/CPSDevice.h | ||
| DeviceIpAddress | FString | Protocol/CPSDevice.h | ||
| ExportClient | TUniquePtr< FExportClient > | Protocol/CPSDevice.h | ||
| IdMap | TMap< FTakeId, FExportClient::FTaskId > | Protocol/CPSDevice.h | ||
| Mutex | FCriticalSection | Protocol/CPSDevice.h | ||
| TakeMetadata | TMap< FTakeId, FGetTakeMetadataResponse::FTakeObject > | Protocol/CPSDevice.h | ||
| TimerManager | TSharedRef< FCaptureTimerManager > | Protocol/CPSDevice.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddTakeMetadata
(
FTakeId InId, |
Protocol/CPSDevice.h | ||
void CancelAllExports() |
Protocol/CPSDevice.h | ||
void CancelExport
(
FTakeId InTakeId |
Protocol/CPSDevice.h | ||
void FetchFileForTake
(
FTakeId InTakeId, |
Fetches the sepcified file for a single take. | Protocol/CPSDevice.h | |
void FetchFiles
(
TUniquePtr< FBaseStream > InStream, |
Fetches the specified files for all takes. | Protocol/CPSDevice.h | |
TProtocolResult< FGetTakeMetadataResponse::FTakeObject > FetchTake
(
const FString& InTakeName |
Protocol/CPSDevice.h | ||
TProtocolResult< TArray< FGetTakeMetadataResponse::FTakeObject > > FetchTakeList() |
Protocol/CPSDevice.h | ||
void FetchThumbnailForTake
(
FTakeId InTakeId, |
Fetches the thumbnail for a single take. | Protocol/CPSDevice.h | |
void FetchThumbnails
(
TUniquePtr< FBaseStream > InStream |
Fetches the thumbnails for all takes. | Protocol/CPSDevice.h | |
FGetTakeMetadataResponse::FTakeObject GetTake
(
FTakeId InId |
Protocol/CPSDevice.h | ||
FTakeId GetTakeId
(
const FString& InTakeName |
Protocol/CPSDevice.h | ||
void InitiateConnect() |
Protocol/CPSDevice.h | ||
bool IsConnected() |
Protocol/CPSDevice.h | ||
void RemoveTakeMetadata
(
FTakeId InId |
Protocol/CPSDevice.h | ||
void StartExport
(
FTakeId InTakeId, |
Protocol/CPSDevice.h | ||
| Protocol/CPSDevice.h | |||
void Stop() |
Protocol/CPSDevice.h | ||
TProtocolResult< void > StopRecording() |
Protocol/CPSDevice.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FCaptureTimerManager > GetTimerManager() |
Protocol/CPSDevice.h | ||
static TSharedPtr< FCPSDevice > MakeCPSDevice
(
FString InDeviceIpAddress, |
Protocol/CPSDevice.h |