MediaSource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "IMediaOptions.h"
#include "Internationalization/Text.h"
#include "Misc/AssertionMacros.h"
#include "Misc/Variant.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "UObject/UObjectGlobals.h"
#include "MediaSourceOptions.h"
 
#include "MediaSource.generated.h"
 
class FVariant;
class IMediaSourceRendererInterface;
class UMediaSource;
class UTexture;
struct FFrame;
 
DECLARE_DELEGATE_RetVal_TwoParams(UMediaSource*, FMediaSourceSpawnDelegate, const FString&, UObject*);
 
UCLASS(Abstract, editinlinenew, BlueprintType, hidecategories=(Object), MinimalAPI)
class UMediaSource
    : public UObject
    , public IMediaOptions
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Media|MediaSource")
    virtual FString GetUrl() const PURE_VIRTUAL(UMediaSource::GetUrl, return FString(););
 
    UFUNCTION(BlueprintCallable, Category="Media|MediaSource")
    virtual bool Validate() const PURE_VIRTUAL(UMediaSource::Validate, return false;);
 
#if WITH_EDITOR
 
    MEDIAASSETS_API void GenerateThumbnail();
 
    UTexture* GetThumbnail() const { return ThumbnailImage; }
 
    void SetThumbnail(UTexture* InTexture) { ThumbnailImage = InTexture; }
 
    virtual FString GetDescriptionString() const { return GetUrl(); }
 
    typedef TTuple<FText, FText, FText> FInfoElement;
    
    MEDIAASSETS_API virtual void GetDetailsPanelInfoElements(TArray<FInfoElement>& OutInfoElements) const;
#endif // WITH_EDITOR
 
    static MEDIAASSETS_API void RegisterSpawnFromFileExtension(const FString& Extension, FMediaSourceSpawnDelegate InDelegate);
    
    static MEDIAASSETS_API void UnregisterSpawnFromFileExtension(const FString& Extension);
 
    static MEDIAASSETS_API UMediaSource* SpawnMediaSourceForString(const FString& MediaPath, UObject* Outer);
 
public:
    //~ UObject interface
    MEDIAASSETS_API virtual void BeginDestroy() override;
 
    //~ IMediaOptions interface
 
    MEDIAASSETS_API virtual FName GetDesiredPlayerName() const override;
    MEDIAASSETS_API virtual bool GetMediaOption(const FName& Key, bool DefaultValue) const override;
    MEDIAASSETS_API virtual double GetMediaOption(const FName& Key, double DefaultValue) const override;
    MEDIAASSETS_API virtual int64 GetMediaOption(const FName& Key, int64 DefaultValue) const override;
    MEDIAASSETS_API virtual FString GetMediaOption(const FName& Key, const FString& DefaultValue) const override;
    MEDIAASSETS_API virtual FText GetMediaOption(const FName& Key, const FText& DefaultValue) const override;
    MEDIAASSETS_API virtual TSharedPtr<FDataContainer, ESPMode::ThreadSafe> GetMediaOption(const FName& Key, const TSharedPtr<FDataContainer, ESPMode::ThreadSafe>& DefaultValue) const override;
    MEDIAASSETS_API virtual bool HasMediaOption(const FName& Key) const override;
    MEDIAASSETS_API virtual const UObject* ToUObject() const override;
 
    UFUNCTION(BlueprintCallable, meta=(DisplayName = "SetMediaOption (boolean)"), Category = "Media|MediaSource")
    MEDIAASSETS_API void SetMediaOptionBool(const FName& Key, bool Value);
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "SetMediaOption (float)"), Category = "Media|MediaSource")
    MEDIAASSETS_API void SetMediaOptionFloat(const FName& Key, float Value);
    MEDIAASSETS_API void SetMediaOptionDouble(const FName& Key, double Value);
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "SetMediaOption (integer64)"), Category = "Media|MediaSource")
    MEDIAASSETS_API void SetMediaOptionInt64(const FName& Key, int64 Value);
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "SetMediaOption (string)"), Category = "Media|MediaSource")
    MEDIAASSETS_API void SetMediaOptionString(const FName& Key, const FString& Value);
 
private:
    TMap<FName, FVariant> MediaOptionsMap;
 
    MEDIAASSETS_API const FVariant* GetMediaOptionDefault(const FName& Key) const;
 
    MEDIAASSETS_API void SetMediaOption(const FName& Key, FVariant& Value);
 
    static MEDIAASSETS_API TMap<FString, FMediaSourceSpawnDelegate>& GetSpawnFromFileExtensionDelegates();
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY(Transient)
    TObjectPtr<UTexture> ThumbnailImage = nullptr;
 
    UPROPERTY(Transient)
    TObjectPtr<UObject> MediaSourceRenderer = nullptr;
 
#endif
};