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 > MediaFrameworkUtilities > UMediaBundle

Light Theme

Dark Theme

UMediaBundle

A bundle of the Media Asset necessary to play a video & audio

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMediaBundle

References

Module	MediaFrameworkUtilities
Header	/Engine/Plugins/Media/MediaFrameworkUtilities/Source/MediaFrameworkUtilities/Public/MediaBundle.h
Include	#include "MediaBundle.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Object))
class UMediaBundle : public UObject

Remarks

A bundle of the Media Asset necessary to play a video & audio

Variables

	Name	Description
bool	bLoopMediaSource	Controls MediaPlayer looping option
bool	bReopenSourceOnError	Automatically try to open the MediaSource again if an error is detected
FOpenCVLensDist...	CurrentLensParameters	Current values of lens parameters to support undo/redo correctly
UTextureRenderT...	LensDisplacementMap	Destination of lens distortion result
FOpenCVLensDist...	LensParameters	Lens parameters of the source
UMaterialInterf...	Material	MediaBundle default Material
TSubclassOf< AM...	MediaBundleActorClass	Class to spawn for that asset.
UMediaPlayer &#...	MediaPlayer	MediaBundle default MediaPlayer
UMediaSource &#...	MediaSource	MediaBundle internal MediaSource
UMediaTexture &...	MediaTexture	MediaBundle default MediaTexture
FOpenCVCameraVi...	UndistortedCameraViewInfo	CameraView information for the undistorted space

Constructors

	Name	Description
	UMediaBundle ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	CloseMediaSource()	Close the media source.
TArray< UPac...	CreateInternalsEditor()	Create other assets required for a MediaBundle to work. Used for duplication and factory
UTextureRend...	GetLensDisplacementTexture()	Get the lens displacement Render Target.
UMaterialInt...	GetMaterial()	Get the material interface.
UMediaPlayer...	GetMediaPlayer()	Get the media player.
UMediaSource...	GetMediaSource()	Get the media source.
UMediaTextur...	GetMediaTexture()	Get the media texture.
FOpenCVCamer...	GetUndistortedCameraViewInfo()	Get the undistorted space camera view information.
bool	IsPlaying()	The media is playing.
FOnMediaStat...	OnMediaStateChanged()	Media state changed event To use when the you want to be inform if the media is playing or not.
bool	OpenMediaSource()	Play the media source.

Overridden from UObject

	Name	Description
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	MediaFramework.MediaSourceSelected Triggered when a media source is selected.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name	Description
FOnMediaStateChanged	Delegate type for media state changed event

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

Take our survey

Dismiss