#include <MediaPlayer.h>

Inheritance diagram for UMediaPlayer:

Public Member Functions
MEDIAASSETS_API bool	CanPause () const

MEDIAASSETS_API bool	CanPlaySource (UMediaSource *MediaSource)

MEDIAASSETS_API bool	CanPlayUrl (const FString &Url)

MEDIAASSETS_API void	Close ()

MEDIAASSETS_API int32	GetAudioTrackChannels (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API int32	GetAudioTrackSampleRate (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API FString	GetAudioTrackType (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API FName	GetDesiredPlayerName () const

MEDIAASSETS_API FTimespan	GetDuration () const

MEDIAASSETS_API float	GetHorizontalFieldOfView () const

virtual MEDIAASSETS_API FText	GetMediaName () const

MEDIAASSETS_API int32	GetNumTracks (EMediaPlayerTrack TrackType) const

MEDIAASSETS_API int32	GetNumTrackFormats (EMediaPlayerTrack TrackType, int32 TrackIndex) const

MEDIAASSETS_API FName	GetPlayerName () const

UMediaPlaylist *	GetPlaylist () const

int32	GetPlaylistIndex () const

MEDIAASSETS_API float	GetRate () const

MEDIAASSETS_API int32	GetSelectedTrack (EMediaPlayerTrack TrackType) const

MEDIAASSETS_API void	GetSupportedRates (TArray< FFloatRange > &OutRates, bool Unthinned) const

MEDIAASSETS_API FTimespan	GetTime () const

MEDIAASSETS_API FTimespan	GetDisplayTime () const

MEDIAASSETS_API UMediaTimeStampInfo *	GetTimeStamp () const

MEDIAASSETS_API UMediaTimeStampInfo *	GetDisplayTimeStamp () const

MEDIAASSETS_API TOptional< FTimecode >	GetVideoTimecode () const

MEDIAASSETS_API FText	GetTrackDisplayName (EMediaPlayerTrack TrackType, int32 TrackIndex) const

MEDIAASSETS_API int32	GetTrackFormat (EMediaPlayerTrack TrackType, int32 TrackIndex) const

MEDIAASSETS_API FString	GetTrackLanguage (EMediaPlayerTrack TrackType, int32 TrackIndex) const

MEDIAASSETS_API const FString &	GetUrl () const

MEDIAASSETS_API float	GetVerticalFieldOfView () const

MEDIAASSETS_API float	GetVideoTrackAspectRatio (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API FIntPoint	GetVideoTrackDimensions (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API float	GetVideoTrackFrameRate (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API FFloatRange	GetVideoTrackFrameRates (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API FString	GetVideoTrackType (int32 TrackIndex, int32 FormatIndex) const

MEDIAASSETS_API FRotator	GetViewRotation () const

MEDIAASSETS_API FTimespan	GetTimeDelay () const

MEDIAASSETS_API bool	HasError () const

MEDIAASSETS_API bool	IsBuffering () const

MEDIAASSETS_API bool	IsConnecting () const

MEDIAASSETS_API bool	IsLooping () const

MEDIAASSETS_API bool	IsPaused () const

MEDIAASSETS_API bool	IsPlaying () const

MEDIAASSETS_API bool	IsPreparing () const

MEDIAASSETS_API bool	IsClosed () const

MEDIAASSETS_API bool	IsReady () const

MEDIAASSETS_API bool	Next ()

MEDIAASSETS_API bool	OpenFile (const FString &FilePath)

bool	OpenPlaylist (UMediaPlaylist *InPlaylist)

MEDIAASSETS_API bool	OpenPlaylistIndex (UMediaPlaylist *InPlaylist, int32 Index)

MEDIAASSETS_API bool	OpenSource (UMediaSource *MediaSource)

MEDIAASSETS_API bool	OpenSourceWithOptions (UMediaSource *MediaSource, const FMediaPlayerOptions &Options)

MEDIAASSETS_API void	OpenSourceLatent (const UObject WorldContextObject, struct FLatentActionInfo LatentInfo, UMediaSource MediaSource, const FMediaPlayerOptions &Options, bool &bSuccess)

MEDIAASSETS_API bool	OpenUrl (const FString &Url)

MEDIAASSETS_API bool	Pause ()

MEDIAASSETS_API bool	Play ()

MEDIAASSETS_API void	PlayAndSeek ()

MEDIAASSETS_API bool	Previous ()

MEDIAASSETS_API bool	Reopen ()

MEDIAASSETS_API bool	Rewind ()

MEDIAASSETS_API bool	Seek (const FTimespan &Time)

MEDIAASSETS_API bool	Scrub (const FTimespan &Time)

MEDIAASSETS_API bool	SelectTrack (EMediaPlayerTrack TrackType, int32 TrackIndex)

MEDIAASSETS_API void	SetBlockOnTime (const FTimespan &Time)

MEDIAASSETS_API void	SetBlockOnTimeRange (const TRange< FTimespan > &TimeRange)

MEDIAASSETS_API void	SetDesiredPlayerName (FName PlayerName)

MEDIAASSETS_API bool	SetLooping (bool Looping)

MEDIAASSETS_API void	SetMediaOptions (const UMediaSource *Options)

MEDIAASSETS_API bool	SetRate (float Rate)

MEDIAASSETS_API bool	SetNativeVolume (float Volume)

MEDIAASSETS_API bool	SetTrackFormat (EMediaPlayerTrack TrackType, int32 TrackIndex, int32 FormatIndex)

MEDIAASSETS_API bool	SetVideoTrackFrameRate (int32 TrackIndex, int32 FormatIndex, float FrameRate)

MEDIAASSETS_API bool	SetViewField (float Horizontal, float Vertical, bool Absolute)

MEDIAASSETS_API bool	SetViewRotation (const FRotator &Rotation, bool Absolute)

MEDIAASSETS_API void	SetTimeDelay (FTimespan TimeDelay)

MEDIAASSETS_API bool	SupportsRate (float Rate, bool Unthinned) const

MEDIAASSETS_API bool	SupportsScrubbing () const

MEDIAASSETS_API bool	SupportsSeeking () const

MEDIAASSETS_API bool	SupportsPlaybackTimeRange () const

MEDIAASSETS_API TRange< FTimespan >	GetPlaybackTimeRange (EMediaTimeRangeType InRangeToGet)

MEDIAASSETS_API FFloatInterval	GetPlaybackTimeRange (EMediaTimeRangeBPType InRangeToGet)

MEDIAASSETS_API bool	SetPlaybackTimeRange (const TRange< FTimespan > &InTimeRange)

MEDIAASSETS_API bool	SetPlaybackTimeRange (FFloatInterval InTimeRange)

MEDIAASSETS_API void	CleanUpBeforeDestroy ()

const FGuid &	GetGuid ()

MEDIAASSETS_API FVariant	GetMediaInfo (FName InfoName) const

template<typename T >
bool	GetMediaInfo (T &Result, FName InfoName) const

MEDIAASSETS_API TSharedPtr< TMap< FString, TArray< TUniquePtr< IMediaMetadataItem > > >, ESPMode::ThreadSafe >	GetMediaMetadata () const

MEDIAASSETS_API TMap< FString, FMediaMetadataItemsBPT >	GetMediaMetadataItems () const

MEDIAASSETS_API TSharedRef< FMediaPlayerFacade, ESPMode::ThreadSafe >	GetPlayerFacade () const

MEDIAASSETS_API void	RegisterWithMediaModule ()

MEDIAASSETS_API void	UnregisterWithMediaModule ()

UMediaPlaylist &	GetPlaylistRef () const

	DECLARE_EVENT_OneParam (UMediaPlayer, FOnMediaEvent, EMediaEvent) FOnMediaEvent &OnMediaEvent()

virtual MEDIAASSETS_API void	BeginDestroy () override

virtual MEDIAASSETS_API FString	GetDesc () override

virtual MEDIAASSETS_API void	PostDuplicate (bool bDuplicateForPIE) override

virtual MEDIAASSETS_API void	PostInitProperties () override

virtual MEDIAASSETS_API void	PostLoad () override

virtual MEDIAASSETS_API TSharedPtr< Audio::IProxyData >	CreateProxyData (const Audio::FProxyDataInitParams &InitParams) override

Public Member Functions inherited from UObject
COREUOBJECT_API	UObject ()

COREUOBJECT_API	UObject (const FObjectInitializer &ObjectInitializer)

COREUOBJECT_API	UObject (EStaticConstructor, EObjectFlags InFlags)

COREUOBJECT_API	UObject (FVTableHelper &Helper)

COREUOBJECT_API UObject *	CreateDefaultSubobject (FName SubobjectFName, UClass ReturnType, UClass ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)

template<class TReturnType >
TReturnType *	CreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)

template<class TReturnType >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)

template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)

template<class TReturnType >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)

template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)

COREUOBJECT_API void	GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)

COREUOBJECT_API UObject *	GetDefaultSubobjectByName (FName ToFind)

virtual COREUOBJECT_API void	PostReinitProperties ()

virtual void	PostCDOContruct ()

virtual COREUOBJECT_API void	PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)

virtual COREUOBJECT_API void	PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)

virtual COREUOBJECT_API void	PreSave (FObjectPreSaveContext SaveContext)

virtual COREUOBJECT_API void	CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)

UE_FORCEINLINE_HINT bool	Modify (bool bAlwaysMarkDirty=true)

UE_FORCEINLINE_HINT bool	IsCapturingAsRootObjectForTransaction () const

virtual bool	ResolveSubobject (const TCHAR SubObjectPath, UObject &OutObject, bool bLoadIfExists)

