ITakeRecorderModule

Public module interface for the Take Recorder module

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

ITakeRecorderModule

References

Module

TakeRecorder

Header

/Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/ITakeRecorderModule.h

Include

#include "ITakeRecorderModule.h"

Syntax

class ITakeRecorderModule : public IModuleInterface

Remarks

Public module interface for the Take Recorder module

Functions

Name Description

Public function

FOnExternalO...

 

GetExternalObjectAddRemoveEventDelegate()

Get the event notifier when an external object has been added or removed.

Public function

TArray< TWea...

 

GetExternalObjects()

Get the take external objects registered to the take recorder.

Public function Const

UTakePreset ...

 

GetPendingTake()

Get the current pending take.

Public function

FOnGenerateW...

 

GetRecordButtonExtensionGenerators()

Get the toolbar extension generators.

Public function

FOnRecordErr...

 

GetRecordErrorCheckGenerator()

Get the delegate for reporting any error conditions in recording state.

Public function

FOnGenerateW...

 

GetToolbarExtensionGenerators()

Get the toolbar extension generators.

Public function

FOnForceSave...

 

OnForceSaveAsPreset()

Get the delegate for handling saving of preset data.

Public function

void

 

RegisterExternalObject

(
    UObject* InExternalObject
)

Register a new class default object that should appear on the take recorder panel.

Public function

void

 

RegisterSettingsObject

(
    UObject* InSettingsObject
)

Register a new class default object that should appear on the take recorder project settings

Public function

FDelegateHan...

 

RegisterSourcesMenuExtension

(
    const FOnExtendSourcesMenu& InExte...
)

Register a new extension callback for the 'Add Source' menu

Public function

void

 

UnregisterExternalObject

(
    UObject* InExternalObject
)

Unregister a new class default object that should appear on the take recorder panel.

Public function

void

 

UnregisterSourcesMenuExtension

(
    FDelegateHandle Handle
)

Unregister a previously registered extension callback for the 'Add Source' menu

Typedefs

Name

Description

FOnExternalObjectAddRemoveEvent

Delegate called when an external object is registered for the take recorder panel.

Constants

Name

Description

TakeRecorderTabLabel

The default label for the take recorder tab

TakeRecorderTabName

The name under which the take recorder tab is registered and invoked

TakesBrowserInstanceName

The Takes Browser Content Browser Instance Name

TakesBrowserTabLabel

The default label for the takes browser

TakesBrowserTabName

The tab name for the takes browser tab

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss