#include <IMediaModule.h>

Inheritance diagram for IMediaModule:

Public Member Functions
virtual FName	GetPlatformName (const FGuid &PlatformGuid) const =0

virtual FGuid	GetPlatformGuid (const FName &PlatformName) const =0

virtual const TArray< IMediaCaptureSupport * > &	GetCaptureSupports () const =0

virtual void	RegisterCaptureSupport (IMediaCaptureSupport &Support)=0

virtual void	UnregisterCaptureSupport (IMediaCaptureSupport &Support)=0

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

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

virtual	~IMediaModule ()

Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()

virtual void	StartupModule ()

virtual void	PreUnloadCallback ()

virtual void	PostLoadCallback ()

virtual void	ShutdownModule ()

virtual bool	SupportsDynamicReloading ()

virtual bool	SupportsAutomaticShutdown ()

virtual bool	IsGameModule () const

Detailed Description

Interface for the Media module.

Media Framework is ticked in several stages. The Input tick happens after the Engine (including Sequencer, game world, and Blueprints) were ticked. This allows any game logic to modify the state of tickable media objects before they fetch input.

The Update tick happens right after the Input tick when all tickable media objects have fetched the latest input based on their current state.

Finally, the Output tick happens after all game and core ticking completed, and after all render commands have been enqueued. It is the very last thing to happen before the frame is complete.

Constructor & Destructor Documentation

◆ ~IMediaModule()

virtual IMediaModule::~IMediaModule ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ CreateMediaPlayerInstanceID()

virtual uint64 IMediaModule::CreateMediaPlayerInstanceID ( )

pure virtual

Get new media player instance ID

Implemented in FMediaModule.

◆ GetCaptureSupports()

virtual const TArray< IMediaCaptureSupport * > & IMediaModule::GetCaptureSupports ( ) const

pure virtual

Get all registered capture device support objects.

Returns: Collection of registered objects.

See also: RegisterCaptureDevices, UnregisterCaptureDevices

Implemented in FMediaModule.

◆ GetClock()

virtual IMediaClock & IMediaModule::GetClock ( )

pure virtual

Get the media clock.

Returns: Media clock.

See also: GetTicker, LockToTimecode

Implemented in FMediaModule.

◆ GetFrameStartTime()

virtual double IMediaModule::GetFrameStartTime ( ) const

pure virtual

Get frame's processing approximate real time start time in seconds

Implemented in FMediaModule.

◆ GetOnTickPreEngineCompleted()

virtual FSimpleMulticastDelegate & IMediaModule::GetOnTickPreEngineCompleted ( )

pure virtual

Get a Delegate that is trigger once all MediaClockSink are TickInput

Returns: the OnTickPreEngineCompleted

Implemented in FMediaModule.

◆ GetPlatformGuid()

virtual FGuid IMediaModule::GetPlatformGuid ( const FName & PlatformName ) const

pure virtual

Implemented in FMediaModule.

◆ GetPlatformName()

virtual FName IMediaModule::GetPlatformName ( const FGuid & PlatformGuid ) const

pure virtual

Implemented in FMediaModule.

◆ GetPlayerFactories()

virtual const TArray< IMediaPlayerFactory * > & IMediaModule::GetPlayerFactories ( ) const

pure virtual

Get the list of installed media player factories.

Returns: Collection of media player factories.

See also: GetPlayerFactory, RegisterPlayerFactory, UnregisterPlayerFactory

Implemented in FMediaModule.

◆ GetPlayerFactory() [1/2]

virtual IMediaPlayerFactory * IMediaModule::GetPlayerFactory ( const FGuid & PlayerPluginGuid ) const

pure virtual

Get a media player factory by GUID.

Parameters

FactoryGuid The GUID of the factory / player.

Returns: The factory, or nullptr if not found.

See also: GetPlayerFactories, RegisterPlayerFactory, UnregisterPlayerFactory

Implemented in FMediaModule.

◆ GetPlayerFactory() [2/2]

virtual IMediaPlayerFactory * IMediaModule::GetPlayerFactory ( const FName & FactoryName ) const

pure virtual

Get a media player factory by name.

Parameters

FactoryName The name of the factory.

Returns: The factory, or nullptr if not found.

See also: GetPlayerFactories, RegisterPlayerFactory, UnregisterPlayerFactory

Implemented in FMediaModule.

◆ GetPlayerLifecycleManagerDelegate()

virtual IMediaPlayerLifecycleManagerDelegate * IMediaModule::GetPlayerLifecycleManagerDelegate ( )

pure virtual

Get player lifetime delegate

Implemented in FMediaModule.

◆ GetTicker()

virtual IMediaTicker & IMediaModule::GetTicker ( )

pure virtual

Get the high-frequency ticker.

Returns: The ticker.

See also: GetClock

Implemented in FMediaModule.

◆ GetTimeSource()

virtual TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe > IMediaModule::GetTimeSource ( )

pure virtual

Get the time source for the media clock.

Returns: The current time source.

Implemented in FMediaModule.

◆ LockToTimecode()

virtual void IMediaModule::LockToTimecode ( bool Locked )

pure virtual

Whether media objects should lock to the media clock's time code.

Time code locking changes will take effect next frame.

Parameters

Locked true to enable time code locking, false to disable.

See also: GetClock

Implemented in FMediaModule.

◆ RegisterCaptureSupport()

virtual void IMediaModule::RegisterCaptureSupport ( IMediaCaptureSupport & Support )

pure virtual

Register a media capture devices support object.

Parameters

Support The support object to register.

See also: GetCaptureDevices, UnregisterCaptureDevices

Implemented in FMediaModule.

◆ RegisterPlayerFactory()

virtual void IMediaModule::RegisterPlayerFactory ( IMediaPlayerFactory & Factory )

pure virtual

Register a media player factory.

Parameters

Factory The media player factory to register.

See also: GetPlayerFactories, RegisterPlayerFactory, UnregisterPlayerFactory

Implemented in FMediaModule.

◆ SetPlayerLifecycleManagerDelegate()

virtual void IMediaModule::SetPlayerLifecycleManagerDelegate ( IMediaPlayerLifecycleManagerDelegate * Delegate )

pure virtual

Set player lifetime delegate

Parameters

Delegate Delegate instance to set for use. Use nullptr to reset delegate.

Implemented in FMediaModule.

◆ SetTimeSource()

virtual void IMediaModule::SetTimeSource ( const TSharedPtr< IMediaTimeSource, ESPMode::ThreadSafe > & NewTimeSource )

pure virtual

Set the time source for the media clock.

Parameters

NewTimeSource The time source to set.

Implemented in FMediaModule.

◆ TickPostEngine()

virtual void IMediaModule::TickPostEngine ( )

pure virtual

Called by the main loop after the game engine has been ticked.

See also: TickPostRender, TickPreEngine, TickPreSlate

Implemented in FMediaModule.

◆ TickPostRender()

virtual void IMediaModule::TickPostRender ( )

pure virtual

Called by the main loop after the entire frame has been rendered.

See also: TickPostEngine, TickPreEngine, TickPreSlate

Implemented in FMediaModule.

◆ TickPreEngine()

virtual void IMediaModule::TickPreEngine ( )

pure virtual

Called by the main loop before the game engine is ticked.

See also: TickPostEngine, TickPostRender, TickPreSlate

Implemented in FMediaModule.

◆ TickPreSlate()

virtual void IMediaModule::TickPreSlate ( )

pure virtual

Called by the main loop before Slate is ticked.

See also: TickPostEngine, TickPostRender, TickPreEngine

Implemented in FMediaModule.

◆ UnregisterCaptureSupport()

virtual void IMediaModule::UnregisterCaptureSupport ( IMediaCaptureSupport & Support )

pure virtual

Unregister a media capture device support object.

Parameters

Support The support object to unregister.

See also: GetCaptureDevices, RegisterCaptureDevices

Implemented in FMediaModule.

◆ UnregisterPlayerFactory()

virtual void IMediaModule::UnregisterPlayerFactory ( IMediaPlayerFactory & Factory )

pure virtual

Unregister a media player factory.

Parameters

Factory The media player factory to unregister.

See also: GetPlayerFactories, RegisterPlayerFactory, RegisterPlayerFactory

Implemented in FMediaModule.

The documentation for this class was generated from the following file:

Engine/Source/Runtime/Media/Public/IMediaModule.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMediaModule()

Member Function Documentation

◆ CreateMediaPlayerInstanceID()

◆ GetCaptureSupports()

◆ GetClock()

◆ GetFrameStartTime()

◆ GetOnTickPreEngineCompleted()

◆ GetPlatformGuid()

◆ GetPlatformName()

◆ GetPlayerFactories()

◆ GetPlayerFactory() [1/2]

◆ GetPlayerFactory() [2/2]

◆ GetPlayerLifecycleManagerDelegate()

◆ GetTicker()

◆ GetTimeSource()

◆ LockToTimecode()

◆ RegisterCaptureSupport()

◆ RegisterPlayerFactory()

◆ SetPlayerLifecycleManagerDelegate()

◆ SetTimeSource()

◆ TickPostEngine()

◆ TickPostRender()

◆ TickPreEngine()

◆ TickPreSlate()

◆ UnregisterCaptureSupport()

◆ UnregisterPlayerFactory()