Navigation
API > API/Plugins > API/Plugins/TakeRecorder
Public module interface for the Take Recorder module
| Name | ITakeRecorderModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/ITakeRecorderModule.h |
| Include Path | #include "ITakeRecorderModule.h" |
Syntax
class ITakeRecorderModule : public IModuleInterface
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FSourceExtensionData | Relevant data for the sources module. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnExternalObjectAddRemoveEvent | TMulticastDelegate_TwoParams< void, UObject *, bool > | Delegate called when an external object is registered for the take recorder panel. | ITakeRecorderModule.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TakeRecorderTabLabel | FText | The default label for the take recorder tab | ITakeRecorderModule.h |
| TakeRecorderTabName | FName | The name under which the take recorder tab is registered and invoked | ITakeRecorderModule.h |
| TakesBrowserInstanceName | FName | The Takes Browser Content Browser Instance Name | ITakeRecorderModule.h |
| TakesBrowserTabLabel | FText | The default label for the takes browser | ITakeRecorderModule.h |
| TakesBrowserTabName | FName | The tab name for the takes browser tab | ITakeRecorderModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCanReviewLastRecordedLevelSequence & GetCanReviewLastRecordedLevelSequenceDelegate() |
Provides the take recorder panel state of review last recording. | ITakeRecorderModule.h | |
FOnExternalObjectAddRemoveEvent & GetExternalObjectAddRemoveEventDelegate() |
Get the event notifier when an external object has been added or removed. | ITakeRecorderModule.h | |
TArray< TWeakObjectPtr<> > & GetExternalObjects() |
Get the take external objects registered to the take recorder. | ITakeRecorderModule.h | |
FLastRecordedLevelSequenceProvider & GetLastLevelSequenceProvider() |
Get the delegate for providing the current level sequence to the take recorder panel. | ITakeRecorderModule.h | |
UTakePreset * GetPendingTake() |
Get the current pending take. | ITakeRecorderModule.h | |
FOnGenerateWidgetExtensions & GetRecordButtonExtensionGenerators () |
Get the toolbar extension generators. | ITakeRecorderModule.h | |
FOnRecordErrorCheck & GetRecordErrorCheckGenerator() |
Get the delegate for reporting any error conditions in recording state. | ITakeRecorderModule.h | |
FOnGenerateWidgetExtensions & GetToolbarExtensionGenerators () |
Get the toolbar extension generators. | ITakeRecorderModule.h | |
FOnForceSaveAsPreset & OnForceSaveAsPreset() |
Get the delegate for handling saving of preset data. | ITakeRecorderModule.h | |
void RegisterExternalObject
(
UObject* InExternalObject |
Register a new class default object that should appear on the take recorder panel. | ITakeRecorderModule.h | |
void RegisterSettingsObject
(
UObject* InSettingsObject |
Register a new class default object that should appear on the take recorder project settings | ITakeRecorderModule.h | |
void RegisterSourcesExtension
(
const FSourceExtensionData& InData |
Register generic extensions for sources. | ITakeRecorderModule.h | |
FDelegateHandle RegisterSourcesMenuExtension
(
const FOnExtendSourcesMenu& InExtension |
Register a new extension callback for the 'Add Source' menu | ITakeRecorderModule.h | |
void UnregisterExternalObject
(
UObject* InExternalObject |
Unregister a new class default object that should appear on the take recorder panel. | ITakeRecorderModule.h | |
void UnregisterSourcesExtension() |
Unregister the source extension. | ITakeRecorderModule.h | |
void UnregisterSourcesMenuExtension
(
FDelegateHandle Handle |
Unregister a previously registered extension callback for the 'Add Source' menu | ITakeRecorderModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ITakeRecorderModule & Get() |
ITakeRecorderModule.h | ||
static bool IsAvailable() |
ITakeRecorderModule.h |