Navigation
API > API/Runtime > API/Runtime/MediaAssets
Interface for the MediaAssets module.
| Name | IMediaAssetsModule |
| Type | class |
| Header File | /Engine/Source/Runtime/MediaAssets/Public/IMediaAssetsModule.h |
| Include Path | #include "IMediaAssetsModule.h" |
Syntax
class IMediaAssetsModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaAssetsModule() |
Virtual destructor. | IMediaAssetsModule.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMediaStateChangedDelegate | TMulticastDelegate_ThreeParams< void, const TArray< FString > &, uint8, bool > | Delegate that reacts to change in Media state (Play, Stop, Pause etc.) | IMediaAssetsModule.h |
| FOnCreateMediaSourceRenderer | TBaseDelegate_NoParams< UObject * > | Delegate to create an object that implements IMediaSourceRendererInterface. | IMediaAssetsModule.h |
| FOnGetPlayerFromObject | TBaseDelegate_TwoParams< UMediaPlayer *, UObject *, UObject *& > | Delegate to get a player from a UObject. | IMediaAssetsModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastOnMediaStateChangedEvent
(
const TArray< FString >& InActorsPathNames, |
Broadcasts the event to all subscribers. | IMediaAssetsModule.h | |
UObject * CreateMediaSourceRenderer() |
Creates an object that implements IMediaSourceRendererInterface. | IMediaAssetsModule.h | |
UMediaPlayer * GetPlayerFromObject
(
UObject* Object, |
Call this to get a media player (and proxy object) from an object. | IMediaAssetsModule.h | |
void RegisterCreateMediaSourceRenderer
(
const FOnCreateMediaSourceRenderer& Delegate |
Register a delegate to create an object that implements IMediaSourceRendererInterface. | IMediaAssetsModule.h | |
int32 RegisterGetPlayerFromObject
(
const FOnGetPlayerFromObject& Delegate |
Plugins should call this so they can provide a function to get a media player from an object. | IMediaAssetsModule.h | |
FDelegateHandle RegisterOnMediaStateChangedEvent
(
FMediaStateChangedDelegate::FDelegate InStateChangedDelegate |
Subscribes to the event that is called whenever any of Media state changes (such as play button was pressed). | IMediaAssetsModule.h | |
void UnregisterCreateMediaSourceRenderer() |
Unregisters the delegate passed in with RegisterCreateMediaSourceRenderer. | IMediaAssetsModule.h | |
void UnregisterGetPlayerFromObject
(
int32 DelegateID |
Call this to unregister a delegate. | IMediaAssetsModule.h | |
void UnregisterOnMediaStateChangedEvent
(
FDelegateHandle InHandle |
Removes event handling. | IMediaAssetsModule.h |