Navigation
API > API/Plugins > API/Plugins/ImgMedia
Interface for the ImgMedia module.
| Name | IImgMediaModule |
| Type | class |
| Header File | /Engine/Plugins/Media/ImgMedia/Source/ImgMedia/Public/IImgMediaModule.h |
| Include Path | #include "IImgMediaModule.h" |
Syntax
class IImgMediaModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IImgMediaModule() |
Virtual destructor. | IImgMediaModule.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CustomFormatAttributeName | FLazyName | Name of attribute in the Exr file that marks it as our custom format. | IImgMediaModule.h |
| CustomFormatTileBorderAttributeName | FLazyName | Name of attribute in the Exr file for the tile border size for our custom format. | IImgMediaModule.h |
| CustomFormatTileHeightAttributeName | FLazyName | Name of attribute in the Exr file for the tile height for our custom format. | IImgMediaModule.h |
| CustomFormatTileWidthAttributeName | FLazyName | Name of attribute in the Exr file for the tile width for our custom format. | IImgMediaModule.h |
| GlobalCache | TSharedPtr< FImgMediaGlobalCache, ESPMode::ThreadSafe > | Holds the global cache. | IImgMediaModule.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnImgMediaPlayerCreated | FOnImgMediaPlayerCreated | Add to this callback to get called whenever a player is created. | IImgMediaModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IMediaPlayer, ESPMode::ThreadSafe > CreatePlayer
(
IMediaEventSink& EventHandler |
Creates a media player for image sequences. | IImgMediaModule.h | |
const TSharedPtr< FImgMediaSceneViewExtension, ESPMode::ThreadSafe > & GetSceneViewExtension() |
Get scene view extension cahcing view information (for mip/tile calculations). | IImgMediaModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IImgMediaModule & Get () |
Singleton-like access to this module's interface. | IImgMediaModule.h | |
static FImgMediaGlobalCache * GetGlobalCache() |
Call this to get the global cache. | IImgMediaModule.h |