1. Epic GamesDeveloper
  3. UImgMediaSource

UImgMediaSource

Media source for EXR image sequences.

Unreal Engine C++ API Reference > Plugins > ImgMedia

Inheritance Hierarchy

References

   
Module ImgMedia
Header /Engine/Plugins/Media/ImgMedia/Source/ImgMedia/Public/ImgMediaSource.h
Include #include "ImgMediaSource.h"

Syntax

UCLASS&40;BlueprintType, HideCategories&61;&40;Overrides, Playback&41;&41;  
class UImgMediaSource : public UBaseMediaSource

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bFillGapsInSequence If true, then any gaps in the sequence will be filled with blank frames.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite FFrameRate FrameRateOverride Overrides the default frame rate stored in the image files (0/0 = do not override).
Protected variable TSharedPtr< FImgMediaMipMapInfo, ESPMode::ThreadSafe > MipMapInfo MipMapInfo object to handle mip maps.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite FString ProxyOverride Name of the proxy directory to use.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FDirectoryPath SequencePath The directory that contains the image sequence files.
Public variable UProperty Category, EditAnywhere Transient FImgMediaSourceCustomizationSequenceProxy SequenceProxy This is only used so we can customize editing of SequencePath.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddTargetObject ( AActor* InActor
)

 This object is using our img sequence.
Public function Static FString

ExpandSequencePathTokens ( const FString& InPath
)

 Returns the path after replacing the supported tokens
Public function Const FString Get the full path to the image sequence.
Public function Const const FImgMediaMipMapInfo * Get our mipmap info object.
Public function Const UFunction BlueprintCallable, Category void

GetProxies ( TArray< FString >& OutProxies
)

 Get the names of available proxy directories.
Public function Const UFunction BlueprintCallable, Category const FString Get the path to the image sequence directory to be played. Supported tokens will be expanded.
Public function Static bool

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

 Returns true if InPath is under InBasePath.
Public function UFunction BlueprintCallable, Category void

RemoveTargetObject ( AActor* InActor
)

 This object is no longer using our img sequence.
Public function Static FString Returns a sanitized sequence path, but without expanding the tokens tokens
Public function UFunction BlueprintCallable, Category void

SetSequencePath ( const FString& Path
)

 Set the path to the image sequence directory this source represents.
Public function UFunction BlueprintCallable, Category void Set the path to the image sequence directory this source represents.

Overridden from UMediaSource

  Type Name Description
Public function Virtual Const FString

GetUrl ()

 Get the media source's URL string (must be implemented in child classes).
Public function Virtual Const bool Validate the media source settings (must be implemented in child classes).

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IMediaOptions

  Type Name Description
Public function Virtual Const int64

GetMediaOption ( const FName& Key,
int64 DefaultValue
)

 Get a signed integer media option.
Public function Virtual Const bool

GetMediaOption ( const FName& Key,
bool DefaultValue
)

 Get a Boolean media option.
Public function Virtual Const FString

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

 Get a string media option.
Public function Virtual Const TSharedPtr< FDataContainer, ESPMode::ThreadSafe >

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

 Get a complex data type media option.
Public function Virtual Const bool

HasMediaOption ( const FName& Key
)

 Check whether the specified option is set.

Deprecated Variables

  Type Name Description
Public variable UProperty bool IsPathRelativeToProjectRoot_DEPRECATED If true, then relative Sequence Paths are relative to the project root directory.

Deprecated Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void

AddGlobalCamera ( AActor* InActor
)

 AddGlobalCamera has been deprecated.
Public function void

AddTargetObject ( AActor* InActor,
float Width
)

 AddTargetObject has been deprecated, please use the variant with no Width argument.
Public function UFunction BlueprintCallable, Category, Meta void

RemoveGlobalCamera ( AActor* InActor
)

 RemoveGlobalCamera has been deprecated.
Public function UFunction BlueprintCallable, Category, Meta void

SetMipLevelDistance ( float Distance
)

 SetMipLevelDistance has been deprecated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page