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

Light Theme

Dark Theme

ULevelSequencePlayer

[ULevelSequencePlayer](API\Runtime\LevelSequence\ULevelSequencePlayer) is used to actually "play" an level sequence asset at runtime.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSequencePlayer

ULevelSequencePlayer

References

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

Syntax

class ULevelSequencePlayer : public UMovieSceneSequencePlayer

Remarks

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.

Variables

	Name	Description
TWeakObjectPtr<...	CachedCameraComponent
FOnLevelSequenc...	OnCameraCut	Event triggered when there is a camera cut
TOptional< int3...	SnapshotOffsetTime
FLevelSequenceS...	SnapshotSettings	How to take snapshots

Constructors

	Name	Description
	ULevelSequencePlayer ( const FObjectInitializer& )

Functions

	Name	Description
ULevelSequen...	CreateLevelSequencePlayer ( UObject* WorldContextObject, ULevelSequence* LevelSequence, FMovieSceneSequencePlaybackSettings..., ALevelSequenceActor*& OutActor )	Create a new level sequence player.
UCameraCompo...	GetActiveCameraComponent()	Get the active camera cut camera
void	GetEventContexts ( UWorld& InWorld, TArray< UObject* >& OutContex... )	Populate the specified array with any given event contexts for the specified world
void	Initialize ( ULevelSequence* InLevelSequenc..., ULevel* InLevel, const FMovieSceneSequencePlaybackSe..., const FLevelSequenceCameraSettings ... )	Initialize the player.
void	RewindForReplay()
void	SetSnapshotOffsetFrames ( int32 InFrameOffset )	Set the offset time for the snapshot in play rate frames.
void	SetSnapshotSettings ( const FLevelSequenceSnapshotSetting... )	Set the settings used to capture snapshots with
void	TakeFrameSnapshot ( FLevelSequencePlayerSnapshot& OutS... )	Take a snapshot of the current state of this player

Overridden from UMovieSceneSequencePlayer

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

Overridden from IMovieScenePlayer

	Name	Description
TArray< UObj...	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*, TInlineAlloc... )	Resolve objects bound to the specified binding ID
void	UpdateCameraCut ( UObject* CameraObject, const EMovieSceneCameraCutParams& ... )	Updates the perspective viewports with the actor to view through

Deprecated Functions

		Name	Description
	ULevelSequen...	GetLevelSequence()	Please use GetSequence instead.
	void	Initialize ( ULevelSequence* InLevelSequenc..., ULevel* InLevel, const FMovieSceneSequencePlaybackSe... )	Added camera settings to Initialize.

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

Take our survey

Dismiss