1. Epic GamesDeveloper
  3. ULevelSequencePlayer

ULevelSequencePlayer

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

API > API/Runtime > API/Runtime/LevelSequence

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.

   
Name ULevelSequencePlayer
Type class
Header File /Engine/Source/Runtime/LevelSequence/Public/LevelSequencePlayer.h
Include Path #include "LevelSequencePlayer.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class ULevelSequencePlayer :  
    public UMovieSceneSequencePlayer ,  
    public UE::MovieScene::FCameraCutPlaybackCapability

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

ULevelSequencePlayer ( const FObjectInitializer&
)

   LevelSequencePlayer.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnCameraCut FOnLevelSequencePlayerCameraCutEvent Event triggered when there is a camera cut LevelSequencePlayer.h
  • BlueprintAssignable
  • Category="Sequencer|Player"

Protected

Name Type Remarks Include Path Unreal Specifiers
CameraSettings FLevelSequenceCameraSettings The camera settings to use when playing the sequence LevelSequencePlayer.h  
ContainerID FActorContainerID World Partition container ID for the world that should be added to any actor locaters when being resolved within the same world. LevelSequencePlayer.h  
Level TWeakObjectPtr< ULevel > The world this player will spawn actors in, if needed LevelSequencePlayer.h  
PreviousSnapshot TOptional< FLevelSequencePlayerSnapshot >   LevelSequencePlayer.h  
SourceAssetPath FTopLevelAssetPath Source asset path denoting the level asset path that has been streamed in. LevelSequencePlayer.h  
WeakStreamingWorld TWeakObjectPtr< UWorld > Optional streaming world that should be used primarily for resolving actor references. LevelSequencePlayer.h  
World TWeakObjectPtr< UWorld > The world this player will spawn actors in, if needed LevelSequencePlayer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UCameraComponent * GetActiveCameraComponent()

 Get the active camera cut camera LevelSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void Initialize ( ULevelSequence* InLevelSequence,
ULevel* InLevel,
const FLevelSequenceCameraSettings& InCameraSettings
)

 Initialize the player. LevelSequencePlayer.h  

void RewindForReplay()

   LevelSequencePlayer.h  

void SetSnapshotOffsetFrames ( int32 InFrameOffset
)

 Set the offset time for the snapshot in play rate frames. LevelSequencePlayer.h  

void SetSourceActorContext ( UWorld* InStreamingWorld,
FActorContainerID InContainerID,
FTopLevelAssetPath InSourceAssetPath
)

   LevelSequencePlayer.h  

void TakeFrameSnapshot ( FLevelSequencePlayerSnapshot& OutSnapshot
) const

 Take a snapshot of the current state of this player LevelSequencePlayer.h  

Overridden from IMovieScenePlayer

Name Remarks Include Path Unreal Specifiers

virtual TArray< UObject * > GetEventContexts ()

   LevelSequencePlayer.h  

virtual UObject * GetPlaybackContext()

   LevelSequencePlayer.h  

Protected

Overridden from UMovieSceneSequencePlayer

Name Remarks Include Path Unreal Specifiers

virtual bool CanPlay()

   LevelSequencePlayer.h  

virtual void OnStartedPlaying()

   LevelSequencePlayer.h  

virtual void OnStopped()

   LevelSequencePlayer.h  

virtual void UpdateMovieSceneInstance ( FMovieSceneEvaluationRange InRange,
EMovieScenePlayerStatus::Type PlayerStatus,
const FMovieSceneUpdateArgs& Args
)

   LevelSequencePlayer.h  

Overridden from IMovieScenePlayer

Name Remarks Include Path Unreal Specifiers

virtual void InitializeRootInstance ( TSharedRef< UE::MovieScene::FSharedPlaybackState > NewSharedPlaybackState
)

   LevelSequencePlayer.h  

virtual void ResolveBoundObjects ( UE::UniversalObjectLocator::FResolveParams& ResolveParams,
const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
) const

   LevelSequencePlayer.h  

Overridden from FCameraCutPlaybackCapability

Name Remarks Include Path Unreal Specifiers

virtual TOptional< EAspectRatioAxisConstraint > GetAspectRatioAxisConstraintOverride()

   LevelSequencePlayer.h  

virtual float GetCameraBlendPlayRate()

   LevelSequencePlayer.h  

virtual void OnCameraCutUpdated ( const UE::MovieScene::FOnCameraCutUpdatedParams& Params
)

   LevelSequencePlayer.h  

virtual bool ShouldUpdateCameraCut()

   LevelSequencePlayer.h  

Static

Name Remarks Include Path Unreal Specifiers

static ULevelSequencePlayer * CreateLevelSequencePlayer ( UObject* WorldContextObject,
ULevelSequence* LevelSequence,
FMovieSceneSequencePlaybackSettings Settings,
ALevelSequenceActor*& OutActor
)

 Create a new level sequence player. LevelSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
  • Meta=(WorldContext="WorldContextObject", DynamicOutputParam="OutActor")

static void GetEventContexts ( UWorld& InWorld,
TArray< UObject* >& OutContexts
)

 Populate the specified array with any given event contexts for the specified world LevelSequencePlayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page