className: FMediaStateChangedDelegate

description: Delegate that reacts to change in Media state (Play, Stop, Pause etc.)

code: typedef TMulticastDelegate_ThreeParams< void, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &, uint8, bool > FMediaStateChangedDelegate


description: Creates an object that implementsIMediaSourceRendererInterface.

module: MediaAssets


description: Broadcasts the event to all subscribers. InActorsPathNames are the paths of selected Medias in the scene.

code: void BroadcastOnMediaStateChangedEvent ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InActorsPathNames, uint8 EnumState, bool bRemoteBroadcast )


className: FOnCreateMediaSourceRenderer

description: Delegate to create an object that implementsIMediaSourceRendererInterface.

code: typedef TBaseDelegate_NoParams< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > FOnCreateMediaSourceRenderer


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

code: void UnregisterTexture ( [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 )


className: FOnGetPlayerFromObject

description: Delegate to get a player from aUObject.

code: typedef TBaseDelegate_TwoParams< [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) *, [UObject](API\Runtime\CoreUObject\UObject\UObject) *, [UObject](API\Runtime\CoreUObject\UObject\UObject) *& > FOnGetPlayerFromObject


description:
The proxy object will implementIMediaPlayerProxyInterface.
Media player, or nullptr if none found.

code: [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * GetPlayerFromObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, [UObject](API\Runtime\CoreUObject\UObject\UObject) *& PlayerProxy )


description:
Plugins should call this so they can provide a function to get a media player from an object.
ID to pass in to UnregisterGetPlayerFromObject.

code: int32 RegisterGetPlayerFromObject ( const [FOnGetPlayerFromObject](API\Runtime\MediaAssets\IMediaAssetsModule\FOnGetPlayerFromObject) & Delegate )


description: Register a delegate to create an object that implementsIMediaSourceRendererInterface.

code: void RegisterCreateMediaSourceRenderer ( const [FOnCreateMediaSourceRenderer](API\Runtime\MediaAssets\IMediaAssetsModule\FOnCreateMediaSourceRenderer) & Delegate )


description: Subscribes to the event that is called whenever any of Media state changes (such as play button was pressed).

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterOnMediaStateChangedEvent ( FMediaStateChangedDelegate::FDelegate InStateChangedDelegate )


description: Unregisters the delegate passed in with RegisterCreateMediaSourceRenderer.


description: Call this to unregister a delegate.

code: void UnregisterGetPlayerFromObject ( int32 DelegateID )


description: Removes event handling.

code: void UnregisterOnMediaStateChangedEvent ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle )


description: Virtual destructor.

code: virtual ~IMediaAssetsModule()


className: IMediaAssetsModule

description: Interface for the MediaAssets module.

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


description: Get the desired playback rate. Note that this is not necessarily the actual rate of the player, merely the desired rate the user wants.

code: float GetProxyRate() const


description:
Call this to see if you can control the media player, or if the owning object is using it.
True if you can control the player.

code: bool IsExternalControlAllowed()


description: Get the media source for a given index.

code: [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * ProxyGetMediaSourceFromIndex ( int32 Index ) const


description: Get a media texture that we can assign a media player to.

code: [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) * ProxyGetMediaTexture ( int32 LayerIndex, int32 TextureIndex )


description: Gets the cache settings for the player.

code: const [FMediaSourceCacheSettings](API\Runtime\MediaAssets\FMediaSourceCacheSettings) & GetCacheSettings() const


description:
This should be called every frame until it returns true. It might take a few frames to discover what the aspect ratio is. Also some proxies might not support aspect ratios, so they will also return true so you do not call this endlessly.
True if you no longer need to call this.

code: bool ProxySetAspectRatio ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * InMediaPlayer )


description: Set the blend value for a texture that was retrieved from ProxyGetMediaTexture.

code: void ProxySetTextureBlend ( int32 LayerIndex, int32 TextureIndex, float Blend )


description:
Changes the desired playback rate.
True on success, false otherwise.

code: bool SetProxyRate ( float Rate )


description: Release a media texture that was retrieved from ProxyGetMediaTexture.

code: void ProxyReleaseMediaTexture ( int32 LayerIndex, int32 TextureIndex )


className: IMediaPlayerProxyInterface

code: class IMediaPlayerProxyInterface


description:
Open the media source to render a texture for.
Media texture that will hold the image.

code: [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) * Open ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * InMediaSource )


className: IMediaSourceRendererInterface

code: class IMediaSourceRendererInterface


description: Default constructor.

code: FMediaCaptureDevice()


description: Create and initialize a new instance.

code: FMediaCaptureDevice ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName, const [FString](API\Runtime\Core\Containers\FString) & InUrl )


className: FMediaCaptureDevice

description: Information about a capture device.

code: struct FMediaCaptureDevice

DisplayName

type: FText

description: Human readable display name.

Url

type: FString

description: Media URL string for use with media players.


description: To filter for a specific subset of devices, use the MakeBitmask node with EMediaWebcamCaptureDeviceFilter as the Bitmask Enum.

code: static void EnumerateWebcamCaptureDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [FMediaCaptureDevice](API\Runtime\MediaAssets\Misc\FMediaCaptureDevice) > & OutDevices, int32 Filter )


description: To filter for a specific subset of devices, use the MakeBitmask node with EMediaAudioCaptureDeviceFilter as the Bitmask Enum.

code: static void EnumerateAudioCaptureDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [FMediaCaptureDevice](API\Runtime\MediaAssets\Misc\FMediaCaptureDevice) > & OutDevices, int32 Filter )


className: UMediaBlueprintFunctionLibrary

description: Blueprint library for Media related functions.

code: class UMediaBlueprintFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


description: To filter for a specific subset of devices, use the MakeBitmask node with EMediaVideoCaptureDeviceFilter as the Bitmask Enum.

code: static void EnumerateVideoCaptureDevices ( [TArray](API\Runtime\Core\Containers\TArray)< [FMediaCaptureDevice](API\Runtime\MediaAssets\Misc\FMediaCaptureDevice) > & OutDevices, int32 Filter )


code: namespace TimeSynchronizableMedia { static [FName](API\Runtime\Core\UObject\FName) TimeSynchronizableMedia::FrameDelay ( "FrameDelay" ) }


code: namespace TimeSynchronizableMedia { static [FName](API\Runtime\Core\UObject\FName) TimeSynchronizableMedia::AutoDetect ( "AutoDetect" ) }


code: namespace TimeSynchronizableMedia { static [FName](API\Runtime\Core\UObject\FName) TimeSynchronizableMedia::TimeDelay ( "TimeDelay" ) }


description: Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


description: Name of bUseTimeSynchronization media option.

code: namespace TimeSynchronizableMedia { static [FName](API\Runtime\Core\UObject\FName) TimeSynchronizableMedia::UseTimeSynchronizatioOption ( "UseTimeSynchronization" ) }


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

code: virtual [FName](API\Runtime\Core\UObject\FName) GetDesiredPlayerName() const


description: Deprecated* Use version that takesFObjectPreSaveContextinstead.

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid PreSave ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Objects created from within PreSave will NOT have PreSave called on them!!!

code: virtual void PreSave ( [FObjectPreSaveContext](API\Runtime\CoreUObject\UObject\FObjectPreSaveContext) ObjectSaveContext )


description:
Get the full path to the file.
GetFilePath


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 )


className: UBaseMediaSource

description: Base class for concrete media sources.

code: class UBaseMediaSource : public [UMediaSource](API\Runtime\MediaAssets\UMediaSource)

PlatformPlayerNames

type: TMap<FString, ...

description: Override native media player plug-ins per platform (Empty = find one automatically).


description: SetFilePath

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


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

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


description: GetProxies

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


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

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


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


className: PrecacheFileOption

description: Name of the PrecacheFile media option.


description: GetFilePath

code: void SetFilePath ( const [FString](API\Runtime\Core\Containers\FString) & Path )


className: UFileMediaSource

