Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ImgMedia > UImgMediaSource

Light Theme

Dark Theme

UImgMediaSource

Media source for EXR image sequences.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMediaSource

UBaseMediaSource

UImgMediaSource

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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
FFrameRate	FrameRateOverride	Overrides the default frame rate stored in the image files (0/0 = do not override).
bool	IsPathRelativeToProjectRoot	If true, then relative Sequence Paths are relative to the project root directory.
TSharedPtr< FIm...	MipMapInfo	MipMapInfo object to handle mip maps.
FString	ProxyOverride	Name of the proxy directory to use.
FDirectoryPath	SequencePath	The directory that contains the image sequence files.

Constructors

	Name	Description
	UImgMediaSource()	Default constructor.

Functions

	Name	Description
void	AddGlobalCamera ( AActor* InActor )	This camera could be looking at any img sequence.
void	AddTargetObject ( AActor* InActor, float Width )	This object is using our img sequence.
FString	GetFullPath()	Get the full path to the image sequence.
const FImgMe...	GetMipMapInfo()	Get our mipmap info object.
void	GetProxies ( TArray< FString >& OutProxies )	Get the names of available proxy directories.
const FStrin...	GetSequencePath()	Get the path to the image sequence directory to be played.
void	RemoveGlobalCamera ( AActor* InActor )	This camera is no longer looking at any img seqeunces.
void	RemoveTargetObject ( AActor* InActor )	This object is no longer using our img sequence.
void	SetMipLevelDistance ( float Distance )	Manually set when mip level 0 should appear.
void	SetSequencePath ( const FString& Path )	Set the path to the image sequence directory this source represents.

Overridden from UMediaSource

		Name	Description
	FString	GetUrl()	Get the media source's URL string (must be implemented in child classes).
	bool	Validate()	Validate the media source settings (must be implemented in child classes).

Overridden from IMediaOptions

	Name	Description
int64	GetMediaOption ( const FName& Key, int64 DefaultValue )	Get a signed integer media option.
FString	GetMediaOption ( const FName& Key, const FString& DefaultValue )	Get a string media option.
TSharedPtr< ...	GetMediaOption ( const FName& Key, const TSharedPtr< FDataContainer, E... )	Get a complex data type media option.
bool	HasMediaOption ( const FName& Key )	Check whether the specified option is set.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss