1. Epic GamesDeveloper
  3. UMovieSceneCapture

UMovieSceneCapture

Class responsible for capturing scene data

API > API/Runtime > API/Runtime/MovieSceneCapture

Class responsible for capturing scene data

   
Name UMovieSceneCapture
Type class
Header File /Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCapture.h
Include Path #include "MovieSceneCapture.h"

Syntax

UCLASS (Config=EditorPerProjectUserSettings, PerObjectConfig, BlueprintType, MinimalAPI)  
class UMovieSceneCapture :  
    public UObject,  
    public IMovieSceneCaptureInterface ,  
    public ICaptureProtocolHost

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneCapture ( const FObjectInitializer& Initializer
)

   MovieSceneCapture.h  

Classes

Name Remarks
FOnCaptureFinished Event that is fired after we've finished capturing

Constants

Name Type Remarks Include Path
MovieSceneCaptureUIName const FName This name is used by the UI to save/load a specific instance of the settings from config that doesn't affect the CDO which would affect scripting environments. MovieSceneCapture.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalCommandLineArguments FString Additional command line arguments to pass to the external process when capturing MovieSceneCapture.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • AdvancedDisplay
  • Meta=(EditCondition=bUseSeparateProcess)
AudioCaptureProtocol TObjectPtr< UMovieSceneAudioCaptureProtocolBase >   MovieSceneCapture.h
  • VisibleAnywhere
  • Category=CaptureSettings
  • Transient
  • Instanced
AudioCaptureProtocolType FSoftClassPath The type of capture protocol to use for audio data. MovieSceneCapture.h
  • Config
  • EditAnywhere
  • NoClear
  • Category=CaptureSettings
  • DisplayName="Audio Output Format"
  • Meta=(MetaClass="/Script/MovieSceneCapture.MovieSceneAudioCaptureProtocolBase", HideViewOptions, ShowDisplayNames)
bCloseEditorWhenCaptureStarts bool When enabled, the editor will shutdown when the capture starts MovieSceneCapture.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • AdvancedDisplay
  • Meta=(EditCondition=bUseSeparateProcess)
bUseSeparateProcess bool Whether to capture the movie in a separate process or not MovieSceneCapture.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • AdvancedDisplay
ImageCaptureProtocol TObjectPtr< UMovieSceneImageCaptureProtocolBase > Capture protocol responsible for actually capturing frame data MovieSceneCapture.h
  • VisibleAnywhere
  • Category=CaptureSettings
  • Transient
  • Instanced
ImageCaptureProtocolType FSoftClassPath The type of capture protocol to use for image data MovieSceneCapture.h
  • Config
  • EditAnywhere
  • NoClear
  • Category=CaptureSettings
  • DisplayName="Image Output Format"
  • Meta=(MetaClass="/Script/MovieSceneCapture.MovieSceneImageCaptureProtocolBase", HideViewOptions, ShowDisplayNames)
InheritedCommandLineArguments FString Command line arguments inherited from this process MovieSceneCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Transient
  • Category=General
  • AdvancedDisplay
  • Meta=(EditCondition=bUseSeparateProcess)
Settings FMovieSceneCaptureSettings Settings that define how to capture MovieSceneCapture.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • Category=CaptureSettings
  • Meta=(ShowOnlyInnerProperties)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CaptureThisFrame ( float DeltaSeconds
)

 Indicate that this frame should be captured - must be called before the movie scene capture is ticked MovieSceneCapture.h  

void DeserializeJson ( const FJsonObject& Object
)

 Deserialize additional json data for this capture MovieSceneCapture.h  

void Finalize()

 Finalize the capturing process, assumes all frames have been processed. MovieSceneCapture.h  

void FinalizeWhenReady()

 Automatically finalizes the capture when all currently pending frames are dealt with MovieSceneCapture.h  

UMovieSceneCaptureProtocolBase * GetAudioCaptureProtocol()

   MovieSceneCapture.h
  • BlueprintCallable
  • Category=Capture

UMovieSceneCaptureProtocolBase * GetImageCaptureProtocol()

 Access the capture protocol we are using MovieSceneCapture.h
  • BlueprintCallable
  • Category=Capture

const FCachedMetrics & GetMetrics()

 Access this object's cached metrics MovieSceneCapture.h  

virtual void LoadFromConfig()

 Load save from config helpers MovieSceneCapture.h  

FOnCaptureFinished & OnCaptureFinished()

   MovieSceneCapture.h  

virtual void PostInitProperties()

   MovieSceneCapture.h  

virtual void SaveToConfig()

   MovieSceneCapture.h  

void SerializeJson ( FJsonObject& Object
)

 Serialize additional json data for this capture MovieSceneCapture.h  

void SetAudioCaptureProtocolType ( TSubclassOf< UMovieSceneCaptureProtocolBase > ProtocolType
)

   MovieSceneCapture.h
  • BlueprintCallable
  • Category=Capture

void SetImageCaptureProtocolType ( TSubclassOf< UMovieSceneCaptureProtocolBase > ProtocolType
)

   MovieSceneCapture.h
  • BlueprintCallable
  • Category=Capture

bool ShouldFinalize()

 Check whether we should automatically finalize this capture MovieSceneCapture.h  

void StartCapture()

 Initialize the capture so that it is able to start capturing frames MovieSceneCapture.h  

void StartWarmup ()

 Starts warming up. MovieSceneCapture.h  

void Tick ( float DeltaSeconds
)

 Called at the end of a frame, before a frame is presented by slate MovieSceneCapture.h  

Overridden from IMovieSceneCaptureInterface

Name Remarks Include Path Unreal Specifiers

virtual void Close()

 Shut down this movie capture MovieSceneCapture.h  

virtual const int32 GetFrameNumberOffset()

 Access Frame Number Offset MovieSceneCapture.h  

virtual FMovieSceneCaptureHandle GetHandle()

 Get a unique handle to this object MovieSceneCapture.h  

virtual const FMovieSceneCaptureSettings & GetSettings()

 Access specific movie scene capture settings MovieSceneCapture.h  

virtual void Initialize ( TSharedPtr< FSceneViewport > Viewport,
int32 PIEInstance
)

 Initialize this capture object by binding it to the specified viewport MovieSceneCapture.h  

virtual void StartCapturing()

 Instruct this capture to start capturing frames MovieSceneCapture.h  

Overridden from ICaptureProtocolHost

Name Remarks Include Path Unreal Specifiers

virtual FFrameRate GetCaptureFrameRate()

 Get the capture frequency MovieSceneCapture.h  

virtual const ICaptureStrategy & GetCaptureStrategy()

 Access the host's capture strategy MovieSceneCapture.h  

virtual double GetEstimatedCaptureDurationSeconds()

 Estimate how long our duration is going to be for pre-allocation purposes. MovieSceneCapture.h  

virtual FString ResolveFileFormat ( const FString& Format,
const FFrameMetrics& FrameMetrics
) const

 Resolve the specified format using the user supplied formatting rules. MovieSceneCapture.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AddFormatMappings ( TMap< FString, FStringFormatArg >& OutFormatMappings,
const FFrameMetrics& FrameMetrics
) const

 Add additional format mappings to be used when generating filenames MovieSceneCapture.h  

virtual void DeserializeAdditionalJson ( const FJsonObject& Object
)

 Custom, additional json deserialization MovieSceneCapture.h  

void ForciblyReinitializeCaptureProtocols()

   MovieSceneCapture.h  

void InitializeCaptureProtocols()

 Initialize the settings structure for the current capture type MovieSceneCapture.h  

virtual bool IsAudioPassIfNeeded ()

 Returns true if this is currently the audio pass, or if an audio pass is not needed. MovieSceneCapture.h  

virtual void OnTick ( float DeltaSeconds
)

 Called at the end of a frame, before a frame is presented by slate MovieSceneCapture.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   MovieSceneCapture.h  

virtual void SerializeAdditionalJson ( FJsonObject& Object
)

 Custom, additional json serialization MovieSceneCapture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page