code: class UFileMediaSource : public [UBaseMediaSource](API\Runtime\MediaAssets\UBaseMediaSource)

FilePath

description: The path to the media file to be played.

PrecacheFile

type: bool

description: Load entire media file into memory and play from there (if possible).


description:
Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate() const


description: Get the media player that this component owns

code: [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * GetMediaPlayer() const


description: Get the media texture that this component owns, bound to its media player.

code: [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) * GetMediaTexture() const


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


className: UMediaComponent

code: class UMediaComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)


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

code: virtual void BeginDestroy()


description: Pause

code: bool CanPause() const


description: SetDesiredPlayerName

code: bool CanPlaySource ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource )


description: SetDesiredPlayerName

code: bool CanPlayUrl ( const [FString](API\Runtime\Core\Containers\FString) & Url )


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

code: void CleanUpBeforeDestroy()


description: Play

code: void Close()


description: IAudioProxyDataFactoryinterface (for Meta Sound support)

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [Audio::IProxyData](API\Runtime\AudioExtensions\IProxyData) > CreateProxyData ( const [Audio::FProxyDataInitParams](API\Runtime\AudioExtensions\FProxyDataInitParams) & InitParams )


className: FOnMediaEvent

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

code: class FOnMediaEvent : public TBaseMulticastDelegate_OneParam< void, EMediaEvent >


description: GetAudioTrackSampleRate

code: [FString](API\Runtime\Core\Containers\FString) GetAudioTrackType ( int32 TrackIndex, int32 FormatIndex ) const


description: GetAudioTrackType

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


description: GetAudioTrackType

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


description: SetDesiredPlayerName


description: Seek


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


description: Seek

code: [UMediaTimeStampInfo](API\Runtime\MediaAssets\UMediaTimeStampInfo) * GetDisplayTimeStamp() const


description:
Get the Guid associated with this media player
The Guid.

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetGuid()


description: SetHorizontalFieldOfView

code: float GetHorizontalFieldOfView() const


description:
Get information about the media that is playing. Not all formats support all information. Some possible common information is in this file, look for MediaInfoNameSourceNumMips for example.
Requested information, or empty if not available.

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


description:
Templated version of GetMediaInfo. No need to deal with variants.
True if the information is found, false if not.

code: template<typename T> bool GetMediaInfo ( T & Result, [FName](API\Runtime\Core\UObject\FName) InfoName ) const


description:
Listen to EMediaEvent::MetadataChanged to catch updates to this data
Map with arrays of IMediaMetaDataItem entries describing any metadata found in the current stream

code: [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:
Listen to EMediaEvent::MetadataChanged to catch updates to this data
Map with arrays of FMediaMetaDataItem entries describing any metadata found in the current stream

code: [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FMediaMetadataItemsBPT](API\Runtime\MediaAssets\FMediaMetadataItemsBPT) > GetMediaMetadataItems() const


description: GetUrl

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


description: SelectTrack

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


description: SelectTrack

code: int32 GetNumTracks ( EMediaPlayerTrack TrackType ) const


description: GetMediaName


description:
Get the media player facade that manages low-level media players
The media player facade.

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


description: GetPlaylistRef

code: [UMediaPlaylist](API\Runtime\MediaAssets\UMediaPlaylist) * GetPlaylist() const


description: GetPlaylist

code: int32 GetPlaylistIndex() const


description: GetPlaylist

code: [UMediaPlaylist](API\Runtime\MediaAssets\UMediaPlaylist) & GetPlaylistRef() const


description: SupportsRate

code: float GetRate() const


description: SelectTrack

code: int32 GetSelectedTrack ( EMediaPlayerTrack TrackType ) const


description: SupportsRate

code: void GetSupportedRates ( [TArray](API\Runtime\Core\Containers\TArray)< [FFloatRange](API\Runtime\Core\Math\FFloatRange) > & OutRates, bool Unthinned ) const


description: SetTimeDelay


description: Seek


description: Seek

code: [UMediaTimeStampInfo](API\Runtime\MediaAssets\UMediaTimeStampInfo) * GetTimeStamp() const


description: SetTrackFormat

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


description: GetTrackLanguage

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


description: GetTrackDisplayName

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


description: SetVerticalFieldOfView

code: float GetVerticalFieldOfView() const


description: GetVideoTrackType

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


description: GetVideoTrackType

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


description: OpenUrl

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


description: SetVideoTrackFrameRate

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


description: GetVideoTrackType

code: [FFloatRange](API\Runtime\Core\Math\FFloatRange) GetVideoTrackFrameRates ( int32 TrackIndex, int32 FormatIndex ) const


description: SetViewRotation

code: FRotator GetViewRotation() const


description: GetVideoTrackFrameRates

code: [FString](API\Runtime\Core\Containers\FString) GetVideoTrackType ( int32 TrackIndex, int32 FormatIndex ) const


description: IsReady

code: bool HasError() const


description: IsReady

code: bool IsBuffering() const


description:
Whether media is currently closed.
true if media is closed, false otherwise.

code: bool IsClosed() const


description: IsReady

code: bool IsConnecting() const


description: SetLooping

code: bool IsLooping() const


description: Pause

code: bool IsPaused() const


description: Play

code: bool IsPlaying() const


description: Play

code: bool IsPreparing() const


description: IsPreparing

code: bool IsReady() const


className: MediaInfoNameSourceNumMips

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


className: MediaInfoNameSourceNumTiles

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


description: SetPlaylist

code: bool Next()


description: Reopen

code: bool OpenFile ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description: Reopen

code: bool OpenPlaylist ( [UMediaPlaylist](API\Runtime\MediaAssets\UMediaPlaylist) * InPlaylist )


description: Reopen

code: bool OpenPlaylistIndex ( [UMediaPlaylist](API\Runtime\MediaAssets\UMediaPlaylist) * InPlaylist, int32 Index )


description: Reopen

code: void OpenSourceLatent ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, struct [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource, const [FMediaPlayerOptions](API\Runtime\MediaUtils\FMediaPlayerOptions) & Options, bool & bSuccess )


description: Reopen

code: bool OpenSource ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource )


description: Reopen

code: bool OpenSourceWithOptions ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource, const [FMediaPlayerOptions](API\Runtime\MediaUtils\FMediaPlayerOptions) & Options )


description: Reopen

code: bool OpenUrl ( const [FString](API\Runtime\Core\Containers\FString) & Url )


description: ResumePIE

code: void PausePIE()


description: Seek

code: bool Pause()


description: SetRate

code: bool Play()


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

code: void PlayAndSeek()


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

code: virtual void PostDuplicate ( bool bDuplicateForPIE )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


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

code: virtual void PostInitProperties()


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

code: virtual void PostLoad()


description: SetPlaylist

code: bool Previous()


description: Register player with media module to be ticked

code: void RegisterWithMediaModule()


description: OpenUrl

code: bool Reopen()


description: PausePIE

code: void ResumePIE()


description: Seek

code: bool Rewind()


description: Rewind

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


description: SetTrackFormat

code: bool SelectTrack ( EMediaPlayerTrack TrackType, int32 TrackIndex )


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

code: void SetBlockOnTime ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Time )


