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 > Runtime > MediaAssets > UMediaPlayer

Light Theme

Dark Theme

UMediaPlayer

Implements a media player asset that can play movies and other media sources.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMediaPlayer

References

Module	MediaAssets
Header	/Engine/Source/Runtime/MediaAssets/Public/MediaPlayer.h
Include	#include "MediaPlayer.h"

Syntax

class UMediaPlayer : public UObject

Remarks

Implements a media player asset that can play movies and other media sources.

Variables

	Name	Description
bool	AffectedByPIEHandling	Whether this player should stop when entering or exiting PIE.
FTimespan	CacheAhead	Duration of samples to cache ahead of the play head.
FTimespan	CacheBehind	Duration of samples to cache behind the play head (when not running as game).
FTimespan	CacheBehindGame	Duration of samples to cache behind the play head (when running as game).
float	HorizontalFieldOfView	The initial horizontal field of view (in Euler degrees; default = 90).
uint32: 1	Loop	Whether the player should loop when media playback reaches the end.
bool	NativeAudioOut	Output any audio via the operating system's sound mixer instead of a Sound Wave asset.
FOnMediaPlayerM...	OnEndReached	A delegate that is invoked when playback has reached the end of the media.
FOnMediaPlayerM...	OnMediaClosed	A delegate that is invoked when a media source has been closed.
FOnMediaPlayerM...	OnMediaOpened	A delegate that is invoked when a media source has been opened.
FOnMediaPlayerM...	OnMediaOpenFailed	A delegate that is invoked when a media source has failed to open.
FOnMediaPlayerM...	OnPlaybackResumed	A delegate that is invoked when media playback has been resumed.
FOnMediaPlayerM...	OnPlaybackSuspended	A delegate that is invoked when media playback has been suspended.
FOnMediaPlayerM...	OnSeekCompleted	A delegate that is invoked when a seek operation completed successfully.
FOnMediaPlayerM...	OnTracksChanged	A delegate that is invoked when the media track collection changed.
UMediaPlaylist ...	Playlist	The play list to use, if any.
int32	PlaylistIndex	The current index of the source in the play list being played.
bool	PlayOnOpen	Automatically start playback after media opened successfully.
uint32: 1	Shuffle	Whether playback should shuffle media sources in the play list.
FTimespan	TimeDelay	Delay of the player's time.
float	VerticalFieldOfView	The initial vertical field of view (in Euler degrees; default = 60).
FRotator	ViewRotation	The initial view rotation.

Constructors

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

Functions

	Name	Description
