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 > Plugins > MediaIOCore > FMediaIOCorePlayerBase

Light Theme

Dark Theme

FMediaIOCorePlayerBase

Implements a base player for hardware IO cards.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaPlayer

IMediaCache

IMediaControls

IMediaTracks

IMediaView

ITimedDataInput

FMediaIOCorePlayerBase

References

Module	MediaIOCore
Header	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCorePlayerBase.h
Include	#include "MediaIOCorePlayerBase.h"

Syntax

class FMediaIOCorePlayerBase :
    public IMediaPlayer,
    protected IMediaCache,
    protected IMediaControls,
    protected IMediaTracks,
    protected IMediaView,
    public ITimedDataInput

Remarks

Implements a base player for hardware IO cards.

The processing of metadata and video frames is delayed until the fetch stage (TickFetch) in order to increase the window of opportunity for receiving frames for the current render frame time code.

Depending on whether the media source enables time code synchronization, the player's current play time (CurrentTime) is derived either from the time codes embedded in frames or from the Engine's global time code.

Variables

	Name	Description
FMediaAudioTrac...	AudioTrackFormat	Format of the audio.
FMediaIOSamplin...	BaseSettings	Base set of settings to start from when setuping channels
bool	bUseTimeSynchronization	Whether to use the Synchronization Time module as time source.
bool	bWarnedIncompatibleFrameRate	Warn when the video frame rate is not the same as the engine's frame rate.
TArray< ITimedD...	Channels	Timed Data Input handler
FCriticalSectio...	CriticalSection	Critical section for synchronizing access to receiver and sinks.
EMediaState	CurrentState	Current state of the media player.
FTimespan	CurrentTime	Current playback time.
IMediaEventSink...	EventSink	The media event handler.
int32	FrameDelay	When using Time Synchronization (TC synchronization), how many frame back of a delay would you like.
FString	OpenUrl	Url used to open the media player.
FTimespan	PreviousFrameTimespan	Previous frame Timespan
FMediaIOCoreSam...	Samples	The media sample cache.
double	TimeDelay	When not using Time Synchronization (use computer time), how many sec back of a delay would you like.
FFrameRate	VideoFrameRate	Video frame rate in the last received sample.
FMediaVideoTrac...	VideoTrackFormat	Format of the video.

Constructors

	Name	Description
	FMediaIOCorePlayerBase ( IMediaEventSink& InEventSink )	Create and initialize a new instance.

Destructors

	Name	Description
	~FMediaIOCorePlayerBase()	Virtual destructor.

Functions

	Name	Description
double	GetApplicationSeconds()	Get the application time with a delta to represent the actual system time.
double	GetPlatformSeconds()	Get the platform time with a delta to represent the actual system time.
const FMedia...	GetSamples()
bool	IsHardwareReady()	Is the IO hardware/device ready to be used.
bool	IsTimecodeLogEnabled()	Log the timecode when a frame is received.
bool	ReadMediaOptions ( const IMediaOptions* Options )	Return true if the options combination are valid.
void	SetupSampleChannels()	Setup settings for the different kind of supported data channels.
void	TickTimeManagement()

Overridden from IMediaPlayer

	Name	Description
void	Close()	Close a previously opened media source.
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.
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.
void	TickFetch ( FTimespan DeltaTime, FTimespan Timecode )	Tick the player in the Fetch phase.

Overridden from IMediaCache

		Name	Description
	int32	GetSampleCount ( EMediaCacheState State )	Query the number of samples for the specified caching state.
	bool	QueryCacheState ( EMediaCacheState State, TRangeSet< FTimespan >& OutTimeRan... )	Query the time ranges of cached media samples for the specified caching state.

Overridden from IMediaControls

	Name	Description
bool	CanControl ( EMediaControl Control )	Whether the specified control is currently available.
FTimespan	GetDuration()	Get the media's duration.
float	GetRate()	Get the nominal playback rate, i.e. 1.0 for real time.
EMediaState	GetState()	Get the state of the media.
EMediaStatus	GetStatus()	Get media player status flags.
TRangeSet< f...	GetSupportedRates ( EMediaRateThinning Thinning )	Get the supported playback rates.
FTimespan	GetTime()	Get the player's current playback time.
bool	IsLooping()	Check whether playback is currently looping.
bool	Seek ( const FTimespan& Time )	Change the media's playback time.
bool	SetLooping ( bool Looping )	Set whether playback should be looping.
bool	SetRate ( float Rate )	Set the current playback rate.

Overridden from IMediaTracks

	Name	Description
bool	GetAudioTrackFormat ( int32 TrackIndex, int32 FormatIndex, FMediaAudioTrackFormat& OutFormat )	Get details about the specified audio track format.
int32	GetNumTrackFormats ( EMediaTrackType TrackType, int32 TrackIndex )	Get the number of formats of the specified track.
int32	GetNumTracks ( EMediaTrackType TrackType )	Get the number of media tracks of the given type.
int32	GetSelectedTrack ( EMediaTrackType TrackType )	Get the index of the currently selected track of the given type.
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 currently selected format of the given track type.
FString	GetTrackLanguage ( EMediaTrackType TrackType, int32 TrackIndex )	Get the language tag of the specified track.
FString	GetTrackName ( EMediaTrackType TrackType, int32 TrackIndex )	Get the internal name of the specified track.
bool	GetVideoTrackFormat ( int32 TrackIndex, int32 FormatIndex, FMediaVideoTrackFormat& OutFormat )	Get details about the specified video track format.
bool	SelectTrack ( EMediaTrackType TrackType, int32 TrackIndex )	Select the active track of the given type.
bool	SetTrackFormat ( EMediaTrackType TrackType, int32 TrackIndex, int32 FormatIndex )	Select the active format on the specified track.

Overridden from ITimedDataInput

	Name	Description
void	AddChannel ( ITimedDataInputChannel* Channe... )	Add a channel belonging to this input
TArray< ITim...	GetChannels()	Get a list of the channel this input has.
FText	GetDisplayName()	Get the name used when displayed.
double	GetEvaluationOffsetInSeconds()	Get the offset in seconds used at evaluation.
ETimedDataIn...	GetEvaluationType()	Get how the input is evaluated.
FFrameRate	GetFrameRate()	Get the frame rate at which the samples is produce.
bool	IsDataBufferSizeControlledByInput()	Does channel from this input support a different buffer size than it's input.
void	RemoveChannel ( ITimedDataInputChannel* Channe... )	Remove channel from the input
void	SetEvaluationOffsetInSeconds ( double Offset )	Set the offset in seconds used at evaluation.
void	SetEvaluationType ( ETimedDataInputEvaluationType Evalu... )	Set how the input is evaluated.

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

Take our survey

Dismiss