UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
MediaPlayer.h File Reference
#include "CoreTypes.h"
#include "Containers/UnrealString.h"
#include "Delegates/Delegate.h"
#include "IMediaOptions.h"
#include "IMediaMetadataItem.h"
#include "IMediaControls.h"
#include "Math/Quat.h"
#include "Math/Rotator.h"
#include "Templates/SharedPointer.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/ScriptMacros.h"
#include "Misc/Guid.h"
#include "Misc/Variant.h"
#include "Misc/Timecode.h"
#include "Engine/LatentActionManager.h"
#include "MediaPlayerOptions.h"
#include "IMediaTimeSource.h"
#include "IAudioProxyInitializer.h"
#include "MediaPlayer.generated.h"

Go to the source code of this file.

Classes

class  UMediaTimeStampInfo
 
struct  FMediaMetadataItemBPT
 
struct  FMediaMetadataItemsBPT
 
class  FMediaPlayerProxy
 
class  UMediaPlayer
 

Typedefs

using FMediaPlayerProxyPtr = TSharedPtr< FMediaPlayerProxy, ESPMode::ThreadSafe >
 

Enumerations

enum class  EMediaPlayerTrack : uint8 {
  Audio , Caption , Metadata , Script ,
  Subtitle , Text , Video
}
 
enum class  EMediaTimeRangeBPType : uint8 { Absolute = (uint8)EMediaTimeRangeType::Absolute , Current = (uint8)EMediaTimeRangeType::Current }
 

Functions

 DECLARE_DYNAMIC_MULTICAST_DELEGATE (FOnMediaPlayerMediaEvent)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnMediaPlayerMediaOpened, FString, OpenedUrl)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnMediaPlayerMediaOpenFailed, FString, FailedUrl)
 

Typedef Documentation

◆ FMediaPlayerProxyPtr

Enumeration Type Documentation

◆ EMediaPlayerTrack

enum class EMediaPlayerTrack : uint8
strong

Media track types.

Note: Keep this in sync with EMediaTrackType

Enumerator
Audio 

Audio track.

Caption 

Caption track.

Metadata 

Metadata track.

Script 

Script track.

Subtitle 

Subtitle track.

Text 

Text track.

Video 

Video track.

◆ EMediaTimeRangeBPType

Blueprint usable enum of EMediaTimeRangeType

Enumerator
Absolute 

Total absolute time range as defined by the media.

Current 

Current time range of the media, set by media internal means or through API calls.

Function Documentation

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE()

DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FOnMediaPlayerMediaEvent  )

Multicast delegate that is invoked when a media event occurred in the player.

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [1/2]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnMediaPlayerMediaOpened  ,
FString  ,
OpenedUrl   
)

Multicast delegate that is invoked when a media player's media has been opened.

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [2/2]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnMediaPlayerMediaOpenFailed  ,
FString  ,
FailedUrl   
)

Multicast delegate that is invoked when a media player's media has failed to open.