MediaPlayerOptions.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "Containers/Map.h"
#include "Misc/Variant.h"
 
#include "MediaPlayerOptions.generated.h"
 
UENUM(BlueprintType)
enum class EMediaPlayerOptionBooleanOverride : uint8
{
    UseMediaPlayerSetting,
    Enabled,
    Disabled
};
 
 
UENUM(BlueprintType)
enum class EMediaPlayerOptionSeekTimeType : uint8
{
    // Ignore the given value and lets the media player choose.
    Ignored,
    // Given seek time is relative to the start of the media.
    RelativeToStartTime
};
 
 
UENUM(BlueprintType)
enum class EMediaPlayerOptionTrackSelectMode : uint8
{
    // Let the media player choose defaults.
    UseMediaPlayerDefaults UMETA(DisplayName="Media player selects default tracks"),
    // Use fixed track indices as specified with MediaPlayerTrackOptions
    UseTrackOptionIndices UMETA(DisplayName="Uses provided track indices"),
    // Use language codes as specified with MediaPlayerInitialTrackLanguageSelection
    UseLanguageCodes UMETA(DisplayName="Use provided language codes or have media player select defaults when there is no match")
};
 
 
USTRUCT(BlueprintType)
struct FMediaPlayerTrackOptions
{
    GENERATED_BODY()
 
    FMediaPlayerTrackOptions() :
        Audio(0),
        Caption(-1),
        Metadata(-1),
        Script(-1),
        Subtitle(-1),
        Text(-1),
        Video(0)
    {
    }
 
    bool operator!=(const FMediaPlayerTrackOptions& Other) const
    {
        return (Audio != Other.Audio
            || Caption != Other.Caption
            || Metadata != Other.Metadata
            || Script != Other.Script
            || Subtitle != Other.Subtitle
            || Text != Other.Text
            || Video != Other.Video);
    }
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Audio;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Caption;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Metadata;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Script;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Subtitle;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Text;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks")
    int32 Video;
};
 
 
USTRUCT(BlueprintType)
struct FMediaPlayerInitialTrackLanguageSelection
{
    GENERATED_BODY()
 
    FMediaPlayerInitialTrackLanguageSelection()
    { }
 
    bool operator!=(const FMediaPlayerInitialTrackLanguageSelection& Other) const
    { return Video != Other.Video || Audio != Other.Audio || Subtitle != Other.Subtitle || Caption != Other.Caption; }
 
    // Language code or codes of the video track to select. Useful when the video contains burned-in subtitles or localized scenes.
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(ToolTip="Comma separated RFC 4647 language ranges in order of priority, or keep empty for default."))
    FString Video;
 
    // Language code or codes of the audio track to select.
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(ToolTip="Comma separated RFC 4647 language ranges in order of priority, or keep empty for default."))
    FString Audio;
 
    // Language code or codes of the subtitle track to select.
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(ToolTip="Comma separated RFC 4647 language ranges in order of priority, or keep empty for default."))
    FString Subtitle;
 
    // Language code or codes of the caption track to select. Captions may not provide language codes if carried in the video signal.
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(ToolTip="Comma separated RFC 4647 language ranges in order of priority, or keep empty for default."))
    FString Caption;
};
 
USTRUCT(BlueprintType)
struct FMediaPlayerOptions
{
    GENERATED_BODY()
 
    FMediaPlayerOptions() :
        TrackSelection(EMediaPlayerOptionTrackSelectMode::UseTrackOptionIndices),
        SeekTime(0),
        SeekTimeType(EMediaPlayerOptionSeekTimeType::RelativeToStartTime),
        PlayOnOpen(EMediaPlayerOptionBooleanOverride::UseMediaPlayerSetting),
        Loop(EMediaPlayerOptionBooleanOverride::UseMediaPlayerSetting)
    {
    }
 
    void SetAllAsOptional()
    {
        SeekTime = FTimespan::MinValue();
        TrackSelection = EMediaPlayerOptionTrackSelectMode::UseMediaPlayerDefaults;
        SeekTimeType = EMediaPlayerOptionSeekTimeType::Ignored;
        PlayOnOpen = EMediaPlayerOptionBooleanOverride::UseMediaPlayerSetting;
        Loop = EMediaPlayerOptionBooleanOverride::UseMediaPlayerSetting;
    }
 
    bool operator!=(const FMediaPlayerOptions& Other) const
    {
        return (Tracks != Other.Tracks
            || TracksByLanguage != Other.TracksByLanguage
            || TrackSelection != Other.TrackSelection
            || SeekTime != Other.SeekTime
            || SeekTimeType != Other.SeekTimeType
            || PlayOnOpen != Other.PlayOnOpen
            || Loop != Other.Loop);
    }
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(DisplayName="Initial track indices", ToolTip="Indices of the media tracks to select for playback", EditCondition="TrackSelection==EMediaPlayerOptionTrackSelectMode::UseTrackOptionIndices"))
    FMediaPlayerTrackOptions Tracks;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(DisplayName="Initial track language", ToolTip="Language of the media tracks to select for playback", EditCondition="TrackSelection==EMediaPlayerOptionTrackSelectMode::UseLanguageCodes"))
    FMediaPlayerInitialTrackLanguageSelection TracksByLanguage;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Tracks", meta=(DisplayName="Initial track selection mode", ToolTip="How the initial media tracks for playback are selected"))
    EMediaPlayerOptionTrackSelectMode TrackSelection;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Misc", meta=(EditCondition="SeekTimeType!=EMediaPlayerOptionSeekTimeType::Ignored"))
    FTimespan SeekTime;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Misc", meta=(DisplayName="Seek time interpretation"))
    EMediaPlayerOptionSeekTimeType SeekTimeType;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Misc")
    EMediaPlayerOptionBooleanOverride PlayOnOpen;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Misc")
    EMediaPlayerOptionBooleanOverride Loop;
 
 
    TMap<FName, FVariant> InternalCustomOptions;
};
 
namespace MediaPlayerOptionValues
{
    inline const FName& Environment()
    { static FName OptName(TEXT("Environment")); return OptName; }
    inline const FName& Environment_Sequencer()
    { static FName OptName(TEXT("Sequencer")); return OptName; }
    inline const FName& Environment_Preview()
    { static FName OptName(TEXT("Preview")); return OptName; }
 
    inline const FName& ImgMediaSmartCacheEnabled()
    { static FName OptName(TEXT("ImgMediaSmartCacheEnabled")); return OptName; }
    inline const FName& ImgMediaSmartCacheTimeToLookAhead()
    { static FName OptName(TEXT("ImgMediaSmartCacheTimeToLookAhead")); return OptName; }
 
    inline const FName& ViewMediaTexture()
    { static FName OptName(TEXT("ViewMediaTexture")); return OptName; }
 
    inline const FName& ParseTimecodeInfo()
    { static FName OptName(TEXT("ParseTimecodeInfo")); return OptName; }
}