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 > Media > IMediaPlayer

Light Theme

Dark Theme

IMediaPlayer

Interface for media players.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaPlayer

FMediaIOCorePlayerBase

References

Module	Media
Header	/Engine/Source/Runtime/Media/Public/IMediaPlayer.h
Include	#include "IMediaPlayer.h"

Syntax

class IMediaPlayer

Remarks

Interface for media players.

Destructors

	Name	Description
	~IMediaPlayer()	Virtual destructor.

Functions

	Name	Description
void	Close()	Close a previously opened media source.
bool	FlushOnSeekCompleted()	Flush sinks when seek ends
bool	FlushOnSeekStarted()	Flush sinks when seek begins
IMediaCache ...	GetCache()	Get the player's cache controls.
IMediaContro...	GetControls()	Get the player's playback controls.
FString	GetInfo()	Get debug information about the player and currently opened media.
FText	GetMediaName()	Get the human readable name of the currently loaded media source.
uint32	GetNewResourcesOnOpen()	Return IMediaPlayerLifecycleManagerDelegate::ResourceFlags bitmask to indicate resource types recreated on a open call
bool	GetPlayerFeatureFlag ( EFeatureFlag )
FGuid	GetPlayerPluginGUID()	Get the GUID for this player plugin.
IMediaSample...	GetSamples()	Get the player's sample queue.
FString	GetStats()	Get playback statistics information.
IMediaTracks...	GetTracks()	Get the player's track collection.
FString	GetUrl()	Get the URL of the currently loaded media.
IMediaView &	GetView()	Get the player's view settings.
bool	Open ( const FString& Url, const IMediaOptions* Options )	Open a media source from a URL with optional parameters.
bool	Open ( const TSharedRef< FArchive, ESPMode..., const FString& OriginalUrl, const IMediaOptions* Options )	Open a media source from a file or memory archive with optional parameters.
bool	Open ( const FString& Url, const IMediaOptions* Options, const FMediaPlayerOptions* Pla... )	Open a media source from a URL with optional asset and player parameters.
void	ProcessVideoSamples()	Any extra processing that the player should do when FMediaPlayerFacade::ProcessVideoSamples is run should be put here.
bool	SetAsyncResourceReleaseNotification ( IAsyncResourceReleaseNotificationRe... )	Set async resource release notification for use with IMediaPlayerLifecycleManagerDelegate
void	SetGuid ( const FGuid& Guid )	Set the player's globally unique identifier.
void	SetLastAudioRenderedSampleTime ( FTimespan SampleTime )	Notify player of last sample time of audio used.
bool	SetNativeVolume ( float Volume )	Set the player's native volume if supported.
void	TickAudio()	Tick the player's audio related code.
void	TickFetch ( FTimespan DeltaTime, FTimespan Timecode )	Tick the player in the Fetch phase.
void	TickInput ( FTimespan DeltaTime, FTimespan Timecode )	Tick the player in the Input phase.

Classes

	Name	Description
	IAsyncResourceReleaseNotification

Enums

	Name	Description
	EFeatureFlag

Typedefs

Name	Description
IAsyncResourceReleaseNotificationRef