LiveLinkSourceSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "LiveLinkSourceFactory.h"
#include "LiveLinkTypes.h"
#include "Misc/FrameNumber.h"
#include "Misc/FrameRate.h"
#include "Templates/SubclassOf.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "LiveLinkSourceSettings.generated.h"
 
UCLASS(config=Engine, defaultconfig)
class ULiveLinkDefaultSourceSettings : public UObject
{
    GENERATED_BODY()
 
public:
    UPROPERTY(config)
    int32 DefaultSourceFrameBufferSize = 10;
};
 
 
class FArchive;
class FProperty;
class ULiveLinkSourceFactory;
 
UENUM()
enum class ELiveLinkSourceMode : uint8
{
    //The source will the latest frame available to evaluate its subjects.
    //This mode will not attempt any type of interpolation or time synchronization.
    Latest,
 
    //The source will use the engine's time to evaluate its subjects.
    //This mode is most useful when smooth animation is desired.
    EngineTime,
 
    //The source will use the engine's timecode to evaluate its subjects.
    //This mode is most useful when sources need to be synchronized with 
    //multiple other external inputs
    //(such as video or other time synchronized sources).
    //Should not be used when the engine isn't setup with a Timecode provider.
    Timecode,
};
 
//~ A customizer will add the properties manually. You'll need to update LiveLinkSourceSettingsDetailCustomization if you add a property here.
USTRUCT()
struct FLiveLinkSourceBufferManagementSettings
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(InlineEditConditionToggle=true))
    bool bValidEngineTimeEnabled = false;
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(ForceUnits=s, ClampMin=0.5, EditCondition="bValidEngineTimeEnabled"))
    float ValidEngineTime = 1.0f;
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(ForceUnits=s))
    float EngineTimeOffset = 0.0f;
    
    UPROPERTY(VisibleAnywhere, Category = "Settings", AdvancedDisplay, meta = (ForceUnits = s))
    double EngineTimeClockOffset = 0.0;
 
    UPROPERTY(VisibleAnywhere, Category = "Settings", AdvancedDisplay, meta = (ForceUnits = s))
    double SmoothEngineTimeOffset = 0.0;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FFrameRate TimecodeFrameRate_DEPRECATED = {24, 1};
#endif
 
    UPROPERTY(EditAnywhere, Category = "Settings")
    bool bGenerateSubFrame = false;
 
    UPROPERTY(VisibleAnywhere, Category = "Settings")
    FFrameRate DetectedFrameRate = { 24, 1 };
 
    UPROPERTY(EditAnywhere, Category = "Settings")
    bool bUseTimecodeSmoothLatest = false;
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(EditCondition="bGenerateSubFrame"))
    FFrameRate SourceTimecodeFrameRate = { 24, 1 };
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(InlineEditConditionToggle=true))
    bool bValidTimecodeFrameEnabled = false;
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(ClampMin=1, EditCondition="bValidTimecodeFrameEnabled"))
    int32 ValidTimecodeFrame = 30;
 
    UPROPERTY(EditAnywhere, Category = "Settings")
    float TimecodeFrameOffset = 0.f;
 
    UPROPERTY(VisibleAnywhere, Category = "Settings", AdvancedDisplay, meta = (ForceUnits = s))
    double TimecodeClockOffset = 0.0;
 
    UPROPERTY(EditAnywhere, Category = "Settings")
    int32 LatestOffset = 0;
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(ClampMin=1, DisplayName="Buffer Size (Frames)"))
    int32 MaxNumberOfFrameToBuffered = 10;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = "Settings")
    bool bKeepAtLeastOneFrame = true;
};
 
USTRUCT()
struct FLiveLinkSourceDebugInfo
{
    GENERATED_BODY()
 
    UPROPERTY(VisibleAnywhere, Category = "Debug")
    FLiveLinkSubjectName SubjectName;
 
    UPROPERTY(VisibleAnywhere, Category = "Debug")
    int32 SnapshotIndex = 0;
 
    UPROPERTY(VisibleAnywhere, Category = "Debug")
    int32 NumberOfBufferAtSnapshot = 0;
};
 
UCLASS(MinimalAPI)
class ULiveLinkSourceSettings : public UObject
{
public:
    GENERATED_BODY()
 
    LIVELINKINTERFACE_API ULiveLinkSourceSettings();
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta=(DisplayName="Evaluation Mode"))
    ELiveLinkSourceMode Mode = ELiveLinkSourceMode::EngineTime;
 
    UPROPERTY(EditAnywhere, Category = "Settings")
    FLiveLinkSourceBufferManagementSettings BufferSettings;
 
    UPROPERTY(EditAnywhere, Category = "Settings")
    bool bTransmitEvaluatedData = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = "Settings")
    FString ConnectionString;
 
    UPROPERTY()
    TSubclassOf<ULiveLinkSourceFactory> Factory;
 
    UPROPERTY(EditAnywhere, Category = "Settings", meta = (DisplayName="Sync Subject"))
    FLiveLinkSubjectName ParentSubject;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TArray<FLiveLinkSourceDebugInfo> SourceDebugInfos_DEPRECATED;
#endif
 
    LIVELINKINTERFACE_API virtual void Serialize(FArchive& Ar) override;
 
#if WITH_EDITOR
    LIVELINKINTERFACE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
#endif
};
 
USTRUCT()
struct
    UE_DEPRECATED(4.23, "FLiveLinkTimeSynchronizationSettings is now unused.")
    FLiveLinkTimeSynchronizationSettings
{
    GENERATED_BODY()
 
    FLiveLinkTimeSynchronizationSettings() : FrameRate(60, 1) {}
 
    UPROPERTY(EditAnywhere, Category = Settings)
    FFrameRate FrameRate;
 
    UPROPERTY(EditAnywhere, Category = Settings)
    FFrameNumber FrameOffset;
};
 
USTRUCT()
struct 
    UE_DEPRECATED(4.23, "FLiveLinkInterpolationSettings is now unused.")
    FLiveLinkInterpolationSettings
{
    GENERATED_BODY()
 
    FLiveLinkInterpolationSettings() 
        : bUseInterpolation_DEPRECATED(false)
        , InterpolationOffset(0.5f) 
    {}
 
    UPROPERTY()
    bool bUseInterpolation_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category = Settings)
    float InterpolationOffset;
};