UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
UMovieSceneCapture Class Reference

#include <MovieSceneCapture.h>

+ Inheritance diagram for UMovieSceneCapture:

Public Member Functions

MOVIESCENECAPTURE_API UMovieSceneCapture (const FObjectInitializer &Initializer)
 
virtual MOVIESCENECAPTURE_API void PostInitProperties () override
 
virtual MOVIESCENECAPTURE_API void Initialize (TSharedPtr< FSceneViewport > InSceneViewport, int32 PIEInstance=-1) override
 
virtual void StartCapturing ()
 
virtual void Close () override
 
virtual FMovieSceneCaptureHandle GetHandle () const override
 
const FMovieSceneCaptureSettings & GetSettings () const override
 
const int32 GetFrameNumberOffset () const override
 
virtual MOVIESCENECAPTURE_API void LoadFromConfig ()
 
virtual MOVIESCENECAPTURE_API void SaveToConfig ()
 
MOVIESCENECAPTURE_API void SerializeJson (FJsonObject &Object)
 
MOVIESCENECAPTURE_API void DeserializeJson (const FJsonObject &Object)
 
 DECLARE_EVENT (UMovieSceneCapture, FOnCaptureFinished)
 
FOnCaptureFinished & OnCaptureFinished ()
 
const FCachedMetrics & GetMetrics () const
 
UMovieSceneCaptureProtocolBase * GetImageCaptureProtocol ()
 
UMovieSceneCaptureProtocolBase * GetAudioCaptureProtocol ()
 
MOVIESCENECAPTURE_API void SetImageCaptureProtocolType (TSubclassOf< UMovieSceneCaptureProtocolBase > ProtocolType)
 
MOVIESCENECAPTURE_API void SetAudioCaptureProtocolType (TSubclassOf< UMovieSceneCaptureProtocolBase > ProtocolType)
 
MOVIESCENECAPTURE_API void StartWarmup ()
 
MOVIESCENECAPTURE_API void StartCapture ()
 
MOVIESCENECAPTURE_API void CaptureThisFrame (float DeltaSeconds)
 
MOVIESCENECAPTURE_API void FinalizeWhenReady ()
 
MOVIESCENECAPTURE_API bool ShouldFinalize () const
 
MOVIESCENECAPTURE_API void Finalize ()
 
MOVIESCENECAPTURE_API void Tick (float DeltaSeconds)
 
MOVIESCENECAPTURE_API FString ResolveFileFormat (const FString &Format, const FFrameMetrics &FrameMetrics) const
 
double GetEstimatedCaptureDurationSeconds () const
 
virtual FFrameRate GetCaptureFrameRate () const
 
virtual const ICaptureStrategy & GetCaptureStrategy () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObject * CreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnType * CreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnType * CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnType * CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnType * CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnType * CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObject * GetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStruct * GetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwrite * GetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunction * FindFunction (FName InName) const
 
COREUOBJECT_API UFunction * FindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHAR * GetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObject * GetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClass * RegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObject * GetOutermostObject () const
 
COREUOBJECT_API UPackage * GetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackage * GetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObject * GetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassType * GetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtility * GetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClass * FindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API void * GetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API void * GetNativeInterfaceAddress (UClass *InterfaceClass)
 
const void * GetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoad * GetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClass * GetClass () const
 
FORCEINLINE UObject * GetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackage * GetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackage * GetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Public Attributes

FSoftClassPath ImageCaptureProtocolType
 
FSoftClassPath AudioCaptureProtocolType
 
TObjectPtr< UMovieSceneImageCaptureProtocolBase > ImageCaptureProtocol
 
TObjectPtr< UMovieSceneAudioCaptureProtocolBase > AudioCaptureProtocol
 
FMovieSceneCaptureSettings Settings
 
bool bUseSeparateProcess
 
bool bCloseEditorWhenCaptureStarts
 
FString AdditionalCommandLineArguments
 
FString InheritedCommandLineArguments
 

Static Public Attributes

static MOVIESCENECAPTURE_API const FName MovieSceneCaptureUIName = FName(TEXT("MovieSceneCaptureUIInstance"))
 

Protected Member Functions

virtual void SerializeAdditionalJson (FJsonObject &Object)
 
virtual void DeserializeAdditionalJson (const FJsonObject &Object)
 
virtual MOVIESCENECAPTURE_API bool IsAudioPassIfNeeded () const
 
virtual void AddFormatMappings (TMap< FString, FStringFormatArg > &OutFormatMappings, const FFrameMetrics &FrameMetrics) const
 
MOVIESCENECAPTURE_API void InitializeCaptureProtocols ()
 
MOVIESCENECAPTURE_API void ForciblyReinitializeCaptureProtocols ()
 
virtual void OnTick (float DeltaSeconds)
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

TSharedPtr< ICaptureStrategy > CaptureStrategy
 
TOptional< FCaptureProtocolInitSettings > InitSettings
 
bool bFinalizeWhenReady
 
FMovieSceneCaptureHandle Handle
 
FCachedMetrics CachedMetrics
 
TMap< FString, FStringFormatArg > FormatMappings
 
bool bCapturing
 
bool bIsAudioCapturePass
 
int32 FrameNumberOffset
 
FOnCaptureFinished OnCaptureFinishedDelegate
 
Scalability::FQualityLevels CachedQualityLevels
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FName & SourceFileTagName ()
 
static COREUOBJECT_API UObject * GetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Detailed Description

Class responsible for capturing scene data

Constructor & Destructor Documentation

◆ UMovieSceneCapture()

UMovieSceneCapture::UMovieSceneCapture ( const FObjectInitializer &  Initializer)

Member Function Documentation

◆ AddFormatMappings()

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

Add additional format mappings to be used when generating filenames

◆ CaptureThisFrame()

void UMovieSceneCapture::CaptureThisFrame ( float  DeltaSeconds)

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

◆ Close()

virtual void UMovieSceneCapture::Close ( )
inlineoverridevirtual

Shut down this movie capture

Implements IMovieSceneCaptureInterface.

◆ DECLARE_EVENT()

UMovieSceneCapture::DECLARE_EVENT ( UMovieSceneCapture  ,
FOnCaptureFinished   
)

Event that is fired after we've finished capturing

◆ DeserializeAdditionalJson()

virtual void UMovieSceneCapture::DeserializeAdditionalJson ( const FJsonObject &  Object)
inlineprotectedvirtual

Custom, additional json deserialization

◆ DeserializeJson()

void UMovieSceneCapture::DeserializeJson ( const FJsonObject &  Object)

Deserialize additional json data for this capture

◆ Finalize()

void UMovieSceneCapture::Finalize ( )

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

◆ FinalizeWhenReady()

void UMovieSceneCapture::FinalizeWhenReady ( )

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

◆ ForciblyReinitializeCaptureProtocols()

void UMovieSceneCapture::ForciblyReinitializeCaptureProtocols ( )
protected

◆ GetAudioCaptureProtocol()

UMovieSceneCaptureProtocolBase * UMovieSceneCapture::GetAudioCaptureProtocol ( )
inline

◆ GetCaptureFrameRate()

virtual FFrameRate UMovieSceneCapture::GetCaptureFrameRate ( ) const
inlinevirtual

Get the capture frequency

Implements ICaptureProtocolHost.

◆ GetCaptureStrategy()

virtual const ICaptureStrategy & UMovieSceneCapture::GetCaptureStrategy ( ) const
inlinevirtual

Access the host's capture strategy

Implements ICaptureProtocolHost.

◆ GetEstimatedCaptureDurationSeconds()

double UMovieSceneCapture::GetEstimatedCaptureDurationSeconds ( ) const
inlinevirtual

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

Implements ICaptureProtocolHost.

◆ GetFrameNumberOffset()

const int32 UMovieSceneCapture::GetFrameNumberOffset ( ) const
inlineoverridevirtual

Access Frame Number Offset

Implements IMovieSceneCaptureInterface.

◆ GetHandle()

virtual FMovieSceneCaptureHandle UMovieSceneCapture::GetHandle ( ) const
inlineoverridevirtual

Get a unique handle to this object

Implements IMovieSceneCaptureInterface.

◆ GetImageCaptureProtocol()

UMovieSceneCaptureProtocolBase * UMovieSceneCapture::GetImageCaptureProtocol ( )
inline

Access the capture protocol we are using

◆ GetMetrics()

const FCachedMetrics & UMovieSceneCapture::GetMetrics ( ) const
inline

Access this object's cached metrics

◆ GetSettings()

const FMovieSceneCaptureSettings & UMovieSceneCapture::GetSettings ( ) const
inlineoverridevirtual

Access specific movie scene capture settings

Implements IMovieSceneCaptureInterface.

◆ Initialize()

void UMovieSceneCapture::Initialize ( TSharedPtr< FSceneViewport >  Viewport,
int32  PIEInstance = -1 
)
overridevirtual

Initialize this capture object by binding it to the specified viewport

Implements IMovieSceneCaptureInterface.

Reimplemented in ULevelCapture.

◆ InitializeCaptureProtocols()

void UMovieSceneCapture::InitializeCaptureProtocols ( )
protected

Initialize the settings structure for the current capture type

◆ IsAudioPassIfNeeded()

bool UMovieSceneCapture::IsAudioPassIfNeeded ( ) const
protectedvirtual

Returns true if this is currently the audio pass, or if an audio pass is not needed. Shorthand for checking if we're in a state where we should finish capture.

◆ LoadFromConfig()

void UMovieSceneCapture::LoadFromConfig ( )
virtual

Load save from config helpers

◆ OnCaptureFinished()

FOnCaptureFinished & UMovieSceneCapture::OnCaptureFinished ( )
inline

◆ OnTick()

virtual void UMovieSceneCapture::OnTick ( float  DeltaSeconds)
inlineprotectedvirtual

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

Reimplemented in ULevelCapture.

◆ PostInitProperties()

void UMovieSceneCapture::PostInitProperties ( )
overridevirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UObject.

◆ ResolveFileFormat()

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

Resolve the specified format using the user supplied formatting rules.

