UImgMediaSettings

Settings for the ImgMedia module.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ImgMediaFactory

Header

/Engine/Plugins/Media/ImgMedia/Source/ImgMediaFactory/Public/ImgMediaSettings.h

Include

#include "ImgMediaSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine)
class UImgMediaSettings : public UObject

Remarks

Settings for the ImgMedia module.

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

CacheBehindPercentage

Percentage of cache to use for frames behind the play head (default = 25%).

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

CacheSizeGB

Maximum size of the look-ahead cache (in GB; default = 1 GB).

Public variable UProperty Category, EditAnywhere, Meta Config

int32

 

CacheThreads

Maximum number of image caching threads to use (0 = number of cores, default = 8).

Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config

int32

 

CacheThreadStackSizeKB

Size of the stack for each caching thread (in kB; default = 128).

Public variable UProperty Category, EditAnywhere Config

FFrameRate

 

DefaultFrameRate

Default frame rate to use if none was specified in image sequence or media source (default = 1/24).

Public variable UProperty Category, EditAnywhere, Meta Config

uint32

 

ExrDecoderThreads

Number of worker threads to use when decoding EXR images (0 = auto).

Public variable UProperty Category, EditAnywhere, Meta Config

float

 

GlobalCacheSizeGB

Maximum size of the global look-ahead cache (in GB; default = 1 GB).

Public variable UProperty Category, EditAnywhere Config

bool

 

UseGlobalCache

Whether to use the global cache or not.

Constructors

Name Description

Public function

UImgMediaSettings()

Default constructor.

Functions

Name Description

Public function Const

FString

 

GetDefaultProxy()

Get the default media source proxy name tag.

Public function Static

FOnImgMediaS...

 

OnSettingsChanged()

Gets a multicast delegate which is called whenever one of the parameters in this settings object changes.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

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
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss