TimecodeProvider.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
 
#include "Misc/FrameRate.h"
#include "Misc/Timecode.h"
#include "Misc/QualifiedFrameTime.h"
 
#include "TimecodeProvider.generated.h"
 
UENUM()
enum class ETimecodeProviderSynchronizationState
{
    Closed,
 
    Error,
 
    Synchronized,
 
    Synchronizing,
};
 
UCLASS(abstract, MinimalAPI)
class UTimecodeProvider : public UObject
{
    GENERATED_BODY()
 
public:
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = "Settings")
    float FrameDelay = 0.f;
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    virtual bool FetchTimecode(FQualifiedFrameTime& OutFrameTime) { return false; };
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    virtual void FetchAndUpdate() {}
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    virtual FQualifiedFrameTime GetQualifiedFrameTime() const PURE_VIRTUAL(UTimecodeProvider::GetQualifiedFrameTime, return FQualifiedFrameTime(););
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    ENGINE_API FQualifiedFrameTime GetDelayedQualifiedFrameTime() const;
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    ENGINE_API FTimecode GetTimecode() const;
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    ENGINE_API FTimecode GetDelayedTimecode() const;
    
    UFUNCTION(BlueprintCallable, Category = "Provider")
    FFrameRate GetFrameRate() const { return GetQualifiedFrameTime().Rate; }
 
    UFUNCTION(BlueprintCallable, Category = "Provider")
    virtual ETimecodeProviderSynchronizationState GetSynchronizationState() const PURE_VIRTUAL(UTimecodeProvider::IsSynchronized, return ETimecodeProviderSynchronizationState::Closed;);
 
public:
    virtual bool Initialize(class UEngine* InEngine) PURE_VIRTUAL(UTimecodeProvider::Initialize, return false;);
 
    virtual void Shutdown(class UEngine* InEngine) PURE_VIRTUAL(UTimecodeProvider::Shutdown, );
 
    virtual bool SupportsAutoDetected() const
    {
        return false;
    }
    
    virtual void SetIsAutoDetected(bool bInIsAutoDetected)
    {
    }
    
    virtual bool IsAutoDetected() const
    {
        return false;
    }
};