UDocumentation
UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMediaAssetsModule.h
Go to the documentation of this file.
1
// Copyright Epic Games, Inc. All Rights Reserved.
2
3
#pragma once
4
5
#include "
Delegates/Delegate.h
"
6
#include "
Modules/ModuleInterface.h
"
7
8
class
IMediaSourceRendererInterface
;
9
class
UMediaPlayer
;
10
class
UObject
;
11
15
class
IMediaAssetsModule
16
:
public
IModuleInterface
17
{
18
public
:
20
DECLARE_DELEGATE_RetVal_TwoParams
(
UMediaPlayer
*,
FOnGetPlayerFromObject
,
UObject
*,
UObject
*&
/*PlayerProxy*/
);
22
DECLARE_DELEGATE_RetVal
(
UObject
*,
FOnCreateMediaSourceRenderer
);
24
DECLARE_MULTICAST_DELEGATE_ThreeParams
(
FMediaStateChangedDelegate
,
const
TArray<FString>
&
/*InActorsPathNames*/
,
uint8
/*EnumState*/
,
bool
/*bRemoteBroadcast*/
);
25
32
virtual
int32
RegisterGetPlayerFromObject
(
const
FOnGetPlayerFromObject
& Delegate) = 0;
33
39
virtual
void
UnregisterGetPlayerFromObject
(
int32
DelegateID) = 0;
40
51
virtual
UMediaPlayer
*
GetPlayerFromObject
(
UObject
*
Object
,
UObject
*&
PlayerProxy
) = 0;
52
56
virtual
void
RegisterCreateMediaSourceRenderer
(
const
FOnCreateMediaSourceRenderer
& Delegate) = 0;
57
61
virtual
void
UnregisterCreateMediaSourceRenderer
() = 0;
62
64
virtual
FDelegateHandle
RegisterOnMediaStateChangedEvent
(FMediaStateChangedDelegate::FDelegate
InStateChangedDelegate
) = 0;
65
67
virtual
void
UnregisterOnMediaStateChangedEvent
(
FDelegateHandle
InHandle
) = 0;
68
69
/* Broadcasts the event to all subscribers. InActorsPathNames are the paths of selected Medias in the scene. */
70
virtual
void
BroadcastOnMediaStateChangedEvent
(
const
TArray<FString>
&
InActorsPathNames
,
uint8
EnumState
,
bool
bRemoteBroadcast
=
false
) = 0;
71
75
virtual
UObject
*
CreateMediaSourceRenderer
() = 0;
76
78
virtual
~IMediaAssetsModule
() { }
79
};
EAudioParameterType::Object
@ Object
int32
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition
Platform.h:1125
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition
SharedPointer.h:127
Delegate.h
ModuleInterface.h
uint8
uint8_t uint8
Definition
binka_ue_file_header.h:8
FDelegateHandle
Definition
IDelegateInstance.h:14
IMediaAssetsModule
Definition
IMediaAssetsModule.h:17
IMediaAssetsModule::DECLARE_MULTICAST_DELEGATE_ThreeParams
DECLARE_MULTICAST_DELEGATE_ThreeParams(FMediaStateChangedDelegate, const TArray< FString > &, uint8, bool)
IMediaAssetsModule::RegisterCreateMediaSourceRenderer
virtual void RegisterCreateMediaSourceRenderer(const FOnCreateMediaSourceRenderer &Delegate)=0
IMediaAssetsModule::RegisterGetPlayerFromObject
virtual int32 RegisterGetPlayerFromObject(const FOnGetPlayerFromObject &Delegate)=0
IMediaAssetsModule::~IMediaAssetsModule
virtual ~IMediaAssetsModule()
Definition
IMediaAssetsModule.h:78
IMediaAssetsModule::BroadcastOnMediaStateChangedEvent
virtual void BroadcastOnMediaStateChangedEvent(const TArray< FString > &InActorsPathNames, uint8 EnumState, bool bRemoteBroadcast=false)=0
IMediaAssetsModule::CreateMediaSourceRenderer
virtual UObject * CreateMediaSourceRenderer()=0
IMediaAssetsModule::GetPlayerFromObject
virtual UMediaPlayer * GetPlayerFromObject(UObject *Object, UObject *&PlayerProxy)=0
IMediaAssetsModule::UnregisterOnMediaStateChangedEvent
virtual void UnregisterOnMediaStateChangedEvent(FDelegateHandle InHandle)=0
IMediaAssetsModule::RegisterOnMediaStateChangedEvent
virtual FDelegateHandle RegisterOnMediaStateChangedEvent(FMediaStateChangedDelegate::FDelegate InStateChangedDelegate)=0
IMediaAssetsModule::DECLARE_DELEGATE_RetVal_TwoParams
DECLARE_DELEGATE_RetVal_TwoParams(UMediaPlayer *, FOnGetPlayerFromObject, UObject *, UObject *&)
IMediaAssetsModule::UnregisterGetPlayerFromObject
virtual void UnregisterGetPlayerFromObject(int32 DelegateID)=0
IMediaAssetsModule::UnregisterCreateMediaSourceRenderer
virtual void UnregisterCreateMediaSourceRenderer()=0
IMediaAssetsModule::DECLARE_DELEGATE_RetVal
DECLARE_DELEGATE_RetVal(UObject *, FOnCreateMediaSourceRenderer)
IMediaSourceRendererInterface
Definition
MediaSourceRendererInterface.h:22
IModuleInterface
Definition
ModuleInterface.h:14
TArray
Definition
Array.h:670
UMediaPlayer
Definition
MediaPlayer.h:176
UObject
Definition
Object.h:95
Engine
Source
Runtime
MediaAssets
Public
IMediaAssetsModule.h
Generated by
1.9.8