UMoviePipelineQueueEngineSubsystem | Unreal Engine 4.27 Documentation

Unreal Engine C++ API Reference > Plugins > MovieRenderPipelineCore

Inheritance Hierarchy

References


Module	MovieRenderPipelineCore
Header	/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueueEngineSubsystem.h
Include	#include "MoviePipelineQueueEngineSubsystem.h"

Syntax

UCLASS&40;BlueprintType, Meta&61;&40;DisplayName&61;"MoviePipeline Runtime Subsystem"&41;&41;  
class UMoviePipelineQueueEngineSubsystem : public UEngineSubsystem

Remarks

This subsystem is intended for use when rendering in a shipping game (but can also be used in PIE during development/testing). See UMoviePipelineQueueSubsystem for the Editor-only queue which is bound to the Movie Render Queue UI. To do simple renders at runtime, call AllocateJob(...) with the Level Sequence you want to render, then call FindOrAddSettingByClass on the job to add the settings (such as render pass, output type, and output directory) that you want for the job. Finally, call RenderJob with the job you just configured. Register a delegate to OnRenderFinished to be notified when the render finished. You can optionally call SetConfiguration(...) before RenderJob to configure some advanced options.

Variables

	Type	Name	Description
	FMoviePipelineWorkFinished	OnRenderFinished	Assign a function to this delegate to get notified when each individual job is finished.

Constructors

	Type	Name	Description
		UMoviePipelineQueueEngineSubsystem ()

Functions

Type	Name	Description
UMoviePipelineExecutorJob *	AllocateJob ( ULevelSequence* InSequence )	Convenience function for creating a UMoviePipelineExecutorJob out of the given Level Sequence asset.
UMoviePipelineExecutorBase *	GetActiveExecutor ()	Returns the active executor (if there is one).
UMoviePipelineQueue *	GetQueue ()	Returns the queue of Movie Pipelines that need to be rendered.
bool	IsRendering ()	Returns true if there is an active executor working on producing a movie.
void	RenderJob ( UMoviePipelineExecutorJob* InJob )	Convenience function for rendering the specified job.
UMoviePipelineExecutorBase *	RenderQueueWithExecutor ( TSubclassOf< UMoviePipelineExecutorBase > InExecutorType )	Starts processing the current queue with the supplied executor class.
void	RenderQueueWithExecutorInstance ( UMoviePipelineExecutorBase* InExecutor )	Starts processing the current queue with the supplied executor.
void	SetConfiguration ( TSubclassOf< UMovieRenderDebugWidget > InProgressWidgetClass, const bool bRenderPlayerViewport )	Sets some advanced configuration options that are used only occasionally to have better control over integrating it into your game/application.

Navigation