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 > Runtime > Media > IMediaTextureSample

Light Theme

Dark Theme

IMediaTextureSample

Interface for media texture samples.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaTextureSample

	FElectraTextureSampleUnix
	FMediaIOCoreTextureSampleBase
	FWebMMediaTextureSample

References

Module	Media
Header	/Engine/Source/Runtime/Media/Public/IMediaTextureSample.h
Include	#include "IMediaTextureSample.h"

Syntax

class IMediaTextureSample

Remarks

Interface for media texture samples.

Media texture samples are generated by media players and sent to the registered media texture sink. They contain a single frame of texture data along with extra metadata, such as dimensions, time codes, and durations.

Depending on the decoder, a frame's pixel data may be stored in a CPU memory buffer, or in an RHI texture resource (only available when compiling against the Engine). The media texture sample API supports both models via the GetBuffer and the GetTexture methods. Sample instances need to implement only one of these.

Destructors

	Name	Description
	~IMediaTextureSample()	Virtual destructor.

Functions

	Name	Description
double	GetAspectRatio()	Get pixel aspect ratio
const void &...	GetBuffer()	Get the sample's frame buffer.
FIntPoint	GetDim()	Get the width and height of the sample.
FTimespan	GetDuration()	Get the amount of time for which the sample is valid.
EMediaTextur...	GetFormat()	Get the texture sample format.
uint8	GetNumMips()	Get the number of mips encoded in the sample
FLinearColor	GetOffset()	Get the Offset applied after ScaleRotation for the sample.
EMediaOrient...	GetOrientation()	Get image orientation vs. physically returned image data
FIntPoint	GetOutputDim()	Get the sample's desired output width and height.
FLinearColor	GetScaleRotation()	Get the ScaleRotation (2x2 matrix) for the sample.
uint32	GetStride()	Get the horizontal stride (aka. pitch) of the sample's frame buffer.
FMediaTimeSt...	GetTime()	Get the sample time (in the player's local clock).
TOptional< F...	GetTimecode()	Get the sample timecode if available.
const FMatri...	GetYUVToRGBMatrix()	Get the YUV to RGB conversion matrix. Equivalent to MediaShaders::YuvToSrgbDefault Matrix.
bool	IsCacheable()	Whether the sample can be held in a cache.
bool	IsOutputSrgb()	Whether the output of the sample is in sRGB color space.
void	Reset()

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

Take our survey

Dismiss