FileMediaSource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "BaseMediaSource.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "UObject/NameTypes.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "FileMediaSource.generated.h"
 
class UObject;
struct FFrame;
struct FPropertyChangedEvent;
 
 
UCLASS(BlueprintType, MinimalAPI)
class UFileMediaSource
    : public UBaseMediaSource
{
    GENERATED_BODY()
 
public:
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category=File, AssetRegistrySearchable)
    FString FilePath;
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category=File, AdvancedDisplay)
    bool PrecacheFile;
 
public:
 
    const FString& GetFilePath() const
    {
        return FilePath;
    }
 
    MEDIAASSETS_API FString GetFullPath() const;
 
    UFUNCTION(BlueprintCallable, Category="Media|FileMediaSource")
    MEDIAASSETS_API void SetFilePath(const FString& Path);
 
#if WITH_EDITOR
    MEDIAASSETS_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
public:
 
    //~ IMediaOptions interface
 
    MEDIAASSETS_API virtual bool GetMediaOption(const FName& Key, bool DefaultValue) const override;
    MEDIAASSETS_API virtual bool HasMediaOption(const FName& Key) const override;
 
public:
 
    //~ UMediaSource interface
 
    MEDIAASSETS_API virtual FString GetUrl() const override;
    MEDIAASSETS_API virtual bool Validate() const override;
 
#if WITH_EDITOR
    MEDIAASSETS_API virtual void GetDetailsPanelInfoElements(TArray<FInfoElement>& OutInfoElements) const override;
#endif
public:
 
    static MEDIAASSETS_API FName PrecacheFileOption;
 
private:
    MEDIAASSETS_API void ResolveFullPath() const;
    MEDIAASSETS_API void ClearResolvedFullPath() const;
    mutable FString ResolvedFullPath; // this is a cached variable updated in ResolveFullPath hence mutable
};