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 > Editor > SequenceRecorder > ISequenceRecorder

Light Theme

Dark Theme

ISequenceRecorder

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

ISequenceRecorder

References

Module	SequenceRecorder
Header	/Engine/Source/Editor/SequenceRecorder/Public/ISequenceRecorder.h
Include	#include "ISequenceRecorder.h"

Syntax

class ISequenceRecorder : public IModuleInterface

Functions

	Name	Description
TWeakObjectP...	AddRecordingGroup()	Adds a new recording group and picks a default name.
void	AddSequenceRecorderExtender ( TSharedPtr< ISequenceRecorderExtend... )	Add an extension to the SequenceRecorder
TUniquePtr< ...	CreateAudioRecorder()	Attempt to create an audio recorder
TWeakObjectP...	DuplicateRecordingGroup()	Duplicates the current recording group if any.
TWeakObjectP...	GetCurrentRecordingGroup()	Returns the current recording group (if any), otherwise returns nullptr.
FQualifiedFr...	GetCurrentRecordingLength()	How long is the currently recording sequence
TArray< FNam...	GetRecordingGroupNames()	Returns a list of names for the recording groups stored in this map.
FGuid	GetRecordingGuid ( AActor* Actor )	Get the spawnable Guid in the currently recording movie scene for the specified actor.
FString	GetSequenceRecordingBasePath()	Get the directory that the sequence should record into.
FString	GetSequenceRecordingName()	Get the name the of the sequence recording.
uint32	GetTakeNumberForActor ( AActor* InActor )	Get the take number of an actor that is queued to record in the current group
bool	HasAudioRecorder()	Check whether we have an audio recorder registered or not
bool	IsRecording()	Are we currently recording a sequence
TWeakObjectP...	LoadRecordingGroup ( const FName Name )	Attempts to load a recording group from the specified name.
void	NotifyActorStartRecording ( AActor* Actor )	Notify we should start recording an actor - usually used for 'actor pooling' implementations to simulate spawning.
void	NotifyActorStopRecording ( AActor* Actor )	Notify we should stop recording an actor - usually used for 'actor pooling' implementations to simulate de-spawning.
FOnRecording...	OnRecordingFinished()	Get the sequence recorder finished delegate
FOnRecording...	OnRecordingGroupAdded()	Get the Recording Group added delegate
FOnRecording...	OnRecordingStarted()	Get the sequence recorder started delegate
UActorRecord...	QueueActorToRecord ( AActor* ActorToRecord )	Add an actor to be recorded when the next recording pass begins
USequenceRec...	QueueObjectToRecord ( UObject* ObjectToRecord )	Add an object to be recorded when the next recording pass begins
bool	RecordSingleNodeInstanceToAnimation ( USkeletalMeshComponent* Previe..., UAnimSequence* NewAsset )	Play the current single node instance on the PreviewComponent from time [0, GetLength()], and record to NewAsset
FDelegateHan...	RegisterAudioRecorder ( const TFunction< TUniquePtr< ISeque... )	Register a function that will return a new audio capturer for the specified parameters
void	RemoveCurrentRecordingGroup()	Removes the current recording group if any. Will make GetRecordingGroup() return nullptr.
void	RemoveSequenceRecorderExtender ( TSharedPtr< ISequenceRecorderExtend... )	Remove an extension from the SequenceRecorder
bool	StartRecording ( UWorld* World, const FSequenceRecorderActorFilter ... )	Start recording the passed-in actors.
bool	StartRecording ( TArrayView< AActor*const > Ac..., const FString& PathToRecordTo, const FString& SequenceName )	Start a recording, possibly with some delay (specified by the sequence recording settings).
bool	StartRecording ( AActor* ActorToRecord, const FString& PathToRecordTo, const FString& SequenceName )	Start a recording, possibly with some delay (specified by the sequence recording settings).
void	StopRecording()	Stop recording current sequence, if any
void	UnregisterAudioRecorder ( FDelegateHandle RegisteredHandle )	Unregister a previously registered audio recorder factory function

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

Take our survey

Dismiss