Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
A base class for video codec outputs for the Movie Pipeline system. To simplify encoder implementations this handles multi-threading for you and will call all of the encoding functions on a dedicated thread. This allows an encoder to do more expensive operations (such as image quantization) without implementing threading yourself, nor having to worry about blocking the game thread.
| Name | UMoviePipelineVideoOutputBase |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineVideoOutputBase.h |
| Include Path | #include "MoviePipelineVideoOutputBase.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, Abstract)
class UMoviePipelineVideoOutputBase : public UMoviePipelineOutputBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineSetting → UMoviePipelineOutputBase → UMoviePipelineVideoOutputBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelineVideoOutputBase() |
MoviePipelineVideoOutputBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AllWriters | TArray< FMoviePipelineCodecWriter > | MoviePipelineVideoOutputBase.h | ||
| bHasError | bool | MoviePipelineVideoOutputBase.h | ||
| OutstandingTasks | FGraphEventArray | MoviePipelineVideoOutputBase.h |
Functions
Public
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Initialize_EncodeThread
(
MovieRenderPipeline::IVideoCodecWriter* InWriter |
MoviePipelineVideoOutputBase.h | ||
virtual TUniquePtr< MovieRenderPipeline::IVideoCodecWriter > Initialize_GameThread
(
const FString& InFileName, |
MoviePipelineVideoOutputBase.h | ||
virtual bool IsAudioSupported() |
MoviePipelineVideoOutputBase.h |
Overridden from UMoviePipelineOutputBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginFinalizeImpl() |
MoviePipelineVideoOutputBase.h | ||
virtual void FinalizeImpl() |
MoviePipelineVideoOutputBase.h | ||
virtual bool HasFinishedProcessingImpl() |
MoviePipelineVideoOutputBase.h | ||
virtual void OnReceiveImageDataImpl
(
FMoviePipelineMergerOutputFrame* InMergedOutputFrame |
MoviePipelineVideoOutputBase.h | ||
virtual void OnShotFinishedImpl
(
const UMoviePipelineExecutorShot* InShot, |
MoviePipelineVideoOutputBase.h |
Overridden from UMoviePipelineSetting
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FText GetFooterText
(
UMoviePipelineExecutorJob* InJob |
Return a string to show in the footer of the details panel. | MoviePipelineVideoOutputBase.h |