1. Epic GamesDeveloper
  3. UImgMediaSettings

UImgMediaSettings

Settings for the ImgMedia module.

API > API/Plugins > API/Plugins/ImgMediaFactory

Settings for the ImgMedia module.

   
Name UImgMediaSettings
Type class
Header File /Engine/Plugins/Media/ImgMedia/Source/ImgMediaFactory/Public/ImgMediaSettings.h
Include Path #include "ImgMediaSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Engine)  
class UImgMediaSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UImgMediaSettings()

 Default constructor. ImgMediaSettings.h  

Typedefs

Name Type Remarks Include Path
FOnImgMediaSettingsChanged TMulticastDelegate_OneParam< void, const UImgMediaSettings * >   ImgMediaSettings.h

Constants

Name Type Remarks Include Path
SettingsChangedDelegate FOnImgMediaSettingsChanged   ImgMediaSettings.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BandwidthThrottlingEnabled bool If there is not enough bandwidth to play the media, then lower it (for example by skipping frames) to try and get playback. ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=General
CacheBehindPercentage float Percentage of cache to use for frames behind the play head (default = 25%). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Caching
  • Meta=(ClampMin=0.0, ClampMax=100.0)
CacheSizeGB float Maximum size of the look-ahead cache (in GB; default = 1 GB). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Caching
  • Meta=(ClampMin=0)
CacheThreads int32 Maximum number of image caching threads to use (0 = number of cores, default = 2). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Caching
  • Meta=(ClampMin=0)
CacheThreadStackSizeKB int32 Size of the stack for each caching thread (in kB; default = 128). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Caching
  • Meta=(ClampMin=128)
  • AdvancedDisplay
DefaultFrameRate FFrameRate Default frame rate to use if none was specified in image sequence or media source (default = 1/24). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=General
ExrDecoderThreads uint32 Number of worker threads to use when decoding EXR images (0 = auto). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=EXR
  • Meta=(ClampMin=0)
GlobalCacheSizeGB float Maximum size of the global look-ahead cache (in GB; default = 1 GB). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Caching
  • Meta=(ClampMin=0)
UseGlobalCache bool Whether to use the global cache or not. ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Caching

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultProxy FString Name of default media source proxy URLs (default = 'proxy'). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Proxies
UseDefaultProxy bool Whether to enable image sequence proxies (default = false). ImgMediaSettings.h
  • Config
  • EditAnywhere
  • Category=Proxies

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GetDefaultProxy()

 Get the default media source proxy name tag. ImgMediaSettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ImgMediaSettings.h  

virtual void PostInitProperties()

   ImgMediaSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static FOnImgMediaSettingsChanged & OnSettingsChanged()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page