Navigation
API > API/Plugins > API/Plugins/MediaFrameworkUtilities
A bundle of the Media Asset necessary to play a video & audio
| Name | UMediaBundle |
| Type | class |
| Header File | /Engine/Plugins/Media/MediaFrameworkUtilities/Source/MediaFrameworkUtilities/Public/MediaBundle.h |
| Include Path | #include "MediaBundle.h" |
Syntax
UCLASS (BlueprintType, HideCategories=(Object))
class UMediaBundle : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaBundle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMediaBundle
(
const FObjectInitializer& ObjectInitializer |
MediaBundle.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnMediaStateChanged | TMulticastDelegate_OneParam< void, bool > | Delegate type for media state changed event | MediaBundle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bLoopMediaSource | bool | Controls MediaPlayer looping option | MediaBundle.h |
|
| bReopenSourceOnError | bool | Automatically try to open the MediaSource again if an error is detected | MediaBundle.h |
|
| MediaBundleActorClass | TSubclassOf< AMediaBundleActorBase > | Class to spawn for that asset. | MediaBundle.h |
|
| MediaSource | TObjectPtr< UMediaSource > | MediaBundle internal MediaSource | MediaBundle.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DefaultActorClass | TSubclassOf< AMediaBundleActorBase > | Default Actor Class from the plugin | MediaBundle.h |
|
| DefaultFailedTexture | TObjectPtr< UTexture > | Default Texture from the plugin | MediaBundle.h |
|
| DefaultMaterial | TObjectPtr< UMaterial > | Default Material from the plugin | MediaBundle.h |
|
| MediaStateChangedDelegate | FOnMediaStateChanged | Delegate for the media state changed event | MediaBundle.h | |
| PreviousWarningTime | double | Last time the warning has been displayed. | MediaBundle.h | |
| ReferenceCount | int32 | Internal reference counter of active media player | MediaBundle.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseMediaSource () |
Close the media source. | MediaBundle.h | |
| Create other assets required for a MediaBundle to work. Used for duplication and factory | MediaBundle.h | ||
UTextureRenderTarget2D * GetLensDisplacementTexture() |
Get the lens displacement Render Target. | MediaBundle.h |
|
UMaterialInterface * GetMaterial() |
Get the material interface. | MediaBundle.h |
|
UMediaPlayer * GetMediaPlayer() |
Get the media player. | MediaBundle.h |
|
UMediaSource * GetMediaSource() |
Get the media source. | MediaBundle.h |
|
UMediaTexture * GetMediaTexture() |
Get the media texture. | MediaBundle.h |
|
FOpenCVCameraViewInfo GetUndistortedCameraViewInfo() |
Get the undistorted space camera view information. | MediaBundle.h |
|
bool IsPlaying () |
The media is playing. | MediaBundle.h | |
FOnMediaStateChanged & OnMediaStateChanged() |
Media state changed event To use when the you want to be inform if the media is playing or not. | MediaBundle.h | |
bool OpenMediaSource () |
Play the media source. | MediaBundle.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostDuplicate
(
bool bDuplicateForPIE |
MediaBundle.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
@EventName MediaFramework.MediaSourceSelected @Trigger Triggered when a media source is selected. | MediaBundle.h | |
virtual void PostLoad() |
MediaBundle.h |