code: void SetBlockOnTimeRange ( const [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > & TimeRange )


description: GetDesiredPlayerName

code: void SetDesiredPlayerName ( [FName](API\Runtime\Core\UObject\FName) PlayerName )


description: Sets the media options used by the player.

code: void SetMediaOptions ( const [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * Options )


description: IsLooping

code: bool SetLooping ( bool Looping )


description: NativeAudioOut

code: bool SetNativeVolume ( float Volume )


description: SupportsRate

code: bool SetRate ( float Rate )


description: GetTimeDelay

code: void SetTimeDelay ( [FTimespan](API\Runtime\Core\Misc\FTimespan) TimeDelay )


description: SelectTrack

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


description: GetVideoTrackType

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


description: SetViewRotation

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


description: SetViewField

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


description: SupportsSeeking

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


description: SupportsSeeking

code: bool SupportsScrubbing() const


description: SupportsScrubbing

code: bool SupportsSeeking() const


className: UMediaPlayer

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

code: class UMediaPlayer : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IAudioProxyDataFactory](API\Runtime\AudioExtensions\IAudioProxyDataFactory)

AffectedByPIEHandling

description: Whether this player should stop when entering or exiting PIE.

CacheAhead

type: FTimespan

description: Duration of samples to cache ahead of the play head.

CacheBehind

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

CacheBehindGame

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

HorizontalFieldOfView

type: float

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

Loop

type: uint32: 1

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

NativeAudioOut

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

OnEndReached

type: FOnMediaPlayerM...

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

OnMediaClosed

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

OnMediaOpened

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

OnMediaOpenFailed

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

OnMetadataChanged

description: A delegate that is invoked when the media metadata changed.

OnPlaybackResumed

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

OnPlaybackSuspended

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

OnSeekCompleted

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

OnTracksChanged

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

Playlist

type: TObjectPtr<UMe...

description: The play list to use, if any.

PlaylistIndex

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

PlayOnOpen

description: Automatically start playback after media opened successfully.

Shuffle

type: uint32:  1

description: Whether playback should shuffle media sources in the play list.

TimeDelay

description: Delay of the player's time.

VerticalFieldOfView

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

ViewRotation

type: FRotator

description: The initial view rotation.


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

code: void UnregisterWithMediaModule()


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


className: UMediaPlayerProxyInterface

description: The proxy object provides a higher level of insight/control than just the media player. For example, the object owning the player may control the player in some cases, and the proxy allows you and the object to avoid conflicts in control.

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


description: Replace

code: bool AddFile ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description: Replace

code: bool Add ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource )


description:
Called during cluster construction if the object can be added to a cluster
true if this object can be inside of a cluster

code: virtual bool CanBeInCluster() const


description: Replace

code: bool AddUrl ( const [FString](API\Runtime\Core\Containers\FString) & Url )


description: GetRandom

