IMediaModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Delegates/Delegate.h"
#include "Misc/Timespan.h"
#include "Modules/ModuleInterface.h"
#include "Templates/SharedPointer.h"
 
class FName;
class IMediaCaptureSupport;
class IMediaClock;
class IMediaPlayerFactory;
class IMediaTicker;
class IMediaTimeSource;
class IMediaPlayerLifecycleManagerDelegate;
 
class IMediaModule
    : public IModuleInterface
{
public:
 
    //~ Platform management
 
    /*
     * Get a nice platform name from a GUID
    */
    virtual FName GetPlatformName(const FGuid& PlatformGuid) const = 0;
 
    /*
     * Get a GUID from a nice platform name
    */
    virtual FGuid GetPlatformGuid(const FName & PlatformName) const = 0;
 
    //~ Capture devices
 
    virtual const TArray<IMediaCaptureSupport*>& GetCaptureSupports() const = 0;
 
    virtual void RegisterCaptureSupport(IMediaCaptureSupport& Support) = 0;
 
    virtual void UnregisterCaptureSupport(IMediaCaptureSupport& Support) = 0;
 
public:
 
    //~ Player factories
 
    virtual const TArray<IMediaPlayerFactory*>& GetPlayerFactories() const = 0;
 
    virtual IMediaPlayerFactory* GetPlayerFactory(const FName& FactoryName) const = 0;
 
    virtual IMediaPlayerFactory* GetPlayerFactory(const FGuid& PlayerPluginGuid) const = 0;
 
    virtual void RegisterPlayerFactory(IMediaPlayerFactory& Factory) = 0;
 
    virtual void UnregisterPlayerFactory(IMediaPlayerFactory& Factory) = 0;
 
    virtual void SetPlayerLifecycleManagerDelegate(IMediaPlayerLifecycleManagerDelegate* Delegate) = 0;
 
    virtual IMediaPlayerLifecycleManagerDelegate* GetPlayerLifecycleManagerDelegate() = 0;
 
    virtual uint64 CreateMediaPlayerInstanceID() = 0;
 
public:
 
    //~ Time management
 
    virtual IMediaClock& GetClock() = 0;
 
    virtual IMediaTicker& GetTicker() = 0;
 
    virtual double GetFrameStartTime() const = 0;
 
    virtual FSimpleMulticastDelegate& GetOnTickPreEngineCompleted() = 0;
 
    virtual void LockToTimecode(bool Locked) = 0;
 
    virtual void SetTimeSource(const TSharedPtr<IMediaTimeSource, ESPMode::ThreadSafe>& NewTimeSource) = 0;
 
 
    virtual TSharedPtr<IMediaTimeSource, ESPMode::ThreadSafe> GetTimeSource() = 0;
 
    virtual void TickPostEngine() = 0;
 
    virtual void TickPostRender() = 0;
 
    virtual void TickPreEngine() = 0;
 
    virtual void TickPreSlate() = 0;
 
public:
 
    virtual ~IMediaModule() { }
};