UTakeRecorderBlueprintLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

TakeRecorder

Header

/Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/Recorder/TakeRecorderBlueprintLibrary.h

Include

#include "Recorder/TakeRecorderBlueprintLibrary.h"

Syntax

UCLASS()
class UTakeRecorderBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category

void

 

CancelRecording()

Cancel recording if there is a recorder currently active

Public function Static UFunction BlueprintPure, Category

UTakeRecorde...

 

GetActiveRecorder()

Retrieve the currently active recorder, or None if there none are active

Public function Static UFunction BlueprintCallable, Category

FTakeRecorde...

 

GetDefaultParameters()

Get the default recorder parameters according to the project and user settings

Public function Static UFunction BlueprintCallable, BlueprintPure, Category

UTakeRecorde...

 

GetTakeRecorderPanel()

Get the currently open take recorder panel, if one is open

Public function Static UFunction BlueprintPure, Category

bool

 

IsRecording()

Check whether a recording is currently active

Public function Static UFunction BlueprintPure, Category

bool

 

IsTakeRecorderEnabled()

Is the Take Recorder enabled in the build

Public function Static

void

 

OnTakeRecorderCancelled()

Public function Static

void

 

OnTakeRecorderFinished

(
    ULevelSequence* InSequenceAsse...
)

Public function Static

void

 

OnTakeRecorderMarkedFrameAdded

(
    const FMovieSceneMarkedFrame& InMa...
)

Public function Static

void

 

OnTakeRecorderPreInitialize()

Public function Static

void

 

OnTakeRecorderStarted()

Public function Static

void

 

OnTakeRecorderStopped()

Public function Static UFunction BlueprintCallable, Category

UTakeRecorde...

 

OpenTakeRecorderPanel()

Get the currently open take recorder panel, if one is open, opening a new one if not

Public function Static UFunction BlueprintCallable, Category

void

 

SetOnTakeRecorderCancelled

(
    FOnTakeRecorderCancelled OnTakeReco...
)

Called when take recording is cancelled.

Public function Static UFunction BlueprintCallable, Category

void

 

SetOnTakeRecorderFinished

(
    FOnTakeRecorderFinished OnTakeRecor...
)

Called when take recording finishes.

Public function Static UFunction BlueprintCallable, Category

void

 

SetOnTakeRecorderMarkedFrameAdded

Called when a marked frame is added.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetOnTakeRecorderPanelChanged

(
    FOnTakeRecorderPanelChanged OnTakeR...
)

Called when a Take Panel is constructed or destroyed.

Public function Static UFunction BlueprintCallable, Category

void

 

SetOnTakeRecorderPreInitialize

(
    FOnTakeRecorderPreInitialize OnTake...
)

Called before initialization occurs (ie. when the recording button is pressed and before the countdown starts)

Public function Static UFunction BlueprintCallable, Category

void

 

SetOnTakeRecorderStarted

(
    FOnTakeRecorderStarted OnTakeRecord...
)

Called when take recording starts.

Public function Static UFunction BlueprintCallable, Category

void

 

SetOnTakeRecorderStopped

(
    FOnTakeRecorderStopped OnTakeRecord...
)

Called when take recording is stopped.

Public function Static

void

 

SetTakeRecorderPanel

(
    UTakeRecorderPanel* InNewPanel
)

Internal function to assign a new take recorder panel singleton.

Public function Static UFunction BlueprintCallable, Category

UTakeRecorde...

 

StartRecording

(
    ULevelSequence* LevelSequence,
    UTakeRecorderSources* Sources,
    UTakeMetaData* MetaData,
    const FTakeRecorderParameters& Par...
)

Start a new recording using the specified parameters.

Public function Static UFunction BlueprintCallable, Category

void

 

StopRecording()

Stop recording if there is a recorder currently active

Classes