code: [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * Get ( int32 Index )


description: GetRandom

code: [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * GetNext ( int32 & InOutIndex )


description: GetPrevious

code: [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * GetRandom ( int32 & OutIndex )


description: GetRandom

code: [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * GetPrevious ( int32 & InOutIndex )


description: Replace

code: void Insert ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource, int32 Index )


description:
Get the number of media sources in the play list.
Number of media sources.

code: int32 Num()


description: Replace

code: bool RemoveAt ( int32 Index )


className: UMediaPlaylist

description: Implements a media play list.

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

Items

type: TArray<TObject...

description: List of media sources to play.


description: Replace

code: bool Remove ( [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * MediaSource )


description: RemoveAt

code: bool Replace ( int32 Index, [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * Replacement )


description: Activates the SceneComponent, should be overridden by native child classes.

code: virtual void Activate ( bool bReset )


description: Adds a clock sink so this can be ticked without the world.

code: void AddClockSink()


code: void CollectAttenuationShapesForVisualization ( [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< [EAttenuationShape::Type](API\Runtime\Engine\Engine\EAttenuationShape__Type), [FBaseAttenuationSettings::AttenuationShapeDetails](API\Runtime\Engine\Engine\FBaseAttenuationSettings\AttenuationShapeDetails) > & ShapeDetailsMap ) const


description: Implemented by the synth component to create a generator object instead of generating audio directly on the synth component. This method prevents UObjects from having to exist in the audio render thread.

code: virtual ISoundGeneratorPtr CreateSoundGenerator ( const [FSoundGeneratorInitParams](API\Runtime\Engine\Sound\FSoundGeneratorInitParams) & InParams )


description:
Get the attenuation settings based on the current component settings.
true if attenuation settings were returned, false if attenuation is disabled.

code: bool BP_GetAttenuationSettingsToApply ( [FSoundAttenuationSettings](API\Runtime\Engine\Sound\FSoundAttenuationSettings) & OutAttenuationSettings )


description: Deactivates the SceneComponent.

code: virtual void Deactivate()


description: Retrieves the current amplitude envelope.

code: float GetEnvelopeValue() const


description: SetMediaPlayer

code: [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * GetMediaPlayer() const


description: Retrieves and normalizes the spectral data if spectral analysis is enabled.


description:
Get the attenuation settings based on the current component settings.
Attenuation settings, or nullptr if attenuation is disabled.

code: const [FSoundAttenuationSettings](API\Runtime\Engine\Sound\FSoundAttenuationSettings) * GetSelectedAttenuationSettings() const


code: virtual [USoundClass](API\Runtime\Engine\Sound\USoundClass) * GetSoundClass()


description: Called when synth is created.

code: virtual bool Init ( int32 & SampleRate )


description: Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

code: virtual void OnRegister()


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


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

code: virtual void PostLoad()


description: Removes the clock sink.

code: void RemoveClockSink()


description: Turns on spectral analysis of the audio generated in the media sound component.

code: void SetEnableSpectralAnalysis ( bool bInSpectralAnalysisEnabled )


description: SetMediaPlayer

code: void SetDefaultMediaPlayer ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * NewMediaPlayer )


description: Turns on amplitude envelope following the audio in the media sound component.

code: void SetEnableEnvelopeFollowing ( bool bInEnvelopeFollowing )


description: Sets the envelope attack and release times (in ms).

code: void SetEnvelopeFollowingsettings ( int32 AttackTimeMsec, int32 ReleaseTimeMsec )


description: Retrieves the spectral data if spectral analysis is enabled.


description: Sets the settings to use for spectral analysis.

code: void SetSpectralAnalysisSettings ( [TArray](API\Runtime\Core\Containers\TArray)< float > InFrequenciesToAnalyze, EMediaSoundComponentFFTSize InFFTSize )


description: GetMediaPlayer

code: void SetMediaPlayer ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * NewMediaPlayer )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


description: Virtual destructor.

code: ~UMediaSoundComponent()


description: Create and initialize a new instance.

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


className: UMediaSoundComponent

description: Implements a sound component for playing a media player's audio output.

code: class UMediaSoundComponent : public [USynthComponent](API\Runtime\AudioMixer\Components\USynthComponent)

Channels

type: EMediaSoundChan...

description: Media sound channel type.

DynamicRateAdjustment

description: Dynamically adjust the sample rate if audio and media clock desynchronize.

MediaPlayer

description: The media player asset associated with this component.

RateAdjustmentFactor

description: Factor for calculating the sample rate adjustment.

RateAdjustmentRange

type: FFloatRange

description: The allowed range of dynamic rate adjustment.


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

code: virtual void BeginDestroy()


description:
Get the media source cache settings, if present.
true if the cache settings are present, false otherwise.

code: bool GetCacheSettings ( [FMediaSourceCacheSettings](API\Runtime\MediaAssets\FMediaSourceCacheSettings) & OutSettings ) const


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

code: virtual [FName](API\Runtime\Core\UObject\FName) GetDesiredPlayerName() const


description: Starts the process to generate a thumbnail.

code: void GenerateThumbnail()


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

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


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

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


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

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


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

code: virtual [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:
Get a string media option.
The option value.

code: virtual [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: Gets our thumbnail texture, if any.

code: [UTexture](API\Runtime\Engine\Engine\UTexture) * GetThumbnail() const


description: GetProxies

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


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

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


description: Call this to register a callback when someone calls SpawnMediaSourceForString. This lets you spawn a media source if the file extension matches what you want.

code: static void RegisterSpawnFromFileExtension ( const [FString](API\Runtime\Core\Containers\FString) & Extension, FMediaSourceSpawnDelegate InDelegate )


description: Call this to set cache settings to pass to the player.

code: void SetCacheSettings ( const [FMediaSourceCacheSettings](API\Runtime\MediaAssets\FMediaSourceCacheSettings) & Settings )


description: Set a boolean parameter to pass to the player.

code: void SetMediaOptionBool ( const [FName](API\Runtime\Core\UObject\FName) & Key, bool Value )


description: Set a double parameter to pass to the player.

code: void SetMediaOptionDouble ( const [FName](API\Runtime\Core\UObject\FName) & Key, double Value )


description: Set an integer64 parameter to pass to the player.

code: void SetMediaOptionInt64 ( const [FName](API\Runtime\Core\UObject\FName) & Key, int64 Value )


description: Set a float parameter to pass to the player.

code: void SetMediaOptionFloat ( const [FName](API\Runtime\Core\UObject\FName) & Key, float Value )


description: Sets what the thumbnail texture should be.

code: void SetThumbnail ( [UTexture](API\Runtime\Engine\Engine\UTexture) * InTexture )


description: Set a string parameter to pass to the player.

code: void SetMediaOptionString ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FString](API\Runtime\Core\Containers\FString) & Value )


description:
Call this to try and create a media source appropriate for the media.
Media source or nullptr if none are appropriate.

code: static [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * SpawnMediaSourceForString ( const [FString](API\Runtime\Core\Containers\FString) & MediaPath, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Outer )


description: Call this to unregister a callback set with RegisterSpawnFromFileExtension.

code: static void UnregisterSpawnFromFileExtension ( const [FString](API\Runtime\Core\Containers\FString) & Extension )


description:
Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate() const


className: UMediaSource

description: Media sources describe the location and/or settings of media objects that can be played in a media player, such as a video file on disk, a video stream on the internet, or a web cam attached to or built into the target device. The location is encoded as a media URL string, whose URI scheme and optional file extension will be used to locate a suitable media player.

code: class UMediaSource : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IMediaOptions](API\Runtime\Media\IMediaOptions)


className: UMediaSourceRendererInterface

description: Interface for an object that can render a media source to a texture.

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


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

code: virtual void BeginDestroy()


description: GetNextSampleTime

code: void CacheNextAvailableSampleTime ( [FTimespan](API\Runtime\Core\Misc\FTimespan) InNextSampleTime )


description:
Calculates the size of this texture if it had MipCount miplevels streamed in. This is the size in GPU memory of the built platformdata, accounting for LODBias, etc.
Total size of all specified mips, in bytes. Returns 0 for error.

code: virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum ) const


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


className: ERenderMode

description: Possible render modes of this media texture.

code: enum ERenderMode { Default = 0, JustInTime, }


description: GetWidth

code: float GetAspectRatio() const


description:
Get current aspect ratio of presented frame.
Aspect ratio of current frame

code: float GetCurrentAspectRatio() const


description:
Gets the number of samples that are available
The number of samples in the queue

code: int32 GetAvailableSampleCount() const


description:
Get current orientation of presented frame.
Orientation of current frame


description: Access the GUID which defines this texture's resources externally throughFExternalTextureRegistry

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


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


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


description: GetWidth

code: int32 GetHeight() const


description: SetMediaPlayer

code: [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * GetMediaPlayer() const


description:
Get the texture's mip-map bias, clamped to a legal range.
Mip-map bias value

code: float GetMipMapBias() const


description: CacheNextAvailableSampleTime


description: Returns the ERenderMode of this media texture


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


description: GetHeight

code: int32 GetWidth() const


description:
Called during async load to determine if PostLoad can be called on the loading thread.
true if this object's PostLoad is thread safe

code: virtual bool IsPostLoadThreadSafe() const


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Renders this media texture. Only has an effect if its RenderMode isERenderMode::JustInTime

code: virtual void JustInTimeRender()


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

code: virtual void PostInitProperties()


description: Set an override for color space conversions

code: void SetColorSpaceOverride ( [UE::Color::EColorSpace](API\Runtime\ColorManagement\UE__Color__EColorSpace) InColorspaceOverride )


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

code: virtual void PostLoad()


description: SetMediaPlayer

code: void SetDefaultMediaPlayer ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * NewMediaPlayer )


description:
Gets the current numbe of mips of the texture.
Number of mips.

code: int32 GetTextureNumMips() const


description: GetMediaPlayer

code: void SetMediaPlayer ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * NewMediaPlayer )


description: Set texture's mip-map bias, for use by the texture resource sampler. Note:UpdateResource()should be called afterwards and the material should be notified.

code: void SetMipMapBias ( float InMipMapBias )


code: void SetRenderedExternalTextureGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InNewGuid )


description: Sets the ERenderMode of this media texture

code: void SetRenderMode ( [ERenderMode](API\Runtime\MediaAssets\UMediaTexture\ERenderMode) InRenderMode )


description: Tick the texture resource.

code: void TickResource ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


description: Update the video sample queue, if necessary.

code: void UpdatePlayerAndQueue()


description: Update sample info

code: void UpdateSampleInfo ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > & Sample )


description: Creates a new resource for the texture, and updates any cached references to the resource. This obviously is just an override to expose to blueprints.

code: virtual void UpdateResource()


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


className: UMediaTexture

description: note: derives directly fromUTexture, not fromUTexture2DorUTexture2DDynamicmaybe should have beenUTexture2DDynamic?

code: class UMediaTexture : public [UTexture](API\Runtime\Engine\Engine\UTexture)

AddressX

type: TEnumAsByte< Te...

description: The addressing mode to use for the X axis.

AddressY

description: The addressing mode to use for the Y axis.

AutoClear

description: Whether to clear the texture when no media is being played (default = enabled).

ClearColor

type: FLinearColor

description: The color used to clear the texture if AutoClear is enabled (default = black).

CurrentAspectRatio

description: Current aspect ratio

CurrentOrientation

type: TEnumAsByte< en...

description: Current media orientation

EnableGenMips

description: Basic enablement for mip generation (default = false).

MediaPlayer

description: The media player asset associated with this texture.

NewStyleOutput

description: Enable new style output.

NumMips

description: The number of mips to use (default = 1).


className: UMediaTimeStampInfo

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


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

code: virtual [FName](API\Runtime\Core\UObject\FName) GetDesiredPlayerName() const


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

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


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

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


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

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


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

code: virtual [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 localized text media option.
The option value.

code: virtual [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: GetProxies

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


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

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


description: Objects created from within PreSave will NOT have PreSave called on them!!!

code: virtual void PreSave ( [FObjectPreSaveContext](API\Runtime\CoreUObject\UObject\FObjectPreSaveContext) ObjectSaveContext )


description: Deprecated* Use version that takesFObjectPreSaveContextinstead.

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid PreSave ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


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 )


className: UPlatformMediaSource

description: Use this asset to override media sources on a per-platform basis.

code: class UPlatformMediaSource : public [UMediaSource](API\Runtime\MediaAssets\UMediaSource)

PlatformMediaSources

description: Media sources per platform.


description:
Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate() const


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


className: UStreamMediaSource

code: class UStreamMediaSource : public [UBaseMediaSource](API\Runtime\MediaAssets\UBaseMediaSource)

StreamUrl

description: The URL to the media stream to be played.


description: Default constructor.

code: UTimeSynchronizableMediaSource()


code: virtual bool SupportsFormatAutoDetection() const


className: UTimeSynchronizableMediaSource

description: Base class for media sources that can be synchronized with the engine's timecode.

code: class UTimeSynchronizableMediaSource : public [UBaseMediaSource](API\Runtime\MediaAssets\UBaseMediaSource)

bAutoDetectInput

description: Whether to autodetect the input or not.

bUseTimeSynchronization

description: Synchronize the media with the engine's timecode.

FrameDelay

description: When using Time Synchronization, how many frame back should it read.

TimeDelay

type: double

description: When not using Time Synchronization, how far back it time should it read.


description:
Get the current time code.
Time code.

module: MediaUtils


description: Virtual destructor.

code: virtual ~FAppMediaTimeSource()


className: FAppMediaTimeSource

description: Implements the a media time source that derives its time from the application's global time.

code: class FAppMediaTimeSource : public [IMediaTimeSource](API\Runtime\Media\IMediaTimeSource)


description: SetInput

code: void ClearInput()


description:
Generate the next frame of audio.
The actual number of frames returned.

code: uint32 Generate ( float * Output, [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) & OutTime, const uint32 FramesRequested, float Rate, [FTimespan](API\Runtime\Core\Misc\FTimespan) Time, FMediaAudioSampleSource & SampleSource, uint32 & JumpFrame )


description: Flush the resampler.

code: void Flush()


description: SetAudioSamples

code: void Initialize ( const uint32 InOutputChannels, const uint32 InOutputSampleRate )


description: ClearInput

code: bool SetInput ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaAudioSample](API\Runtime\Media\IMediaAudioSample), ESPMode::ThreadSafe > & Sample )


