IMediaAssetsModule Class Reference

#include <IMediaAssetsModule.h>

Inheritance diagram for IMediaAssetsModule:

Public Member Functions
	DECLARE_DELEGATE_RetVal_TwoParams (UMediaPlayer *, FOnGetPlayerFromObject, UObject *, UObject *&)
	DECLARE_DELEGATE_RetVal (UObject *, FOnCreateMediaSourceRenderer)
	DECLARE_MULTICAST_DELEGATE_ThreeParams (FMediaStateChangedDelegate, const TArray< FString > &, uint8, bool)
virtual int32	RegisterGetPlayerFromObject (const FOnGetPlayerFromObject &Delegate)=0
virtual void	UnregisterGetPlayerFromObject (int32 DelegateID)=0
virtual UMediaPlayer *	GetPlayerFromObject (UObject *Object, UObject *&PlayerProxy)=0
virtual void	RegisterCreateMediaSourceRenderer (const FOnCreateMediaSourceRenderer &Delegate)=0
virtual void	UnregisterCreateMediaSourceRenderer ()=0
virtual FDelegateHandle	RegisterOnMediaStateChangedEvent (FMediaStateChangedDelegate::FDelegate InStateChangedDelegate)=0
virtual void	UnregisterOnMediaStateChangedEvent (FDelegateHandle InHandle)=0
virtual void	BroadcastOnMediaStateChangedEvent (const TArray< FString > &InActorsPathNames, uint8 EnumState, bool bRemoteBroadcast=false)=0
virtual UObject *	CreateMediaSourceRenderer ()=0
virtual	~IMediaAssetsModule ()
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 MediaAssets module.

Constructor & Destructor Documentation

~IMediaAssetsModule()

virtual IMediaAssetsModule::~IMediaAssetsModule ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

BroadcastOnMediaStateChangedEvent()

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

pure virtual

Implemented in FMediaAssetsModule.

CreateMediaSourceRenderer()

virtual UObject * IMediaAssetsModule::CreateMediaSourceRenderer ( )

pure virtual

Creates an object that implements IMediaSourceRendererInterface.

Implemented in FMediaAssetsModule.

DECLARE_DELEGATE_RetVal()

IMediaAssetsModule::DECLARE_DELEGATE_RetVal	(	UObject *	,
		FOnCreateMediaSourceRenderer
	)

Delegate to create an object that implements IMediaSourceRendererInterface.

DECLARE_DELEGATE_RetVal_TwoParams()

IMediaAssetsModule::DECLARE_DELEGATE_RetVal_TwoParams	(	UMediaPlayer *	,
		FOnGetPlayerFromObject	,
		UObject *	,
		UObject *&
	)

Delegate to get a player from a UObject.

DECLARE_MULTICAST_DELEGATE_ThreeParams()

IMediaAssetsModule::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FMediaStateChangedDelegate	,
		const TArray< FString > &	,
		uint8	,
		bool
	)

Delegate that reacts to change in Media state (Play, Stop, Pause etc.)

GetPlayerFromObject()

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

pure virtual

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

Object	Object to get the player from.
PlayerProxy	Will be set to the proxy object (or nullptr if none).

Returns

Media player, or nullptr if none found.

Implemented in FMediaAssetsModule.

RegisterCreateMediaSourceRenderer()

virtual void IMediaAssetsModule::RegisterCreateMediaSourceRenderer ( const FOnCreateMediaSourceRenderer &  Delegate )

pure virtual

Register a delegate to create an object that implements IMediaSourceRendererInterface.

Implemented in FMediaAssetsModule.

RegisterGetPlayerFromObject()

virtual int32 IMediaAssetsModule::RegisterGetPlayerFromObject ( const FOnGetPlayerFromObject &  Delegate )

pure virtual

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

Parameters

Delegate

Delegate to get a media player.

Returns

ID to pass in to UnregisterGetPlayerFromObject.

Implemented in FMediaAssetsModule.

RegisterOnMediaStateChangedEvent()

virtual FDelegateHandle IMediaAssetsModule::RegisterOnMediaStateChangedEvent ( FMediaStateChangedDelegate::FDelegate  InStateChangedDelegate )

pure virtual

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

Implemented in FMediaAssetsModule.

UnregisterCreateMediaSourceRenderer()

virtual void IMediaAssetsModule::UnregisterCreateMediaSourceRenderer ( )

pure virtual

Unregisters the delegate passed in with RegisterCreateMediaSourceRenderer.

Implemented in FMediaAssetsModule.

UnregisterGetPlayerFromObject()

virtual void IMediaAssetsModule::UnregisterGetPlayerFromObject ( int32  DelegateID )

pure virtual

Call this to unregister a delegate.

Parameters

DelegateID

ID returned from RegisterGetPlayerFromObject.

Implemented in FMediaAssetsModule.

UnregisterOnMediaStateChangedEvent()

virtual void IMediaAssetsModule::UnregisterOnMediaStateChangedEvent ( FDelegateHandle  InHandle )

pure virtual

Removes event handling.

Implemented in FMediaAssetsModule.

---

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

• Engine/Source/Runtime/MediaAssets/Public/IMediaAssetsModule.h