bool	CanPause()	Check whether media playback can be paused right now.
bool	CanPlaySource ( UMediaSource* MediaSource )	Check whether the specified media source can be played by this player.
bool	CanPlayUrl ( const FString& Url )	Check whether the specified URL can be played by this player.
void	Close()	Close the currently open media, if any.
int32	GetAudioTrackChannels ( int32 TrackIndex, int32 FormatIndex )	Get the number of channels in the specified audio track.
int32	GetAudioTrackSampleRate ( int32 TrackIndex, int32 FormatIndex )	Get the sample rate of the specified audio track.
FString	GetAudioTrackType ( int32 TrackIndex, int32 FormatIndex )	Get the type of the specified audio track format.
FName	GetDesiredPlayerName()	Get the name of the current desired native player.
FTimespan	GetDuration()	Get the media's duration.
const FGuid ...	GetGuid()	Get the Guid associated with this media player
float	GetHorizontalFieldOfView()	Get the current horizontal field of view (only for 360 videos).
FText	GetMediaName()	Get the human readable name of the currently loaded media source.
int32	GetNumTrackFormats ( EMediaPlayerTrack TrackType, int32 TrackIndex )	Get the number of formats of the specified track.
int32	GetNumTracks ( EMediaPlayerTrack TrackType )	Get the number of tracks of the given type.
TSharedRef< ...	GetPlayerFacade()	Get the media player facade that manages low-level media players
FName	GetPlayerName()	Get the name of the current native media player.
UMediaPlayli...	GetPlaylist()	Get the current play list.
int32	GetPlaylistIndex()	Get the current play list index.
UMediaPlayli...	GetPlaylistRef()	Get the current play list.
float	GetRate()	Get the media's current playback rate.
int32	GetSelectedTrack ( EMediaPlayerTrack TrackType )	Get the index of the currently selected track of the given type.
void	GetSupportedRates ( TArray< FFloatRange >& OutRates, bool Unthinned )	Get the supported playback rates.
FTimespan	GetTime()	Get the media's current playback time.
FTimespan	GetTimeDelay()	Delay of the player's time.
UMediaTimeSt...	GetTimeStamp()	Get the media's current playback timestamp.
FText	GetTrackDisplayName ( EMediaPlayerTrack TrackType, int32 TrackIndex )	Get the human readable name of the specified track.
int32	GetTrackFormat ( EMediaPlayerTrack TrackType, int32 TrackIndex )	Get the index of the active format of the specified track type.
FString	GetTrackLanguage ( EMediaPlayerTrack TrackType, int32 TrackIndex )	Get the language tag of the specified track.
const FStrin...	GetUrl()	Get the URL of the currently loaded media, if any.
float	GetVerticalFieldOfView()	Get the current vertical field of view (only for 360 videos).
float	GetVideoTrackAspectRatio ( int32 TrackIndex, int32 FormatIndex )	Get the aspect ratio of the specified video track.
FIntPoint	GetVideoTrackDimensions ( int32 TrackIndex, int32 FormatIndex )	Get the current dimensions of the specified video track.
float	GetVideoTrackFrameRate ( int32 TrackIndex, int32 FormatIndex )	Get the frame rate of the specified video track.
FFloatRange	GetVideoTrackFrameRates ( int32 TrackIndex, int32 FormatIndex )	Get the supported range of frame rates of the specified video track.
FString	GetVideoTrackType ( int32 TrackIndex, int32 FormatIndex )	Get the type of the specified video track format.
FRotator	GetViewRotation()	Get the current view rotation (only for 360 videos).
bool	HasError()	Check whether the player is in an error state.
bool	IsBuffering()	Check whether playback is buffering data.
bool	IsClosed()	Whether media is currently closed.
bool	IsConnecting()	Check whether the player is currently connecting to a media source.
bool	IsLooping()	Check whether playback is looping.
bool	IsPaused()	Check whether playback is currently paused.
bool	IsPlaying()	Check whether playback has started.
bool	IsPreparing()	Check whether the media is currently opening or buffering.
bool	IsReady()	Check whether media is ready for playback.
bool	Next()	Open the next item in the current play list.
UMediaPlayer...	OnMediaEvent()
bool	OpenFile ( const FString& FilePath )	Opens the specified media file path.
bool	OpenPlaylist ( UMediaPlaylist* InPlaylist )	Open the first media source in the specified play list.
bool	OpenPlaylistIndex ( UMediaPlaylist* InPlaylist, int32 Index )	Open a particular media source in the specified play list.
bool	OpenSource ( UMediaSource* MediaSource )	Open the specified media source.
void	OpenSourceLatent ( const UObject* WorldContextObj..., FLatentActionInfo LatentInfo, UMediaSource* MediaSource, const FMediaPlayerOptions& Options, bool& bSuccess )	Open the specified media source with options using a latent action.
bool	OpenSourceWithOptions ( UMediaSource* MediaSource, const FMediaPlayerOptions& Options )	Open the specified media source with supplied options applied.
bool	OpenUrl ( const FString& Url )	Opens the specified media URL.
bool	Pause()	Pauses media playback. This is the same as setting the playback rate to 0.0.
void	PausePIE()	Called when PIE has been paused.
bool	Play()	Starts media playback. This is the same as setting the playback rate to 1.0.
void	PlayAndSeek()	Starts playback from the media opened event, but can be used elsewhere.
bool	Previous()	Open the previous item in the current play list.
void	RegisterWithMediaModule()	Register player with media module to be ticked
bool	Reopen()	Reopens the currently opened media or play list.
void	ResumePIE()	Called when PIE has been resumed.
bool	Rewind()	Rewinds the media to the beginning. This is the same as seeking to zero time.
bool	Seek ( const FTimespan& Time )	Seeks to the specified playback time.
bool	SelectTrack ( EMediaPlayerTrack TrackType, int32 TrackIndex )	Select the active track of the given type.
void	SetBlockOnTime ( const FTimespan& Time )	Set the time on which to block.
void	SetBlockOnTimeRange ( const TRange< FTimespan >& TimeRan... )	Set the time range on which to block.
void	SetDesiredPlayerName ( FName PlayerName )	Set the name of the desired native player.
bool	SetLooping ( bool Looping )	Enables or disables playback looping.
void	SetMediaOptions ( const UMediaSource* Options )	Sets the media options used by the player.
bool	SetNativeVolume ( float Volume )	Set the volume on the native player if not mixing with Sound Wave asset.
bool	SetRate ( float Rate )	Changes the media's playback rate.
void	SetTimeDelay ( FTimespan TimeDelay )	Delay of the player's time.
bool	SetTrackFormat ( EMediaPlayerTrack TrackType, int32 TrackIndex, int32 FormatIndex )	Set the format on the specified track.
bool	SetVideoTrackFrameRate ( int32 TrackIndex, int32 FormatIndex, float FrameRate )	Set the frame rate of the specified video track.
bool	SetViewField ( float Horizontal, float Vertical, bool Absolute )	Set the field of view (only for 360 videos).
bool	SetViewRotation ( const FRotator& Rotation, bool Absolute )	Set the view's rotation (only for 360 videos).
bool	SupportsRate ( float Rate, bool Unthinned )	Check whether the specified playback rate is supported.
bool	SupportsScrubbing()	Check whether the currently loaded media supports scrubbing.
bool	SupportsSeeking()	Check whether the currently loaded media can jump to a certain position.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Classes

	Name	Description
	FOnMediaEvent	Get an event delegate that is invoked when a media event occurred.

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

Take our survey

Dismiss