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 > MediaUtils > FMediaPlayerFacade

Light Theme

Dark Theme

FMediaPlayerFacade

Facade for low-level media player objects.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaClockSink

IMediaTickable

IMediaEventSink

TSharedFromThis

FMediaPlayerFacade

References

Module	MediaUtils
Header	/Engine/Source/Runtime/MediaUtils/Public/MediaPlayerFacade.h
Include	#include "MediaPlayerFacade.h"

Syntax

class FMediaPlayerFacade :
    public IMediaClockSink,
    public IMediaTickable,
    protected IMediaEventSink,
    public TSharedFromThis< FMediaPlayerFacade, ESPMode::ThreadSafe >

Remarks

Facade for low-level media player objects.

The purpose of this class is to provide a simpler interface to low-level media player implementations. It implements common functionality, such as translating between time codes and play times, and manages the selection and creation of player implementations for a given media source.

Note that, unlike the low-level methods in IMediaTracks, most track and track format related methods in this class allow for INDEX_NONE to be used as track and format indices in order to indicate the 'current selection'.

Variables

	Name	Description
TOptional< FMed...	ActivePlayerOptions	Active media player options.
FName	DesiredPlayerName	Name of the desired native player, if any.
FTimespan	TimeDelay	Extra time to reduce from current player's time.

Constructors

	Name	Description
	FMediaPlayerFacade()	Default constructor.

Destructors

	Name	Description
	~FMediaPlayerFacade()	Virtual destructor.

Functions

	Name	Description
