Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > TakeRecorder > Recorder > UTakeRecorderBlueprintLibrary

Light Theme

Dark Theme

UTakeRecorderBlueprintLibrary

Windows

MacOS

Linux

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](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UTakeRecorderBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

	Name	Description
UTakeRecorde...	GetActiveRecorder()	Retrieve the currently active recorder, or None if there none are active
FTakeRecorde...	GetDefaultParameters()	Get the default recorder parameters according to the project and user settings
UTakeRecorde...	GetTakeRecorderPanel()	Get the currently open take recorder panel, if one is open
bool	IsRecording()	Check whether a recording is currently active
bool	IsTakeRecorderEnabled()	Is the Take Recorder enabled in the build
void	OnTakeRecorderCancelled()
void	OnTakeRecorderFinished ( ULevelSequence* InSequenceAsse... )
void	OnTakeRecorderMarkedFrameAdded ( const FMovieSceneMarkedFrame& InMa... )
void	OnTakeRecorderPreInitialize()
void	OnTakeRecorderStarted()
void	OnTakeRecorderStopped()
UTakeRecorde...	OpenTakeRecorderPanel()	Get the currently open take recorder panel, if one is open, opening a new one if not
void	SetOnTakeRecorderCancelled ( FOnTakeRecorderCancelled OnTakeReco... )	Called when take recording is cancelled.
void	SetOnTakeRecorderFinished ( FOnTakeRecorderFinished OnTakeRecor... )	Called when take recording finishes.
void	SetOnTakeRecorderMarkedFrameAdded ( FOnTakeRecorderMarkedFrameAdded OnT... )	Called when a marked frame is added.
void	SetOnTakeRecorderPanelChanged ( FOnTakeRecorderPanelChanged OnTakeR... )	Called when a Take Panel is constructed or destroyed.
void	SetOnTakeRecorderPreInitialize ( FOnTakeRecorderPreInitialize OnTake... )	Called before initialization occurs (ie. when the recording button is pressed and before the countdown starts)
void	SetOnTakeRecorderStarted ( FOnTakeRecorderStarted OnTakeRecord... )	Called when take recording starts.
void	SetOnTakeRecorderStopped ( FOnTakeRecorderStopped OnTakeRecord... )	Called when take recording is stopped.
void	SetTakeRecorderPanel ( UTakeRecorderPanel* InNewPanel )	Internal function to assign a new take recorder panel singleton.
UTakeRecorde...	StartRecording ( ULevelSequence* LevelSequence, UTakeRecorderSources* Sources, UTakeMetaData* MetaData, const FTakeRecorderParameters& Par... )	Start a new recording using the specified parameters.
void	StopRecording()	Stop recording if there is a recorder currently active

Classes

	Name	Description
	FOnTakeRecorderCancelled
	FOnTakeRecorderFinished
	FOnTakeRecorderMarkedFrameAdded
	FOnTakeRecorderPanelChanged
	FOnTakeRecorderPreInitialize
	FOnTakeRecorderStarted
	FOnTakeRecorderStopped

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss