Inheritance diagram for FMediaModule:

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

virtual FGuid	GetPlatformGuid (const FName &PlatformName) const override

virtual const TArray< IMediaCaptureSupport * > &	GetCaptureSupports () const override

virtual IMediaClock &	GetClock () override

virtual const TArray< IMediaPlayerFactory * > &	GetPlayerFactories () const override

virtual IMediaPlayerFactory *	GetPlayerFactory (const FName &FactoryName) const override

virtual IMediaPlayerFactory *	GetPlayerFactory (const FGuid &PlayerpPluginGUID) const override

virtual IMediaTicker &	GetTicker () override

virtual FSimpleMulticastDelegate &	GetOnTickPreEngineCompleted () override

virtual void	LockToTimecode (bool Locked) override

virtual void	RegisterCaptureSupport (IMediaCaptureSupport &Support) override

virtual void	RegisterPlayerFactory (IMediaPlayerFactory &Factory) override

virtual void	SetPlayerLifecycleManagerDelegate (IMediaPlayerLifecycleManagerDelegate *Delegate) override

virtual IMediaPlayerLifecycleManagerDelegate *	GetPlayerLifecycleManagerDelegate () override

virtual uint64	CreateMediaPlayerInstanceID () override

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

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

virtual void	TickPostEngine () override

virtual void	TickPostRender () override

virtual void	TickPreEngine () override

virtual void	TickPreSlate () override

virtual void	UnregisterCaptureSupport (IMediaCaptureSupport &Support) override

virtual void	UnregisterPlayerFactory (IMediaPlayerFactory &Factory) override

virtual double	GetFrameStartTime () const override

virtual void	StartupModule () override

virtual void	ShutdownModule () override

virtual bool	SupportsDynamicReloading () override

Public Member Functions inherited from IMediaModule
virtual	~IMediaModule ()

Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()

virtual void	PreUnloadCallback ()

virtual void	PostLoadCallback ()

virtual bool	SupportsAutomaticShutdown ()

virtual bool	IsGameModule () const

Detailed Description

Implements the Media module.

Member Function Documentation

◆ CreateMediaPlayerInstanceID()

virtual uint64 FMediaModule::CreateMediaPlayerInstanceID ( )

inlineoverridevirtual

Get new media player instance ID

Implements IMediaModule.

◆ GetCaptureSupports()

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

inlineoverridevirtual

Get all registered capture device support objects.

Returns: Collection of registered objects.

See also: RegisterCaptureDevices, UnregisterCaptureDevices

Implements IMediaModule.

◆ GetClock()

virtual IMediaClock & FMediaModule::GetClock ( )

inlineoverridevirtual

Get the media clock.

Returns: Media clock.

See also: GetTicker, LockToTimecode

Implements IMediaModule.

◆ GetFrameStartTime()

virtual double FMediaModule::GetFrameStartTime ( ) const

inlineoverridevirtual

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

Implements IMediaModule.

◆ GetOnTickPreEngineCompleted()

virtual FSimpleMulticastDelegate & FMediaModule::GetOnTickPreEngineCompleted ( )

inlineoverridevirtual

Get a Delegate that is trigger once all MediaClockSink are TickInput

Returns: the OnTickPreEngineCompleted

Implements IMediaModule.

◆ GetPlatformGuid()

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

inlineoverridevirtual

Implements IMediaModule.

◆ GetPlatformName()

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

inlineoverridevirtual

Implements IMediaModule.

◆ GetPlayerFactories()

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

inlineoverridevirtual

Get the list of installed media player factories.

Returns: Collection of media player factories.

See also: GetPlayerFactory, RegisterPlayerFactory, UnregisterPlayerFactory

Implements IMediaModule.

◆ GetPlayerFactory() [1/2]

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

inlineoverridevirtual

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

Implements IMediaModule.

◆ GetPlayerFactory() [2/2]

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

inlineoverridevirtual

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

Implements IMediaModule.

◆ GetPlayerLifecycleManagerDelegate()

virtual IMediaPlayerLifecycleManagerDelegate * FMediaModule::GetPlayerLifecycleManagerDelegate ( )

inlineoverridevirtual

Get player lifetime delegate

Implements IMediaModule.

◆ GetTicker()

virtual IMediaTicker & FMediaModule::GetTicker ( )

inlineoverridevirtual

Get the high-frequency ticker.

Returns: The ticker.

See also: GetClock

Implements IMediaModule.

◆ GetTimeSource()

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

inlineoverridevirtual

Get the time source for the media clock.

Returns: The current time source.

Implements IMediaModule.

◆ LockToTimecode()

virtual void FMediaModule::LockToTimecode ( bool Locked )

inlineoverridevirtual

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

Implements IMediaModule.

◆ RegisterCaptureSupport()

virtual void FMediaModule::RegisterCaptureSupport ( IMediaCaptureSupport & Support )

inlineoverridevirtual

Register a media capture devices support object.

Parameters

Support The support object to register.

See also: GetCaptureDevices, UnregisterCaptureDevices

Implements IMediaModule.

◆ RegisterPlayerFactory()

virtual void FMediaModule::RegisterPlayerFactory ( IMediaPlayerFactory & Factory )

inlineoverridevirtual

Register a media player factory.

Parameters

Factory The media player factory to register.

See also: GetPlayerFactories, RegisterPlayerFactory, UnregisterPlayerFactory

Implements IMediaModule.

◆ SetPlayerLifecycleManagerDelegate()

virtual void FMediaModule::SetPlayerLifecycleManagerDelegate ( IMediaPlayerLifecycleManagerDelegate * Delegate )

inlineoverridevirtual

Set player lifetime delegate

Parameters

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

Implements IMediaModule.

◆ SetTimeSource()

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

inlineoverridevirtual

Set the time source for the media clock.

Parameters

NewTimeSource The time source to set.

Implements IMediaModule.

◆ ShutdownModule()

virtual void FMediaModule::ShutdownModule ( )

inlineoverridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

◆ StartupModule()

virtual void FMediaModule::StartupModule ( )

inlineoverridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.