1. Epic GamesDeveloper
  3. UImgMediaSource

UImgMediaSource

Media source for EXR image sequences.

API > API/Plugins > API/Plugins/ImgMedia

Media source for EXR image sequences.

Image sequence media sources point to a directory that contains a series of image files in which each image represents a single frame of the sequence. BMP, EXR, PNG and JPG images are currently supported. EXR image sequences are optimized for performance. The first frame of an image sequence is used to determine the image dimensions (all formats) and frame rate (EXR only).

The image sequence directory may contain sub-directories, which are called 'proxies'. Proxies can be used to provide alternative media for playback during development and testing of a game. One common scenario is the use of low resolution versions of image sequence media on computers that are too slow or don't have enough storage to play the original high-res media.

   
Name UImgMediaSource
Type class
Header File /Engine/Plugins/Media/ImgMedia/Source/ImgMedia/Public/ImgMediaSource.h
Include Path #include "ImgMediaSource.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, HideCategories=(Overrides, Playback))  
class UImgMediaSource : public UBaseMediaSource

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UImgMediaSource()

 Default constructor. ImgMediaSource.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bFillGapsInSequence bool If true, then any gaps in the sequence will be filled with blank frames. ImgMediaSource.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Sequence
FrameRateOverride FFrameRate Overrides the default frame rate stored in the image files (0/0 = do not override). ImgMediaSource.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Sequence
  • AdvancedDisplay
ProxyOverride FString Name of the proxy directory to use. ImgMediaSource.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Sequence
  • AdvancedDisplay
SequenceProxy FImgMediaSourceCustomizationSequenceProxy This is only used so we can customize editing of SequencePath. ImgMediaSource.h
  • EditAnywhere
  • Transient
  • Category=Sequence
SourceColorSettings FMediaSourceColorSettings Manual definition of media source color space & encoding. ImgMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Sequence"
  • Meta=(DisplayAfter="SequencePath", ShowOnlyInnerProperties)
StartTimecode FTimecode Specification of a timecode associated with the start of the sequence. ImgMediaSource.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Timecode"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTargetObject ( AActor* InActor
)

 This object is using our img sequence. ImgMediaSource.h
  • BlueprintCallable
  • Category="ImgMedia|ImgMediaSource"

FString GetFullPath()

 Get the full path to the image sequence. ImgMediaSource.h  

const FImgMediaMipMapInfo * GetMipMapInfo()

 Get our mipmap info object. ImgMediaSource.h  

void GetProxies ( TArray< FString >& OutProxies
) const

 Get the names of available proxy directories. ImgMediaSource.h
  • BlueprintCallable
  • Category="ImgMedia|ImgMediaSource"
Get the path to the image sequence directory to be played. Supported tokens will be expanded. ImgMediaSource.h
  • BlueprintCallable
  • Category="ImgMedia|ImgMediaSource"

void RemoveTargetObject ( AActor* InActor
)

 This object is no longer using our img sequence. ImgMediaSource.h
  • BlueprintCallable
  • Category="ImgMedia|ImgMediaSource"

void SetSequencePath ( const FString& Path
)

 Set the path to the image sequence directory this source represents. ImgMediaSource.h
  • BlueprintCallable
  • Category="ImgMedia|ImgMediaSource"

void SetTokenizedSequencePath ( const FString& Path
)

 Set the path to the image sequence directory this source represents. ImgMediaSource.h
  • BlueprintCallable
  • Category="ImgMedia|ImgMediaSource"

Overridden from UMediaSource

Name Remarks Include Path Unreal Specifiers

virtual void GetDetailsPanelInfoElements ( TArray< FInfoElement >& OutInfoElements
) const

   ImgMediaSource.h  

virtual FString GetUrl()

   ImgMediaSource.h  

virtual bool Validate()

   ImgMediaSource.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ImgMediaSource.h  

virtual void Serialize ( FArchive& Ar
)

   ImgMediaSource.h  

Overridden from IMediaOptions

Name Remarks Include Path Unreal Specifiers

virtual int64 GetMediaOption ( const FName& Key,
int64 DefaultValue
) const

   ImgMediaSource.h  

virtual bool GetMediaOption ( const FName& Key,
bool DefaultValue
) const

   ImgMediaSource.h  

virtual FString GetMediaOption ( const FName& Key,
const FString& DefaultValue
) const

   ImgMediaSource.h  

virtual TSharedPtr< FDataContainer, ESPMode::ThreadSafe > GetMediaOption ( const FName& Key,
const TSharedPtr< FDataContainer, ESPMode::ThreadSafe >& DefaultValue
) const

   ImgMediaSource.h  

virtual bool HasMediaOption ( const FName& Key
) const

   ImgMediaSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString ExpandSequencePathTokens ( const FString& InPath
)

 Returns the path after replacing the supported tokens ImgMediaSource.h  

static bool IsPathUnderBasePath ( const FString& InPath,
const FString& InBasePath,
FString& OutRelativePath
)

 Returns true if InPath is under InBasePath. ImgMediaSource.h  

static FString SanitizeTokenizedSequencePath ( const FString& InPath
)

 Returns a sanitized sequence path, but without expanding the tokens tokens ImgMediaSource.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
IsPathRelativeToProjectRoot_DEPRECATED bool If true, then relative Sequence Paths are relative to the project root directory. ImgMediaSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page