description: Deprecated* OnSourceCreationPanelClosed is deprecated. LiveLinkSourceFactory can now be used at runtime. The factory won't work until it's been updated.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILiveLinkSource](API\Runtime\LiveLinkInterface\ILiveLinkSource) > OnSourceCreationPanelClosed ( bool bMakeSource )


className: ULiveLinkSourceFactory

description: Base class of factory that creates Source. A source can be created in the editor via the Live Link panel or at runtime via a connection string.

module: LiveLinkInterface

code: class ULiveLinkSourceFactory : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Deprecated* CreateSourceCreationPanel is deprecated. LiveLinkSourceFactory can now be used at runtime. This factory won't work until it's been updated.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateSourceCreationPanel()


className: ULiveLinkSourceSettings

description: Base class for live link source settings (can be replaced by sources themselves)

code: class ULiveLinkSourceSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

BufferSettings

type: FLiveLinkSource...

description: How the frame buffers are managed.

ConnectionString

type: FString

description: Connection information that is needed by the factory to recreate the source from a preset.

Factory

type: TSubclassOf<UL...

description: Factory used to create the source.

Mode

type: ELiveLinkSource...

description: The the subject how to create the frame snapshot.


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


className: ULiveLinkSubjectSettings

description: Base class for live link subject settings.

code: class ULiveLinkSubjectSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bRebroadcastSubject

type: bool

description: If enabled, rebroadcast this subject

FrameRate

type: FFrameRate

description: Last FrameRate estimated by the subject.

InterpolationProcessor

type: TObjectPtr<ULi...

description: The interpolation processor the subject will use.

PreProcessors

type: TArray<TObject...

description: List of available preprocessor the subject will use.

Translators

description: List of available translator the subject can use.


code: virtual void ClearFrames()


description: Returns true whether this virtual subject depends on the Subject named SubjectName

code: virtual bool DependsOnSubject ( [FName](API\Runtime\Core\UObject\FName) SubjectName ) const


code: virtual bool EvaluateFrame ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [ULiveLinkRole](API\Runtime\LiveLinkInterface\ULiveLinkRole) > InDesiredRole, [FLiveLinkSubjectFrameData](API\Runtime\LiveLinkInterface\FLiveLinkSubjectFrameData) & OutFrame )


description: Returns the current frame data of this virtual subject

code: const FLiveLinkFrameDataStruct & GetFrameData() const


code: virtual const [FLiveLinkSubjectFrameData](API\Runtime\LiveLinkInterface\FLiveLinkSubjectFrameData) & GetFrameSnapshot() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FLiveLinkTime](API\Runtime\LiveLinkInterface\FLiveLinkTime) > GetFrameTimes() const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [ULiveLinkFrameTranslator::FWorkerSharedPtr](API\Runtime\LiveLinkInterface\ULiveLinkFrameTranslator\FWorkerSharedPtr) > GetFrameTranslators() const


code: [ILiveLinkClient](API\Runtime\LiveLinkInterface\ILiveLinkClient) * GetClient() const


code: virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [ULiveLinkRole](API\Runtime\LiveLinkInterface\ULiveLinkRole) > GetRole() const


code: virtual FLiveLinkStaticDataStruct & GetStaticData()


code: virtual const FLiveLinkStaticDataStruct & GetStaticData() const


code: virtual [FLiveLinkSubjectKey](API\Runtime\LiveLinkInterface\FLiveLinkSubjectKey) GetSubjectKey() const


description: Returns the live subjects associated with this virtual one

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FLiveLinkSubjectName](API\Runtime\LiveLinkInterface\FLiveLinkSubjectName) > & GetSubjects() const


description: Returns the translators assigned to this virtual subject

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ULiveLinkFrameTranslator](API\Runtime\LiveLinkInterface\ULiveLinkFrameTranslator) * > & GetTranslators() const


description: Whether snapshot has valid frame data

code: bool HasValidFrameData() const


code: virtual bool HasValidFrameSnapshot() const


description: Whether snapshot has valid static data

code: bool HasValidStaticData() const


code: virtual void Initialize ( [FLiveLinkSubjectKey](API\Runtime\LiveLinkInterface\FLiveLinkSubjectKey) SubjectKey, [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [ULiveLinkRole](API\Runtime\LiveLinkInterface\ULiveLinkRole) > Role, [ILiveLinkClient](API\Runtime\LiveLinkInterface\ILiveLinkClient) * LiveLinkClient )


description: Invalidates our snapshot's frame data

code: void InvalidateFrameData()


description: Invalidates our snapshot's static data

code: void InvalidateStaticData()


description: When rebroadcasting, has the static data been rebroadcasted?

code: virtual bool HasStaticDataBeenRebroadcasted() const


description: Whether this subject is rebroadcasted

code: virtual bool IsRebroadcasted() const


description: Sets the static data for this subject as rebroadcasted

code: virtual void SetStaticDataAsRebroadcasted ( const bool bInSent )


description: Updates our snapshot's frame data

code: void UpdateFrameDataSnapshot ( FLiveLinkFrameDataStruct && NewFrameData )


description: Updates our snapshot's static data

code: void UpdateStaticDataSnapshot ( FLiveLinkStaticDataStruct && NewStaticData )


className: ULiveLinkVirtualSubject

description: A Virtual subject is made up of one or more real subjects from a source.

code: class ULiveLinkVirtualSubject : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [ILiveLinkSubject](API\Runtime\LiveLinkInterface\ILiveLinkSubject)

bHasStaticDataBeenRebroadcast

description: If true, static data has been sent for this rebroadcast

bRebroadcastSubject

description: If enabled, rebroadcast this subject

LiveLinkClient

type: ILiveLinkClient...

description: LiveLinkClient to get access to subjects

Role

description: The role the subject was build with.

SnapshotAccessCriticalSection

type: FCriticalSectio...

description: Lock to protect the FrameSnapshot.

SubjectKey

type: FLiveLinkSubjec...

description: Name of the subject

Subjects

type: TArray<FLiveLi...

description: Names of the real subjects to combine into a virtual subject


module: LiveLinkMessageBusFramework

code: FLiveLinkClearSubject()


code: FLiveLinkClearSubject ( const [FName](API\Runtime\Core\UObject\FName) & InSubjectName )


className: FLiveLinkClearSubject

code: struct FLiveLinkClearSubject

SubjectName

type: FName

description: Name of the subject to clear.


className: FLiveLinkConnectMessage

code: struct FLiveLinkConnectMessage


className: FLiveLinkHeartbeatMessage

code: struct FLiveLinkHeartbeatMessage


description: Updates the list of translators valid for this frame

code: void UpdateTranslatorsForThisFrame()


className: SubjectAnnotation

code: static [FName](API\Runtime\Core\UObject\FName) SubjectAnnotation = TEXT("SubjectName");


className: FLiveLinkMessageAnnotation

code: struct FLiveLinkMessageAnnotation


description: Default constructor for the receiver

code: FLiveLinkPingMessage()


code: FLiveLinkPingMessage ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPollRequest, int32 InLiveLinkVersion )


className: FLiveLinkPingMessage

code: struct FLiveLinkPingMessage

PollRequest

type: FGuid


className: RoleAnnotation

code: static [FName](API\Runtime\Core\UObject\FName) RoleAnnotation = TEXT("Role");


description: Default constructor for the receiver

code: FLiveLinkPongMessage()


description: Deprecated* This version of theFLiveLinkPongMessageconstructor is deprecated. Please use the new constructor instead to ensure the LiveLinkVersion is set properly.

code: FLiveLinkPongMessage ( const [FString](API\Runtime\Core\Containers\FString) & InProviderName, const [FString](API\Runtime\Core\Containers\FString) & InMachineName, const [FGuid](API\Runtime\Core\Misc\FGuid) & InPollRequest )


code: FLiveLinkPongMessage ( const [FString](API\Runtime\Core\Containers\FString) & InProviderName, const [FString](API\Runtime\Core\Containers\FString) & InMachineName, const [FGuid](API\Runtime\Core\Misc\FGuid) & InPollRequest, int32 InLiveLinkVersion )


className: FLiveLinkPongMessage

code: struct FLiveLinkPongMessage

CreationPlatformTime

type: double


code: const [FString](API\Runtime\Core\Containers\FString) & GetMachineName() const


description: Remove named subject

code: virtual void ClearSubject ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName )


code: const [FString](API\Runtime\Core\Containers\FString) & GetProviderName() const


description: Is this provider currently connected to something.

code: virtual bool HasConnection() const


description: Function for managing connection status changed delegate.

code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterConnStatusChangedHandle ( const FLiveLinkProviderConnectionStatusChanged::FDelegate & ConnStatusChanged )


description: Inform UE that a subject won't be streamed anymore.

code: virtual void RemoveSubject ( const [FName](API\Runtime\Core\UObject\FName) SubjectName )


code: template<typename MessageType> void SendMessage ( MessageType * Message )


code: template<typename MessageType> void SendMessage ( MessageType * Message, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Address )


code: template<typename MessageType> void Subscribe()


code: virtual void UnregisterConnStatusChangedHandle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


description: Update subject with additional metadata

code: virtual void UpdateSubjectFrame ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName, const [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & BoneTransforms, const [TArray](API\Runtime\Core\Containers\TArray)< [FLiveLinkCurveElement](API\Runtime\LiveLinkInterface\FLiveLinkCurveElement) > & CurveData, const [FLiveLinkMetaData](API\Runtime\LiveLinkInterface\FLiveLinkMetaData) & MetaData, double Time )


description: Update subject with transform data

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid UpdateSubjectFrame ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName, const [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & BoneTransforms, const [TArray](API\Runtime\Core\Containers\TArray)< [FLiveLinkCurveElement](API\Runtime\LiveLinkInterface\FLiveLinkCurveElement) > & CurveData, double Time )


description: RemoveSubject

code: virtual bool UpdateSubjectFrameData ( const [FName](API\Runtime\Core\UObject\FName) SubjectName, FLiveLinkFrameDataStruct && FrameData )


description: RemoveSubject

code: virtual bool UpdateSubjectStaticData ( const [FName](API\Runtime\Core\UObject\FName) SubjectName, [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [ULiveLinkRole](API\Runtime\LiveLinkInterface\ULiveLinkRole) > Role, FLiveLinkStaticDataStruct && StaticData )


code: FLiveLinkProvider ( const [FString](API\Runtime\Core\Containers\FString) & InProviderName )


description: Update hierarchy for named subject

code: virtual void UpdateSubject ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & BoneNames, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & BoneParents )


code: FLiveLinkProvider ( const [FString](API\Runtime\Core\Containers\FString) & InProviderName, struct [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) && EndpointBuilder )


code: virtual ~FLiveLinkProvider()


className: FTrackedSubject

description: Subject that the application has told us about.

code: struct FTrackedSubject

Curves

description: Curve data.

MetaData

type: FLiveLinkMetaDa...

description: MetaData for subject.

RefSkeleton

type: FLiveLinkRefSke...

description: Ref skeleton to go with transform data.

Time

description: Incrementing time (application time) for interpolation purposes.

Transforms

type: TArray< FTransf...

description: Bone transform data.


className: FLiveLinkProvider

code: struct FLiveLinkProvider : public [ILiveLinkProvider](API\Runtime\LiveLinkMessageBusFramework\ILiveLinkProvider)


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILiveLinkProvider](API\Runtime\LiveLinkMessageBusFramework\ILiveLinkProvider) > CreateLiveLinkProvider ( const [FString](API\Runtime\Core\Containers\FString) & ProviderName )


description:
Create a Live Link Provider based on a class derived fromILiveLinkProviderinstead of using the default Live Link Provider.
Shared pointer to the ILiveLinkProvider-derived class. Use StaticCastSharedPtr to cast it back to child class type.

code: template<typename T> static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILiveLinkProvider](API\Runtime\LiveLinkMessageBusFramework\ILiveLinkProvider) > CreateLiveLinkProvider ( const [FString](API\Runtime\Core\Containers\FString) & ProviderName, struct [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) && EndpointBuilder )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterConnStatusChangedHandle ( const FLiveLinkProviderConnectionStatusChanged::FDelegate & ConnStatusChanged )


code: bool HasConnection() const


code: void RemoveSubject ( const [FName](API\Runtime\Core\UObject\FName) SubjectName )


description: RemoveSubject

code: bool UpdateSubjectStaticData ( const [FName](API\Runtime\Core\UObject\FName) SubjectName, [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [ULiveLinkRole](API\Runtime\LiveLinkInterface\ULiveLinkRole) > Role, FLiveLinkStaticDataStruct && StaticData )


code: void UnregisterConnStatusChangedHandle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


description: RemoveSubject

code: bool UpdateSubjectFrameData ( const [FName](API\Runtime\Core\UObject\FName) SubjectName, FLiveLinkFrameDataStruct && FrameData )


code: virtual ~ILiveLinkProvider()


className: ILiveLinkProvider

code: struct ILiveLinkProvider : public [ILiveLinkProvider_Base_DEPRECATED](API\Runtime\LiveLinkMessageBusFramework\ILiveLinkProvider_Base_DEPRECATE-)


description: Remove named subject

code: void ClearSubject ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName )


description: Update subject with transform data

code: virtual void UpdateSubjectFrame ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName, const [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & BoneTransforms, const [TArray](API\Runtime\Core\Containers\TArray)< [FLiveLinkCurveElement](API\Runtime\LiveLinkInterface\FLiveLinkCurveElement) > & CurveData, double Time )


description: Update subject with additional metadata

code: virtual void UpdateSubjectFrame ( const [FName](API\Runtime\Core\UObject\FName) & SubjectName, const [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & BoneTransforms, const [TArray](API\Runtime\Core\Containers\TArray)< [FLiveLinkCurveElement](API\Runtime\LiveLinkInterface\FLiveLinkCurveElement) > & CurveData, const [FLiveLinkMetaData](API\Runtime\LiveLinkInterface\FLiveLinkMetaData) & MetaData, double Time )


module: LocalFileNetworkReplayStreaming

code: namespace EQueuedLocalFileRequestType { enum Type { StartRecording, WriteHeader, WritingHeader, WritingStream, StopRecording, StartPlayback, ReadingHeader, ReadingStream, EnumeratingStreams, WritingCheckpoint, ReadingCheckpoint, UpdatingEvent, EnumeratingEvents, RequestingEvent, StopStreaming, DeletingFinishedStream, RefreshingLiveStream, KeepReplay, RenameReplay, RenameReplayFriendlyName, } }


code: namespace EQueuedLocalFileRequestType { const TCHAR * EQueuedLocalFileRequestType::ToString ( [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) Type ) }


code: FCachedFileRequest ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InRequestData, const double InLastAccessTime )


code: FCachedFileRequest ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && InRequestData, const double InLastAccessTime )


className: FCachedFileRequest

code: class FCachedFileRequest

RequestData

type: TArray< uint8 >


code: virtual void FinishRequest()


code: FGenericQueuedLocalFileRequest ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocalFileNetworkReplayStreamer](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileNetworkReplayStreamer) > & InStreamer, [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) InType, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> && InCompletionCallback )


className: FGenericQueuedLocalFileRequest

code: class FGenericQueuedLocalFileRequest : public [FQueuedLocalFileRequest](API\Runtime\LocalFileNetworkReplayStreaming\FQueuedLocalFileRequest), public [TSharedFromThis< FGenericQueuedLocalFileRequest, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

CompletionCallback

type: TFunction< void...


code: FLocalFileChunkInfo()


className: FLocalFileChunkInfo

description: Struct to hold chunk metadata

code: struct FLocalFileChunkInfo

ChunkType

type: ELocalFileChunk...


code: void CountBytes ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


code: FLocalFileEventInfo()


className: FLocalFileEventInfo

description: Struct to hold event metadata

code: struct FLocalFileEventInfo

Group

type: FString


code: virtual void IssueRequest()


code: virtual void Flush()


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object will ever be able to tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame
true if object will ever want to be ticked, false otherwise.

code: virtual ETickableTickType GetTickableTickType() const


code: bool HasAnyPendingRequests() const


description:
Used to determine if an object should be ticked when the game is paused. Defaults to false, as that mimics old behavior.
true if it should be ticked when paused, false otherwise

code: virtual bool IsTickableWhenPaused() const


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


description: FTickableGameObject

code: virtual void Tick ( float DeltaTime )


className: FLocalFileNetworkReplayStreamingFactory

code: class FLocalFileNetworkReplayStreamingFactory : public [INetworkReplayStreamingFactory](API\Runtime\NetworkReplayStreaming\INetworkReplayStreamingFactory), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)

LocalFileStreamers

type: TArray<TShared...


code: template<typename DelegateResultType> void AddCachedFileRequestToQueue ( [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) RequestType, int32 InCacheKey, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InCompletionCallback )


code: template<typename DelegateResultType> void AddDelegateFileRequestToQueue ( [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) RequestType, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InCompletionCallback )


code: template<typename DelegateType, typename DelegateResultType> void AddDelegateFileRequestToQueue ( [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) RequestType, const DelegateType & Delegate, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InFunction )


code: virtual void AddEvent ( const uint32 TimeInMS, const [FString](API\Runtime\Core\Containers\FString) & Group, const [FString](API\Runtime\Core\Containers\FString) & Meta, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


code: virtual void AddOrUpdateEvent ( const [FString](API\Runtime\Core\Containers\FString) & Name, const uint32 TimeInMS, const [FString](API\Runtime\Core\Containers\FString) & Group, const [FString](API\Runtime\Core\Containers\FString) & Meta, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


code: template<typename StorageType> void AddGenericRequestToQueue ( [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) RequestType, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(StorageType &)> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(StorageType &)> && InCompletionCallback )


code: void AddRequestToCache ( int32 ChunkIndex, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & RequestData )


code: void AddRequestToCache ( int32 ChunkIndex, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && RequestData )


description: Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)

code: virtual void AddUserToReplay ( const [FString](API\Runtime\Core\Containers\FString) & UserString )


code: void AddSimpleRequestToQueue ( [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) RequestType, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> && InCompletionCallback )


code: bool AllowEncryptedWrite() const


code: void CancelStreamingRequests()


code: static bool CleanUpOldReplays ( const [FString](API\Runtime\Core\Containers\FString) & DemoPath, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FString](API\Runtime\Core\Containers\FString) > AdditionalRelativeDemoPaths )


code: void CleanupRequestCache()


code: virtual bool CompressBuffer ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBuffer, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutCompressed ) const


code: void ConditionallyFlushStream()


code: void ConditionallyLoadNextChunk()


code: void ConditionallyRefreshReplayInfo()


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > CreateLocalFileReader ( const [FString](API\Runtime\Core\Containers\FString) & InFilename ) const


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > CreateLocalFileWriter ( const [FString](API\Runtime\Core\Containers\FString) & InFilename ) const


code: virtual bool DecompressBuffer ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCompressed, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBuffer ) const


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > CreateLocalFileWriterForOverwrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename ) const


code: virtual bool DecryptBuffer ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Ciphertext, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Plaintext, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > EncryptionKey ) const


description: Attempts to delete the stream with the specified name. May execute asynchronously.

code: virtual void DeleteFinishedStream ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, const FDeleteFinishedStreamCallback & Delegate )


code: virtual void DeleteFinishedStream ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback & Delegate )


code: void DeleteFinishedStream_Internal ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback & Delegate )


code: virtual void DownloadHeader ( const FDownloadHeaderCallback & Delegate )


code: virtual bool EncryptBuffer ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Plaintext, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Ciphertext, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > EncryptionKey ) const


