IMediaPlayerFactory.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Internationalization/Text.h"
#include "Templates/SharedPointer.h"
 
class FString;
class IMediaEventSink;
class IMediaOptions;
class IMediaPlayer;
 
 
enum class EMediaFeature
{
    AudioSamples,
 
    AudioTracks,
 
    CaptionTracks,
 
    MetadataTracks,
 
    OverlaySamples,
 
    SubtitleTracks,
 
    TextTracks,
 
    Video360,
 
    VideoSamples,
 
    VideoStereo,
 
    VideoTracks
};
 
 
class IMediaPlayerFactory
{
public:
 
    virtual bool CanPlayUrl(const FString& Url, const IMediaOptions* Options, TArray<FText>* OutWarnings, TArray<FText>* OutErrors) const = 0;
 
    virtual TSharedPtr<IMediaPlayer, ESPMode::ThreadSafe> CreatePlayer(IMediaEventSink& EventSink) = 0;
 
    virtual FText GetDisplayName() const = 0;
 
    virtual FName GetPlayerName() const = 0;
 
    virtual FGuid GetPlayerPluginGUID() const = 0;
 
    virtual const TArray<FString>& GetSupportedPlatforms() const = 0;
 
    virtual bool SupportsFeature(EMediaFeature Feature) const = 0;
 
public:
 
    bool CanPlayUrl(const FString& Url, const IMediaOptions* Options) const
    {
        return CanPlayUrl(Url, Options, nullptr, nullptr);
    }
 
    virtual int32 GetPlayabilityConfidenceScore(const FString& Url, const IMediaOptions* Options, TArray<FText>* OutWarnings, TArray<FText>* OutErrors) const
    {
        return CanPlayUrl(Url, Options, OutWarnings, OutErrors) ? 100 : 0;
    }
 
    bool SupportsPlatform(const FString& PlatformName) const
    {
        return GetSupportedPlatforms().Contains(PlatformName);
    }
 
public:
 
    virtual ~IMediaPlayerFactory() { }
};