USequencerToolsFunctionLibrary

This is a set of helper functions to access various parts of the Sequencer API via Python.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

SequencerScriptingEditor

Header

/Engine/Plugins/MovieScene/SequencerScripting/Source/SequencerScriptingEditor/Public/SequencerTools.h

Include

#include "SequencerTools.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, Meta=(ScriptName="SequencerTools"))
class USequencerToolsFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

This is a set of helper functions to access various parts of the Sequencer API via Python. Because Sequencer itself is not suitable for exposing, most functionality gets wrapped by UObjects that have an easier API to work with. This UObject provides access to these wrapper UObjects where needed.

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category

void

 

CancelMovieRender()

Attempts to cancel an in-progress Render to Movie. Does nothing if there is no render in progress.

Public function Static UFunction BlueprintCallable, Category

bool

 

ExportAnimSequence

(
    UWorld* World,
    ULevelSequence* Sequence,
    UAnimSequence* AnimSequence,
    const FSequencerBindingProxy& Bind...
)

Export Passed in Binding as an Anim Seqquence.

Public function Static UFunction BlueprintCallable, Category

bool

 

ExportFBX

(
    UWorld* InWorld,
    ULevelSequence* InSequence,
    const TArray< FSequencerBindingProx...,
    UFbxExportOption* OverrideOpti...,
    const FString& InFBXFileName
)

Export Passed in Bindings to FBX

Public function Static UFunction BlueprintCallable, Category

TArray< FSeq...

 

GetBoundObjects

(
    UWorld* InWorld,
    ULevelSequence* InSequence,
    const TArray< FSequencerBindingProx...,
    const FSequencerScriptingRange& In...
)

Retrieve all objects currently bound to the specified binding identifiers.

Public function Static UFunction BlueprintCallable, Category

TArray< FSeq...

 

GetObjectBindings

(
    UWorld* InWorld,
    ULevelSequence* InSequence,
    const TArray< UObject* >& InO...,
    const FSequencerScriptingRange& In...
)

Get the object bindings for the requested object.

Public function Static UFunction BlueprintCallable, Category

bool

 

ImportFBX

(
    UWorld* InWorld,
    ULevelSequence* InSequence,
    const TArray< FSequencerBindingProx...,
    UMovieSceneUserImportFBXSettings&#...,
    const FString& InImportFilename
)

Import Passed in Bindings to FBX

Public function Static UFunction BlueprintCallable, Category

bool

 

IsRenderingMovie()

Returns if Render to Movie is currently in progress.

Public function Static UFunction BlueprintCallable, Category

bool

 

RenderMovie

(
    UMovieSceneCapture* InCaptureS...,
    FOnRenderMovieStopped OnFinishedCal...
)

Attempts to render a sequence to movie based on the specified settings.

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