description: Default constructor.

code: FMediaAudioResampler()


className: FMediaAudioResampler

code: class FMediaAudioResampler


code: FMediaAudioSampleQueue ( uint32 MaxSamplesInQueue )


code: void SetAudioTime ( const [FMediaTimeStampSample](API\Runtime\Media\FMediaTimeStampSample) & InAudioTime )


className: FMediaAudioSampleQueue

description: Audio sample queue.

code: class FMediaAudioSampleQueue : public [TMediaSampleQueue< class IMediaAudioSample, class FMediaAudioSampleSink >](API\Runtime\MediaUtils\TMediaSampleQueue)


description: Get last sampled current audio timestamp being played


className: FMediaAudioSampleSink

description: Type definition for audio sample sink.

code: class FMediaAudioSampleSink : public [TMediaSampleSink< class IMediaAudioSample >](API\Runtime\MediaUtils\TMediaSampleSink)


description: Get primary audio sink and cleanup any invalid sinks


className: FMediaAudioSampleSinks

code: class FMediaAudioSampleSinks : public [TMediaSampleSinks< IMediaAudioSample, FMediaAudioSampleSink >](API\Runtime\MediaUtils\TMediaSampleSinks)


className: FOnPreSampleRenderDelegate

code: typedef TMulticastDelegate_ThreeParams< void, const [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) *, bool, [TSharedMediaTextureSample](API\Runtime\MediaUtils\FMediaDelegates\TSharedMediaTextureSample) > FOnPreSampleRenderDelegate


className: FOnSampleDiscardedDelegate

code: typedef TMulticastDelegate_TwoParams< void, const [UMediaTexture](API\Runtime\MediaAssets\UMediaTexture) *, [TSharedMediaTextureSample](API\Runtime\MediaUtils\FMediaDelegates\TSharedMediaTextureSample) > FOnSampleDiscardedDelegate


className: TSharedMediaTextureSample

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > TSharedMediaTextureSample


className: FMediaDelegates

code: class FMediaDelegates


description: AddVideoSampleSink

code: void AddAudioSampleSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FMediaAudioSampleSink](API\Runtime\MediaUtils\FMediaAudioSampleSink), ESPMode::ThreadSafe > & SampleSink )


description: AddVideoSampleSink

code: void AddCaptionSampleSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FMediaOverlaySampleSink, ESPMode::ThreadSafe > & SampleSink )


description: AddVideoSampleSink

code: void AddSubtitleSampleSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FMediaOverlaySampleSink, ESPMode::ThreadSafe > & SampleSink )


description: AddVideoSampleSink

code: void AddMetadataSampleSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FMediaBinarySampleSink, ESPMode::ThreadSafe > & SampleSink )


description: AddSubtitleSampleSink

code: void AddVideoSampleSink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FMediaTextureSampleSink, ESPMode::ThreadSafe > & SampleSink )


description:
Whether sample fetching should block.
true if sample fetching should block, false otherwise.

code: bool BlockOnFetch() const


description: SetRate

code: bool CanResume() const


description: SetDesiredPlayerName

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


description: Pause

code: bool CanPause() const


description: Seek

code: bool CanScrub() const


description: Close the currently open media, if any.

code: void Close()


description: Seek

code: bool CanSeek() const


className: FOnMediaEvent

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

code: class FOnMediaEvent : public TBaseMulticastDelegate_OneParam< void, EMediaEvent >


description: Flush all media sample sinks & player plugin.

code: void Flush ( bool bExcludePlayer, bool bOnSeek )


description: GetAudioTrackType

code: uint32 GetAudioTrackChannels ( int32 TrackIndex, int32 FormatIndex ) const


description: GetVideoTrackFormat

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


description:
The timestamp returned here will reflect a user-logic oriented version. (e.g. during seeks this will return the seek target rather than the last valid frame still displayed)
Playback time stamp.


description: GetAudioTrackType

code: uint32 GetAudioTrackSampleRate ( int32 TrackIndex, int32 FormatIndex ) const


description: Seek


description: SetGuid

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetGuid()


description: GetAudioTrackSampleRate

code: [FString](API\Runtime\Core\Containers\FString) GetAudioTrackType ( int32 TrackIndex, int32 FormatIndex ) const


description: GetStats


description: UMediaPlayer::GetMediaInfo.

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


description:
Get time of last audio sample played
Time of last audio sample played.


description:
Listen to EMediaEvent::MetadataChanged to catch updates to this data
Map with arrays of IMediaMetaDataItem entries describing any metadata found in the current stream

code: [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: GetUrl


description: SelectTrack

code: int32 GetNumTracks ( EMediaTrackType TrackType ) const


description: SelectTrack

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


description:
Get the low-level player associated with this object.
The player, or nullptr if no player was created.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaPlayer](API\Runtime\Media\IMediaPlayer), ESPMode::ThreadSafe > GetPlayer() const


description:
Get a player that can play the specified media URL.
The player if found, or nullptr otherwise.

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


description: SupportsRate

code: float GetRate() const


description: GetMediaName


description: GetInfo


description: SelectTrack

code: int32 GetSelectedTrack ( EMediaTrackType TrackType ) const


description: SupportsRate

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


description:
Get the media's current playback time stamp.
Playback time stamp.


description: Seek


description: Internal function to retrieve the current timestamp

code: [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) GetTimeStampInternal ( bool bForDisplay ) const


description: GetTrackLanguage

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


description: SetTrackFormat

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


description: GetTrackDisplayName

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


description:
Get the URL of the currently loaded media, if any.
Media URL, or empty string if no media was loaded.

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


description: GetVideoTrackType

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


description: GetVideoTrackType

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


description: GetVideoTrackType

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


description: GetVideoTrackType

code: [TRange](API\Runtime\Core\Math\TRange)< float > GetVideoTrackFrameRates ( int32 TrackIndex, int32 FormatIndex ) const


description: GetVideoTrackFrameRates

code: [FString](API\Runtime\Core\Containers\FString) GetVideoTrackType ( int32 TrackIndex, int32 FormatIndex ) const


description: SetViewField

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


description: SetViewOrientation

code: bool GetViewOrientation ( FQuat & OutOrientation ) const


description: IsReady

code: bool HasError() const


code: bool HaveAudioPlayback() const


code: bool HaveVideoPlayback() const


description: IsLooping

code: bool IsBuffering() const


description:
Whether media is currently closed.
true if media is closed, false otherwise.

code: bool IsClosed() const


description: GetVideoTrackFormat

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


description: IsLooping

code: bool IsConnecting() const


description: SetLooping

code: bool IsLooping() const


description: Pause

code: bool IsPaused() const


description: Play

code: bool IsPlaying() const


description: Stop

code: bool IsReady() const


description:
Open a media source from a URL with optional parameters.
true if the media is being opened, false otherwise.

code: 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: Process the given media event.

code: void ProcessEvent ( EMediaEvent Event, bool bIsBroadcastAllowed )


description: Query the time ranges of cached media samples for the specified caching state.

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


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

code: virtual void ReceiveMediaEvent ( EMediaEvent Event )


description: Rewind

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


description: SetTrackFormat

code: bool SelectTrack ( EMediaTrackType TrackType, int32 TrackIndex )


description: Sets whether the player can broadcast events when running on a thread other than the game thread.

code: void SetAreEventsSafeForAnyThread ( bool bInAreEventsSafeForAnyThread )


description: TickFetch

