Navigation
API > API/Plugins > API/Plugins/TakeRecorder > API/Plugins/TakeRecorder/Recorder
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UBlueprintFunctionLibrary
- UTakeRecorderBlueprintLibrary
References
| Module | TakeRecorder |
| Header | /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/Recorder/TakeRecorderBlueprintLibrary.h |
| Include | #include "Recorder/TakeRecorderBlueprintLibrary.h" |
Syntax
UCLASS&40;&41;
class UTakeRecorderBlueprintLibrary : public UBlueprintFunctionLibrary
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Cancel recording if there is a recorder currently active | ||
| UTakeRecorder * | Retrieve the currently active recorder, or None if there none are active | ||
| FTakeRecorderParameters | Get the default recorder parameters according to the project and user settings | ||
| UTakeRecorderPanel * | Get the currently open take recorder panel, if one is open | ||
| bool | IsRecording () |
Check whether a recording is currently active | |
| bool | Is the Take Recorder enabled in the build | ||
| void | |||
| void | OnTakeRecorderFinished
(
ULevelSequence* InSequenceAsset |
||
| void | OnTakeRecorderMarkedFrameAdded
(
const FMovieSceneMarkedFrame& InMarkedFrame |
||
| void | |||
| void | |||
| void | |||
| UTakeRecorderPanel * | Get the currently open take recorder panel, if one is open, opening a new one if not | ||
| void | SetDefaultParameters
(
const FTakeRecorderParameters& DefaultParameters |
Set the default recorder parameters | |
| void | SetOnTakeRecorderCancelled
(
FOnTakeRecorderCancelled OnTakeRecorderCancelled |
Called when take recording is cancelled. | |
| void | SetOnTakeRecorderFinished
(
FOnTakeRecorderFinished OnTakeRecorderFinished |
Called when take recording finishes. | |
| void | SetOnTakeRecorderMarkedFrameAdded
(
FOnTakeRecorderMarkedFrameAdded OnTakeRecorderMarkedFrameAdded |
Called when a marked frame is added. | |
| void | SetOnTakeRecorderPanelChanged
(
FOnTakeRecorderPanelChanged OnTakeRecorderPanelChanged |
Called when a Take Panel is constructed or destroyed. | |
| void | SetOnTakeRecorderPreInitialize
(
FOnTakeRecorderPreInitialize OnTakeRecorderPreInitialize |
Called before initialization occurs (ie. when the recording button is pressed and before the countdown starts) | |
| void | SetOnTakeRecorderStarted
(
FOnTakeRecorderStarted OnTakeRecorderStarted |
Called when take recording starts. | |
| void | SetOnTakeRecorderStopped
(
FOnTakeRecorderStopped OnTakeRecorderStopped |
Called when take recording is stopped. | |
| void | SetTakeRecorderPanel
(
UTakeRecorderPanel* InNewPanel |
Internal function to assign a new take recorder panel singleton. | |
| UTakeRecorder * | StartRecording
(
ULevelSequence* LevelSequence, |
Start a new recording using the specified parameters. | |
| void | Stop recording if there is a recorder currently active |