IMediaControls.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Math/Range.h"
#include "Math/RangeSet.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/Timespan.h"
#include "Misc/Optional.h"
 
 
enum class EMediaControl
{
    BlockOnFetch,
 
    Pause,
 
    Resume,
 
    Scrub,
 
    Seek,
 
    PlaybackRange
};
 
 
enum class EMediaSeekDirection
{
    Backward,
 
    Beginning,
 
    End,
 
    Forward
};
 
 
enum class EMediaRateThinning
{
    Thinned,
 
    Unthinned
};
 
 
enum class EMediaState
{
    Closed,
 
    Error,
 
    Paused,
 
    Playing,
 
    Preparing,
 
    Stopped
};
 
 
enum class EMediaStatus
{
    None = 0x0,
 
    Buffering = 0x1,
 
    Connecting = 0x2
};
 
 
ENUM_CLASS_FLAGS(EMediaStatus);
 
 
enum class EMediaTimeRangeType
{
    Absolute,
 
    Current
};
 
 
struct FMediaSeekParams
{
    TOptional<int32> NewSequenceIndex;
};
 
 
class IMediaControls
{
public:
 
    virtual bool CanControl(EMediaControl Control) const = 0;
 
    virtual FTimespan GetDuration() const = 0;
 
    virtual float GetRate() const = 0;
 
    virtual EMediaState GetState() const = 0;
 
    virtual EMediaStatus GetStatus() const = 0;
 
    virtual TRangeSet<float> GetSupportedRates(EMediaRateThinning Thinning) const = 0;
 
    virtual FTimespan GetTime() const = 0;
 
    virtual bool IsLooping() const = 0;
 
    virtual bool Seek(const FTimespan& Time) = 0;
 
    virtual bool SetLooping(bool Looping) = 0;
 
    virtual bool SetRate(float Rate) = 0;
 
    virtual void SetBlockingPlaybackHint(bool bFacadeWillUseBlockingPlayback)
    {
    }
 
 
    virtual bool Seek(const FTimespan& InNewTime, const FMediaSeekParams& InAdditionalParams)
    {
        return Seek(InNewTime);
    }
 
public:
 
    inline bool Pause()
    {
        return SetRate(0.0f);
    }
 
    inline bool Play()
    {
        return SetRate(1.0f);
    }
 
    UE_DEPRECATED(5.6, "Use absolute seeking only. This method will be removed soon.")
    bool Seek(const FTimespan& TimeOffset, EMediaSeekDirection Direction)
    {
        FTimespan SeekTime;
 
        switch (Direction)
        {
        case EMediaSeekDirection::Backward:
            SeekTime = GetTime() - TimeOffset;
            break;
 
        case EMediaSeekDirection::Beginning:
            SeekTime = TimeOffset;
            break;
 
        case EMediaSeekDirection::End:
            SeekTime = GetDuration() - TimeOffset;
            break;
 
        case EMediaSeekDirection::Forward:
            SeekTime = GetTime() + TimeOffset;
            break;
        }
 
        return Seek(SeekTime);
    }
 
    virtual TRange<FTimespan> GetPlaybackTimeRange(EMediaTimeRangeType InRangeToGet) const
    {
        return TRange<FTimespan>(FTimespan(0), GetDuration());
    }
 
    virtual bool SetPlaybackTimeRange(const TRange<FTimespan>& InTimeRange)
    {
        return false;
    }
 
public:
 
    virtual ~IMediaControls() { }
};