code: void SetBlockOnTime ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Time )


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

code: void SetBlockOnTimeRange ( const [TRange](API\Runtime\Core\Math\TRange)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > & TimeRange )


description: Play

code: bool IsPreparing() const


description: Set sample caching options.

code: void SetCacheWindow ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Ahead, [FTimespan](API\Runtime\Core\Misc\FTimespan) Behind )


description: GetGuid

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


description:
Record last audio sample played to track audio sync (for automated tests)
true if playback is being prepared, false otherwise.

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


description: IsLooping

code: bool SetLooping ( bool Looping )


description: Changes media ooptions on the player.

code: void SetMediaOptions ( const [IMediaOptions](API\Runtime\Media\IMediaOptions) * Options )


description: NativeAudioOut

code: bool SetNativeVolume ( float Volume )


description: SupportsRate

code: bool SetRate ( float Rate )


description: SelectTrack

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


description: GetVideoTrackType

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


description: SetViewOrientation

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


description: SetViewField

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


description: CanSeek

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


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: Tick the object.

code: virtual void TickTickable()


description: Default constructor.

code: FMediaPlayerFacade ( [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) > InMediaPlayer )


description: Virtual destructor.

code: virtual ~FMediaPlayerFacade()


className: FMediaPlayerFacade

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

code: class FMediaPlayerFacade : public [IMediaClockSink](API\Runtime\Media\IMediaClockSink), public [IMediaTickable](API\Runtime\Media\IMediaTickable), protected [IMediaEventSink](API\Runtime\Media\IMediaEventSink), public [TSharedFromThis< FMediaPlayerFacade, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

ActivePlayerOptions

type: TOptional<FMed...

description: Active media player options.

DesiredPlayerName

type: FName

description: Name of the desired native player, if any.

description: Extra time to reduce from current player's time.


description: Check if this Media Options is not equal to another one.

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


className: FMediaPlayerOptions

code: struct FMediaPlayerOptions

Loop

type: EMediaPlayerOpt...

Tracks

type: FMediaPlayerTra...


className: MaxAudioSinkDepth

code: static const int32 MaxAudioSinkDepth = 512;


className: MaxCaptionSinkDepth

code: static const int32 MaxCaptionSinkDepth = 256;


className: MaxMetadataSinkDepth

code: static const int32 MaxMetadataSinkDepth = 256;


className: MaxSubtitleSinkDepth

code: static const int32 MaxSubtitleSinkDepth = 256;


className: FMediaPlayerQueueDepths

description: These are not used inside MediaFramework and are meant to support older player sources code only.

code: struct FMediaPlayerQueueDepths


description: Check if this Media Player Track Options is not equal to another one.

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


className: FMediaPlayerTrackOptions

code: struct FMediaPlayerTrackOptions


className: EMediaRecorderNumerationStyle

code: enum EMediaRecorderNumerationStyle { AppendFrameNumber, AppendSampleTime, }


code: FMediaRecorderData &40; const TSharedRef< FMediaPlayerFacade, ESPMode::ThreadSafe > & InPlayerFacade, const FString & InBaseFilename &41;


className: FMediaRecorderData

code: struct FMediaRecorderData

BaseFilename

type: FString

description: BaseFilename(including with path and filename) for each recorded frames.

bResetAlpha

type: bool

description: If the format support it, set the alpha to 1 (or 255)

CompressionQuality

description: An image format specific compression setting.

NumerationStyle

type: EMediaRecorderN...

description: How to numerate the filename.

PlayerFacade

type: TSharedRef<FMe...

description: The media player facade to record from.

TargetImageFormat

type: EImageFormat

description: The format to save the image to.


description: Start recording samples from a given media player.

code: void StartRecording ( const [FMediaRecorderData](API\Runtime\MediaUtils\FMediaRecorder\FMediaRecorderData) & InRecoderData )


description: Stop recording media samples.

code: void StopRecording()


description: Tick the recorder.

code: void TickRecording()


description: Blocking call that will wait for all frames to be recorded before returning.

code: bool WaitPendingTasks ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InDuration )


className: MaxVideoSinkDepth

code: static const int32 MaxVideoSinkDepth = 8;


description: Default constructor.

code: FMediaRecorder()


className: FMediaRecorder

description: Records samples from a media player. Loop, seek or reverse and not supported. Currently only records texture samples and that support sample format 8bit BGRA, half float RBGA

code: class FMediaRecorder


description: Update

code: void Empty()


description: GetOverlaySamples

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaAudioSample](API\Runtime\Media\IMediaAudioSample), ESPMode::ThreadSafe > GetAudioSample ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Time )


description: GetCachedVideoSampleRanges

code: void GetCachedAudioSampleRanges ( [TRangeSet](API\Runtime\Core\Math\TRangeSet)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > & OutTimeRanges ) const


description: GetVideoSample

code: void GetCachedVideoSampleRanges ( [TRangeSet](API\Runtime\Core\Math\TRangeSet)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > & OutTimeRanges ) const


description: GetVideoSample

code: void GetOverlaySamples ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Time, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe >> & OutSamples )


description: GetOverlaySamples

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > GetVideoSample ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Time, bool Forward )


description: Set the time window of samples to cache.

code: void SetCacheWindow ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Ahead, [FTimespan](API\Runtime\Core\Misc\FTimespan) Behind )


description: Is currently recording media samples.

code: bool IsRecording() const


description: Shutdown

code: void Tick ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, float Rate, [FTimespan](API\Runtime\Core\Misc\FTimespan) Time )


className: TSampleSet

description: Template for sample cache sets.

code: typedef [TSet](API\Runtime\Core\Containers\TSet)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SampleType, ESPMode::ThreadSafe >, TSampleKeyFuncs< SampleType >> TSampleSet


description: Default constructor.

code: FMediaSampleCache()


description: NumAudio

code: void AddAudio ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaAudioSample](API\Runtime\Media\IMediaAudioSample), ESPMode::ThreadSafe > & Sample )


className: FMediaSampleCache

description: Implements a cache for media samples.

code: class FMediaSampleCache


description: NumMetadata

code: void AddMetadata ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaBinarySample](API\Runtime\Media\IMediaBinarySample), ESPMode::ThreadSafe > & Sample )


description: NumCaption

code: void AddCaption ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe > & Sample )


description: NumSubtitle

code: void AddSubtitle ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample), ESPMode::ThreadSafe > & Sample )


description: NumVideo

code: void AddVideo ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), ESPMode::ThreadSafe > & Sample )


description: Check if can receive more audio samples

code: virtual bool CanReceiveAudioSamples ( uint32 Num ) const


description: Check if can receive more caption samples

code: virtual bool CanReceiveCaptionSamples ( uint32 Num ) const


description: Check if can receive more metadata samples

code: virtual bool CanReceiveMetadataSamples ( uint32 Num ) const


description: Check if can receive more subtitle samples

code: virtual bool CanReceiveSubtitleSamples ( uint32 Num ) const


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


description: Check if can receive more video samples

code: virtual bool CanReceiveVideoSamples ( uint32 Num ) const


code: virtual bool DiscardCaptionSamples ( 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 DiscardVideoSamples ( 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 )


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 )


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 )


description: Fetch video sample best suited for the given time range. Samples prior to the selected one will be removed from the queue.

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 )


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 )


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 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()


className: MaxNumberOfQueuedAudioSamples

code: static constexpr uint32 MaxNumberOfQueuedAudioSamples = 4;


className: MaxNumberOfQueuedCaptionSamples

code: static constexpr uint32 MaxNumberOfQueuedCaptionSamples = 4;


className: MaxNumberOfQueuedMetaDataSamples

code: static constexpr uint32 MaxNumberOfQueuedMetaDataSamples = 4;


className: MaxNumberOfQueuedVideoSamples

code: static constexpr uint32 MaxNumberOfQueuedVideoSamples = 4;


className: MaxNumberOfQueuedSubtitlesSamples

code: static constexpr uint32 MaxNumberOfQueuedSubtitlesSamples = 4;