Implements ICaptureProtocolHost.

◆ SaveToConfig()

void UMovieSceneCapture::SaveToConfig ( )
virtual

◆ SerializeAdditionalJson()

virtual void UMovieSceneCapture::SerializeAdditionalJson ( FJsonObject &  Object)
inlineprotectedvirtual

Custom, additional json serialization

◆ SerializeJson()

void UMovieSceneCapture::SerializeJson ( FJsonObject &  Object)

Serialize additional json data for this capture

◆ SetAudioCaptureProtocolType()

void UMovieSceneCapture::SetAudioCaptureProtocolType ( TSubclassOf< UMovieSceneCaptureProtocolBase >  ProtocolType)

◆ SetImageCaptureProtocolType()

void UMovieSceneCapture::SetImageCaptureProtocolType ( TSubclassOf< UMovieSceneCaptureProtocolBase >  ProtocolType)

◆ ShouldFinalize()

bool UMovieSceneCapture::ShouldFinalize ( ) const

Check whether we should automatically finalize this capture

◆ StartCapture()

void UMovieSceneCapture::StartCapture ( )

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

◆ StartCapturing()

virtual void UMovieSceneCapture::StartCapturing ( )
inlinevirtual

Instruct this capture to start capturing frames

Implements IMovieSceneCaptureInterface.

◆ StartWarmup()

void UMovieSceneCapture::StartWarmup ( )

Starts warming up. May be optionally called before StartCapture(). This can be used to start rendering frames early, before any files are captured or written out

◆ Tick()

void UMovieSceneCapture::Tick ( float  DeltaSeconds)

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

Member Data Documentation

◆ AdditionalCommandLineArguments

FString UMovieSceneCapture::AdditionalCommandLineArguments

Additional command line arguments to pass to the external process when capturing

◆ AudioCaptureProtocol

TObjectPtr<UMovieSceneAudioCaptureProtocolBase> UMovieSceneCapture::AudioCaptureProtocol

◆ AudioCaptureProtocolType

FSoftClassPath UMovieSceneCapture::AudioCaptureProtocolType

The type of capture protocol to use for audio data.

◆ bCapturing

bool UMovieSceneCapture::bCapturing
protected

Whether we have started capturing or not

◆ bCloseEditorWhenCaptureStarts

bool UMovieSceneCapture::bCloseEditorWhenCaptureStarts

When enabled, the editor will shutdown when the capture starts

◆ bFinalizeWhenReady

bool UMovieSceneCapture::bFinalizeWhenReady
protected

Whether we should automatically attempt to capture frames every tick or not

◆ bIsAudioCapturePass

bool UMovieSceneCapture::bIsAudioCapturePass
protected

If we're currently doing an audio pass or not

◆ bUseSeparateProcess

bool UMovieSceneCapture::bUseSeparateProcess

Whether to capture the movie in a separate process or not

◆ CachedMetrics

FCachedMetrics UMovieSceneCapture::CachedMetrics
protected

Cached metrics for this capture operation

◆ CachedQualityLevels

Scalability::FQualityLevels UMovieSceneCapture::CachedQualityLevels
protected

Cached quality levels

◆ CaptureStrategy

TSharedPtr<ICaptureStrategy> UMovieSceneCapture::CaptureStrategy
protected

Strategy used for capture (real-time/fixed-time-step)

◆ FormatMappings

TMap<FString, FStringFormatArg> UMovieSceneCapture::FormatMappings
protected

Format mappings used for generating filenames

◆ FrameNumberOffset

int32 UMovieSceneCapture::FrameNumberOffset
protected

Frame number index offset when saving out frames. This is used to allow the frame numbers on disk to match what they would be in the authoring application, rather than a simple 0-based sequential index

◆ Handle

FMovieSceneCaptureHandle UMovieSceneCapture::Handle
protected

Our unique handle, used for external representation without having to link to the MovieSceneCapture module

◆ ImageCaptureProtocol

TObjectPtr<UMovieSceneImageCaptureProtocolBase> UMovieSceneCapture::ImageCaptureProtocol

Capture protocol responsible for actually capturing frame data

◆ ImageCaptureProtocolType

FSoftClassPath UMovieSceneCapture::ImageCaptureProtocolType

The type of capture protocol to use for image data

◆ InheritedCommandLineArguments

FString UMovieSceneCapture::InheritedCommandLineArguments

Command line arguments inherited from this process

◆ InitSettings

TOptional<FCaptureProtocolInitSettings> UMovieSceneCapture::InitSettings
protected

The settings we will use to set up the capture protocol

◆ MovieSceneCaptureUIName

const FName UMovieSceneCapture::MovieSceneCaptureUIName = FName(TEXT("MovieSceneCaptureUIInstance"))
static

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.

◆ OnCaptureFinishedDelegate

FOnCaptureFinished UMovieSceneCapture::OnCaptureFinishedDelegate
protected

Event that is triggered when capturing has finished

◆ Settings

FMovieSceneCaptureSettings UMovieSceneCapture::Settings

Settings that define how to capture

The documentation for this class was generated from the following files: