1. Epic GamesDeveloper
  3. UTakeRecorderBlueprintLibrary

UTakeRecorderBlueprintLibrary

API > API/Plugins > API/Plugins/TakeRecorder

   
Name UTakeRecorderBlueprintLibrary
Type class
Header File /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/Recorder/TakeRecorderBlueprintLibrary.h
Include Path #include "Recorder/TakeRecorderBlueprintLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UTakeRecorderBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void CancelRecording()

 Cancel recording if there is a recorder currently active Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"

static UTakeRecorder * GetActiveRecorder()

 Retrieve the currently active recorder, or None if there none are active Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintPure
  • Category="Take Recorder"

static FTakeRecorderParameters GetDefaultParameters()

 Get the default recorder parameters according to the project and user settings Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"

static UTakeRecorderPanel * GetTakeRecorderPanel()

 Get the currently open take recorder panel, if one is open Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Take Recorder"

static bool IsRecording()

 Check whether a recording is currently active Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintPure
  • Category="Take Recorder"

static bool IsTakeRecorderEnabled()

 Is the Take Recorder enabled in the build Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintPure
  • Category="Take Recorder"

static void OnTakeRecorderCancelled()

   Recorder/TakeRecorderBlueprintLibrary.h  

static void OnTakeRecorderFinished ( ULevelSequence* InSequenceAsset
)

   Recorder/TakeRecorderBlueprintLibrary.h  

static void OnTakeRecorderMarkedFrameAdded ( const FMovieSceneMarkedFrame& InMarkedFrame
)

   Recorder/TakeRecorderBlueprintLibrary.h  

static void OnTakeRecorderPreInitialize()

   Recorder/TakeRecorderBlueprintLibrary.h  

static void OnTakeRecorderStarted()

   Recorder/TakeRecorderBlueprintLibrary.h  

static void OnTakeRecorderStopped()

   Recorder/TakeRecorderBlueprintLibrary.h  

static UTakeRecorderPanel * OpenTakeRecorderPanel()

 Get the currently open take recorder panel, if one is open, opening a new one if not Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"

static void SetDefaultParameters ( const FTakeRecorderParameters& DefaultParameters
)

 Set the default recorder parameters Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"

static void SetOnTakeRecorderCancelled ( FOnTakeRecorderCancelled OnTakeRecorderCancelled
)

   Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use TakeRecorderSubsystem::TakeRecorderCancelled")

static void SetOnTakeRecorderFinished ( FOnTakeRecorderFinished OnTakeRecorderFinished
)

   Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use TakeRecorderSubsystem::TakeRecorderFinished")

static void SetOnTakeRecorderMarkedFrameAdded ( FOnTakeRecorderMarkedFrameAdded OnTakeRecorderMarkedFrameAdded
)

   Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use TakeRecorderSubsystem::TakeRecorderMarkedFrameAdded")

static void SetOnTakeRecorderPanelChanged ( FOnTakeRecorderPanelChanged OnTakeRecorderPanelChanged
)

 Called when a Take Panel is constructed or destroyed. Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DisplayName="Set On Take Recorder Panel Changed")

static void SetOnTakeRecorderPreInitialize ( FOnTakeRecorderPreInitialize OnTakeRecorderPreInitialize
)

   Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use TakeRecorderSubsystem::TakeRecorderPreInitialize")

static void SetOnTakeRecorderStarted ( FOnTakeRecorderStarted OnTakeRecorderStarted
)

   Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use TakeRecorderSubsystem::TakeRecorderStarted")

static void SetOnTakeRecorderStopped ( FOnTakeRecorderStopped OnTakeRecorderStopped
)

   Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use TakeRecorderSubsystem::TakeRecorderStopped")

static void SetTakeRecorderPanel ( UTakeRecorderPanel* InNewPanel
)

 Internal function to assign a new take recorder panel singleton. Recorder/TakeRecorderBlueprintLibrary.h  

static UTakeRecorder * StartRecording ( ULevelSequence* LevelSequence,
UTakeRecorderSources* Sources,
UTakeMetaData* MetaData,
const FTakeRecorderParameters& Parameters
)

 Start a new recording using the specified parameters. Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"

static void StopRecording()

 Stop recording if there is a recorder currently active Recorder/TakeRecorderBlueprintLibrary.h
  • BlueprintCallable
  • Category="Take Recorder"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page