description: NumVideo

code: virtual int32 NumAudio() const


description: NumVideo

code: virtual int32 NumCaption() const


description: NumVideo

code: virtual int32 NumMetadataSamples() const


description: NumSubtitle

code: virtual int32 NumVideoSamples() const


description: NumVideo

code: virtual int32 NumSubtitleSamples() const


description:
Peek next video sample's timestamp
true if value could be retrieved, false otherwise

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


description: Remove any caption samples from the queue that have no chance of being displayed anymore

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 )


description: Remove any subtitle samples from the queue that have no chance of being displayed anymore

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


description: Remove any video samples from the queue that have no chance of being displayed anymore

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


code: FMediaSamples ( uint32 InMaxNumberOfQueuedAudioSamples, uint32 InMaxNumberOfQueuedVideoSamples, uint32 InMaxNumberOfQueuedCaptionSamples, uint32 InMaxNumberOfQueuedSubtitlesSamples, uint32 InMaxNumberOfQueuedMetaDataSamples )


className: FMediaSamples

description: General purpose media sample queue.

code: class FMediaSamples : public [IMediaSamples](API\Runtime\Media\IMediaSamples)


className: FMediaSampleSinkEventData

code: struct FMediaSampleSinkEventData

type: union FMediaSam...

Attached

type: FMediaSampleSin...

MediaPlayer

type: UMediaPlayer&#...

PlaybackRate

type: float


code: TSharedPtr< FMediaPlayerFacade, ESPMode::ThreadSafe > GetFacade&40;&41; const


code: bool SubmitOpenRequest &40; IOpenRequestRef && OpenRequest &41;


className: IControl

description: Control interface for lifecycle delegate.

code: class IControl


className: IControlRef

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IControl](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControl), ESPMode::ThreadSafe > IControlRef


code: const IMediaOptions &42; GetOptions&40;&41; const


code: IMediaPlayerFactory &42; GetPlayerFactory&40;&41; const


code: const FMediaPlayerOptions &42; GetPlayerOptions&40;&41; const


code: const FString & GetUrl&40;&41; const


code: bool WillCreateNewPlayer&40;&41; const


code: bool WillUseNewResources &40; uint32 ResourceFlags &41; const


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


className: IOpenRequest

description: Request to create and open a player.

code: class IOpenRequest


className: IOpenRequestRef

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IOpenRequest](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IOpenRequest), ESPMode::ThreadSafe > IOpenRequestRef


code: void OnMediaPlayerClosed ( [IControlRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControlRef) Control )


code: void OnMediaPlayerCreateFailed ( [IControlRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControlRef) Control )


code: void OnMediaPlayerCreated ( [IControlRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControlRef) Control )


code: void OnMediaPlayerDestroyed ( [IControlRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControlRef) Control )


code: bool OnMediaPlayerOpen ( [IControlRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControlRef) Control, [IOpenRequestRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IOpenRequestRef) OpenRequest )


code: void OnMediaPlayerResourcesReleased ( [IControlRef](API\Runtime\MediaUtils\IMediaPlayerLifecycleManagerDele-\IControlRef) Control, uint32 ResourceFlags )


code: enum { ResourceFlags_All = (1 << 2) - 1 }


code: enum { ResourceFlags_Any = ResourceFlags_All }


code: enum { ResourceFlags_Decoder = 1 << 0 }


code: enum { ResourceFlags_OutputBuffers = 1 << 1 }


className: IMediaPlayerLifecycleManagerDelegate

description: The low level player instance release resources. This callback receives a bitmask of possible resource types (Resource_Flag...) to allow proper tracking of players that release certain types of resources at different times. Some players will issue this callback asynchronously, it may hence be triggered long (100-200ms are possible) after the closing or destruction of a player.


description: ShutdownPoolable

code: virtual void InitializePoolable()


description: Used to check if returned object is ready for reuse right away

code: virtual bool IsReadyForReuse()


description: InitializePoolable

code: virtual void ShutdownPoolable()


description: Virtual destructor.

code: virtual ~IMediaPoolable()


className: IMediaPoolable

description: Interface for objects that can be pooled.

code: class IMediaPoolable


description: ToUnique

code: ObjectType * Acquire()


description: ToShared

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ObjectType, ESPMode::ThreadSafe > AcquireShared()


description:
Get the number of objects available in the pool.
Number of available objects.

code: int32 Num() const


description: Acquire

code: void Release ( ObjectType * Object )


description: GetObject

code: void Reset ( uint32 NumObjects )


description: Regular tick call

code: void Tick()


description: ToUnique

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ObjectType, ESPMode::ThreadSafe > ToShared ( ObjectType * Object )


description: Default constructor.

code: TMediaObjectPool ( ObjectAllocator * ObjectAllocatorInstance )


description: Create and initialize a new instance.

code: TMediaObjectPool ( uint32 NumReserve )


className: TMediaObjectPool

description: Poolable objects are required to implement theIMediaPoolableinterface.

code: template<typename ObjectType, typename ObjectAllocator> class TMediaObjectPool


className: TMediaPoolDefaultObjectAllocator

code: template<typename ObjectType> class TMediaPoolDefaultObjectAllocator


description: Pop

code: virtual bool Dequeue ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SampleType, ESPMode::ThreadSafe > & OutSample )


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


code: bool FetchBestSampleForTimeRange ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SampleType, ESPMode::ThreadSafe > & OutSample, bool bReverse )


code: virtual bool CanAcceptSamples ( int32 NumSamples ) const


code: virtual bool Enqueue ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< SampleType, ESPMode::ThreadSafe > & Sample )


code: void FindRangeInQueue ( const [TRange](API\Runtime\Core\Math\TRange)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > & TimeRange, bool bReverse, int32 & FirstPossibleIndex, int32 & LastPossibleIndex, int32 & NumOldSamplesAtBegin )


description: Peek


description: Pop

code: virtual bool Peek ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SampleType, ESPMode::ThreadSafe > & OutSample )


description: Peek

code: virtual bool Pop()


code: TMediaSampleQueue ( int32 InMaxSamplesInQueue )


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


description: Virtual destructor.

code: virtual ~TMediaSampleQueue()


className: TMediaSampleQueue

description: Template for media sample queues.

code: template<typename SampleType, typename SinkType> class TMediaSampleQueue : public SinkType, public [TMediaSampleSource< SampleType >](API\Runtime\MediaUtils\TMediaSampleSource)

CriticalSection

type: FCriticalSectio...

Samples

type: TArray<TShared...


description: RequestFlush

code: bool Enqueue ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< SampleType, ESPMode::ThreadSafe > & Sample )


description:
Override in implementation as needed
True if samples could be accepted, false otherwise


className: FOnMediaSampleSinkEvent

description: Register to receive events flowing to this sink

code: class FOnMediaSampleSinkEvent : public TBaseMulticastDelegate_TwoParams< void, EMediaSampleSinkEvent, const FMediaSampleSinkEventData & >


description: RequestFlush

code: int32 Num() const


description: Receive event

code: void ReceiveEvent ( EMediaSampleSinkEvent Event, const [FMediaSampleSinkEventData](API\Runtime\MediaUtils\FMediaSampleSinkEventData) & Data )


description: Num

code: void RequestFlush()


description: Virtual destructor.

code: virtual ~TMediaSampleSink()


className: TMediaSampleSink

description: TMediaSampleQueue

code: template<typename SampleType> class TMediaSampleSink


description: Remove

code: void Add ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< SinkType, ESPMode::ThreadSafe > & SampleSink, [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * Player )


description: Remove any invalid sinks

code: void Cleanup()


description: Flush


description: Enqueue

code: void Flush ( [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * MediaPlayer )


description:
Check if any sinks are inserted
True if empty, false otherwise

code: bool IsEmpty() const


description: Receive event and broadcast to sinks


description: Remove


description: Num

code: void Remove ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< SinkType, ESPMode::ThreadSafe > & SampleSink, [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) * Player )


className: TMediaSampleSinks

description: Collection of media sample sinks.

code: template<typename SampleType, typename SinkType> class TMediaSampleSinks

Sinks

type: TArray<TWeakPt...

description: The collection of registered sinks.


description: Pop

code: bool Dequeue ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SampleType, ESPMode::ThreadSafe > & OutSample )


description: Pop

code: bool Peek ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SampleType, ESPMode::ThreadSafe > & OutSample )


description: Peek

code: bool Pop()


className: TMediaSampleSource

description: TMediaSampleQueue

code: template<typename SampleType> class TMediaSampleSource


description: Virtual destructor.

code: virtual ~TMediaSampleSource()


className: FConversionToMeshDescriptionOptions

module: MeshConversion

bSetPolyGroups

description: Should triangle groups be transfered to MeshDescription via custom PolyTriGroups attribute

bTransformVtxColorsSRGBToLinear

description: Should Vertex Colors of MeshDescription be transformed from SRGB to Linear

bUpdateNormals

description: Should normals of MeshDescription be updated, if available and relevant

bUpdatePositions

description: Should Positions of vertices in MeshDescription be updated

bUpdateTangents

description: Should Tangents and BiTangentSign of MeshDescription be updated, if available and relevant

bUpdateUVs

description: Should UVs of MeshDescription be updated, if available and relevant

bUpdateVtxColors

description: Should Vertex Colors of MeshDescription be updated, if available and relevant


description: The counterpart to this method is MeshDescriptionToDynamicMesh::ApplyVertexColorTransform which will undo this color transformation when the MeshDescription is read back.

code: void ApplyVertexColorTransform ( FVector4f & Color ) const


description: Utility functions for common configuration cases

code: void SetToVertexColorsOnly()


description: Note: Don't copy tangents if the resulting MeshDescription corresponds to a StaticMesh with autogenerated tangents in this case the MeshDescription is expected to have empty tangents.

code: void Convert ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, bool bCopyTangents )


description: Transfer PolygroupLayers from DynamicMesh AttributeSet to MeshDescription. Will copy to existing MeshDescription TriangleAttributeif one with the same name exists. Otherwise will register a new one.

code: void ConvertPolygroupLayers ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, const [TArray](API\Runtime\Core\Containers\TArray)< [FTriangleID](API\Runtime\MeshDescription\FTriangleID) > & IndexToTriangleIDMap )


description: Transfer WeightLayers from DynamicMesh AttributeSet to MeshDescription. Will copy to existing MeshDescription VertexAttributeif one with the same name exists. Otherwise will register a new one.

code: void ConvertWeightLayers ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, const [TArray](API\Runtime\Core\Containers\TArray)< [FVertexID](API\Runtime\MeshDescription\FVertexID) > & IndexToVertexIDMap )


description: Internal functions that you can also call directly Ignore any Attributes on input Mesh, calculate per-vertex normals and have MeshDescription compute tangents. One VertexInstance per input vertex is generated

code: void Convert_NoAttributes ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut )


code: void Convert_NoSharedInstances ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, bool bCopyTangents )


description: Note: This doesn't copy any tangents from the FDynamicMesh Note: This conversion is not currently being used. It is unclear if all consumers ofFMeshDescriptioncan handle such shared vertex instances

code: void Convert_SharedInstances ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut )


description: Checks if element counts match. If false then Update can't be called  you must call Convert Result is based on the current ConversionOptions (e.g. if you are only updating vertices, mismatched triangles are ok)

code: bool HaveMatchingElementCounts ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * DynamicMesh, const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * MeshDescription )


description: Checks if element counts match. If false then Update can't be called  you must call Convert

code: static bool HaveMatchingElementCounts ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * DynamicMesh, const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * MeshDescription, bool bVerticesOnly, bool bAttributesOnly )


description: Update existing MeshDescription based on DynamicMesh. Assumes mesh topology has not changed. Copies positions optionally, normals, tangents and UVs

code: void Update ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, bool bUpdateNormals, bool bUpdateTangents, bool bUpdateUVs )


description: Use the MeshIn Overlays to update the Tangent and BinormalSign attributes of the MeshDescription, assuming mesh topology has not changed. Does not modify any other attributes. NOTE: assumes the order of triangles in the MeshIn correspond to the ordering you'd get by iterating over triangles, on MeshOut This matches conversion currently used in MeshDescriptionToDynamicMesh.cpp, but if that changes we will need to change this function to match!

code: void UpdateTangents ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut )


description: Update only attributes, assuming the mesh topology has not changed. Does not touch positions. NOTE: assumes the order of triangles in the MeshIn correspond to the ordering you'd get by iterating over triangles, on MeshOut This matches conversion currently used in MeshDescriptionToDynamicMesh.cpp, but if that changes we will need to change this function to match!

code: void UpdateAttributes ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, bool bUpdateNormals, bool bUpdateTangents, bool bUpdateUVs )


description: Use the TMeshTangents to update the Tangent and BinormalSign attributes of the MeshDescription, assuming mesh topology has not changed. Does not modify any other attributes. NOTE: this ignores any tangent or bitangent overlays on the MeshIn, and instead uses the tangent and bitangent information stored in the TMeshTangents NOTE: assumes the order of triangles in the MeshIn correspond to the ordering you'd get by iterating over triangles, on MeshOut This matches conversion currently used in MeshDescriptionToDynamicMesh.cpp, but if that changes we will need to change this function to match!

code: void UpdateTangents ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut, const [UE::Geometry::TMeshTangents](API\Runtime\GeometryCore\DynamicMesh\TMeshTangents)< double > * SrcTangents )


description: Updates the given mesh description based conversion options provided in the constructor. Assumes the mesh topology has not changed. Annoyingly, this can't just be namedUpdate()due to ambiguity with the function below, which existed beforehand and should probably have been this function instead.

code: void UpdateUsingConversionOptions ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut )


description: Update only vertex colors, assuming the mesh topology has not changed. Does not touch positions or other attributes. NOTE: assumes the order of triangles in the MeshIn correspond to the ordering you'd get by iterating over triangles, on MeshOut This matches conversion currently used in MeshDescriptionToDynamicMesh.cpp, but if that changes we will need to change this function to match!

code: void UpdateVertexColors ( const [FDynamicMesh3](API\Runtime\GeometryCore\DynamicMesh\FDynamicMesh3) * MeshIn, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshOut )


code: FDynamicMeshToMeshDescription ( [FConversionToMeshDescriptionOptions](API\Runtime\MeshConversion\FConversionToMeshDescriptionOpti-) ConversionOptions )


code: FDynamicMeshToMeshDescription()


className: FDynamicMeshToMeshDescription

description: Convert FDynamicMesh3 toFMeshDescription

code: class FDynamicMeshToMeshDescription

bPrintDebugMessages

description: If true, will print some possibly-helpful debugging spew to output log

ConversionOptions

type: FConversionToMe...

description: General settings for conversions to mesh description


className: FMeshConversionModule

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


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: Append new vertex instance and return ID

code: [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID) AppendInstance ( const [FVertexID](API\Runtime\MeshDescription\FVertexID) & VertexID )


description: Append an arbitrary polygon to the mesh with the given PolygonGroup ID Unique Vertex instances will be created for each polygon-vertex.

code: [FPolygonID](API\Runtime\MeshDescription\FPolygonID) AppendPolygon ( const [TArray](API\Runtime\Core\Containers\TArray)< [FVertexID](API\Runtime\MeshDescription\FVertexID) > & Vertices, const [FPolygonGroupID](API\Runtime\MeshDescription\FPolygonGroupID) & PolygonGroup )


description: Append a triangle to the mesh with the given PolygonGroup ID

code: [FTriangleID](API\Runtime\MeshDescription\FTriangleID) AppendTriangle ( const [FVertexID](API\Runtime\MeshDescription\FVertexID) * Triangle, const [FPolygonGroupID](API\Runtime\MeshDescription\FPolygonGroupID) & PolygonGroup )