Navigation
API > API/Plugins > API/Plugins/CaptureManagerUnrealEndpoint
An ingest endpoint (UE/UEFN instance) for the Capture Manager.
| Name | FUnrealEndpoint |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/CaptureManager/CaptureManagerApp/Source/CaptureManagerUnrealEndpoint/Public/CaptureManagerUnrealEndpoint.h |
| Include Path | #include "CaptureManagerUnrealEndpoint.h" |
Syntax
class FUnrealEndpoint
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FUnrealEndpoint
(
FUnrealEndpointInfo InEndpointInfo |
CaptureManagerUnrealEndpoint.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FUnrealEndpoint() |
CaptureManagerUnrealEndpoint.h |
Structs
| Name | Remarks |
|---|---|
| FImpl |
Enums
Public
| Name | Remarks |
|---|---|
| EConnectionState |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Impl | TSharedPtr< FImpl > | CaptureManagerUnrealEndpoint.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddTakeUploadTask
(
TUniquePtr< FTakeUploadTask > InTakeUploadTask |
Adds a take upload task to the queue for this endpoint. | CaptureManagerUnrealEndpoint.h | |
void CancelTakeUploadTask
(
FGuid InTakeUploadTask |
Cancels the upload task with the supplied task ID. | CaptureManagerUnrealEndpoint.h | |
FUnrealEndpointInfo GetInfo() |
CaptureManagerUnrealEndpoint.h | ||
void Retire() |
Permanently retires the endpoint and stops the connection. This prevents further API calls from functioning. | CaptureManagerUnrealEndpoint.h | |
void StartConnection () |
Starts the connection to the endpoint (if not already started). | CaptureManagerUnrealEndpoint.h | |
void StopConnection () |
Stops the connection to the endpoint (if not already stopped). | CaptureManagerUnrealEndpoint.h | |
bool WaitForConnectionState
(
EConnectionState InConnectionState, |
Blocks until either the connection is made or the timeout is exceeded. | CaptureManagerUnrealEndpoint.h |