Navigation
API > API/Plugins > API/Plugins/ImgMediaFactory
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UImgMediaSettings
References
| Module | ImgMediaFactory |
| Header | /Engine/Plugins/Media/ImgMedia/Source/ImgMediaFactory/Public/ImgMediaSettings.h |
| Include | #include "ImgMediaSettings.h" |
Syntax
UCLASS&40;Config&61;Engine&41;
class UImgMediaSettings : public UObject
Remarks
Settings for the ImgMedia module.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | BandwidthThrottlingEnabled | If there is not enough bandwidth to play the media, then lower it (for example by skipping frames) to try and get playback. | |
| float | CacheBehindPercentage | Percentage of cache to use for frames behind the play head (default = 25%). | |
| float | CacheSizeGB | Maximum size of the look-ahead cache (in GB; default = 1 GB). | |
| int32 | CacheThreads | Maximum number of image caching threads to use (0 = number of cores, default = 2). | |
| int32 | CacheThreadStackSizeKB | Size of the stack for each caching thread (in kB; default = 128). | |
| FFrameRate | DefaultFrameRate | Default frame rate to use if none was specified in image sequence or media source (default = 1/24). | |
| uint32 | ExrDecoderThreads | Number of worker threads to use when decoding EXR images (0 = auto). | |
| float | GlobalCacheSizeGB | Maximum size of the global look-ahead cache (in GB; default = 1 GB). | |
| bool | UseGlobalCache | Whether to use the global cache or not. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default constructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FString | Get the default media source proxy name tag. | ||
| FOnImgMediaSettingsChanged & | Gets a multicast delegate which is called whenever one of the parameters in this settings object changes. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
Typedefs
| Name | Description |
|---|---|
| FOnImgMediaSettingsChanged |
Constants
| Name | Description |
|---|---|
| SettingsChangedDelegate |