UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
FMediaAssetsModule Class Reference
+ Inheritance diagram for FMediaAssetsModule:

Public Member Functions

virtual int32 RegisterGetPlayerFromObject (const FOnGetPlayerFromObject &Delegate) override
 
virtual void UnregisterGetPlayerFromObject (int32 DelegateID) override
 
virtual UMediaPlayer * GetPlayerFromObject (UObject *Object, UObject *&PlayerProxy) override
 
virtual void RegisterCreateMediaSourceRenderer (const FOnCreateMediaSourceRenderer &Delegate) override
 
virtual void UnregisterCreateMediaSourceRenderer ()
 
virtual FDelegateHandle RegisterOnMediaStateChangedEvent (FMediaStateChangedDelegate::FDelegate InStateChangedDelegate) override
 
virtual void UnregisterOnMediaStateChangedEvent (FDelegateHandle InHandle) override
 
virtual void BroadcastOnMediaStateChangedEvent (const TArray< FString > &InActorsPathNames, uint8 EnumState, bool bRemoteBroadcast=false) override
 
virtual UObject * CreateMediaSourceRenderer () override
 
virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual bool SupportsDynamicReloading () override
 
- Public Member Functions inherited from FSelfRegisteringExec
CORE_API FSelfRegisteringExec ()
 
virtual CORE_API ~FSelfRegisteringExec ()
 
- Public Member Functions inherited from FExec
virtual CORE_API ~FExec ()
 
virtual CORE_API bool Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 
- Public Member Functions inherited from IMediaAssetsModule
 DECLARE_DELEGATE_RetVal_TwoParams (UMediaPlayer *, FOnGetPlayerFromObject, UObject *, UObject *&)
 
 DECLARE_DELEGATE_RetVal (UObject *, FOnCreateMediaSourceRenderer)
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FMediaStateChangedDelegate, const TArray< FString > &, uint8, bool)
 
virtual ~IMediaAssetsModule ()
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Protected Member Functions

virtual bool Exec_Runtime (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
 
- Protected Member Functions inherited from FExec
virtual bool Exec_Dev (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 
virtual bool Exec_Editor (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 

Additional Inherited Members

- Static Public Member Functions inherited from FSelfRegisteringExec
static CORE_API bool StaticExec (UWorld *Inworld, const TCHAR *Cmd, FOutputDevice &Ar)
 

Detailed Description

Implements the MediaAssets module.

Member Function Documentation

◆ BroadcastOnMediaStateChangedEvent()

virtual void FMediaAssetsModule::BroadcastOnMediaStateChangedEvent ( const TArray< FString > &  InActorsPathNames,
uint8  EnumState,
bool  bRemoteBroadcast = false 
)
inlineoverridevirtual

Implements IMediaAssetsModule.

◆ CreateMediaSourceRenderer()

virtual UObject * FMediaAssetsModule::CreateMediaSourceRenderer ( )
inlineoverridevirtual

Creates an object that implements IMediaSourceRendererInterface.

Implements IMediaAssetsModule.

◆ Exec_Runtime()

virtual bool FMediaAssetsModule::Exec_Runtime ( UWorld *  InWorld,
const TCHAR *  Cmd,
FOutputDevice &  Ar 
)
inlineoverrideprotectedvirtual

Implementation of Exec that is called on all targets where UE_ALLOW_EXEC_COMMANDS is true

Reimplemented from FExec.

◆ GetPlayerFromObject()

virtual UMediaPlayer * FMediaAssetsModule::GetPlayerFromObject ( UObject *  Object,
UObject *&  PlayerProxy 
)
inlineoverridevirtual

Call this to get a media player (and proxy object) from an object. This will query any plugins that have called RegisterGetPlayerFromObject.

The proxy object will implement IMediaPlayerProxyInterface.

Parameters
ObjectObject to get the player from.
PlayerProxyWill be set to the proxy object (or nullptr if none).
Returns
Media player, or nullptr if none found.

Implements IMediaAssetsModule.

◆ RegisterCreateMediaSourceRenderer()

virtual void FMediaAssetsModule::RegisterCreateMediaSourceRenderer ( const FOnCreateMediaSourceRenderer &  Delegate)
inlineoverridevirtual

Register a delegate to create an object that implements IMediaSourceRendererInterface.

Implements IMediaAssetsModule.

◆ RegisterGetPlayerFromObject()

virtual int32 FMediaAssetsModule::RegisterGetPlayerFromObject ( const FOnGetPlayerFromObject &  Delegate)
inlineoverridevirtual

Plugins should call this so they can provide a function to get a media player from an object.

Parameters
DelegateDelegate to get a media player.
Returns
ID to pass in to UnregisterGetPlayerFromObject.

Implements IMediaAssetsModule.

◆ RegisterOnMediaStateChangedEvent()

virtual FDelegateHandle FMediaAssetsModule::RegisterOnMediaStateChangedEvent ( FMediaStateChangedDelegate::FDelegate  InStateChangedDelegate)
inlineoverridevirtual

Subscribes to the event that is called whenever any of Media state changes (such as play button was pressed).

Implements IMediaAssetsModule.

◆ ShutdownModule()

virtual void FMediaAssetsModule::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 FMediaAssetsModule::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.

◆ SupportsDynamicReloading()

virtual bool FMediaAssetsModule::SupportsDynamicReloading ( )
inlineoverridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns
Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.

◆ UnregisterCreateMediaSourceRenderer()

virtual void FMediaAssetsModule::UnregisterCreateMediaSourceRenderer ( )
inlinevirtual

Unregisters the delegate passed in with RegisterCreateMediaSourceRenderer.

Implements IMediaAssetsModule.

◆ UnregisterGetPlayerFromObject()

virtual void FMediaAssetsModule::UnregisterGetPlayerFromObject ( int32  DelegateID)
inlineoverridevirtual

Call this to unregister a delegate.

Parameters
DelegateIDID returned from RegisterGetPlayerFromObject.

Implements IMediaAssetsModule.

◆ UnregisterOnMediaStateChangedEvent()

virtual void FMediaAssetsModule::UnregisterOnMediaStateChangedEvent ( FDelegateHandle  InHandle)
inlineoverridevirtual

Removes event handling.

Implements IMediaAssetsModule.

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