1. Epic GamesDeveloper
  3. ULevelSequencePlayer

ULevelSequencePlayer

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

Unreal Engine C++ API Reference > Runtime > LevelSequence

Inheritance Hierarchy

  • UMovieSceneSequencePlayer
  • UE::MovieScene::FCameraCutPlaybackCapability
  • ULevelSequencePlayer
  • UAvaSequencePlayer

References

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

Syntax

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

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

  Type Name Description
Protected variable TWeakObjectPtr< UCameraComponent > CachedCameraComponent  
Public variable UProperty Category BlueprintAssignable FOnLevelSequencePlayerCameraCutEvent OnCameraCut Event triggered when there is a camera cut
Protected variable TOptional< int32 > SnapshotOffsetTime  

Constructors

  Type Name Description
Public function  

ULevelSequencePlayer ( const FObjectInitializer&
)

  

Functions

  Type Name Description
Protected function Virtual Const bool

CanPlay ()

  
Public function Static UFunction BlueprintCallable, Category, Meta ULevelSequencePlayer *

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

 Create a new level sequence player.
Public function Const UFunction BlueprintCallable, Category UCameraComponent * Get the active camera cut camera
Protected function Virtual TOptional< EAspectRatioAxisConstraint >  
Protected function Virtual float  
Public function Virtual Const TArray< UObject * >  
Public function Static void

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

 Populate the specified array with any given event contexts for the specified world
Public function Virtual Const UObject *  
Public function void

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

 Initialize the player.
Protected function Virtual void

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

  
Protected function Virtual void

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

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual Const void

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

  
Public function void  
Public function void

SetSnapshotOffsetFrames ( int32 InFrameOffset
)

 Set the offset time for the snapshot in play rate frames.
Public function void

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

  
Protected function Virtual bool  
Public function Const void Take a snapshot of the current state of this player
Protected function Virtual void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page