code: virtual void EnumerateEvents ( const [FString](API\Runtime\Core\Containers\FString) & Group, const FEnumerateEventsCallback & Delegate )


code: virtual void EnumerateEvents ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const FEnumerateEventsCallback & Delegate )


code: virtual void EnumerateEvents ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const int32 UserIndex, const FEnumerateEventsCallback & Delegate )


code: void EnumerateEvents_Internal ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const int32 UserIndex, const FEnumerateEventsCallback & Delegate )


description: Retrieves the streams that have been recently viewed. May execute asynchronously.

code: virtual void EnumerateRecentStreams ( const [FNetworkReplayVersion](API\Runtime\Core\Misc\FNetworkReplayVersion) & ReplayVersion, const int32 UserIndex, const FEnumerateStreamsCallback & Delegate )


description: Retrieves the streams that are available for viewing. May execute asynchronously. Allows the caller to pass in a custom list of query parameters

code: virtual void EnumerateStreams ( const [FNetworkReplayVersion](API\Runtime\Core\Misc\FNetworkReplayVersion) & ReplayVersion, const int32 UserIndex, const [FString](API\Runtime\Core\Containers\FString) & MetaString, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ExtraParms, const FEnumerateStreamsCallback & Delegate )


className: FileMagic

code: static const uint32 FileMagic = 0x1CA2E27F;


code: void FixupFriendlyNameLength ( const [FString](API\Runtime\Core\Containers\FString) & UnfixedName, [FString](API\Runtime\Core\Containers\FString) & FixedName ) const


className: FLocalFileReplayResult

code: typedef [UE::Net::TNetResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult)< ELocalFileReplayResult > FLocalFileReplayResult


className: FLocalFileSerializationInfo

code: struct FLocalFileSerializationInfo

FileCustomVersions

type: FCustomVersionC...


code: virtual void FlushCheckpoint ( const uint32 TimeInMS )


code: void FlushCheckpointInternal ( const uint32 TimeInMS )


code: void FlushStream ( const uint32 TimeInMS )


code: virtual void GenerateEncryptionKey ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & EncryptionKey )


description: Returns a name formatted as "demoX", where X is between 1 and MAX_DEMOS, inclusive. Returns the first value that doesn't yet exist, or if they all exist, returns the oldest one (it will be overwritten).


description: Must be relative to the base demo path.

code: virtual [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FString](API\Runtime\Core\Containers\FString) > GetAdditionalRelativeDemoPaths() const


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetCheckpointArchive()


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetCachedFileContents ( const [FString](API\Runtime\Core\Containers\FString) & Filename ) const


code: virtual int32 GetDecompressedSizeBackCompat ( [FArchive](API\Runtime\Core\Serialization\FArchive) & InCompressed ) const


code: static const [FString](API\Runtime\Core\Containers\FString) & GetDefaultDemoSavePath()


code: static bool GetDemoFreeStorageSpace ( uint64 & DiskFreeSpace, const [FString](API\Runtime\Core\Containers\FString) & DemoPath )


code: static [FString](API\Runtime\Core\Containers\FString) GetDemoFullFilename ( const [FString](API\Runtime\Core\Containers\FString) & DemoPath, const [FString](API\Runtime\Core\Containers\FString) & FileName )


code: [FString](API\Runtime\Core\Containers\FString) GetDemoFullFilename ( const [FString](API\Runtime\Core\Containers\FString) & FileName ) const


description: Gets the current base directory where Demos are stored. Note, this will always fail for streamers that don't support replays stored on disk.

code: virtual EStreamingOperationResult GetDemoPath ( [FString](API\Runtime\Core\Containers\FString) & DemoPath ) const


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetHeaderArchive()


description: Returns the maximum size of the friendly name text for this streamer, or 0 for unlimited.

code: virtual uint32 GetMaxFriendlyNameSize() const


description: Returns the active replay name

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReplayID() const


code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * GetStreamingArchive()


description: Return current recording/playback state

code: virtual EReplayStreamerState GetReplayStreamerState() const


description: Time in milliseconds

code: virtual uint32 GetTotalDemoTime() const


code: virtual void GotoTimeInMS ( const uint32 TimeInMS, const FGotoCallback & Delegate, EReplayCheckpointType CheckpointType )


code: virtual void GotoCheckpointIndex ( const int32 CheckpointIndex, const FGotoCallback & Delegate, EReplayCheckpointType CheckpointType )


code: bool HasPendingFileRequests() const


code: virtual bool IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointType ) const


code: virtual bool IsDataAvailable() const


code: virtual bool IsDataAvailableForTimeRange ( const uint32 StartTimeInMS, const uint32 EndTimeInMS )


description: Returns true if the playing stream is currently in progress

code: virtual bool IsLive() const


code: bool IsFileRequestPendingOrInProgress ( const [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) RequestType ) const


code: bool IsFileRequestInProgress() const


code: virtual bool IsLoadingCheckpoint() const


code: bool IsNamedStreamLive ( const [FString](API\Runtime\Core\Containers\FString) & StreamName ) const


code: bool IsStreaming() const


description: Used to commit a replay to permanent storage.

code: virtual void KeepReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const bool bKeep, const FKeepReplayCallback & Delegate )


code: virtual void KeepReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback & Delegate )


className: MaxFriendlyNameLen

code: static const uint32 MaxFriendlyNameLen = 256;


className: LatestVersion

code: static const uint32 LatestVersion = FLocalFileReplayCustomVersion::LatestVersion;


code: void OnFileRequestComplete ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FQueuedLocalFileRequest](API\Runtime\LocalFileNetworkReplayStreaming\FQueuedLocalFileRequest), ESPMode::ThreadSafe > & Request )


code: void KeepReplay_Internal ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback & Delegate )


className: OnReplayFinishedWriting


code: bool ProcessNextFileRequest()


code: bool ReadReplayInfo ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & OutReplayInfo ) const


code: bool ReadReplayInfo ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & OutReplayInfo, EReadReplayInfoFlags Flags ) const


code: bool ReadReplayInfo ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive, [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & OutReplayInfo, EReadReplayInfoFlags Flags ) const


code: bool ReadReplayInfo ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive, [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & OutReplayInfo, struct [FLocalFileSerializationInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileNetworkReplayStreamer\FLocalFileSerial-) & SerializationInfo, EReadReplayInfoFlags Flags ) const


code: virtual void RefreshHeader()


description: Used to change the name of a replay. Note, thiswillchange the name used to refer to the replay (if successful).

code: virtual void RenameReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewName, const FRenameReplayCallback & Delegate )


code: virtual void RenameReplay ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewName, const int32 UserIndex, const FRenameReplayCallback & Delegate )


description: Used to change the friendly name of a replay. Note, changing the friendly namedoes notchange the name used to refer to replay.

code: virtual void RenameReplayFriendlyName ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewFriendlyName, const FRenameReplayCallback & Delegate )


code: virtual void RenameReplayFriendlyName ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback & Delegate )


code: void RenameReplayFriendlyName_Internal ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback & Delegate )


code: void RenameReplay_Internal ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & NewName, const int32 UserIndex, const FRenameReplayCallback & Delegate )


code: virtual void RequestEventData ( const [FString](API\Runtime\Core\Containers\FString) & EventID, const FRequestEventDataCallback & Delegate )


code: void RequestEventData_Internal ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & EventId, const int32 UserIndex, const FRequestEventDataCallback & Delegate )


code: virtual void RequestEventData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & EventID, const FRequestEventDataCallback & Delegate )


code: virtual void RequestEventData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & EventId, const int32 UserIndex, const FRequestEventDataCallback & Delegate )


code: virtual void RequestEventGroupData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const FRequestEventGroupDataCallback & Delegate )


code: virtual void RequestEventGroupData ( const [FString](API\Runtime\Core\Containers\FString) & Group, const FRequestEventGroupDataCallback & Delegate )


code: virtual void RequestEventGroupData ( const [FString](API\Runtime\Core\Containers\FString) & ReplayName, const [FString](API\Runtime\Core\Containers\FString) & Group, const int32 UserIndex, const FRequestEventGroupDataCallback & Delegate )


code: virtual void SearchEvents ( const [FString](API\Runtime\Core\Containers\FString) & EventGroup, const FSearchEventsCallback & Delegate )


description: Changes the base directory where Demos are stored. Note, this will always fail for streamers that don't support replays stored on disk. This method should not be called after StartStreaming, or while async operations are pending on a streamer.

code: virtual EStreamingOperationResult SetDemoPath ( const [FString](API\Runtime\Core\Containers\FString) & DemoPath )


description: Deprecated* No longer used

code: PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid SetLastError ( const ENetworkReplayError::Type InLastError )


code: void SetLastError ( [FLocalFileReplayResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult) && Result )


description: INetworkReplayStreamerimplementation

code: virtual void StartStreaming ( const [FStartStreamingParameters](API\Runtime\NetworkReplayStreaming\FStartStreamingParameters) & Params, const FStartStreamingCallback & Delegate )


description: Sets a hint for how much data needs to be kept in memory. If set to a value greater than zero, a streamer implementation may free any in-memory data that would be required to go to a time before the beginning of the buffer.

code: virtual void SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds )


code: virtual bool SupportsCompression() const


code: virtual void StopStreaming()


code: virtual void SetHighPriorityTimeRange ( const uint32 StartTimeInMS, const uint32 EndTimeInMS )


code: void Tick ( float DeltaSeconds )


code: virtual bool SupportsEncryption() const


