ULevelSequencePlayer | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	LevelSequence
Header	/Engine/Source/Runtime/LevelSequence/Public/LevelSequencePlayer.h
Include	#include "LevelSequencePlayer.h"

class ULevelSequencePlayer : public UMovieSceneSequencePlayer

ULevelSequencePlayer is used to actually "play" an level sequence asset at runtime.

This class keeps track of playback state and provides functions for manipulating an level sequence while its playing.

Type	Name	Description
TWeakObjectPtr< UCameraComponent >	CachedCameraComponent
FOnLevelSequencePlayerCameraCutEvent	OnCameraCut	Event triggered when there is a camera cut
TOptional< int32 >	SnapshotOffsetTime

	Type	Name	Description
		ULevelSequencePlayer ( const FObjectInitializer& )

Type	Name	Description
ULevelSequencePlayer *	CreateLevelSequencePlayer ( UObject* WorldContextObject, ULevelSequence* LevelSequence, FMovieSceneSequencePlaybackSettings Settings, ALevelSequenceActor*& OutActor )	Create a new level sequence player.
UCameraComponent *	GetActiveCameraComponent ()	Get the active camera cut camera
void	GetEventContexts ( UWorld& InWorld, TArray< UObject* >& OutContexts )	Populate the specified array with any given event contexts for the specified world
void	Initialize ( ULevelSequence* InLevelSequence, ULevel* InLevel, const FLevelSequenceCameraSettings& InCameraSettings )	Initialize the player.
void	RewindForReplay ()
void	SetSnapshotOffsetFrames ( int32 InFrameOffset )	Set the offset time for the snapshot in play rate frames.
void	TakeFrameSnapshot ( FLevelSequencePlayerSnapshot& OutSnapshot )	Take a snapshot of the current state of this player

	Type	Name	Description
	bool	CanPlay ()
	void	OnStartedPlaying ()
	void	OnStopped ()
	void	UpdateMovieSceneInstance ( FMovieSceneEvaluationRange InRange, EMovieScenePlayerStatus::Type PlayerStatus, const FMovieSceneUpdateArgs& Args )

Type	Name	Description
TArray< UObject * >	GetEventContexts ()	Access the event contexts for this movie scene player
UObject *	GetPlaybackContext ()	Access the playback context for this movie scene player
void	ResolveBoundObjects ( const FGuid& InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence& Sequence, UObject* ResolutionContext, TArray< UObject*, TInlineAllocator< 1 >>& OutObjects )	Resolve objects bound to the specified binding ID
void	UpdateCameraCut ( UObject* CameraObject, const EMovieSceneCameraCutParams& CameraCutParams )	Updates the perspective viewports with the actor to view through

	Type	Name	Description
	void	Initialize ( ULevelSequence* InLevelSequence, ULevel* InLevel, const FMovieSceneSequencePlaybackSettings& Settings, const FLevelSequenceCameraSettings& InCameraSettings )	Use SetPlaybackSettings(...) then Initialize(ULevelSequence, ULevel, const FLevelSequenceCameraSettings&)