void	AddAudioSampleSink ( const TSharedRef< FMediaAudioSample... )	Add the given audio sample sink to this player.
void	AddCaptionSampleSink ( const TSharedRef< FMediaOverlaySamp... )	Add the given audio sample sink to this player.
void	AddMetadataSampleSink ( const TSharedRef< FMediaBinarySampl... )	Add the given audio sample sink to this player.
void	AddSubtitleSampleSink ( const TSharedRef< FMediaOverlaySamp... )	Add the given audio sample sink to this player.
void	AddVideoSampleSink ( const TSharedRef< FMediaTextureSamp... )	Add the given audio sample sink to this player.
bool	BlockOnFetch()	Whether sample fetching should block.
bool	CanPause()	Whether playback can be paused.
bool	CanPlayUrl ( const FString& Url, const IMediaOptions* Options )	Whether the specified URL can be played by this player.
bool	CanResume()	Whether playback can be resumed.
bool	CanScrub()	Whether playback can be scrubbed.
bool	CanSeek()	Whether playback can jump to a position.
void	Close()	Close the currently open media, if any.
void	FlushSinks()	Flush all media sample sinks.
uint32	GetAudioTrackChannels ( int32 TrackIndex, int32 FormatIndex )	Get the number of channels in the specified audio track.
bool	GetAudioTrackFormat ( int32 TrackIndex, int32 FormatIndex, FMediaAudioTrackFormat& OutFormat )	Get details about the specified audio track format.
uint32	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.
FTimespan	GetDuration()	Get the media's duration.
const FGuid ...	GetGuid()	Get the player's globally unique identifier.
FString	GetInfo()	Get debug information about the player and currently opened media.
FTimespan	GetLastAudioRenderedSampleTime()	Get time of last audio sample played
FTimespan	GetLastAudioSampleProcessedTime()	Get time of last audio sample decoded
FTimespan	GetLastVideoSampleProcessedTime()	Get time of last video sample decoded
FText	GetMediaName()	Get the human readable name of the currently loaded media source.
int32	GetNumTrackFormats ( EMediaTrackType TrackType, int32 TrackIndex )	Get the number of formats of the specified track.
int32	GetNumTracks ( EMediaTrackType TrackType )	Get the number of tracks of the given type.
TSharedPtr< ...	GetPlayer()	Get the low-level player associated with this object.
TSharedPtr< ...	GetPlayerForUrl ( const FString& Url, const IMediaOptions* Options )	Get a player that can play the specified media URL.
FName	GetPlayerName()	Get the name of the current native media player.
float	GetRate()	Get the media's current playback rate.
int32	GetSelectedTrack ( EMediaTrackType TrackType )	Get the index of the currently selected track of the given type.
FString	GetStats()	Get playback statistics information.
TRangeSet< f...	GetSupportedRates ( bool Unthinned )	Get the supported playback rates.
FTimespan	GetTime()	Get the media's current playback time.
FText	GetTrackDisplayName ( EMediaTrackType TrackType, int32 TrackIndex )	Get the human readable name of the specified track.
int32	GetTrackFormat ( EMediaTrackType TrackType, int32 TrackIndex )	Get the index of the active format of the specified track.
FString	GetTrackLanguage ( EMediaTrackType 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	GetVideoTrackAspectRatio ( int32 TrackIndex, int32 FormatIndex )	Get the aspect ratio of the specified video track.
FIntPoint	GetVideoTrackDimensions ( int32 TrackIndex, int32 FormatIndex )	Get the width and height of the specified video track.
bool	GetVideoTrackFormat ( int32 TrackIndex, int32 FormatIndex, FMediaVideoTrackFormat& OutFormat )	Get details about the specified audio track format.
float	GetVideoTrackFrameRate ( int32 TrackIndex, int32 FormatIndex )	Get frame rate of the specified video track.
TRange< floa...	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.
bool	GetViewField ( float& OutHorizontal, float& OutVertical )	Get the field of view.
bool	GetViewOrientation ( FQuat& OutOrientation )	Get the view's orientation.
bool	HasError()	Check whether the player is in an error state.
bool	IsBuffering()	Whether the player is currently buffering data.
bool	IsClosed()	Whether media is currently closed.
bool	IsConnecting()	Whether the player is currently connecting to a media source.
bool	IsLooping()	Whether playback is looping.
bool	IsPaused()	Whether playback is currently paused.
bool	IsPlaying()	Whether playback is in progress.
bool	IsPreparing()	Whether the media is currently opening or buffering.
bool	IsReady()	Whether media is ready for playback.
FMediaPlayer...	OnMediaEvent()
bool	Open ( const FString& Url, const IMediaOptions* Options, const FMediaPlayerOptions* Pla... )	Open a media source from a URL with optional parameters.
void	ProcessAudioSamples ( IMediaSamples& Samples, TRange< FTimespan > TimeRange )	Fetch audio samples from the player and forward them to the registered sinks.
void	ProcessCaptionSamples ( IMediaSamples& Samples, TRange< FTimespan > TimeRange )	Fetch audio samples from the player and forward them to the registered sinks.
void	ProcessEvent ( EMediaEvent Event )	Process the given media event.
void	ProcessMetadataSamples ( IMediaSamples& Samples, TRange< FTimespan > TimeRange )	Fetch metadata samples from the player and forward them to the registered sinks.
void	ProcessSubtitleSamples ( IMediaSamples& Samples, TRange< FTimespan > TimeRange )	Fetch subtitle samples from the player and forward them to the registered sinks.
void	ProcessVideoSamples ( IMediaSamples& Samples, TRange< FTimespan > TimeRange )	Fetch video samples from the player and forward them to the registered sinks.
void	QueryCacheState ( EMediaTrackType TrackType, EMediaCacheState State, TRangeSet< FTimespan >& OutTimeRan... )	Query the time ranges of cached media samples for the specified caching state.
bool	Seek ( const FTimespan& Time )	Seeks to the specified playback time.
void	SelectDefaultTracks()	Select the default media tracks.
bool	SelectTrack ( EMediaTrackType TrackType, int32 TrackIndex )	Select the active track of the given type.
void	SetBlockOnTime ( const FTimespan& Time )	Set the time on which to block.
void	SetCacheWindow ( FTimespan Ahead, FTimespan Behind )	Set sample caching options.
void	SetGuid ( FGuid& Guid )	Set the player's globally unique identifier.
void	SetLastAudioRenderedSampleTime ( FTimespan SampleTime )	Record last audio sample played to track audio sync (for automated tests)
bool	SetLooping ( bool Looping )	Enables or disables playback looping.
void	SetMediaOptions ( const IMediaOptions* Options )	Changes media ooptions on the player.
bool	SetNativeVolume ( float Volume )	Changes the media's native volume.
bool	SetRate ( float Rate )	Changes the media's playback rate.
bool	SetTrackFormat ( EMediaTrackType 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.
bool	SetViewOrientation ( const FQuat& Orientation, bool Absolute )	Set the view's orientation.
bool	SupportsRate ( float Rate, bool Unthinned )	Whether the specified playback rate is supported.

Overridden from IMediaClockSink

	Name	Description
void	TickFetch ( FTimespan DeltaTime, FTimespan Timecode )	Called each tick to handle updates after the Engine ticked.
void	TickInput ( FTimespan DeltaTime, FTimespan Timecode )	Called each tick to handle input before the Engine is ticked.
void	TickOutput ( FTimespan DeltaTime, FTimespan Timecode )	Called each tick to output the rendered frame.

Overridden from IMediaTickable

		Name	Description
	void	TickTickable()	Tick the object.

Overridden from IMediaEventSink

		Name	Description
	void	ReceiveMediaEvent ( EMediaEvent Event )	Receive the given media event.

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