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 API Reference > Editor > Sequencer > ISequencer

Light Theme

Dark Theme

ISequencer

Interface for sequencers.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMovieScenePlayer

TSharedFromThis

ISequencer

References

Module	Sequencer
Header	/Engine/Source/Editor/Sequencer/Public/ISequencer.h
Include	#include "ISequencer.h"

Syntax

class ISequencer :
public IMovieScenePlayer,
public TSharedFromThis< ISequencer >

Remarks

Interface for sequencers.

Variables

		Name	Description
	FOnCameraAddedT...	CameraAddedToSequencer
	FOnGetCanRecord	GetCanRecord
	FOnGetIsBinding...	GetIsBindingVisible
	FOnGetIsRecordi...	GetIsRecording
	FOnGetIsTrackVi...	GetIsTrackVisible
	FOnGetPlaybackS...	GetPlaybackSpeeds
	FOnInitializeDe...	InitializeDetailsPanelEvent

Functions

	Name	Description
TArray< FGui...	AddActors ( const TArray< TWeakObjectPtr< AActo..., bool bSelectActors )	Add actors as possessable objects to sequencer.
void	AddSubSequence ( UMovieSceneSequence* Sequence )	Adds a movie scene as a section inside the current movie scene
bool	CanKeyProperty ( FCanKeyPropertyParams CanKeyPropert... )
void	Close()	Close the sequencer.
TArray< FGui...	ConvertToSpawnable ( FGuid Guid )	Convert the Possessable to a Spawnable. Returns an array of Spawnable Id's
FGuid	CreateBinding ( UObject& InObject, const FString& InName )	Create a new binding for the specified object
void	EmptySelection()	Empties the current selection.
void	EnterSilentMode()	Puts sequencer in a silent state (whereby it will not redraw viewports, or attempt to update external state besides the sequence itself)
void	ExitSilentMode()	Leaves a silent state (see above)
void	ExternalSelectionHasChanged()	Called when the external selection has changed in such a way that sequencer should re-synchronize its selection states
TArrayView< ...	FindObjectsInCurrentSequence ( const FGuid& InObjectBinding )
UObject *...	FindSpawnedObjectOrTemplate ( const FGuid& BindingId )	Attempt to find a spawned object in the currently focused movie scene, or the template object for the specified binding ID, if possible
UMovieSceneS...	FindSubSection ( FMovieSceneSequenceID SequenceID )	Attempt to locate the sub section that relates to the specified sequence ID.
void	FocusSequenceInstance ( UMovieSceneSubSection& Section )	Focuses a sub-movie scene (MovieScene within a MovieScene) in the sequencer.
void	ForceEvaluate()	Forcefully reevaluate the sequence immediately
EAllowEditsM...	GetAllowEditsMode()
EAutoChangeM...	GetAutoChangeMode()
bool	GetAutoSetTrackDefaults()	Gets whether or not property track defaults will be automatically set when adding tracks.
void	GetCameraObjectBindings ( TArray< FGuid >& OutBindingIDs )	Gets the list of bindings for camera objects.
TSharedPtr< ...	GetCommandBindings ( ESequencerCommandBindings Type )
FOnCurveDisp...	GetCurveDisplayChanged()	Gets a multicast delegate when the curve edtior associated with this sequencer has it's selection change.
FText	GetDisplayName ( FGuid InBinding )	Get the Display Name of the Object Binding Track.
FFrameRate	GetFocusedDisplayRate()	Get the display rate of the currently focused sequence
UMovieSceneS...	GetFocusedMovieSceneSequence()
FMovieSceneS...	GetFocusedMovieSceneSequenceTransform()
FMovieSceneS...	GetFocusedTemplateID()
FFrameRate	GetFocusedTickResolution()	Get the tick resolution of the currently focused sequence
FQualifiedFr...	GetGlobalTime()	Gets the global time.
FGuid	GetHandleToObject ( UObject* Object, bool bCreateHandleIfMissing, const FName& CreatedFolderName )	Gets a handle to runtime information about the object being manipulated by a movie scene
bool	GetInfiniteKeyAreas()
EKeyGroupMod...	GetKeyGroupMode()
EMovieSceneK...	GetKeyInterpolation()
void	GetKeysFromSelection ( TUniquePtr< FSequencerKeyCollection..., float DuplicateThresoldTime )	Get all the keys for the current sequencer selection
uint32	GetLocalLoopIndex()
FQualifiedFr...	GetLocalTime()	Gets the current time of the time slider relative to the currently focused movie scene
TArray< FMov...	GetMarkedFrames()
TSharedRef< ...	GetNumericTypeInterface()
ISequencerOb...	GetObjectChangeListener()
float	GetPlaybackSpeed()
FFrameRate	GetRootDisplayRate()	Get the display rate of the currently root sequence
UMovieSceneS...	GetRootMovieSceneSequence()
FMovieSceneS...	GetRootTemplateID()
FFrameRate	GetRootTickResolution()	Get the tick resolution of the currently root sequence
void	GetSelectedFolders ( TArray< UMovieSceneFolder* >&... )	Gets the currently selected folders.
void	GetSelectedKeyAreas ( TArray< const IKeyArea* >& Ou..., bool bIncludeSelectedKeys )	Gets the currently selected key areas.
void	GetSelectedObjects ( TArray< FGuid >& OutSelectedObject... )	Gets the currently selected Object Guids
void	GetSelectedSections ( TArray< UMovieSceneSection* > ... )	Gets the currently selected sections.
void	GetSelectedTracks ( TArray< UMovieSceneTrack* >& ... )	Gets the currently selected tracks.
FSequencerSe...	GetSelection()
FOnSelection...	GetSelectionChangedObjectGuids()	Gets a multicast delegate with an array of FGuid of bound objects which is called when the outliner node selection changes.
FOnSelection...	GetSelectionChangedSections()	Gets a multicast delegate with an array of UMovieSceneSections which is called when the outliner node selection changes.
FOnSelection...	GetSelectionChangedTracks()	Gets a multicast delegate with an array of UMovieSceneTracks which is called when the outliner node selection changes.
FSequencerSe...	GetSelectionPreview()
TRange< FFra...	GetSelectionRange()	Get the selection range.
USequencerSe...	GetSequencerSettings()	Getter for sequencer settings
TSharedRef< ...	GetSequencerWidget()
TSharedPtr< ...	GetToolkitHost()	Returns the Toolkit hosting the sequencer instance, if any
TSharedPtr< ...	GetTopTimeSliderWidget()	Get the top time slider from the main widget.
TArray< FTex...	GetTrackFilterNames()	Gets all the available track filter names
FAnimatedRan...	GetViewRange()
bool	IsAllowedToChange()
bool	IsInSilentMode()	Checks whether we're in silent mode or not
bool	IsPerspectiveViewportCameraCutEnabled()	Gets whether perspective viewport hijacking is enabled.
bool	IsPerspectiveViewportPossessionEnabled()	Gets whether perspective viewport hijacking is enabled.
bool	IsReadOnly()	Whether the sequence is read-only
bool	IsTrackFilterEnabled ( const FText& InTrackFilterName )	Gets whether the specified track filter is on/off
void	KeyProperty ( FKeyPropertyParams KeyPropertyParam... )
FGuid	MakeNewSpawnable ( UObject& SourceObject, UActorFactory* ActorFactory, bool bSetupDefaults )	Attempts to add a new spawnable to the MovieScene for the specified object (asset, class or actor instance)
TSharedRef< ...	MakeTimeRange ( const TSharedRef< SWidget >& Inner..., bool bShowWorkingRange, bool bShowViewRange, bool bShowPlaybackRange )	Create a widget containing the spinboxes for setting the working and playback range
TSharedRef< ...	MakeTransportControls ( bool bExtended )
void	NotifyMovieSceneDataChanged ( EMovieSceneDataChangeType DataChang... )
void	NotifyMovieSceneDataChangedInternal()
void	ObjectImplicitlyAdded ( UObject* InObject )	Specify that an object was implicitly added.
void	ObjectImplicitlyRemoved ( UObject* InObject )	Specify that an object was implicitly removed.
ISequencer::...	OnActivateSequence()
FOnActorAdde...	OnActorAddedToSequencer()
void	OnAddTrack ( const TWeakObjectPtr< UMovieSceneTr..., const FGuid& ObjectBinding )	Should be called after adding a track to the MovieScene.
FOnBeginScru...	OnBeginScrubbingEvent()	Gets a multicast delegate which is executed whenever the user begins scrubbing.
FOnCameraAdd...	OnCameraAddedToSequencer()
ISequencer::...	OnCameraCut()
FOnChannelCh...	OnChannelChanged()	Gets a multicast delegate which is executed whenever a channel is changed by Sequencer.
FOnCloseEven...	OnCloseEvent()
FOnEndScrubb...	OnEndScrubbingEvent()	Gets a multicast delegate which is executed whenever the user stops scrubbing.
FOnGetCanRec...	OnGetCanRecord()
FOnGetIsBind...	OnGetIsBindingVisible()
FOnGetIsReco...	OnGetIsRecording()
FOnGetIsTrac...	OnGetIsTrackVisible()
FOnGlobalTim...	OnGlobalTimeChanged()	Gets a multicast delegate which is executed whenever the global time changes.
ISequencer::...	OnInitializeDetailsPanel()
FOnMovieScen...	OnMovieSceneBindingsChanged()	Gets a multicast delegate which is executed whenever the movie scene bindings are changed.
FOnMovieScen...	OnMovieSceneBindingsPasted()	Gets a multicast delegate which is executed whenever bindings are pasted.
FOnMovieScen...	OnMovieSceneDataChanged()	Gets a multicast delegate which is executed whenever the movie scene data is changed.
FReply	OnPlay ( bool bTogglePlay )	Play or toggle playback at the specified play rate
FOnPlayEvent...	OnPlayEvent()	Gets a multicast delegate which is executed whenever the user begins playing the sequence.
ISequencer::...	OnPostSave()
ISequencer::...	OnPreSave()
FOnRecordEve...	OnRecordEvent()	Gets a multicast delegate which is executed whenever the user toggles recording.
FOnStopEvent...	OnStopEvent()	Gets a multicast delegate which is executed whenever the user stops playing the sequence.
FOnTreeViewC...	OnTreeViewChanged()	Gets a multicast delegate which is executed whenever the sequencer tree view changes, like when an object is added, or filtered from the view
void	Pause()	Pause playback
void	PlayTo ( FMovieSceneSequencePlaybackParams P... )	Play from the current time to the requested time
void	RecreateCurveEditor()	Recreate any associated Curve Editor
void	RefreshTree()	Refresh the sequencer tree view
void	RenderMovie ( const TArray< UMovieSceneCinematicS... )	Render movie for a section.
void	RequestEvaluate()	Forcefully reevaluate the sequence on the next frame
void	RequestInvalidateCachedData()	Invalidate cached data so that it will be reevaluated on the next frame
void	ResetTimeController()	Reset the timing manager to the clock source specified by the root movie scene
void	ResetToNewRootSequence ( UMovieSceneSequence& NewAnimation )	Resets sequencer with a new animation
void	RestorePlaybackSpeed()	Restores the speed to 1.
void	ResumeSelectionBroadcast()
void	SelectByChannels ( UMovieSceneSection* Section, TArrayView< const FMovieSceneChanne..., bool bSelectParentInstead, bool bSelect )	Selects the nodes that relate to the specified channels
void	SelectByChannels ( UMovieSceneSection* Section, const TArray< FName >& InChannelNa..., bool bSelectParentInstead, bool bSelect )	Selects the nodes that relate to the specified channels
void	SelectByNthCategoryNode ( UMovieSceneSection* Section, int Index, bool bSelect )	Selects nodes by the nth category node under a section
void	SelectByPropertyPaths ( const TArray< FString >& InPropert... )	Selects property tracks by property path
void	SelectFolder ( UMovieSceneFolder* Folder )	Selects a folder
void	SelectObject ( FGuid ObjectBinding )	Selects an object by GUID
void	SelectSection ( UMovieSceneSection* Section )	Selects a section
void	SelectTrack ( UMovieSceneTrack* Track )	Selects a track
void	SetAllowEditsMode ( EAllowEditsMode AllowEditsMode )	Sets where edits are allowed
void	SetAutoChangeMode ( EAutoChangeMode AutoChangeMode )	SSets the current auto-change mode.
void	SetClampRange ( TRange< double > NewClampRange )	Set the clamp range
void	SetDisplayName ( FGuid InBinding, const FText& InDisplayName )	Set the Display Name of the Object Binding Track.
void	SetGlobalTime ( FFrameTime Time, bool bEvaluate )	Set the global time directly, without performing any auto-scroll, snapping or other adjustments to the supplied time
void	SetInfiniteKeyAreas ( bool bInfiniteKeyAreas )	Set infinite key area default
void	SetKeyGroupMode ( EKeyGroupMode Mode )	Sets which channels are keyed when a channel is keyed
void	SetKeyInterpolation ( EMovieSceneKeyInterpolation )	Set default key interpolation
void	SetLocalTime ( FFrameTime Time, ESnapTimeMode SnapTimeMode, bool bEvaluate )	Sets the cursor position relative to the currently focused sequence
void	SetLocalTimeDirectly ( FFrameTime NewTime, bool bEvaluate )	Set the current local time directly, with no other snapping, scrolling or manipulation
void	SetPerspectiveViewportCameraCutEnabled ( bool bEnabled )	Sets whether perspective viewport camera cutting is enabled.
void	SetPerspectiveViewportPossessionEnabled ( bool bEnabled )	Sets whether perspective viewport hijacking is enabled.
void	SetPlaybackSpeed ( float InPlaybackSpeed )
void	SetSelectionRangeEnd ( FFrameTime EndFrame )	Set the selection range's end position to the requested time.
void	SetSelectionRangeStart ( FFrameTime StartFrame )	Set the selection range's start position to the requested time.
void	SetSequencerSettings ( USequencerSettings* )	Setter for sequencer settings
void	SetTrackFilterEnabled ( const FText& InTrackFilterName, bool bEnabled )	Sets the specified track filter to be on or off
void	SetViewRange ( TRange< double > NewViewRange, EViewRangeInterpolation Interpolati... )	Set the view range, growing the working range to accomodate, if necessary
void	SnapToClosestPlaybackSpeed()	Snaps to the closest available speed to the current one.
void	SuppressAutoEvaluation ( UMovieSceneSequence* Sequence, const FGuid& InSignature )	Suppresses automatic evaluation the specified sequence and signature are the only difference that would prompt a re-evaluation
void	SuspendSelectionBroadcast()
void	ThrobKeySelection()	Throb key or section selection
void	ThrobSectionSelection()
void	UpdatePlaybackRange()

Classes

	Name	Description
	FOnActivateSequence
	FOnCameraCut
	FOnInitializeDetailsPanel
	FOnPostSave
	FOnPreSave

Typedefs

Name	Description
FOnActorAddedToSequencer
FOnBeginScrubbingEvent
FOnCameraAddedToSequencer	A delegate which will can be used in response to a camera being added to the sequence.
FOnChannelChanged
FOnCloseEvent
FOnCurveDisplayChanged
FOnEndScrubbingEvent
FOnGetCanRecord	A delegate which will determine whether a recording is possible
FOnGetIsBindingVisible	A delegate which will determine whether a binding should be visible in the tree.
FOnGetIsRecording	A delegate which will determine whether there is a recording in progress
FOnGetIsTrackVisible	A delegate which will determine whether a track should be visible in the tree.
FOnGetPlaybackSpeeds
FOnGlobalTimeChanged
FOnMovieSceneBindingsChanged
FOnMovieSceneBindingsPasted
FOnMovieSceneDataChanged
FOnPlayEvent
FOnRecordEvent
FOnSelectionChangedObjectGuids
FOnSelectionChangedSections
FOnSelectionChangedTracks
FOnStopEvent
FOnTreeViewChanged