UImgMediaSource

Media source for EXR image sequences.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ImgMedia

Header

/Engine/Plugins/Media/ImgMedia/Source/ImgMedia/Public/ImgMediaSource.h

Include

#include "ImgMediaSource.h"

Syntax

UCLASS(BlueprintType, HideCategories=(Overrides, Playback))
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

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).

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

IsPathRelativeToProjectRoot

If true, then relative Sequence Paths are relative to the project root directory.

Protected variable

TSharedPtr< FIm...

 

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

FImgMediaSource...

 

SequenceProxy

This is only used so we can customize editing of SequencePath.

Constructors

Name Description

Public function

UImgMediaSource()

Default constructor.

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

AddGlobalCamera

(
    AActor* InActor
)

This camera could be looking at any img sequence.

Public function UFunction BlueprintCallable, Category

void

 

AddTargetObject

(
    AActor* InActor,
    float Width
)

This object is using our img sequence.

Protected function Const

FString

 

GetFullPath()

Get the full path to the image sequence.

Public function Const

const FImgMe...

 

GetMipMapInfo()

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 FStrin...

 

GetSequencePath()

Get the path to the image sequence directory to be played.

Public function UFunction BlueprintCallable, Category

void

 

RemoveGlobalCamera

(
    AActor* InActor
)

This camera is no longer looking at any img seqeunces.

Public function UFunction BlueprintCallable, Category

void

 

RemoveTargetObject

(
    AActor* InActor
)

This object is no longer using our img sequence.

Public function UFunction BlueprintCallable, Category

void

 

SetMipLevelDistance

(
    float Distance
)

Manually set when mip level 0 should appear.

Public function UFunction BlueprintCallable, Category

void

 

SetSequencePath

(
    const FString& Path
)

Set the path to the image sequence directory this source represents.

Overridden from UMediaSource

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()

Validate the media source settings (must be implemented in child classes).

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Overridden from IMediaOptions

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< ...

 

GetMediaOption

(
    const FName& Key,
    const TSharedPtr< FDataContainer, E...
)

Get a complex data type media option.

Public function Virtual Const

bool

 

HasMediaOption

(
    const FName& Key
)

Check whether the specified option is set.