code: void UpdateCurrentReplayInfo ( [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & ReplayInfo, EUpdateReplayInfoFlags UpdateFlags )


code: virtual void UpdatePlaybackTime ( uint32 TimeInMS )


code: virtual void UpdateTotalDemoTime ( uint32 TimeInMS )


code: void WriteHeader()


code: bool WriteReplayInfo ( const [FString](API\Runtime\Core\Containers\FString) & StreamName, const [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & ReplayInfo )


code: bool WriteReplayInfo ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive, const [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & ReplayInfo )


code: bool WriteReplayInfo ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive, const [FLocalFileReplayInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileReplayInfo) & InReplayInfo, struct [FLocalFileSerializationInfo](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileNetworkReplayStreamer\FLocalFileSerial-) & SerializationInfo )


code: FLocalFileNetworkReplayStreamer()


code: FLocalFileNetworkReplayStreamer ( const [FString](API\Runtime\Core\Containers\FString) & InDemoSavePath )


className: FLocalFileNetworkReplayStreamer

description: Local file streamer that supports playback/recording to a single file on disk

code: class FLocalFileNetworkReplayStreamer : public [INetworkReplayStreamer](API\Runtime\NetworkReplayStreaming\INetworkReplayStreamer), public [TSharedFromThis< FLocalFileNetworkReplayStreamer >](API\Runtime\Core\Templates\TSharedFromThis)

ActiveRequest

type: TSharedPtr<FQu...

bCacheFileReadsInMemory

type: bool

CheckpointAr

type: FLocalFileStrea...

description: Handle to the archive that will read/write checkpoint files

CurrentReplayInfo

type: FLocalFileRepla...

description: Currently playing or recording replay metadata

CurrentStreamName

description: Remember the name of the current stream, if any.

DeltaCheckpointCache

type: TMap< int32,TS...

description: Map of checkpoint index to cached value

FileContentsCache

type: TMap<FString, ...

HeaderAr

description: Handle to the archive that will read/write the demo header

RequestCache

description: Map of chunk index to cached value

StreamAr

description: Handle to the archive that will read/write network packets

StreamerState

type: EReplayStreamer...

description: Overall state of the streamer

StreamTimeRange

type: TInterval< uint...


className: Guid

description: The GUID for this custom version number.

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) Guid = FGuid(0x95A4f03E, 0x7E0B49E4, 0xBA43D356, 0x94FF87D9);


code: FLocalFileReplayCustomVersion()


className: Type

code: enum Type { BeforeCustomVersionWasAdded = 0, FixedSizeFriendlyName = 1, CompressionSupport = 2, RecordingTimestamp = 3, StreamChunkTimes = 4, FriendlyNameCharEncoding = 5, EncryptionSupport = 6, CustomVersions = 7, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FLocalFileReplayCustomVersion

code: struct FLocalFileReplayCustomVersion


code: FLocalFileReplayDataInfo()


code: void CountBytes ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) const


code: FLocalFileReplayInfo()


className: FLocalFileReplayDataInfo

description: Struct to hold replay data chunk metadata

code: struct FLocalFileReplayDataInfo


className: FLocalFileReplayInfo

description: Struct to hold metadata about an entire replay

code: struct FLocalFileReplayInfo

Checkpoints

type: TArray<FLocalF...

Timestamp

type: FDateTime


description: Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

code: virtual bool AtEnd()


code: [FLocalFileStreamFArchive](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileStreamFArchive) & operator= ( const [FLocalFileStreamFArchive](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileStreamFArchive) & )


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


code: virtual void Serialize ( void * V, int64 Length )


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


code: int64 Tell() const


description: Resets all of the base archive members.

code: virtual void Reset()


code: int64 TotalSize() const


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


code: FLocalFileStreamFArchive ( const [FLocalFileStreamFArchive](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileStreamFArchive) & )


className: FLocalFileStreamFArchive

description: Archive to wrap the file reader and respect chunk boundaries

code: class FLocalFileStreamFArchive : public [FArchive](API\Runtime\Core\Serialization\FArchive)


code: void CancelRequest()


code: virtual bool GetCachedRequest()


code: void FinishRequest()


code: void IssueRequest()


code: FQueuedLocalFileRequest ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocalFileNetworkReplayStreamer](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileNetworkReplayStreamer) > & InStreamer, [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) InType )


className: FQueuedLocalFileRequest

code: class FQueuedLocalFileRequest

bCancelled

type: FThreadSafeBool

RequestType

type: EQueuedLocalFil...

Streamer

type: TSharedPtr<FLo...


code: virtual ~FQueuedLocalFileRequest()


className: TGenericCachedLocalFileRequest

code: template<typename DelegateResultType> class TGenericCachedLocalFileRequest : public [TGenericQueuedLocalFileRequest< TLocalFileRequestCommonData< DelegateResultType > >](API\Runtime\LocalFileNetworkReplayStreaming\TGenericQueuedLocalFileRequest)


code: TGenericCachedLocalFileRequest ( int32 InCacheKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocalFileNetworkReplayStreamer](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileNetworkReplayStreamer) > & InStreamer, [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) InType, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TLocalFileRequestCommonData](API\Runtime\LocalFileNetworkReplayStreaming\TLocalFileRequestCommonData)< DelegateResultType > &)> && InCompletionCallback )


code: virtual void FinishRequest()


className: TGenericQueuedLocalFileRequest

code: template<typename StorageType> class TGenericQueuedLocalFileRequest : public [FQueuedLocalFileRequest](API\Runtime\LocalFileNetworkReplayStreaming\FQueuedLocalFileRequest), public [TSharedFromThis< TGenericQueuedLocalFileRequest< StorageType >, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

CompletionCallback

type: TFunction< void...

Storage

type: StorageType


code: virtual void IssueRequest()


code: TGenericQueuedLocalFileRequest ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocalFileNetworkReplayStreamer](API\Runtime\LocalFileNetworkReplayStreaming\FLocalFileNetworkReplayStreamer) > & InStreamer, [EQueuedLocalFileRequestType::Type](API\Runtime\LocalFileNetworkReplayStreaming\EQueuedLocalFileRequestType__Typ-) InType, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(StorageType &)> && InFunction, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(StorageType &)> && InCompletionCallback )


code: void DoTask ( [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) CurrentThread, const FGraphEventRef & MyCompletionGraphEvent )


code: [TFuture](API\Runtime\Core\Async\TFuture)< ResultType > GetFuture()


code: TLocalFileAsyncGraphTask ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< ResultType()> && InFunction, [TPromise](API\Runtime\Core\Async\TPromise)< ResultType > && InPromise )


className: TLocalFileAsyncGraphTask

code: template<typename ResultType> class TLocalFileAsyncGraphTask : public [FAsyncGraphTaskBase](API\Runtime\Core\Async\FAsyncGraphTaskBase)


className: TLocalFileRequestCommonData

code: template<typename DelegateResultType> class TLocalFileRequestCommonData

AsyncError

type: ELocalFileRepla...

DataBuffer

type: TArray< uint8 >

DelegateResult

type: DelegateResultT...


code: namespace UE { namespace Net { void UE::Net::AddToChainResultPtr ( [TPimplPtr](API\Runtime\Core\Templates\TPimplPtr)< [FNetResult](API\Runtime\NetCore\Net\Core\Connection\FNetResult), EPimplPtrMode::DeepCopy > & ResultPtr, [TNetResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult)< ELocalFileReplayResult > && Result ) } }


code: namespace UE { namespace Net { [FNetResult](API\Runtime\NetCore\Net\Core\Connection\FNetResult) UE::Net::AddToAndConsumeChainResultPtr ( [TPimplPtr](API\Runtime\Core\Templates\TPimplPtr)< [FNetResult](API\Runtime\NetCore\Net\Core\Connection\FNetResult), EPimplPtrMode::DeepCopy > & ResultPtr, [TNetResult](API\Runtime\NetCore\Net\Core\Connection\TNetResult)< ELocalFileReplayResult > && Result ) } }


module: MaterialShaderQualitySettings

code: bool CanOverride ( EShaderPlatform ShaderPlatform ) const


code: bool HasAnyOverridesSet() const


code: FMaterialQualityOverrides()


className: FMaterialQualityOverrides

description: FMaterialQualityOverridesrepresents the full set of possible material overrides per quality level.

code: struct FMaterialQualityOverrides

bDisableMaterialNormalCalculation

type: bool

MobileShadowQuality

type: EMobileShadowQu...


description: Called when details should be customized

code: virtual void CustomizeDetails ( [IDetailLayoutBuilder](API\Editor\PropertyEditor\IDetailLayoutBuilder) & DetailBuilder )


description: Makes a new instance of this detail layout class for a specific detail view requesting it.

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IDetailCustomization](API\Editor\PropertyEditor\IDetailCustomization) > MakeInstance ( const FOnUpdateMaterialShaderQuality InUpdateMaterials )


code: FMaterialShaderQualitySettingsCustomization ( const FOnUpdateMaterialShaderQuality InUpdateMaterials )


code: class FMaterialShaderQualitySettingsCustomization : public [IDetailCustomization](API\Editor\PropertyEditor\IDetailCustomization)


code: const [FName](API\Runtime\Core\UObject\FName) & GetPreviewPlatform()


code: [UShaderPlatformQualitySettings](API\Runtime\MaterialShaderQualitySettings\UShaderPlatformQualitySettings) * GetShaderPlatformQualitySettings ( [FName](API\Runtime\Core\UObject\FName) PlatformName )


code: const [UShaderPlatformQualitySettings](API\Runtime\MaterialShaderQualitySettings\UShaderPlatformQualitySettings) * GetShaderPlatformQualitySettings ( EShaderPlatform ShaderPlatform )


code: bool HasPlatformQualitySettings ( EShaderPlatform ShaderPlatform, [EMaterialQualityLevel::Type](API\Runtime\Engine\EMaterialQualityLevel__Type) QualityLevel )


className: RenderQualitySingleton

code: static class [UMaterialShaderQualitySettings](API\Runtime\MaterialShaderQualitySettings\UMaterialShaderQualitySettings) * RenderQualitySingleton = nullptr;


description: OverrideGetShaderPlatformQualitySettings()return value with the specified platform's settings. An empty PlatformName or otherwise non existent platform will causeGetShaderPlatformQualitySettings()to revert to its default behaviour.

code: void SetPreviewPlatform ( [FName](API\Runtime\Core\UObject\FName) PlatformName )


code: UMaterialShaderQualitySettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UMaterialShaderQualitySettings

description: UCLASS(config = Engine, defaultconfig)

code: class UMaterialShaderQualitySettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: void BuildHash ( [EMaterialQualityLevel::Type](API\Runtime\Engine\EMaterialQualityLevel__Type) QualityLevel, class [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & OutHash ) const


description: Returns the override config hierarchy platform (if NDAd platforms need defaults to not be in Base*.ini but still want editor to load them)

code: virtual const TCHAR * GetConfigOverridePlatform() const


code: void AppendToHashState ( [EMaterialQualityLevel::Type](API\Runtime\Engine\EMaterialQualityLevel__Type) QualityLevel, class [FSHA1](API\Runtime\Core\Misc\FSHA1) & HashState ) const


code: const [FMaterialQualityOverrides](API\Runtime\MaterialShaderQualitySettings\FMaterialQualityOverrides) & GetQualityOverrides ( [EMaterialQualityLevel::Type](API\Runtime\Engine\EMaterialQualityLevel__Type) QualityLevel ) const


className: UShaderPlatformQualitySettings

code: class UShaderPlatformQualitySettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

ConfigPlatformName

type: FString

QualityOverrides

type: FMaterialQualit...


code: UShaderPlatformQualitySettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: FMediaCaptureDeviceInfo

description: Information about a capture device.

module: Media

code: struct FMediaCaptureDeviceInfo

DisplayName

type: FText

description: Human readable display name.

Info

description: Device specific debug information.

Type

type: EMediaCaptureDe...

description: The type of capture device.

Url

description: Media URL string for use with media players.


className: FMediaAudioTrackFormat

description: Audio track format details.

code: struct FMediaAudioTrackFormat

BitsPerSample

description: Number of bits per sample.

NumChannels

description: Number of audio channels.

SampleRate

description: Sample rate (in samples per second).

TypeName

description: Name of the format type.


code: [FMaterialQualityOverrides](API\Runtime\MaterialShaderQualitySettings\FMaterialQualityOverrides) & GetQualityOverrides ( [EMaterialQualityLevel::Type](API\Runtime\Engine\EMaterialQualityLevel__Type) QualityLevel )


className: FMediaTextureTilingDescription

description: Description of how the media texture sample is tiled (only used by tiled image sequences currently).

code: struct FMediaTextureTilingDescription

TileNum

type: FIntPoint


code: bool operator!= ( const [FMediaTileCoordinate](API\Runtime\Media\FMediaTileCoordinate) & Other ) const


code: bool operator== ( const [FMediaTileCoordinate](API\Runtime\Media\FMediaTileCoordinate) & Other ) const


code: FMediaTileCoordinate ( uint16 InX, uint16 InY )


code: FMediaTileCoordinate ( int32 InX, int32 InY )


code: FMediaTileCoordinate ( EForceInit )


code: static int64 AdjustSecondaryIndex ( int64 InSequenceIndex, int32 Add )


code: static int64 AdjustPrimaryIndex ( int64 InSequenceIndex, int32 Add )


className: FMediaTileCoordinate

description: Tile coordinate of a tiled media source/texture.

code: struct FMediaTileCoordinate


code: static int32 GetPrimaryIndex ( int64 InSequenceIndex )


code: static int32 GetSecondaryIndex ( int64 InSequenceIndex )


code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) operator+ ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other ) const


code: static int64 MakeSequenceIndex ( int32 PrimaryIndex, int32 SecondaryIndex )


code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & operator+= ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other )


code: bool operator== ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other ) const


code: bool operator> ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other ) const


code: bool operator>= ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other ) const


code: bool operator< ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other ) const


code: bool operator<= ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other ) const


code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) operator- ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other ) const


code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) operator- ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other ) const


code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & operator-= ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other )


code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & operator-= ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & Other )


className: FMediaTimeStamp

description: All comparison operators of this class will operate to indicate ordering relative to playback, not position on the timeline!

code: class FMediaTimeStamp

Time

type: FTimespan


code: FMediaTimeStamp ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InTime, int64 InSequenceIndex )


code: FMediaTimeStamp ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InTime )


code: FMediaTimeStampSample ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & InTimeStamp, double InSampledAtTime )


className: FMediaTimeStampSample

code: class FMediaTimeStampSample

SampledAtTime

type: double

TimeStamp

type: FMediaTimeStamp


className: FMediaVideoTrackFormat

description: Video track format details.

code: struct FMediaVideoTrackFormat

Dim

description: Width and height of the video (in pixels).

FrameRate

type: float

description: Active frame rate (in frames per second).

FrameRates

type: TRange< float >

description: Supported frame rate range.

TypeName

description: Name of the format type.


description: GetTime

code: const void * GetBuffer()


description: GetTime


description: GetTime

code: uint32 GetChannels() const


description: GetTime

code: uint32 GetFrames() const


description: GetSampleRate


description: GetTime

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FTimecode](API\Runtime\Core\Misc\FTimecode) > GetTimecode() const


description: GetTime

code: uint32 GetSampleRate() const


description: Virtual destructor.

code: virtual ~IMediaAudioSample()


className: IMediaAudioSample

description: Interface for media audio samples.

code: class IMediaAudioSample


description: GetTime

code: const void * GetData()


description: Get the GUID identifying the derived type that may implement additional, type specific methods. If the GUID matches a type known type it is safe to static cast this class to the derived type. This is usually done to identify the format of the binary data carried here.

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetGUID() const


description: GetTime

code: uint32 GetSize() const


description: Virtual destructor.

code: virtual ~IMediaBinarySample()


className: IMediaBinarySample

description: Interface for media binary data samples.

code: class IMediaBinarySample


description:
Query the number of samples for the specified caching state.
Sample count.

code: virtual int32 GetSampleCount ( EMediaCacheState State ) const


description:
This method can be used to probe a media player's decoder for which samples are scheduled for loading, being loaded, or finished loading. This is generally only supported by those players that expose some kind of internal sample caching or load/decode scheduling mechanism, and most players may simply ignore this call.
true on success, false if not supported.

code: virtual bool QueryCacheState ( EMediaCacheState State, [TRangeSet](API\Runtime\Core\Math\TRangeSet)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > & OutTimeRanges ) const


description: Virtual destructor.

code: virtual ~IMediaCache()


className: IMediaCache

description: IMediaView

code: class IMediaCache


description: EnumerateVideoCaptureDevices

code: void EnumerateAudioCaptureDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [FMediaCaptureDeviceInfo](API\Runtime\Media\FMediaCaptureDeviceInfo) > & OutDeviceInfos )


description: EnumerateAudioCaptureDevices

code: void EnumerateVideoCaptureDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [FMediaCaptureDeviceInfo](API\Runtime\Media\FMediaCaptureDeviceInfo) > & OutDeviceInfos )


description: Virtual destructor.

code: virtual ~IMediaCaptureSupport()


className: IMediaCaptureSupport

description: Interface for media capture support classes.

code: class IMediaCaptureSupport


description: RemoveSink

code: void AddSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaClockSink](API\Runtime\Media\IMediaClockSink), ESPMode::ThreadSafe > & Sink )


description: IsTimecodeLocked


description: GetTimecode

code: bool IsTimecodeLocked() const


description: Virtual destructor.

code: virtual ~IMediaClock()


description: AddSink

code: void RemoveSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaClockSink](API\Runtime\Media\IMediaClockSink), ESPMode::ThreadSafe > & Sink )


className: IMediaClock

description: Interface for media framework clocks.

code: class IMediaClock


description: TickRender

code: virtual void TickFetch ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: TickRender

code: virtual void TickInput ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: TickRender

code: virtual void TickOutput ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: TickOutput

code: virtual void TickRender ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: Virtual destructor.

code: virtual ~IMediaClockSink()


className: IMediaClockSink

description: TickOutput Called each tick from the main thread after the Engine has been ticked and the frame finished rendering. It can be used by output plug-ins to write the completed frame to disk or stream it over the network.

code: class IMediaClockSink


description:
Whether the specified control is currently available.
true if the control is available, false otherwise.

code: bool CanControl ( EMediaControl Control ) const


description: GetTime


description: SetRate

code: float GetRate() const


description: IsLooping

code: EMediaState GetState() const


description:
Get media player status flags.
Status flags.

code: EMediaStatus GetStatus() const


description: Seek


description: SupportsRate

code: [TRangeSet](API\Runtime\Core\Math\TRangeSet)< float > GetSupportedRates ( EMediaRateThinning Thinning ) const


description: SetLooping

code: bool IsLooping() const


description: Stop

code: bool Pause()


description: Stop

code: bool Play()


description: GetTime

code: bool Seek ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Time )


description: GetTime

code: bool Seek ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & TimeOffset, EMediaSeekDirection Direction )


description: Implement as needed by the player.

code: virtual void SetBlockingPlaybackHint ( bool bFacadeWillUseBlockingPlayback )


description: Play

code: bool SetRate ( float Rate )


description: IsLooping

code: bool SetLooping ( bool Looping )


className: IMediaControls

description: IMediaView

code: class IMediaControls


description: Implementors must be thread-safe as this method may be called from arbitrary worker threads.

code: void ReceiveMediaEvent ( EMediaEvent Event )


className: IMediaEventSink

description: Interface for classes that receive media player events.

code: class IMediaEventSink


description: Virtual destructor.

code: virtual ~IMediaControls()


description: Virtual destructor.

code: virtual ~IMediaEventSink()


description: Language this item is described in. This should a three letter ISO 639-2 code. If no language is specified this item is intended to be used when no other item exists in the user's preferred language.

code: const [FString](API\Runtime\Core\Containers\FString) & GetLanguageCode() const


description: The value of the metadata item.

code: const [FVariant](API\Runtime\Core\Misc\FVariant) & GetValue() const


className: IMediaMetadataItem

description: This structure describes a metadata item.

code: class IMediaMetadataItem


description: Get new media player instance ID

code: uint64 CreateMediaPlayerInstanceID()


description: LockToTimecode


description: UnregisterCaptureDevices

code: const [TArray](API\Runtime\Core\Containers\TArray)< [IMediaCaptureSupport](API\Runtime\Media\IMediaCaptureSupport) * > & GetCaptureSupports() const


description: Get frame's processing approximate real time start time in seconds

code: double GetFrameStartTime() const


description:
Get a Delegate that is trigger once all MediaClockSink are TickInput
the OnTickPreEngineCompleted


description: Get a nice platform name from a GUID

code: [FName](API\Runtime\Core\UObject\FName) GetPlatformName ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PlatformGuid ) const


description: Optional mime type of the item described by Value. This should be set when Value is of type EVariantTypes::ByteArray For example, if this item is a binary JPEG image the mime type should be set as "image/jpeg" to identify the type of the payload.

code: const [FString](API\Runtime\Core\Containers\FString) & GetMimeType() const


description: Get a GUID from a nice platform name

code: [FGuid](API\Runtime\Core\Misc\FGuid) GetPlatformGuid ( const [FName](API\Runtime\Core\UObject\FName) & PlatformName ) const


description: UnregisterPlayerFactory

code: const [TArray](API\Runtime\Core\Containers\TArray)< [IMediaPlayerFactory](API\Runtime\Media\IMediaPlayerFactory) * > & GetPlayerFactories() const


description: UnregisterPlayerFactory

code: [IMediaPlayerFactory](API\Runtime\Media\IMediaPlayerFactory) * GetPlayerFactory ( const [FName](API\Runtime\Core\UObject\FName) & FactoryName ) const


description: UnregisterPlayerFactory

code: [IMediaPlayerFactory](API\Runtime\Media\IMediaPlayerFactory) * GetPlayerFactory ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PlayerPluginGuid ) const


description: Get player lifetime delegate


description: GetClock


description:
Get the time source for the media clock.
The current time source.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTimeSource](API\Runtime\Media\IMediaTimeSource), ESPMode::ThreadSafe > GetTimeSource()


description: GetClock

code: void LockToTimecode ( bool Locked )


description: UnregisterCaptureDevices

code: void RegisterCaptureSupport ( [IMediaCaptureSupport](API\Runtime\Media\IMediaCaptureSupport) & Support )


description: UnregisterPlayerFactory

code: void RegisterPlayerFactory ( [IMediaPlayerFactory](API\Runtime\Media\IMediaPlayerFactory) & Factory )


description: Set the time source for the media clock.

code: void SetTimeSource ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTimeSource](API\Runtime\Media\IMediaTimeSource), ESPMode::ThreadSafe > & NewTimeSource )


description: Set player lifetime delegate

code: void SetPlayerLifecycleManagerDelegate ( [IMediaPlayerLifecycleManagerDelegate](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-) * Delegate )


description: TickPreSlate

code: void TickPostEngine()


description: TickPreSlate

code: void TickPreEngine()


description: TickPreSlate

code: void TickPostRender()


description: TickPreEngine

code: void TickPreSlate()


description: RegisterPlayerFactory

code: void UnregisterPlayerFactory ( [IMediaPlayerFactory](API\Runtime\Media\IMediaPlayerFactory) & Factory )


description: Virtual destructor.

code: virtual ~IMediaModule()


className: IMediaModule

description: Finally, the Output tick happens after all game and core ticking completed, and after all render commands have been enqueued. It is the very last thing to happen before the frame is complete.

code: class IMediaModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: virtual &126;FDataContainer&40;&41;


className: FDataContainer

code: class FDataContainer : public [TSharedFromThis< FDataContainer, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description:
Get the name of the desired native player.
Native player name, or NAME_None to auto select.


description:
Get a Boolean media option.
The option value.

code: bool GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, bool DefaultValue ) const


description: RegisterCaptureDevices

code: void UnregisterCaptureSupport ( [IMediaCaptureSupport](API\Runtime\Media\IMediaCaptureSupport) & Support )


description:
Get a double precision floating point media option.
The option value.

code: double GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, double DefaultValue ) const


description:
Get a string media option.
The option value.

code: [FString](API\Runtime\Core\Containers\FString) GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FString](API\Runtime\Core\Containers\FString) & DefaultValue ) const


description:
Get a complex data type media option.
The option value.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDataContainer](API\Runtime\Media\IMediaOptions\FDataContainer), ESPMode::ThreadSafe > GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDataContainer](API\Runtime\Media\IMediaOptions\FDataContainer), ESPMode::ThreadSafe > & DefaultValue ) const


description:
Get a signed integer media option.
The option value.

code: int64 GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, int64 DefaultValue ) const


description:
Get a localized text media option.
The option value.

code: [FText](API\Runtime\Core\Internationalization\FText) GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FText](API\Runtime\Core\Internationalization\FText) & DefaultValue ) const


description:
Check whether the specified option is set.
true if the option is set, false otherwise.

code: bool HasMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const


className: IMediaOptions

description: Interface for media options.

code: class IMediaOptions


description:
Get the amount of time for which the sample should be displayed.
Sample duration.


description: Get the GUID identifying the derived type that may implement additional, type specific methods. If the GUID matches a type known type it is safe to static cast this class to the derived type.

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetGUID() const


description: GetText

code: [TOptional](API\Runtime\Core\IO\TOptional)< FVector2D > GetPosition() const


description: GetType


description:
This value is used primarily for debugging purposes.
Sample time.


description: GetTime

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FTimecode](API\Runtime\Core\Misc\FTimecode) > GetTimecode() const


description: GetText

code: EMediaOverlaySampleType GetType() const


description: Virtual destructor.

code: virtual ~IMediaOverlaySample()


className: IMediaOverlaySample

description: Interface for media overlay text samples.

code: class IMediaOverlaySample


description: Open

code: void Close()


className: EFeatureFlag

code: enum EFeatureFlag { AllowShutdownOnClose = 0, UsePlaybackTimingV2, UseRealtimeWithVideoOnly, AlwaysPullNewestVideoFrame, PlayerUsesInternalFlushOnSeek, IsTrackSwitchSeamless, }


description:
Flush sinks when seek ends
true if sinks should be flushed when a seek finishes

code: virtual bool FlushOnSeekCompleted() const


description:
Flush sinks when seek begins
true if sinks should be flushed when a seek starts

code: virtual bool FlushOnSeekStarted() const


description: GetView


description: GetStats


description: Metadata may change over time. Its presence or change is reported by a MetadataChanged event.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [TArray](API\Runtime\Core\Containers\TArray)< [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IMediaMetadataItem](API\Runtime\Media\IMediaMetadataItem) > > >, ESPMode::ThreadSafe > GetMediaMetadata() const


description: UMediaPlayer::GetMediaInfo.

code: virtual [FVariant](API\Runtime\Core\Misc\FVariant) GetMediaInfo ( [FName](API\Runtime\Core\UObject\FName) InfoName ) const


description: GetUrl

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetMediaName() const


description: Return IMediaPlayerLifecycleManagerDelegate::ResourceFlags bitmask to indicate resource types recreated on a open call

code: virtual uint32 GetNewResourcesOnOpen() const


code: virtual bool GetPlayerFeatureFlag ( [EFeatureFlag](API\Runtime\Media\IMediaPlayer\EFeatureFlag) ) const


description: GetPlayerName


description: GetInfo


description:
Get the URL of the currently loaded media.
Media URL.


code: void Signal &40; uint32 ResourceFlags &41;


description: GetTracks


className: IAsyncResourceReleaseNotificationRef


className: IAsyncResourceReleaseNotification

code: class IAsyncResourceReleaseNotification


description: OnOpenFailed

code: bool Open ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [IMediaOptions](API\Runtime\Media\IMediaOptions) * Options )


description: OnOpenFailed

code: bool Open ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchive](API\Runtime\Core\Serialization\FArchive), ESPMode::ThreadSafe > & Archive, const [FString](API\Runtime\Core\Containers\FString) & OriginalUrl, const [IMediaOptions](API\Runtime\Media\IMediaOptions) * Options )


description: Open a media source from a URL with optional asset and player parameters.

code: virtual bool Open ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [IMediaOptions](API\Runtime\Media\IMediaOptions) * Options, const [FMediaPlayerOptions](API\Runtime\MediaUtils\FMediaPlayerOptions) * PlayerOptions )


description: Any extra processing that the player should do when FMediaPlayerFacade::ProcessVideoSamples is run should be put here.

code: virtual void ProcessVideoSamples()


description: Set async resource release notification for use withIMediaPlayerLifecycleManagerDelegate

code: virtual bool SetAsyncResourceReleaseNotification ( [IAsyncResourceReleaseNotificationRef](API\Runtime\Media\IMediaPlayer\IAsyncResourceReleaseNotificatio-) AsyncDestructNotification )


description: Set the player's globally unique identifier.

code: virtual void SetGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Guid )


description: Notify player of last sample time of audio used.

code: virtual void SetLastAudioRenderedSampleTime ( [FTimespan](API\Runtime\Core\Misc\FTimespan) SampleTime )


description:
Set the player's native volume if supported.
true on success, false otherwise.

code: virtual bool SetNativeVolume ( float Volume )


description: TickFetch

code: virtual void TickAudio()


description: TickInput

code: virtual void TickFetch ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: TickFetch

code: virtual void TickInput ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: Virtual destructor.

code: virtual ~IMediaPlayer()


className: IMediaPlayer

description: IMediaPlayerFactory

code: class IMediaPlayer


description:
Whether the player can play the specified source URL.
true if the source can be played, false otherwise.

code: bool CanPlayUrl ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [IMediaOptions](API\Runtime\Media\IMediaOptions) * Options ) const


code: bool CanPlayUrl ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [IMediaOptions](API\Runtime\Media\IMediaOptions) * Options, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > * OutWarnings, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > * OutErrors ) const


description:
Creates a media player.
A new media player, or nullptr if a player couldn't be created.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaPlayer](API\Runtime\Media\IMediaPlayer), ESPMode::ThreadSafe > CreatePlayer ( [IMediaEventSink](API\Runtime\Media\IMediaEventSink) & EventSink )


description: GetName


description: GetDisplayName


description: GetPlayerName


description:
Check whether the media player supports the specified feature.
true if the feature is supported, false otherwise.

code: bool SupportsFeature ( EMediaFeature Feature ) const


description: GetSupportedUriSchemes

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetSupportedPlatforms() const


description: GetSupportedPlatforms

code: bool SupportsPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName ) const


description: Virtual destructor.

code: virtual ~IMediaPlayerFactory()


code: virtual bool CanReceiveAudioSamples ( uint32 Num ) const


code: virtual bool CanReceiveCaptionSamples ( uint32 Num ) const


className: IMediaPlayerFactory

description: IMediaPlayer

code: class IMediaPlayerFactory


code: virtual bool CanReceiveSubtitleSamples ( uint32 Num ) const


code: virtual bool CanReceiveVideoSamples ( uint32 Num ) const


code: virtual bool DiscardAudioSamples ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, bool bReverse )


code: virtual bool DiscardMetadataSamples ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, bool bReverse )


code: virtual bool DiscardCaptionSamples ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, bool bReverse )


code: virtual bool DiscardSubtitleSamples ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, bool bReverse )


code: virtual bool CanReceiveMetadataSamples ( uint32 Num ) const


code: virtual bool DiscardVideoSamples ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, bool bReverse )


description: FetchVideo

code: virtual bool FetchAudio ( [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaAudioSample](API\Runtime\Media\IMediaAudioSample), ESPMode::ThreadSafe > & OutSample )


className: EFetchBestSampleResult

code: enum EFetchBestSampleResult { Ok = 0, NoSample, NotSupported, }


code: virtual bool FetchAudio ( [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaAudioSample](API\Runtime\Media\IMediaAudioSample), ESPMode::ThreadSafe > & OutSample )


code: virtual [EFetchBestSampleResult](API\Runtime\Media\IMediaSamples\EFetchBestSampleResult) FetchBestVideoSampleForTimeRange ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > & OutSample, bool bReverse )


description: FetchVideo

code: virtual bool FetchCaption ( [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe > & OutSample )


code: virtual bool FetchCaption ( [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe > & OutSample )


code: virtual bool FetchMetadata ( [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaBinarySample](API\Runtime\Media\IMediaBinarySample), ESPMode::ThreadSafe > & OutSample )


description: FetchVideo

code: virtual bool FetchMetadata ( [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaBinarySample](API\Runtime\Media\IMediaBinarySample), ESPMode::ThreadSafe > & OutSample )


description: FetchVideo

code: virtual bool FetchSubtitle ( [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe > & OutSample )


code: virtual bool FetchSubtitle ( [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe > & OutSample )


description: FetchSubtitle

code: virtual bool FetchVideo ( [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > & OutSample )


code: virtual bool FetchVideo ( [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > & OutSample )


description: Discard any outstanding media samples.

code: virtual void FlushSamples()


code: virtual int32 NumSubtitleSamples() const


code: virtual int32 NumMetadataSamples() const


code: virtual int32 NumVideoSamples() const


code: bool PeekVideoSampleTime ( [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & TimeStamp )


code: virtual uint32 PurgeOutdatedCaptionSamples ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & ReferenceTime, bool bReversed, [FTimespan](API\Runtime\Core\Misc\FTimespan) MaxAge )


code: virtual uint32 PurgeOutdatedMetadataSamples ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & ReferenceTime, bool bReversed, [FTimespan](API\Runtime\Core\Misc\FTimespan) MaxAge )


code: virtual uint32 PurgeOutdatedSubtitleSamples ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & ReferenceTime, bool bReversed, [FTimespan](API\Runtime\Core\Misc\FTimespan) MaxAge )


code: virtual uint32 PurgeOutdatedVideoSamples ( const [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & ReferenceTime, bool bReversed, [FTimespan](API\Runtime\Core\Misc\FTimespan) MaxAge )


description: Virtual destructor.

code: virtual ~IMediaSamples()


className: IMediaSamples

description: IMediaView

code: class IMediaSamples


description:
Get pixel aspect ratio
Pixel aspect ratio

code: virtual double GetAspectRatio() const


description: GetTime

code: const void * GetBuffer()


description: GetTime

code: FIntPoint GetDim() const


code: virtual FVector2f GetDisplayPrimaryGreen() const


code: virtual FVector2f GetDisplayPrimaryBlue() const


description: GetTime


code: virtual FVector2f GetDisplayPrimaryRed() const


description: Get EOTF / "Gamma" / encoding type of data

code: virtual [UE::Color::EEncoding](API\Runtime\ColorManagement\UE__Color__EEncoding) GetEncodingType() const


description: Get full range color flag

code: virtual bool GetFullRange() const


description:
Get Colorspace conversion matrix to convert to CIE1931 XYZ space
Conversion Matrix

code: virtual FMatrix44f GetGamutToXYZMatrix() const


code: virtual float GetHDRNitsNormalizationFactor() const


description:
Default implementation provided as most samples will not feature mips
Number of mips in the sample (including base level)

code: virtual uint8 GetNumMips() const


description: For use with "external image" style output onlyFLinearColorwith xy = offset, zw must be zero

code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetOffset() const


description:
Get image orientation vs. physically returned image data
Image orientation

code: virtual EMediaOrientation GetOrientation() const


description:
Get complete 4x4 matrix to apply to the sample's pixels to yield RGB data in the sample's gamut
Conversion Matrix

code: virtual FMatrix44f GetSampleToRGBMatrix() const


description: GetTime

code: FIntPoint GetOutputDim() const


description: For use with "external image" style output only. UseGetOrientation()otherwiseFLinearColorwith xy = row 0 (dotted with U), zw = row 1 (dotted with V)

code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetScaleRotation() const


description: GetTime

code: uint32 GetStride() const


description:
Default implementation provided as most samples will not feature tiles
TileInfo struct

code: virtual [FMediaTextureTilingDescription](API\Runtime\Media\FMediaTextureTilingDescription) GetTilingDescription() const


description: GetTexture


description: GetTime

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FTimecode](API\Runtime\Core\Misc\FTimecode) > GetTimecode() const


description:
Get white point of color space of the data contain in the sample
White point

code: virtual FVector2f GetWhitePoint() const


description:
Non-cacheable video samples become invalid when the next sample is available, and only the latest sample should be kept by video sample consumers.
true if cacheable, false otherwise.

code: bool IsCacheable() const


description:
Default is equivalent to MediaShaders::YuvToRgbRec709Scaled Matrix. NOTE: previously in UE4 this was YuvToRgbRec601Scaled
Conversion Matrix

code: virtual const FMatrix & GetYUVToRGBMatrix() const


description:
Whether the output of the sample is in sRGB color space.
true if sRGB, false otherwise.

code: bool IsOutputSrgb() const


description: Reset sample to empty state

code: virtual void Reset()


className: IMediaTextureSample

description: Depending on the decoder, a frame's pixel data may be stored in a CPU memory buffer, or in an RHI texture resource (only available when compiling against the Engine). The media texture sample API supports both models via the GetBuffer and the GetTexture methods. Sample instances need to implement only one of these.

code: class IMediaTextureSample


description: Virtual destructor.

code: virtual ~IMediaTextureSample()


description:
Apply a color conversion on the input and store the result in the destination texture.
true If the color conversion was successfully applied.

code: bool ApplyColorConversion ( FTexture2DRHIRef & InSrcTexture, FTexture2DRHIRef & InDstTexture )


className: IMediaTextureSampleColorConverter

description: Interface class to implement custom sample color conversion

code: class IMediaTextureSampleColorConverter


code: bool Convert ( FTexture2DRHIRef & InDstTexture, const [FConversionHints](API\Runtime\Media\IMediaTextureSampleConverter\FConversionHints) & Hints )


className: EConverterInfoFlags

code: enum EConverterInfoFlags { ConverterInfoFlags_Default = 0, ConverterInfoFlags_WillCreateOutputTexture = 1 << 0, ConverterInfoFlags_PreprocessOnly = 1 << 1, ConverterInfoFlags_NeedUAVOutputTexture = 1 << 2, }


className: FConversionHints

code: struct FConversionHints


code: virtual ~IMediaTextureSampleConverter()


code: virtual uint32 GetConverterInfoFlags() const


className: IMediaTextureSampleConverter

description: Interface class to implement custom sample conversion

code: class IMediaTextureSampleConverter


description: Tick the object.

code: void TickTickable()


description: Virtual destructor.

code: virtual ~IMediaTickable()


description: UnregisterTickable

code: void AddTickable ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaTickable](API\Runtime\Media\IMediaTickable), ESPMode::ThreadSafe > & Tickable )


className: IMediaTickable

description: Interface for objects that can be ticked from the high-frequency media thread.

code: class IMediaTickable


description: RegisterTickable

code: void RemoveTickable ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaTickable](API\Runtime\Media\IMediaTickable), ESPMode::ThreadSafe > & Tickable )


description: Virtual destructor.

code: virtual ~IMediaTicker()


className: IMediaTicker

description: Interface for the high-frequency media ticker.

code: class IMediaTicker


description: Virtual destructor.

code: virtual ~IMediaTimeSource()


description:
Get the current time code.
Time code.


className: IMediaTimeSource

description: Interface for media clock time sources.

code: class IMediaTimeSource


description: GetVideoTrackFormat

code: bool GetAudioTrackFormat ( int32 TrackIndex, int32 FormatIndex, [FMediaAudioTrackFormat](API\Runtime\Media\FMediaAudioTrackFormat) & OutFormat ) const


description: SelectTrack

code: int32 GetNumTracks ( EMediaTrackType TrackType ) const


description: GetTrackDisplayName

code: int32 GetNumTrackFormats ( EMediaTrackType TrackType, int32 TrackIndex ) const


description: SelectTrack

code: int32 GetSelectedTrack ( EMediaTrackType TrackType ) const


description: GetTrackName

code: [FText](API\Runtime\Core\Internationalization\FText) GetTrackDisplayName ( EMediaTrackType TrackType, int32 TrackIndex ) const


description: SetTrackFormat

code: int32 GetTrackFormat ( EMediaTrackType TrackType, int32 TrackIndex ) const


description: GetTrackName

code: [FString](API\Runtime\Core\Containers\FString) GetTrackLanguage ( EMediaTrackType TrackType, int32 TrackIndex ) const


description: GetAudioTrackFormat

code: bool GetVideoTrackFormat ( int32 TrackIndex, int32 FormatIndex, [FMediaVideoTrackFormat](API\Runtime\Media\FMediaVideoTrackFormat) & OutFormat ) const


description: SetTrackFormat

code: bool SelectTrack ( EMediaTrackType TrackType, int32 TrackIndex )


description: SelectTrack

code: bool SetTrackFormat ( EMediaTrackType TrackType, int32 TrackIndex, int32 FormatIndex )


description: Virtual destructor.

code: virtual ~IMediaTracks()


description: SetTrackFormat

code: virtual bool SetVideoTrackFrameRate ( int32 TrackIndex, int32 FormatIndex, float FrameRate )


description: GetTrackLanguage

code: [FString](API\Runtime\Core\Containers\FString) GetTrackName ( EMediaTrackType TrackType, int32 TrackIndex ) const


className: IMediaTracks

description: IMediaView

code: class IMediaTracks


description: SetViewField

code: virtual bool GetViewField ( float & OutHorizontal, float & OutVertical ) const


description: SetViewOrientation

code: virtual bool GetViewOrientation ( FQuat & OutOrientation ) const


description: SetVisibleTiles

code: virtual bool GetVisibleTiles ( [TMap](API\Runtime\Core\Containers\TMap)< int32, [TSet](API\Runtime\Core\Containers\TSet)< [FMediaTileCoordinate](API\Runtime\Media\FMediaTileCoordinate) >> & OutTiles ) const


description:
Whether the view focus is enabled.
true if enabled, false otherwise.

code: virtual bool IsViewFocusEnabled() const


description:
Set the inter-ocular distance.
true on success, false otherwise.

code: virtual bool SetInteroccularDistance ( float Distance )


description: SetViewOrientation

code: virtual bool SetViewField ( float Horizontal, float Vertical, bool Absolute )


description: SetViewFocusOrientation

code: virtual bool SetViewFocusField ( float Horizontal, float Vertical )


description: SetViewFocusOrientation

code: virtual bool SetViewFocusEnabled ( bool Enabled )


description: SetViewField

code: virtual bool SetViewFocusOrientation ( const FQuat & Orientation )


description: SetViewField

code: virtual bool SetViewOrientation ( const FQuat & Orientation, bool Absolute )


description: SetViewFocusOrientation

code: virtual bool SetViewFocusOffImportance ( float Importance )


description: GetVisibleTiles

code: virtual bool SetVisibleTiles ( [TMap](API\Runtime\Core\Containers\TMap)< int32, [TSet](API\Runtime\Core\Containers\TSet)< [FMediaTileCoordinate](API\Runtime\Media\FMediaTileCoordinate) >> && InTiles )


description: Virtual destructor.

code: virtual ~IMediaView()


className: IMediaView

description: IMediaTracks

code: class IMediaView


className: FMediaMetadataItemsBPT

module: MediaAssets

code: struct FMediaMetadataItemsBPT

Items

type: TArray<FMediaM...


className: FMediaMetadataItemBPT

code: struct FMediaMetadataItemBPT


className: bWasAudioProxyClassImplemented

code: static constexpr bool bWasAudioProxyClassImplemented = true;


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaPlayerFacade](API\Runtime\MediaUtils\FMediaPlayerFacade), ESPMode::ThreadSafe > GetPlayerFacade() const


className: TIsPODType< FMediaTileCoordinate >

code: template<> struct TIsPODType< FMediaTileCoordinate >


code: FMediaPlayerProxy ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * Player )


code: FMediaPlayerProxy ( const [FMediaPlayerProxy](API\Runtime\MediaAssets\FMediaPlayerProxy) & Other )


className: FMediaPlayerProxy

description: Proxy implementation for Metasound integration

code: class FMediaPlayerProxy : public [Audio::TProxyData< FMediaPlayerProxy >](API\Runtime\AudioExtensions\TProxyData)


className: FMediaSoundComponentSpectralData

code: struct FMediaSoundComponentSpectralData

FrequencyHz

description: The frequency hz of the spectrum value.

Magnitude

description: The magnitude of the spectrum at this frequency.


className: FSoundGeneratorParams

code: struct FSoundGeneratorParams

FrequenciesToAnalyze

type: TArray< float >

SampleQueue

type: TSharedPtr<FMe...


code: float GetCurrentEnvelopeValue() const


description: Optional. Called on audio generator thread right when the generator ends generating.

code: virtual void OnEndGenerate()


description: Called when a new buffer is required.

code: virtual int32 OnGenerateAudio ( float * OutAudio, int32 NumSamples )


code: void SetCachedData ( float InCachedRate, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InCachedTime )


code: void SetEnableEnvelopeFollowing ( bool bInEnvelopeFollowingEnabled )


code: void SetEnableSpectralAnalysis ( bool bInSpectralAnlaysisEnabled )


code: void SetEnvelopeFollowingSettings ( int32 InAttackTimeMsec, int32 InReleaseTimeMsec )


code: void SetLastPlaySampleTime ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InLastPlaySampleTime )


code: void SetSampleQueue ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaAudioSampleQueue](API\Runtime\MediaUtils\FMediaAudioSampleQueue), ESPMode::ThreadSafe > & InSampleQueue )


code: void SetSpectrumAnalyzerSettings ( [Audio::FSpectrumAnalyzerSettings::EFFTSize](API\Runtime\SignalProcessing\DSP\FSpectrumAnalyzerSettings\EFFTSize) InFFTSize, const [TArray](API\Runtime\Core\Containers\TArray)< float > & InFrequenciesToAnalyze )


code: FMediaSoundGenerator ( [FSoundGeneratorParams](API\Runtime\MediaAssets\FMediaSoundGenerator\FSoundGeneratorParams) & InParams )


code: virtual ~FMediaSoundGenerator()


className: FMediaSoundGenerator

description: Class implements anISoundGeneratorto feed decoded audio to audio renderering async tasks.

code: class FMediaSoundGenerator : public [ISoundGenerator](API\Runtime\Engine\Sound\ISoundGenerator)


code: bool operator== ( const [FMediaSourceCacheSettings](API\Runtime\MediaAssets\FMediaSourceCacheSettings) & Other ) const


code: bool operator!= ( const [FMediaSourceCacheSettings](API\Runtime\MediaAssets\FMediaSourceCacheSettings) & Other ) const


description:
Access engine from here.
Engine.

code: static [FMediaTextureTracker](API\Runtime\MediaAssets\FMediaTextureTracker) & Get()


description:
Get which objects are usnig a specific media texture.
Nullptr if nothing found, or a pointer to an array of objects.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FMediaTextureTrackerObject](API\Runtime\MediaAssets\FMediaTextureTrackerObject), ESPMode::ThreadSafe > > * GetObjects ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) > InTexture ) const


className: FMediaSourceCacheSettings

description: Cache settings to pass to the player.

code: struct FMediaSourceCacheSettings

bOverride

description: Override the default cache settings. Currently only the ImgMedia player supports these settings.

TimeToLookAhead

description: The cache will fill up with frames that are up to this time from the current time.


description: @ return List of textures.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) > > & GetTextures()


description: Each object should call this for each media texture that the object has.

code: void RegisterTexture ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaTextureTrackerObject](API\Runtime\MediaAssets\FMediaTextureTrackerObject), ESPMode::ThreadSafe > & InInfo, [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) > InTexture )


code: virtual ~FMediaTextureTracker()


className: FMediaTextureTracker

description: Tracks which media textures are used by which objects.

code: class FMediaTextureTracker

MapTextureToObject

type: TMap<TWeakObje...

description: Maps a media texture to an array of playback components.

MediaTextures

type: TArray<TWeakOb...

description: Array of media textures that we know about.


className: FOnMediaPlayerMediaEvent

description: Multicast delegate that is invoked when a media event occurred in the player.

code: class FOnMediaPlayerMediaEvent


className: FOnMediaPlayerMediaOpened

description: Multicast delegate that is invoked when a media player's media has been opened.

code: class FOnMediaPlayerMediaOpened


className: FMediaTextureTrackerObject

description: Holds info on a single object.

code: struct FMediaTextureTrackerObject

MeshRange

description: Arc size in degrees used for visible tiles calculations, specific to the sphere.

MipLevelToUpscale

description: Mip level to upscale into lower quality mips.

MipMapLODBias

description: LOD bias for the mipmap level.

Object

type: TWeakObjectPtr<...

description: Actor that is using our img sequence.

VisibleMipsTilesCalculations

type: EMediaTextureVi...

description: Specify type of mesh used for visible mips and tiles calculations.


className: FOnMediaPlayerMediaOpenFailed

description: Multicast delegate that is invoked when a media player's media has failed to open.

code: class FOnMediaPlayerMediaOpenFailed