Navigation
API > API/Plugins > API/Plugins/MediaFrameworkUtilities
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 (BlueprintType, HideCategories=(Object))
class UMediaBundle : public UObject
Remarks
A bundle of the Media Asset necessary to play a video & audio
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bLoopMediaSource | Controls MediaPlayer looping option | |
| bool | bReopenSourceOnError | Automatically try to open the MediaSource again if an error is detected | |
| FOpenCVLensDistortionParameters | CurrentLensParameters | Current values of lens parameters to support undo/redo correctly | |
| TObjectPtr< UTextureRenderTarget2D > | LensDisplacementMap | Destination of lens distortion result | |
| FOpenCVLensDistortionParameters | LensParameters | Lens parameters of the source | |
| TObjectPtr< UMaterialInterface > | Material | MediaBundle default Material | |
| TSubclassOf< AMediaBundleActorBase > | MediaBundleActorClass | Class to spawn for that asset. | |
| TObjectPtr< UMediaPlayer > | MediaPlayer | MediaBundle default MediaPlayer | |
| TObjectPtr< UMediaSource > | MediaSource | MediaBundle internal MediaSource | |
| TObjectPtr< UMediaTexture > | MediaTexture | MediaBundle default MediaTexture | |
| FOpenCVCameraViewInfo | UndistortedCameraViewInfo | CameraView information for the undistorted space |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UMediaBundle
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Close the media source. | ||
| TArray< UPackage * > | Create other assets required for a MediaBundle to work. Used for duplication and factory | ||
| UTextureRenderTarget2D * | Get the lens displacement Render Target. | ||
| UMaterialInterface * | GetMaterial () |
Get the material interface. | |
| UMediaPlayer * | Get the media player. | ||
| UMediaSource * | Get the media source. | ||
| UMediaTexture * | Get the media texture. | ||
| FOpenCVCameraViewInfo | Get the undistorted space camera view information. | ||
| bool | IsPlaying () |
The media is playing. | |
| FOnMediaStateChanged & | Media state changed event To use when the you want to be inform if the media is playing or not. | ||
| bool | Play the media source. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostDuplicate
(
bool bDuplicateForPIE |
Called after duplication & serialization and before PostLoad. | |
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
@EventName MediaFramework.MediaSourceSelected @Trigger 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 |