virtual bool	IsReadyForAsyncPostLoad () const

virtual COREUOBJECT_API void	PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)

virtual bool	IsReadyForFinishDestroy ()

virtual COREUOBJECT_API void	FinishDestroy ()

virtual COREUOBJECT_API void	Serialize (FArchive &Ar)

virtual COREUOBJECT_API void	Serialize (FStructuredArchive::FRecord Record)

virtual void	ShutdownAfterError ()

virtual void	PostInterpChange (FProperty *PropertyThatChanged)

virtual COREUOBJECT_API void	PostRename (UObject *OldOuter, const FName OldName)

virtual void	PreDuplicate (FObjectDuplicationParameters &DupParams)

virtual void	PostDuplicate (EDuplicateMode::Type DuplicateMode)

virtual COREUOBJECT_API bool	NeedsLoadForClient () const

virtual COREUOBJECT_API bool	NeedsLoadForServer () const

virtual COREUOBJECT_API bool	NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const

virtual bool	NeedsLoadForEditorGame () const

virtual bool	IsEditorOnly () const

virtual bool	HasNonEditorOnlyReferences () const

virtual bool	IsPostLoadThreadSafe () const

virtual COREUOBJECT_API bool	IsDestructionThreadSafe () const

virtual COREUOBJECT_API void	GetPreloadDependencies (TArray< UObject * > &OutDeps)

virtual void	GetPrestreamPackages (TArray< UObject * > &OutPrestream)

virtual void	ExportCustomProperties (FOutputDevice &Out, uint32 Indent)

virtual void	ImportCustomProperties (const TCHAR SourceText, FFeedbackContext Warn)

virtual void	PostEditImport ()

virtual void	PostReloadConfig (class FProperty *PropertyThatWasLoaded)

virtual COREUOBJECT_API bool	Rename (const TCHAR NewName=nullptr, UObject NewOuter=nullptr, ERenameFlags Flags=REN_None)

COREUOBJECT_API UScriptStruct *	GetSparseClassDataStruct () const

virtual bool	GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const

virtual COREUOBJECT_API void	GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)

SIZE_T	GetResourceSizeBytes (EResourceSizeMode::Type Mode)

virtual FName	GetExporterName (void)

COREUOBJECT_API void	CallAddReferencedObjects (FReferenceCollector &Collector)

virtual FRestoreForUObjectOverwrite *	GetRestoreForUObjectOverwrite ()

virtual bool	AreNativePropertiesIdenticalTo (UObject *Other) const

virtual COREUOBJECT_API void	GetAssetRegistryTags (FAssetRegistryTagsContext Context) const

virtual COREUOBJECT_API void	GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const

COREUOBJECT_API void	GetAssetRegistryTags (FAssetData &Out) const

COREUOBJECT_API void	GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const

virtual COREUOBJECT_API bool	IsAsset () const

virtual COREUOBJECT_API FPrimaryAssetId	GetPrimaryAssetId () const

virtual COREUOBJECT_API bool	IsLocalizedResource () const

virtual COREUOBJECT_API bool	IsSafeForRootSet () const

virtual COREUOBJECT_API void	TagSubobjects (EObjectFlags NewFlags)

virtual COREUOBJECT_API void	GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const

virtual COREUOBJECT_API void	GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const

virtual COREUOBJECT_API void	RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)

virtual COREUOBJECT_API bool	IsNameStableForNetworking () const

virtual COREUOBJECT_API bool	IsFullNameStableForNetworking () const

virtual COREUOBJECT_API bool	IsSupportedForNetworking () const

virtual void	GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)

virtual COREUOBJECT_API void	PreNetReceive ()

virtual COREUOBJECT_API void	PostNetReceive ()

virtual void	PostRepNotifies ()

virtual COREUOBJECT_API void	PreDestroyFromReplication ()

COREUOBJECT_API bool	IsSelected () const

COREUOBJECT_API void	SerializeScriptProperties (FArchive &Ar) const

COREUOBJECT_API void	SerializeScriptProperties (FStructuredArchive::FSlot Slot) const

COREUOBJECT_API void	ReinitializeProperties (UObject SourceObject=NULL, struct FObjectInstancingGraph InstanceGraph=NULL)

COREUOBJECT_API FString	GetDetailedInfo () const

COREUOBJECT_API bool	ConditionalBeginDestroy ()

COREUOBJECT_API bool	ConditionalFinishDestroy ()

COREUOBJECT_API void	ConditionalPostLoad ()

COREUOBJECT_API void	ConditionalPreload ()

COREUOBJECT_API void	ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)

bool	IsBasedOnArchetype (const UObject *const SomeObject) const

COREUOBJECT_API UFunction *	FindFunction (FName InName) const

COREUOBJECT_API UFunction *	FindFunctionChecked (FName InName) const

virtual COREUOBJECT_API void	BuildSubobjectMapping (UObject OtherObject, TMap< UObject , UObject * > &ObjectMapping) const

COREUOBJECT_API void	CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const

COREUOBJECT_API bool	CheckDefaultSubobjects (bool bForceCheck=false) const

COREUOBJECT_API void	SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR Filename=nullptr, FConfigCacheIni Config=GConfig, bool bAllowCopyToDefaultObject=true)

COREUOBJECT_API void	SaveConfig (const FSaveConfigContext &Context)

COREUOBJECT_API void	UpdateDefaultConfigFile (const FString &SpecificFileLocation="")

COREUOBJECT_API bool	TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)

COREUOBJECT_API void	UpdateGlobalUserConfigFile ()

COREUOBJECT_API void	UpdateProjectUserConfigFile ()

COREUOBJECT_API void	UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)

COREUOBJECT_API FString	GetDefaultConfigFilename () const

COREUOBJECT_API FString	GetGlobalUserConfigFilename () const

COREUOBJECT_API FString	GetProjectUserConfigFilename () const

virtual const TCHAR *	GetConfigOverridePlatform () const

virtual void	OverrideConfigSection (FString &SectionName)

virtual void	OverridePerObjectConfigSection (FString &SectionName)

COREUOBJECT_API void	LoadConfig (UClass ConfigClass=nullptr, const TCHAR Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > OutAccessedKeys=nullptr)

COREUOBJECT_API void	ReloadConfig (UClass ConfigClass=NULL, const TCHAR Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)

COREUOBJECT_API void	ParseParms (const TCHAR *Parms)

COREUOBJECT_API void	OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)

COREUOBJECT_API void	RetrieveReferencers (TArray< FReferencerInformation > OutInternalReferencers, TArray< FReferencerInformation > OutExternalReferencers)

COREUOBJECT_API void	SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)

COREUOBJECT_API UObject *	GetArchetype () const

COREUOBJECT_API void	GetArchetypeInstances (TArray< UObject * > &Instances)

COREUOBJECT_API void	InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)

template<class T >
bool	Implements () const

virtual COREUOBJECT_API void	ProcessEvent (UFunction Function, void Parms)

virtual int32	GetFunctionCallspace (UFunction Function, FFrame Stack)

virtual bool	CallRemoteFunction (UFunction Function, void Parms, struct FOutParmRec OutParms, FFrame Stack)

COREUOBJECT_API bool	CallFunctionByNameWithArguments (const TCHAR Cmd, FOutputDevice &Ar, UObject Executor, bool bForceCallWithNonExec=false)

COREUOBJECT_API void	CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)

	DECLARE_FUNCTION (ProcessInternal)

virtual bool	ProcessConsoleExec (const TCHAR Cmd, FOutputDevice &Ar, UObject Executor)

COREUOBJECT_API void	SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)

virtual UClass *	RegenerateClass (UClass ClassToRegenerate, UObject PreviousCDO)

COREUOBJECT_API bool	IsInBlueprint () const

COREUOBJECT_API void	DestroyNonNativeProperties ()

virtual void	MarkAsEditorOnlySubobject ()

COREUOBJECT_API void	AbortInsideMemberFunction () const

	DECLARE_FUNCTION (execUndefined)

	DECLARE_FUNCTION (execLocalVariable)

	DECLARE_FUNCTION (execInstanceVariable)

	DECLARE_FUNCTION (execDefaultVariable)

	DECLARE_FUNCTION (execLocalOutVariable)

	DECLARE_FUNCTION (execInterfaceVariable)

	DECLARE_FUNCTION (execClassSparseDataVariable)

	DECLARE_FUNCTION (execInterfaceContext)

	DECLARE_FUNCTION (execArrayElement)

	DECLARE_FUNCTION (execBoolVariable)

	DECLARE_FUNCTION (execClassDefaultVariable)

	DECLARE_FUNCTION (execEndFunctionParms)

	DECLARE_FUNCTION (execNothing)

	DECLARE_FUNCTION (execNothingInt32)

	DECLARE_FUNCTION (execNothingOp4a)

	DECLARE_FUNCTION (execBreakpoint)

	DECLARE_FUNCTION (execTracepoint)

	DECLARE_FUNCTION (execWireTracepoint)

	DECLARE_FUNCTION (execInstrumentation)

	DECLARE_FUNCTION (execEndOfScript)

	DECLARE_FUNCTION (execReturnNothing)

	DECLARE_FUNCTION (execEmptyParmValue)

	DECLARE_FUNCTION (execJump)

	DECLARE_FUNCTION (execJumpIfNot)

	DECLARE_FUNCTION (execAssert)

	DECLARE_FUNCTION (execPushExecutionFlow)

	DECLARE_FUNCTION (execPopExecutionFlow)

	DECLARE_FUNCTION (execComputedJump)

	DECLARE_FUNCTION (execPopExecutionFlowIfNot)

	DECLARE_FUNCTION (execLet)

	DECLARE_FUNCTION (execLetObj)

	DECLARE_FUNCTION (execLetWeakObjPtr)

	DECLARE_FUNCTION (execLetBool)

	DECLARE_FUNCTION (execLetDelegate)

	DECLARE_FUNCTION (execLetMulticastDelegate)

	DECLARE_FUNCTION (execAddMulticastDelegate)

	DECLARE_FUNCTION (execClearMulticastDelegate)

	DECLARE_FUNCTION (execEatReturnValue)

	DECLARE_FUNCTION (execRemoveMulticastDelegate)

	DECLARE_FUNCTION (execSelf)

	DECLARE_FUNCTION (execContext)

	DECLARE_FUNCTION (execContext_FailSilent)

	DECLARE_FUNCTION (execStructMemberContext)

	DECLARE_FUNCTION (execVirtualFunction)

	DECLARE_FUNCTION (execFinalFunction)

	DECLARE_FUNCTION (execLocalVirtualFunction)

	DECLARE_FUNCTION (execLocalFinalFunction)

	DECLARE_FUNCTION (execStructCmpEq)

	DECLARE_FUNCTION (execStructCmpNe)

	DECLARE_FUNCTION (execStructMember)

	DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)

	DECLARE_FUNCTION (execNotEqual_DelegateDelegate)

	DECLARE_FUNCTION (execEqualEqual_DelegateFunction)

	DECLARE_FUNCTION (execNotEqual_DelegateFunction)

	DECLARE_FUNCTION (execIntConst)

	DECLARE_FUNCTION (execInt64Const)

	DECLARE_FUNCTION (execUInt64Const)

	DECLARE_FUNCTION (execSkipOffsetConst)

	DECLARE_FUNCTION (execFloatConst)

	DECLARE_FUNCTION (execDoubleConst)

	DECLARE_FUNCTION (execStringConst)

	DECLARE_FUNCTION (execUnicodeStringConst)

	DECLARE_FUNCTION (execTextConst)

	DECLARE_FUNCTION (execPropertyConst)

	DECLARE_FUNCTION (execObjectConst)

	DECLARE_FUNCTION (execSoftObjectConst)

	DECLARE_FUNCTION (execFieldPathConst)

	DECLARE_FUNCTION (execInstanceDelegate)

	DECLARE_FUNCTION (execNameConst)

	DECLARE_FUNCTION (execByteConst)

	DECLARE_FUNCTION (execIntZero)

	DECLARE_FUNCTION (execIntOne)

	DECLARE_FUNCTION (execTrue)

	DECLARE_FUNCTION (execFalse)

	DECLARE_FUNCTION (execNoObject)

	DECLARE_FUNCTION (execNullInterface)

	DECLARE_FUNCTION (execIntConstByte)

	DECLARE_FUNCTION (execRotationConst)

	DECLARE_FUNCTION (execVectorConst)

	DECLARE_FUNCTION (execVector3fConst)

	DECLARE_FUNCTION (execTransformConst)

	DECLARE_FUNCTION (execStructConst)

	DECLARE_FUNCTION (execSetArray)

	DECLARE_FUNCTION (execSetSet)

	DECLARE_FUNCTION (execSetMap)

	DECLARE_FUNCTION (execArrayConst)

	DECLARE_FUNCTION (execSetConst)

	DECLARE_FUNCTION (execMapConst)

	DECLARE_FUNCTION (execBitFieldConst)

	DECLARE_FUNCTION (execNew)

	DECLARE_FUNCTION (execClassContext)

	DECLARE_FUNCTION (execNativeParm)

	DECLARE_FUNCTION (execCast)

	DECLARE_FUNCTION (execDynamicCast)

	DECLARE_FUNCTION (execMetaCast)

	DECLARE_FUNCTION (execInterfaceCast)

	DECLARE_FUNCTION (execDoubleToFloatCast)

	DECLARE_FUNCTION (execFloatToDoubleCast)

	DECLARE_FUNCTION (execObjectToBool)

	DECLARE_FUNCTION (execInterfaceToBool)

	DECLARE_FUNCTION (execObjectToInterface)

	DECLARE_FUNCTION (execInterfaceToInterface)

	DECLARE_FUNCTION (execInterfaceToObject)

	DECLARE_FUNCTION (execGetDynArrayElement)

	DECLARE_FUNCTION (execSetDynArrayElement)

	DECLARE_FUNCTION (execGetDynArrayLength)

	DECLARE_FUNCTION (execSetDynArrayLength)

	DECLARE_FUNCTION (execDynArrayInsert)

	DECLARE_FUNCTION (execDynArrayRemove)

	DECLARE_FUNCTION (execDynArrayFind)

	DECLARE_FUNCTION (execDynArrayFindStruct)

	DECLARE_FUNCTION (execDynArrayAdd)

	DECLARE_FUNCTION (execDynArrayAddItem)

	DECLARE_FUNCTION (execDynArrayInsertItem)

	DECLARE_FUNCTION (execDynArrayRemoveItem)

	DECLARE_FUNCTION (execDynArraySort)

	DECLARE_FUNCTION (execBindDelegate)

	DECLARE_FUNCTION (execCallMulticastDelegate)

	DECLARE_FUNCTION (execLetValueOnPersistentFrame)

	DECLARE_FUNCTION (execCallMathFunction)

	DECLARE_FUNCTION (execSwitchValue)

	DECLARE_FUNCTION (execArrayGetByRef)

	DECLARE_FUNCTION (execAutoRtfmTransact)

	DECLARE_FUNCTION (execAutoRtfmStopTransact)

	DECLARE_FUNCTION (execAutoRtfmAbortIfNot)

void	ExecuteUbergraph (int32 EntryPoint)

virtual void	ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const

virtual uint64	GetNetPushIdDynamic () const

Public Member Functions inherited from UObjectBaseUtility
	UObjectBaseUtility ()

	UObjectBaseUtility (EObjectFlags InFlags)

void	SetFlags (EObjectFlags NewFlags)

void	ClearFlags (EObjectFlags FlagsToClear)

bool	HasAnyFlags (EObjectFlags FlagsToCheck) const

bool	HasAllFlags (EObjectFlags FlagsToCheck) const

UE_FORCEINLINE_HINT EObjectFlags	GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const

UE_FORCEINLINE_HINT void	Mark (EObjectMark Marks) const

UE_FORCEINLINE_HINT void	UnMark (EObjectMark Marks) const

UE_FORCEINLINE_HINT bool	HasAnyMarks (EObjectMark Marks) const

UE_FORCEINLINE_HINT bool	HasAllMarks (EObjectMark Marks) const

UE_FORCEINLINE_HINT EObjectMark	GetAllMarks () const

void	MarkAsGarbage ()

void	ClearGarbage ()

UE_FORCEINLINE_HINT void	AddToRoot ()

UE_FORCEINLINE_HINT void	RemoveFromRoot ()

UE_FORCEINLINE_HINT bool	IsRooted () const

UE_FORCEINLINE_HINT int32	GetRefCount () const

bool	ThisThreadAtomicallyClearedRFUnreachable ()

UE_FORCEINLINE_HINT bool	IsUnreachable () const

UE_FORCEINLINE_HINT bool	IsNative () const

void	SetInternalFlags (EInternalObjectFlags FlagsToSet) const

UE_FORCEINLINE_HINT EInternalObjectFlags	GetInternalFlags () const

UE_FORCEINLINE_HINT bool	HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const

void	ClearInternalFlags (EInternalObjectFlags FlagsToClear) const

bool	AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const

COREUOBJECT_API FString	GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const

COREUOBJECT_API void	GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const

COREUOBJECT_API void	GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const

COREUOBJECT_API FString	GetPathName (const UObject *StopOuter=NULL) const

COREUOBJECT_API void	GetPathName (const UObject *StopOuter, FString &ResultString) const

COREUOBJECT_API void	GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const

virtual bool	CanBeClusterRoot () const

virtual COREUOBJECT_API void	CreateCluster ()

virtual void	OnClusterMarkedAsPendingKill ()

COREUOBJECT_API void	AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)

COREUOBJECT_API FString	GetFullGroupName (bool bStartWithOuter) const

UE_FORCEINLINE_HINT FString	GetName () const

UE_FORCEINLINE_HINT void	GetName (FString &ResultString) const

UE_FORCEINLINE_HINT void	AppendName (FString &ResultString) const

COREUOBJECT_API bool	IsPackageExternal () const

COREUOBJECT_API void	DetachExternalPackage ()

COREUOBJECT_API void	ReattachExternalPackage ()

COREUOBJECT_API UObject *	GetOutermostObject () const

COREUOBJECT_API UPackage *	GetPackage () const

UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath	GetVersePath () const

COREUOBJECT_API UPackage *	GetOutermost () const

COREUOBJECT_API bool	MarkPackageDirty () const

COREUOBJECT_API bool	IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject\|RF_ClassDefaultObject) const

COREUOBJECT_API UObject *	GetTypedOuter (UClass *Target) const

template<typename T >
T *	GetTypedOuter () const

template<typename InterfaceClassType >
InterfaceClassType *	GetImplementingOuter () const

COREUOBJECT_API UObjectBaseUtility *	GetImplementingOuterObject (const UClass *InInterfaceClass) const

COREUOBJECT_API bool	IsIn (const UObject *SomeOuter) const

COREUOBJECT_API bool	IsIn (const UPackage *SomePackage) const

COREUOBJECT_API bool	IsInOuter (const UObject *SomeOuter) const

COREUOBJECT_API bool	IsInPackage (const UPackage *SomePackage) const

COREUOBJECT_API bool	IsInA (const UClass *SomeBaseClass) const

COREUOBJECT_API bool	RootPackageHasAnyFlags (uint32 CheckFlagMask) const

template<typename OtherClassType >
bool	IsA (OtherClassType SomeBase) const

template<class T >
bool	IsA () const

COREUOBJECT_API const UClass *	FindNearestCommonBaseClass (const UClass *TestClass) const

COREUOBJECT_API void *	GetInterfaceAddress (UClass *InterfaceClass)

COREUOBJECT_API void *	GetNativeInterfaceAddress (UClass *InterfaceClass)

const void *	GetNativeInterfaceAddress (UClass *InterfaceClass) const

COREUOBJECT_API bool	IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject\|RF_DefaultSubObject\|RF_InheritableComponentTemplate) const

COREUOBJECT_API bool	IsDefaultSubobject () const

COREUOBJECT_API class FLinkerLoad *	GetLinker () const

COREUOBJECT_API int32	GetLinkerIndex () const

COREUOBJECT_API FPackageFileVersion	GetLinkerUEVersion () const

int32	GetLinkerUE4Version () const

COREUOBJECT_API int32	GetLinkerLicenseeUEVersion () const

int32	GetLinkerLicenseeUE4Version () const

COREUOBJECT_API int32	GetLinkerCustomVersion (FGuid CustomVersionKey) const

UE_FORCEINLINE_HINT bool	operator< (const UObjectBaseUtility &Other) const

TStatId	GetStatID (bool bForDeferredUse=false) const

Public Member Functions inherited from UObjectBase
COREUOBJECT_API	UObjectBase (UClass InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())

virtual COREUOBJECT_API	~UObjectBase ()

COREUOBJECT_API bool	IsValidLowLevel () const

COREUOBJECT_API bool	IsValidLowLevelFast (bool bRecursive=true) const

FORCEINLINE uint32	GetUniqueID () const

FORCEINLINE UClass *	GetClass () const

FORCEINLINE UObject *	GetOuter () const

FORCEINLINE FName	GetFName () const

virtual COREUOBJECT_API FName	GetFNameForStatID () const

COREUOBJECT_API UPackage *	GetExternalPackage () const

COREUOBJECT_API void	SetExternalPackage (UPackage *InPackage)

COREUOBJECT_API UPackage *	GetExternalPackageInternal () const

COREUOBJECT_API void	MarkAsReachable () const

COREUOBJECT_API void	AddRef () const

COREUOBJECT_API void	ReleaseRef () const

FORCEINLINE EObjectFlags	GetFlags () const

FORCENOINLINE void	AtomicallySetFlags (EObjectFlags FlagsToAdd)

FORCENOINLINE void	AtomicallyClearFlags (EObjectFlags FlagsToClear)

Protected Attributes
uint32	Loop:1

TObjectPtr< UMediaPlaylist >	Playlist

int32	PlaylistIndex

FTimespan	TimeDelay

float	HorizontalFieldOfView

float	VerticalFieldOfView

FRotator	ViewRotation

Additional Inherited Members
Public Types inherited from UObject
enum class	ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }

typedef UObject	WithinClass

Static Public Member Functions inherited from UObject
static COREUOBJECT_API void	UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)

static COREUOBJECT_API void	UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)

static COREUOBJECT_API bool	CanCreateInCurrentContext (UObject *Template)

static COREUOBJECT_API void	AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)

static COREUOBJECT_API const FName &	SourceFileTagName ()

static COREUOBJECT_API UObject *	GetArchetypeFromRequiredInfo (const UClass Class, const UObject Outer, FName Name, EObjectFlags ObjectFlags)

Static Public Member Functions inherited from UObjectBaseUtility
static bool	IsGarbageEliminationEnabled ()

static bool	IsPendingKillEnabled ()

static void	SetGarbageEliminationEnabled (bool bEnabled)

static COREUOBJECT_API void	ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)

Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString	RemoveClassPrefix (const TCHAR *ClassName)

static void	PrefetchClass (UObject *Object)

static void	PrefetchOuter (UObject *Object)

Protected Member Functions inherited from UObject
virtual FString	GetDetailedInfoInternal () const

COREUOBJECT_API bool	CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const

virtual COREUOBJECT_API bool	CheckDefaultSubobjectsInternal () const

Protected Member Functions inherited from UObjectBase
	UObjectBase ()

COREUOBJECT_API	UObjectBase (EObjectFlags InFlags)

COREUOBJECT_API void	LowLevelRename (FName NewName, UObject *NewOuter=NULL)

virtual void	RegisterDependencies ()

COREUOBJECT_API void	Register (class UClass (StaticClassFn)(), const TCHAR PackageName, const TCHAR Name)

COREUOBJECT_API void	Register (const TCHAR PackageName, const TCHAR Name)

virtual COREUOBJECT_API void	DeferredRegister (UClass UClassStaticClass, const TCHAR PackageName, const TCHAR *Name)

FORCEINLINE void	SetFlagsTo (EObjectFlags NewFlags)

Detailed Description

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

Member Function Documentation

◆ BeginDestroy()

void UMediaPlayer::BeginDestroy ( )

overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UObject.

◆ CanPause()

bool UMediaPlayer::CanPause ( ) const

Check whether media playback can be paused right now.

Playback can be paused if the media supports pausing and if it is currently playing.

Returns: true if pausing playback can be paused, false otherwise.

See also: CanPlay, Pause

◆ CanPlaySource()

bool UMediaPlayer::CanPlaySource ( UMediaSource * MediaSource )

Check whether the specified media source can be played by this player.

If a desired player name is set for this player, it will only check whether that particular player type can play the specified source.

Parameters

MediaSource The media source to check.

Returns: true if the media source can be opened, false otherwise.

See also: CanPlayUrl, SetDesiredPlayerName

◆ CanPlayUrl()

bool UMediaPlayer::CanPlayUrl ( const FString & Url )

Check whether the specified URL can be played by this player.

If a desired player name is set for this player, it will only check whether that particular player type can play the specified URL.

Parameters

Url	The URL to check.

See also: CanPlaySource, SetDesiredPlayerName

◆ CleanUpBeforeDestroy()

void UMediaPlayer::CleanUpBeforeDestroy ( )

Clean up before this object is destroyed. Normally you would not need to call this, but if you want to clean up resources before garbage collection (e.g. you are in the editor) then this could be helpful.

◆ Close()

void UMediaPlayer::Close ( )

Close the currently open media, if any.

See also: OnMediaClosed, OpenPlaylist, OpenPlaylistIndex, OpenSource, OpenUrl, Pause, Play

◆ CreateProxyData()

TSharedPtr< Audio::IProxyData > UMediaPlayer::CreateProxyData ( const Audio::FProxyDataInitParams & InitParams )

overridevirtual

Reimplemented from IAudioProxyDataFactory.

◆ DECLARE_EVENT_OneParam()

UMediaPlayer::DECLARE_EVENT_OneParam	(	UMediaPlayer	,
		FOnMediaEvent	,
		EMediaEvent
	)		&

inline

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

Returns: The delegate.

◆ GetAudioTrackChannels()

int32 UMediaPlayer::GetAudioTrackChannels	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the number of channels in the specified audio track.

Parameters

TrackIndex	Index of the audio track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Number of channels.

See also: GetAudioTrackSampleRate, GetAudioTrackType

◆ GetAudioTrackSampleRate()

int32 UMediaPlayer::GetAudioTrackSampleRate	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the sample rate of the specified audio track.

Parameters

TrackIndex	Index of the audio track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Samples per second.

See also: GetAudioTrackChannels, GetAudioTrackType

◆ GetAudioTrackType()

FString UMediaPlayer::GetAudioTrackType	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the type of the specified audio track format.

Parameters

TrackIndex	The index of the track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Audio format type string.

See also: GetAudioTrackSampleRate, GetAudioTrackSampleRate

◆ GetDesc()

FString UMediaPlayer::GetDesc ( void )

overridevirtual

Return a one line description of an object for viewing in the thumbnail view of the generic browser

Reimplemented from UObject.

◆ GetDesiredPlayerName()

FName UMediaPlayer::GetDesiredPlayerName ( ) const

Get the name of the current desired native player.

Returns: The name of the desired player, or NAME_None if not set.

See also: SetDesiredPlayerName

◆ GetDisplayTime()

FTimespan UMediaPlayer::GetDisplayTime ( ) const

Get the media's current playback time as appropriate for display.

Returns: Playback time.

See also: GetDuration, Seek

◆ GetDisplayTimeStamp()

UMediaTimeStampInfo * UMediaPlayer::GetDisplayTimeStamp ( ) const

Get the media's current playback timestamp as appropriate for display.

Returns: Playback timestamp.

See also: GetDuration, Seek

◆ GetDuration()

FTimespan UMediaPlayer::GetDuration ( ) const

Get the media's duration.

Returns: A time span representing the duration.

See also: GetTime, Seek

◆ GetGuid()

const FGuid & UMediaPlayer::GetGuid ( )

inline

Get the Guid associated with this media player

Returns: The Guid.

◆ GetHorizontalFieldOfView()

float UMediaPlayer::GetHorizontalFieldOfView ( ) const

Get the current horizontal field of view (only for 360 videos).

Returns: Horizontal field of view (in Euler degrees).

See also: GetVerticalFieldOfView, GetViewRotation, SetHorizontalFieldOfView

◆ GetMediaInfo() [1/2]

FVariant UMediaPlayer::GetMediaInfo ( FName InfoName ) const

Get information about the media that is playing. Not all formats support all information. Some possible common information is in this file, look for MediaInfoNameSourceNumMips for example.

Parameters

InfoName Name of the information we want.

Returns: Requested information, or empty if not available.

◆ GetMediaInfo() [2/2]

template<typename T >

bool UMediaPlayer::GetMediaInfo	(	T &	Result,
		FName	InfoName
	)		const

inline

Templated version of GetMediaInfo. No need to deal with variants.

Parameters

T	Type of the information.
Result	If the information is found and is the correct type, then this will be set to its value. It will not be set otherwise.
InfoName	Name of the information.

Returns: True if the information is found, false if not.

◆ GetMediaMetadata()

TSharedPtr< TMap< FString, TArray< TUniquePtr< IMediaMetadataItem > > >, ESPMode::ThreadSafe > UMediaPlayer::GetMediaMetadata ( ) const

Get meta data contained in the current stream

Returns: Map with arrays of IMediaMetaDataItem entries describing any metadata found in the current stream

Note: Listen to EMediaEvent::MetadataChanged to catch updates to this data

◆ GetMediaMetadataItems()

TMap< FString, FMediaMetadataItemsBPT > UMediaPlayer::GetMediaMetadataItems ( ) const

This is the blueprint accessible version of the GetMediaMetadata.

Returns: Map with arrays of FMediaMetaDataItem entries describing any metadata found in the current stream

Note: Listen to EMediaEvent::MetadataChanged to catch updates to this data

◆ GetMediaName()

FText UMediaPlayer::GetMediaName ( ) const

virtual

Get the human readable name of the currently loaded media source.

Returns: Media source name, or empty text if no media is opened

See also: GetPlayerName, GetUrl

◆ GetNumTrackFormats()

int32 UMediaPlayer::GetNumTrackFormats	(	EMediaPlayerTrack	TrackType,
		int32	TrackIndex
	)		const

Get the number of formats of the specified track.

Parameters

TrackType	The type of media tracks.
TrackIndex	The index of the track.

Returns: Number of formats.

See also: GetNumTracks, GetSelectedTrack, SelectTrack

◆ GetNumTracks()

int32 UMediaPlayer::GetNumTracks ( EMediaPlayerTrack TrackType ) const

Get the number of tracks of the given type.

Parameters

TrackType The type of media tracks.

Returns: Number of tracks.

See also: GetNumTrackFormats, GetSelectedTrack, SelectTrack

◆ GetPlaybackTimeRange() [1/2]

FFloatInterval UMediaPlayer::GetPlaybackTimeRange ( EMediaTimeRangeBPType InRangeToGet )

Blueprint accessible version of GetPlaybackTimeRange. This returns the range truncated into a blueprint usable float interval and should not be used for live streams as 32 bit floats can not store wallclock times with enough precision.

◆ GetPlaybackTimeRange() [2/2]

TRange< FTimespan > UMediaPlayer::GetPlaybackTimeRange ( EMediaTimeRangeType InRangeToGet )

Returns the current playback range of the media. If playing back a range is not supported, the range returned will be equal to [ 0, GetDuration() ). The media may have an implicit default range provided by the container format or other means without having called SetPlaybackTimeRange(). The media may have internal time values not starting at 0, which are conveyed by the range. Since the range may be only a portion of the media, the duration of the returned range may be less than the media overall duration returned by GetDuration(). For live video streams the range may change dynamically as new content becomes available and old content falls off the timeline.

Parameters

InRangeToGet The type of range to get. Absolute returns the media's smallest and largest timeline values. Unless continuously changing in a Live stream this is usually the same as [ 0, GetDuration() ]. The base time does not have to be zero though. Current returns the currently set range, which is a subset of the absolute range.

Returns: The playback range as queried for.

See also: SupportsPlaybackTimeRange, SetPlaybackTimeRange, GetDuration

◆ GetPlayerFacade()

TSharedRef< FMediaPlayerFacade, ESPMode::ThreadSafe > UMediaPlayer::GetPlayerFacade ( ) const

Get the media player facade that manages low-level media players

Returns: The media player facade.

◆ GetPlayerName()

FName UMediaPlayer::GetPlayerName ( ) const

Get the name of the current native media player.

Returns: Player name, or NAME_None if not available.

See also: GetMediaName

◆ GetPlaylist()

UMediaPlaylist * UMediaPlayer::GetPlaylist ( ) const

inline

Get the current play list.

Media players always have a valid play list. In C++ code you can use the GetPlaylistRef to get a reference instead of a pointer to it.

Returns: The play list.

See also: GetPlaylistIndex, GetPlaylistRef

◆ GetPlaylistIndex()

int32 UMediaPlayer::GetPlaylistIndex ( ) const

inline

Get the current play list index.

Returns: Play list index.

See also: GetPlaylist

◆ GetPlaylistRef()

UMediaPlaylist & UMediaPlayer::GetPlaylistRef ( ) const

inline

Get the current play list.

Returns: The play list.

See also: GetPlaylistIndex, GetPlaylist

◆ GetRate()

float UMediaPlayer::GetRate ( ) const

Get the media's current playback rate.

Returns: The playback rate.

See also: SetRate, SupportsRate

◆ GetSelectedTrack()

int32 UMediaPlayer::GetSelectedTrack ( EMediaPlayerTrack TrackType ) const

Get the index of the currently selected track of the given type.

Parameters

TrackType The type of track to get.

Returns: The index of the selected track, or INDEX_NONE if no track is active.

See also: GetNumTracks, GetTrackFormat, SelectTrack

◆ GetSupportedRates()

void UMediaPlayer::GetSupportedRates	(	TArray< FFloatRange > &	OutRates,
		bool	Unthinned
	)		const

Get the supported playback rates.

Parameters

Unthinned	Whether the rates are for unthinned playback.
OutRates	Will contain the the ranges of supported rates.

See also: SetRate, SupportsRate

◆ GetTime()

FTimespan UMediaPlayer::GetTime ( ) const

Get the media's current playback time.

Returns: Playback time.

See also: GetDuration, Seek

◆ GetTimeDelay()

FTimespan UMediaPlayer::GetTimeDelay ( ) const

Delay of the player's time.

Returns: Delay added to the player's time used to manually sync multiple sources.

See also: SetTimeDelay

◆ GetTimeStamp()

UMediaTimeStampInfo * UMediaPlayer::GetTimeStamp ( ) const

Get the media's current playback timestamp.

Returns: Playback timestamp.

See also: GetDuration, Seek

◆ GetTrackDisplayName()

FText UMediaPlayer::GetTrackDisplayName	(	EMediaPlayerTrack	TrackType,
		int32	TrackIndex
	)		const

Get the human readable name of the specified track.

Parameters

TrackType	The type of track.
TrackIndex	The index of the track, or INDEX_NONE for the selected one.

Returns: Display name.

See also: GetNumTracks, GetTrackLanguage

◆ GetTrackFormat()

int32 UMediaPlayer::GetTrackFormat	(	EMediaPlayerTrack	TrackType,
		int32	TrackIndex
	)		const

Get the index of the active format of the specified track type.

Parameters

TrackType	The type of track.
TrackIndex	The index of the track, or INDEX_NONE for the selected one.

Returns: The index of the selected format.

See also: GetNumTrackFormats, GetSelectedTrack, SetTrackFormat

◆ GetTrackLanguage()

FString UMediaPlayer::GetTrackLanguage	(	EMediaPlayerTrack	TrackType,
		int32	TrackIndex
	)		const

Get the language tag of the specified track.

Parameters

TrackType	The type of track.
TrackIndex	The index of the track, or INDEX_NONE for the selected one.

Returns: Language tag, i.e. "en-US" for English, or "und" for undefined.

See also: GetNumTracks, GetTrackDisplayName

◆ GetUrl()

const FString & UMediaPlayer::GetUrl ( ) const

Get the URL of the currently loaded media, if any.

Returns: Media URL, or empty string if no media was loaded.

See also: OpenUrl

◆ GetVerticalFieldOfView()

float UMediaPlayer::GetVerticalFieldOfView ( ) const

Get the current vertical field of view (only for 360 videos).

Returns: Vertical field of view (in Euler degrees), or 0.0 if not available.

See also: GetHorizontalFieldOfView, GetViewRotation, SetVerticalFieldOfView

◆ GetVideoTimecode()

TOptional< FTimecode > UMediaPlayer::GetVideoTimecode ( ) const

Get the timecode from the video track, if one is available. If available, the returned value will be the timecode of the sample most recently sent into the video sink.

Returns: Most recently delivered video timecode from the video track.

Note: Even if timecode is available, the value returned reflects the timecode that most recently delivered to the video sink. During a seek operation the timecode will be unset.

◆ GetVideoTrackAspectRatio()

float UMediaPlayer::GetVideoTrackAspectRatio	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the aspect ratio of the specified video track.

Parameters

TrackIndex	Index of the video track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Aspect ratio.

See also: GetVideoTrackDimensions, GetVideoTrackFrameRate, GetVideoTrackFrameRates, GetVideoTrackType

◆ GetVideoTrackDimensions()

FIntPoint UMediaPlayer::GetVideoTrackDimensions	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the current dimensions of the specified video track.

Parameters

TrackIndex	The index of the track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Video dimensions (in pixels).

See also: GetVideoTrackAspectRatio, GetVideoTrackFrameRate, GetVideoTrackFrameRates, GetVideoTrackType

◆ GetVideoTrackFrameRate()

float UMediaPlayer::GetVideoTrackFrameRate	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the frame rate of the specified video track.

Parameters

TrackIndex	The index of the track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Frame rate (in frames per second).

See also: GetVideoTrackAspectRatio, GetVideoTrackDimensions, GetVideoTrackFrameRates, GetVideoTrackType, SetVideoTrackFrameRate

◆ GetVideoTrackFrameRates()

FFloatRange UMediaPlayer::GetVideoTrackFrameRates	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the supported range of frame rates of the specified video track.

Parameters

TrackIndex	The index of the track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Frame rate range (in frames per second).

See also: GetVideoTrackAspectRatio, GetVideoTrackDimensions, GetVideoTrackFrameRate, GetVideoTrackType

◆ GetVideoTrackType()

FString UMediaPlayer::GetVideoTrackType	(	int32	TrackIndex,
		int32	FormatIndex
	)		const

Get the type of the specified video track format.

Parameters

TrackIndex	The index of the track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.

Returns: Video format type string.

See also: GetVideoTrackAspectRatio, GetVideoTrackDimensions, GetVideoTrackFrameRate, GetVideoTrackFrameRates

◆ GetViewRotation()

FRotator UMediaPlayer::GetViewRotation ( ) const

Get the current view rotation (only for 360 videos).

Returns: View rotation, or zero rotator if not available.

See also: GetHorizontalFieldOfView, GetVerticalFieldOfView, SetViewRotation

◆ HasError()

bool UMediaPlayer::HasError ( ) const

Check whether the player is in an error state.

When the player is in an error state, no further operations are possible. The current media must be closed, and a new media source must be opened before the player can be used again. Errors are usually caused by faulty media files or interrupted network connections.

See also: IsReady

◆ IsBuffering()

bool UMediaPlayer::IsBuffering ( ) const

Check whether playback is buffering data.

Returns: true if looping, false otherwise.

See also: IsConnecting, IsLooping, IsPaused, IsPlaying, IsPreparing, IsReady

◆ IsClosed()

bool UMediaPlayer::IsClosed ( ) const

Whether media is currently closed.

Returns: true if media is closed, false otherwise.

◆ IsConnecting()

bool UMediaPlayer::IsConnecting ( ) const

Check whether the player is currently connecting to a media source.

Returns: true if connecting, false otherwise.

See also: IsBuffering, IsLooping, IsPaused, IsPlaying, IsPreparing, IsReady

◆ IsLooping()

bool UMediaPlayer::IsLooping ( ) const

Check whether playback is looping.

Returns: true if looping, false otherwise.

See also: IsBuffering, IsConnecting, IsPaused, IsPlaying, IsPreparing, IsReady, SetLooping

◆ IsPaused()

bool UMediaPlayer::IsPaused ( ) const

Check whether playback is currently paused.

Returns: true if playback is paused, false otherwise.

See also: CanPause, IsBuffering, IsConnecting, IsLooping, IsPaused, IsPlaying, IsPreparing, IsReady, Pause

◆ IsPlaying()

bool UMediaPlayer::IsPlaying ( ) const

Check whether playback has started.

Returns: true if playback has started, false otherwise.

See also: CanPlay, IsBuffering, IsConnecting, IsLooping, IsPaused, IsPlaying, IsPreparing, IsReady, Play

◆ IsPreparing()

bool UMediaPlayer::IsPreparing ( ) const

Check whether the media is currently opening or buffering.

Returns: true if playback is being prepared, false otherwise.

See also: CanPlay, IsBuffering, IsConnecting, IsLooping, IsPaused, IsPlaying, IsReady, Play

◆ IsReady()

bool UMediaPlayer::IsReady ( ) const

Check whether media is ready for playback.

A player is ready for playback if it has a media source opened that finished preparing and is not in an error state.

Returns: true if media is ready, false otherwise.

See also: HasError, IsBuffering, IsConnecting, IsLooping, IsPaused, IsPlaying, IsPreparing

◆ Next()

bool UMediaPlayer::Next ( )

Open the next item in the current play list.

The player will start playing the new media source if it was playing something previously, otherwise it will only open the media source.

Returns: true on success, false otherwise.

See also: Close, OpenUrl, OpenSource, Play, Previous, SetPlaylist

◆ OpenFile()

bool UMediaPlayer::OpenFile ( const FString & FilePath )

Opens the specified media file path.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Parameters

FilePath The file path to open.

Returns: true if the file path will be opened, false otherwise.

See also: GetUrl, Close, OpenPlaylist, OpenPlaylistIndex, OpenSource, OpenUrl, Reopen

◆ OpenPlaylist()

bool UMediaPlayer::OpenPlaylist ( UMediaPlaylist * InPlaylist )

inline

Open the first media source in the specified play list.

Parameters

InPlaylist The play list to open.

Returns: true if the source will be opened, false otherwise.

See also: Close, OpenFile, OpenPlaylistIndex, OpenSource, OpenUrl, Reopen

◆ OpenPlaylistIndex()

bool UMediaPlayer::OpenPlaylistIndex	(	UMediaPlaylist *	InPlaylist,
		int32	Index
	)

Open a particular media source in the specified play list.

Parameters

InPlaylist	The play list to open.
Index	The index of the source to open.

Returns: true if the source will be opened, false otherwise.

See also: Close, OpenFile, OpenPlaylist, OpenSource, OpenUrl, Reopen

◆ OpenSource()

bool UMediaPlayer::OpenSource ( UMediaSource * MediaSource )

Open the specified media source.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Parameters

MediaSource The media source to open.

Returns: true if the source will be opened, false otherwise.

See also: Close, OpenFile, OpenPlaylist, OpenPlaylistIndex, OpenUrl, Reopen

◆ OpenSourceLatent()

void UMediaPlayer::OpenSourceLatent	(	const UObject *	WorldContextObject,
		struct FLatentActionInfo	LatentInfo,
		UMediaSource *	MediaSource,
		const FMediaPlayerOptions &	Options,
		bool &	bSuccess
	)

Open the specified media source with options using a latent action.

A result of true indicates that the player successfully completed all requested operations.

Parameters

MediaSource	The media source to open.
Options	The media player options to apply.
bSuccess	All requested operations have completed successfully.

See also: Close, OpenFile, OpenPlaylist, OpenPlaylistIndex, OpenUrl, Reopen

◆ OpenSourceWithOptions()

bool UMediaPlayer::OpenSourceWithOptions	(	UMediaSource *	MediaSource,
		const FMediaPlayerOptions &	Options
	)

Open the specified media source with supplied options applied.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Parameters

MediaSource	The media source to open.
Options	The media player options to apply.

Returns: true if the source will be opened, false otherwise.

See also: Close, OpenFile, OpenPlaylist, OpenPlaylistIndex, OpenUrl, Reopen

◆ OpenUrl()

bool UMediaPlayer::OpenUrl ( const FString & Url )

Opens the specified media URL.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Parameters

Url	The URL to open.

Returns: true if the URL will be opened, false otherwise.

See also: GetUrl, Close, OpenFile, OpenPlaylist, OpenPlaylistIndex, OpenSource, Reopen

◆ Pause()

bool UMediaPlayer::Pause ( )

Pauses media playback.

This is the same as setting the playback rate to 0.0.

Returns: true if playback is being paused, false otherwise.

See also: CanPause, Close, Next, Play, Previous, Rewind, Seek

◆ Play()

bool UMediaPlayer::Play ( )

Starts media playback.

This is the same as setting the playback rate to 1.0.

Returns: true if playback is starting, false otherwise.

See also: CanPlay, GetRate, Next, Pause, Previous, SetRate

◆ PlayAndSeek()

void UMediaPlayer::PlayAndSeek ( )

Starts playback from the media opened event, but can be used elsewhere.

◆ PostDuplicate()

void UMediaPlayer::PostDuplicate ( bool bDuplicateForPIE )

overridevirtual

Called after duplication & serialization and before PostLoad. Used to e.g. make sure UStaticMesh's UModel gets copied as well. Note: NOT called on components on actor duplication (alt-drag or copy-paste). Use PostEditImport as well to cover that case.

Reimplemented from UObject.

◆ PostInitProperties()

void UMediaPlayer::PostInitProperties ( )

overridevirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UObject.

◆ PostLoad()

void UMediaPlayer::PostLoad ( )

overridevirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from UObject.

◆ Previous()

bool UMediaPlayer::Previous ( )

Open the previous item in the current play list.

The player will start playing the new media source if it was playing something previously, otherwise it will only open the media source.

Returns: true on success, false otherwise.

See also: Close, Next, OpenUrl, OpenSource, Play, SetPlaylist

◆ RegisterWithMediaModule()

void UMediaPlayer::RegisterWithMediaModule ( )

Register player with media module to be ticked

◆ Reopen()

bool UMediaPlayer::Reopen ( )

Reopens the currently opened media or play list.

Returns: true if the media will be opened, false otherwise.

See also: Close, Open, OpenFile, OpenPlaylist, OpenPlaylistIndex, OpenSource, OpenUrl

◆ Rewind()

bool UMediaPlayer::Rewind ( )

Rewinds the media to the beginning.

This is the same as seeking to zero time.

Returns: true if rewinding, false otherwise.

See also: GetTime, Seek

◆ Scrub()

bool UMediaPlayer::Scrub ( const FTimespan & Time )

Seeks to the specified playback time as soon as possible.

If the player is currently seeking, the new seek request will be queued and executed as soon as the current one is completed. It will guarantee that at least one sample of the previous seek makes it to the sample queue. if new seek requests are performed in rapid succession (as in scrubbing), the requests are aggregated and only the most recent request will be performed. As a result, OnSeekCompleted event is only sent for the request that got performed.

If the player is not currently seeking, Seek will be called immediately.

Parameters

Time	The playback time to set.

Returns: true on success, false otherwise.

See also: Seek

◆ Seek()

bool UMediaPlayer::Seek ( const FTimespan & Time )

Seeks to the specified playback time.

Parameters

Time	The playback time to set.

Returns: true on success, false otherwise.

See also: GetTime, Rewind

◆ SelectTrack()

bool UMediaPlayer::SelectTrack	(	EMediaPlayerTrack	TrackType,
		int32	TrackIndex
	)

Select the active track of the given type.

The selected track will use its currently active format. Active formats will be remembered on a per track basis. The first available format is active by default. To switch the track format, use SetTrackFormat instead.

Parameters

TrackType	The type of track to select.
TrackIndex	The index of the track to select, or INDEX_NONE to deselect.

Returns: true if the track was selected, false otherwise.

See also: GetNumTracks, GetSelectedTrack, SetTrackFormat

◆ SetBlockOnTime()

void UMediaPlayer::SetBlockOnTime ( const FTimespan & Time )

Set the time on which to block.

If set, this player will block in TickInput or TickFetch until the video sample for the specified time are actually available.

Parameters

Time	The time to block on, or FTimespan::MinValue to disable.

◆ SetBlockOnTimeRange()

void UMediaPlayer::SetBlockOnTimeRange ( const TRange< FTimespan > & TimeRange )

Set the time range on which to block.

If set, this player will block in TickInput or TickFetch until the video sample for the specified time are actually available.

Parameters

TimeRange The time range to block on, or empty range to disable.

◆ SetDesiredPlayerName()

void UMediaPlayer::SetDesiredPlayerName ( FName PlayerName )

Set the name of the desired native player.

Parameters

PlayerName The name of the player to set.

See also: GetDesiredPlayerName

◆ SetLooping()

bool UMediaPlayer::SetLooping ( bool Looping )

Enables or disables playback looping.

Parameters

Looping Whether playback should be looped.

Returns: true on success, false otherwise.

See also: IsLooping

◆ SetMediaOptions()

void UMediaPlayer::SetMediaOptions ( const UMediaSource * Options )

Sets the media options used by the player.

Parameters

Options Options to pass to the player.

◆ SetNativeVolume()

bool UMediaPlayer::SetNativeVolume ( float Volume )

Set the volume on the native player if not mixing with Sound Wave asset.

The SetNativeVolume can be used to change the audio output volume at runtime. Note that not all media player plug-ins may support native audio output on all platforms.

Parameters

Volume The volume to set.

Returns: true on success, false otherwise.

See also: NativeAudioOut

◆ SetPlaybackTimeRange() [1/2]

bool UMediaPlayer::SetPlaybackTimeRange ( const TRange< FTimespan > & InTimeRange )

Sets a new media playback range. Has an effect only if SupportsPlaybackTimeRange() returns true and the media supports it. A live stream cannot be constrained to a range. The range will be clamped if necessary to be within the media's absolute time range. Changing the time range may trigger an implicit Seek() depending on where the current playback position is located with regard to the new range. Unless prevented by the media a playback range can be cleared by passing an empty range.

Parameters

InTimeRange The new playback range to set.

Returns: true if successful, false otherwise.

See also: SupportsPlaybackTimeRange, GetPlaybackTimeRange

◆ SetPlaybackTimeRange() [2/2]

bool UMediaPlayer::SetPlaybackTimeRange ( FFloatInterval InTimeRange )

Blueprint accessible version of SetPlaybackTimeRange(). The range is set through a blueprint usable float interval which may not have enough precision to represent the range accurately.

◆ SetRate()

bool UMediaPlayer::SetRate ( float Rate )

Changes the media's playback rate.

Parameters

Rate	The playback rate to set.

Returns: true on success, false otherwise.

See also: GetRate, SupportsRate

◆ SetTimeDelay()

void UMediaPlayer::SetTimeDelay ( FTimespan TimeDelay )

Delay of the player's time.

This setting can be used to manually sync multiple sources. Set to 1 seconds, if you would like that Player to play 1 second behind its current time. If the value is too big, it is possible that the player would not hold that frame for that long.

Returns: true on success, false otherwise.

See also: GetTimeDelay

◆ SetTrackFormat()

bool UMediaPlayer::SetTrackFormat	(	EMediaPlayerTrack	TrackType,
		int32	TrackIndex,
		int32	FormatIndex
	)

Set the format on the specified track.

Selecting the format will not switch to the specified track. To switch tracks, use SelectTrack instead. If the track is already selected, the format change will be applied immediately.

Parameters

TrackType	The type of track to update.
TrackIndex	The index of the track to update.
FormatIndex	The index of the format to select (must be valid).

Returns: true if the track was selected, false otherwise.

See also: GetNumTrackFormats, GetNumTracks, GetTrackFormat, SelectTrack

◆ SetVideoTrackFrameRate()

bool UMediaPlayer::SetVideoTrackFrameRate	(	int32	TrackIndex,
		int32	FormatIndex,
		float	FrameRate
	)

Set the frame rate of the specified video track.

Parameters

TrackIndex	The index of the track, or INDEX_NONE for the selected one.
FormatIndex	Index of the track format, or INDEX_NONE for the selected one.
FrameRate	The frame rate to set (must be in range of format's supported frame rates).

Returns: true on success, false otherwise.

See also: GetVideoTrackAspectRatio, GetVideoTrackDimensions, GetVideoTrackFrameRate, GetVideoTrackFrameRates, GetVideoTrackType

◆ SetViewField()

bool UMediaPlayer::SetViewField	(	float	Horizontal,
		float	Vertical,
		bool	Absolute
	)

Set the field of view (only for 360 videos).

Parameters

Horizontal	Horizontal field of view (in Euler degrees).
Vertical	Vertical field of view (in Euler degrees).
Whether	the field of view change should be absolute (true) or relative (false).

Returns: true on success, false otherwise.

See also: GetHorizontalFieldOfView, GetVerticalFieldOfView, SetViewRotation

◆ SetViewRotation()

bool UMediaPlayer::SetViewRotation	(	const FRotator &	Rotation,
		bool	Absolute
	)

Set the view's rotation (only for 360 videos).

Parameters

Rotation	The desired view rotation.
Whether	the rotation change should be absolute (true) or relative (false).

Returns: true on success, false otherwise.

See also: GetViewRotation, SetViewField

◆ SupportsPlaybackTimeRange()

bool UMediaPlayer::SupportsPlaybackTimeRange ( ) const

Check whether the player supports playing back of range within the media.

Returns: true if playing back a range is supported, false otherwise.

See also: GetPlaybackTimeRange, SetPlaybackTimeRange

◆ SupportsRate()

bool UMediaPlayer::SupportsRate	(	float	Rate,
		bool	Unthinned
	)		const

Check whether the specified playback rate is supported.

Parameters

Rate	The playback rate to check.
Unthinned	Whether no frames should be dropped at the given rate.

See also: SupportsScrubbing, SupportsSeeking

◆ SupportsScrubbing()

bool UMediaPlayer::SupportsScrubbing ( ) const

Check whether the currently loaded media supports scrubbing.

Returns: true if scrubbing is supported, false otherwise.

See also: SupportsRate, SupportsSeeking

◆ SupportsSeeking()

bool UMediaPlayer::SupportsSeeking ( ) const

Check whether the currently loaded media can jump to a certain position.

Returns: true if seeking is supported, false otherwise.

See also: SupportsRate, SupportsScrubbing

◆ UnregisterWithMediaModule()

void UMediaPlayer::UnregisterWithMediaModule ( )

When the player goes out of scope, make sure to clean up the clock sink

Member Data Documentation

◆ CacheAhead

FTimespan UMediaPlayer::CacheAhead

Duration of samples to cache ahead of the play head.

See also: CacheBehind, CacheBehindGame

◆ CacheBehind

FTimespan UMediaPlayer::CacheBehind

Duration of samples to cache behind the play head (when not running as game).

See also: CacheAhead, CacheBehindGame

◆ CacheBehindGame

FTimespan UMediaPlayer::CacheBehindGame

Duration of samples to cache behind the play head (when running as game).

See also: CacheAhead, CacheBehind

◆ HorizontalFieldOfView

float UMediaPlayer::HorizontalFieldOfView

protected

The initial horizontal field of view (in Euler degrees; default = 90).

This setting is used only for 360 videos. It determines the portion of the video that is visible at a time. To modify the field of view at runtime in Blueprints, use the SetHorizontalFieldOfView function.

See also: GetHorizontalFieldOfView, SetHorizontalFieldOfView, VerticalFieldOfView, ViewRotation

◆ Loop

uint32 UMediaPlayer::Loop

protected

Whether the player should loop when media playback reaches the end.

Use the SetLooping function to change this value at runtime.

See also: IsLooping, SetLooping

◆ MediaInfoNameKeyframeInterval

FLazyName UMediaPlayer::MediaInfoNameKeyframeInterval

static

Keyframe interval. Int32.

◆ MediaInfoNameSourceNumMips

FLazyName UMediaPlayer::MediaInfoNameSourceNumMips

static

These are possible common information for use with GetMediaInfo. They also describe the type of data that will be needed to retrieve the information. Number of mip map levels in the source. Int32.

◆ MediaInfoNameSourceNumTiles

FLazyName UMediaPlayer::MediaInfoNameSourceNumTiles

static

Number of tiles (X and Y) in the source. IntPoint.

◆ MediaInfoNameStartTimecodeFrameRate

FLazyName UMediaPlayer::MediaInfoNameStartTimecodeFrameRate

static

Start Timecode frame rate. String.

◆ MediaInfoNameStartTimecodeValue

FLazyName UMediaPlayer::MediaInfoNameStartTimecodeValue

static

Start Timecode. SMPTE format (ex: HH:MM:SS:FF) string.

◆ NativeAudioOut

bool UMediaPlayer::NativeAudioOut

Output any audio via the operating system's sound mixer instead of a Sound Wave asset.

If enabled, the assigned Sound Wave asset will be ignored. The SetNativeVolume function can then be used to change the audio output volume at runtime. Note that not all media player plug-ins may support native audio output on all platforms.

See also: SetNativeVolume

◆ OnBufferingCompleted

FOnMediaPlayerMediaEvent UMediaPlayer::OnBufferingCompleted

A delegate that may be invoked when the player completes buffering data. This event should not be relied upon since not all media players support this.

See also: OnBufferingStart

◆ OnBufferingStart

FOnMediaPlayerMediaEvent UMediaPlayer::OnBufferingStart

A delegate that is invoked when the player starts buffering data. This event is not sent by all media players.

See also: OnBufferingCompleted

◆ OnEndReached

FOnMediaPlayerMediaEvent UMediaPlayer::OnEndReached

A delegate that is invoked when playback has reached the end of the media.

◆ OnMediaClosed

FOnMediaPlayerMediaEvent UMediaPlayer::OnMediaClosed

A delegate that is invoked when a media source has been closed.

◆ OnMediaOpened

FOnMediaPlayerMediaOpened UMediaPlayer::OnMediaOpened

A delegate that is invoked when a media source has been opened.

Depending on whether the underlying player implementation opens the media synchronously or asynchronously, this event may be executed before or after the call to OpenSource / OpenUrl returns.

See also: OnMediaOpenFailed, OnTracksChanged

◆ OnMediaOpenFailed

FOnMediaPlayerMediaOpenFailed UMediaPlayer::OnMediaOpenFailed

A delegate that is invoked when a media source has failed to open.

This delegate is only executed if OpenSource / OpenUrl returned true and the media failed to open asynchronously later. It is not executed if OpenSource / OpenUrl returned false, indicating an immediate failure.

See also: OnMediaOpened

◆ OnMetadataChanged

FOnMediaPlayerMediaEvent UMediaPlayer::OnMetadataChanged

A delegate that is invoked when the media metadata changed.

See also: OnMediaOpened

◆ OnPlaybackResumed

FOnMediaPlayerMediaEvent UMediaPlayer::OnPlaybackResumed

A delegate that is invoked when media playback has been resumed.

See also: OnPlaybackSuspended

◆ OnPlaybackSuspended

FOnMediaPlayerMediaEvent UMediaPlayer::OnPlaybackSuspended

A delegate that is invoked when media playback has been suspended.

See also: OnPlaybackResumed

◆ OnSeekCompleted

FOnMediaPlayerMediaEvent UMediaPlayer::OnSeekCompleted

A delegate that is invoked when a seek operation completed successfully.

Depending on whether the underlying player implementation performs seeks synchronously or asynchronously, this event may be executed before or after the call to Seek returns.

◆ OnTracksChanged

FOnMediaPlayerMediaEvent UMediaPlayer::OnTracksChanged

A delegate that is invoked when the media track collection changed.

See also: OnMediaOpened

◆ Playlist

TObjectPtr<UMediaPlaylist> UMediaPlayer::Playlist

mutableprotected

The play list to use, if any.

Use the OpenPlaylist or OpenPlaylistIndex function to change this value at runtime.

See also: OpenPlaylist, OpenPlaylistIndex

◆ PlaylistIndex

int32 UMediaPlayer::PlaylistIndex

protected

The current index of the source in the play list being played.

Use the Previous and Next methods to change this value at runtime.

See also: Next, Previous

◆ PlayOnOpen

bool UMediaPlayer::PlayOnOpen

Automatically start playback after media opened successfully.

If disabled, listen to the OnMediaOpened Blueprint event to detect when the media finished opening, and then start playback using the Play function.

See also: OpenFile, OpenPlaylist, OpenPlaylistIndex, OpenSource, OpenUrl, Play

◆ Shuffle

uint32 UMediaPlayer::Shuffle

Whether playback should shuffle media sources in the play list.

See also: OpenPlaylist, OpenPlaylistIndex

◆ TimeDelay

FTimespan UMediaPlayer::TimeDelay

protected

Delay of the player's time.

See also: SetTimeDelay, GetTimeDelay

◆ VerticalFieldOfView

float UMediaPlayer::VerticalFieldOfView

protected

The initial vertical field of view (in Euler degrees; default = 60).

This setting is used only for 360 videos. It determines the portion of the video that is visible at a time. To modify the field of view at runtime in Blueprints, use the SetHorizontalFieldOfView function.

Please note that some 360 video players may be able to change only the horizontal field of view, and this setting may be ignored.

See also: GetVerticalFieldOfView, SetVerticalFieldOfView, HorizontalFieldOfView, ViewRotation

◆ ViewRotation

FRotator UMediaPlayer::ViewRotation

protected

The initial view rotation.

This setting is used only for 360 videos. It determines the rotation of the video's view. To modify the view orientation at runtime in Blueprints, use the GetViewRotation and SetViewRotation functions.

Please note that not all players may support video view rotations.

See also: GetViewRotation, SetViewRotation, HorizontalFieldOfView, VerticalFieldOfView

The documentation for this class was generated from the following files:

Engine/Source/Runtime/MediaAssets/Public/MediaPlayer.h
Engine/Source/Runtime/MediaAssets/Private/Assets/MediaPlayer.cpp

Static Public Attributes
static MEDIAASSETS_API FLazyName	MediaInfoNameSourceNumMips

static MEDIAASSETS_API FLazyName	MediaInfoNameSourceNumTiles

static MEDIAASSETS_API FLazyName	MediaInfoNameStartTimecodeValue

static MEDIAASSETS_API FLazyName	MediaInfoNameStartTimecodeFrameRate

static MEDIAASSETS_API FLazyName	MediaInfoNameKeyframeInterval

Public Attributes
FOnMediaPlayerMediaEvent	OnEndReached

FOnMediaPlayerMediaEvent	OnMediaClosed

FOnMediaPlayerMediaOpened	OnMediaOpened

FOnMediaPlayerMediaOpenFailed	OnMediaOpenFailed

FOnMediaPlayerMediaEvent	OnPlaybackResumed

FOnMediaPlayerMediaEvent	OnPlaybackSuspended

FOnMediaPlayerMediaEvent	OnSeekCompleted

FOnMediaPlayerMediaEvent	OnTracksChanged

FOnMediaPlayerMediaEvent	OnMetadataChanged

FOnMediaPlayerMediaEvent	OnBufferingStart

FOnMediaPlayerMediaEvent	OnBufferingCompleted

FTimespan	CacheAhead

FTimespan	CacheBehind

FTimespan	CacheBehindGame

bool	NativeAudioOut

bool	PlayOnOpen

uint32	Shuffle: 1

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BeginDestroy()

◆ CanPause()

◆ CanPlaySource()

◆ CanPlayUrl()

◆ CleanUpBeforeDestroy()

◆ Close()

◆ CreateProxyData()

◆ DECLARE_EVENT_OneParam()

◆ GetAudioTrackChannels()

◆ GetAudioTrackSampleRate()

◆ GetAudioTrackType()

◆ GetDesc()

◆ GetDesiredPlayerName()

◆ GetDisplayTime()

◆ GetDisplayTimeStamp()

◆ GetDuration()

◆ GetGuid()

◆ GetHorizontalFieldOfView()

◆ GetMediaInfo() [1/2]

◆ GetMediaInfo() [2/2]

◆ GetMediaMetadata()

◆ GetMediaMetadataItems()

◆ GetMediaName()

◆ GetNumTrackFormats()

◆ GetNumTracks()

◆ GetPlaybackTimeRange() [1/2]

◆ GetPlaybackTimeRange() [2/2]

◆ GetPlayerFacade()

◆ GetPlayerName()

◆ GetPlaylist()

◆ GetPlaylistIndex()

◆ GetPlaylistRef()

◆ GetRate()

◆ GetSelectedTrack()

◆ GetSupportedRates()

◆ GetTime()

◆ GetTimeDelay()

◆ GetTimeStamp()

◆ GetTrackDisplayName()

◆ GetTrackFormat()

◆ GetTrackLanguage()

◆ GetUrl()

◆ GetVerticalFieldOfView()

◆ GetVideoTimecode()

◆ GetVideoTrackAspectRatio()

◆ GetVideoTrackDimensions()

◆ GetVideoTrackFrameRate()

◆ GetVideoTrackFrameRates()

◆ GetVideoTrackType()

◆ GetViewRotation()

◆ HasError()

◆ IsBuffering()

◆ IsClosed()

◆ IsConnecting()

◆ IsLooping()

◆ IsPaused()

◆ IsPlaying()

◆ IsPreparing()

◆ IsReady()

◆ Next()

◆ OpenFile()

◆ OpenPlaylist()

◆ OpenPlaylistIndex()

◆ OpenSource()

◆ OpenSourceLatent()

◆ OpenSourceWithOptions()

◆ OpenUrl()

◆ Pause()

◆ Play()

◆ PlayAndSeek()

◆ PostDuplicate()

◆ PostInitProperties()

◆ PostLoad()