UMediaPlayerTimeSynchronizationSource

Synchronization Source using the Media Player framework

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTimeSynchronizationSource

UMediaPlayerTimeSynchronizationSource

References

Module

MediaFrameworkUtilities

Header

/Engine/Plugins/Media/MediaFrameworkUtilities/Source/MediaFrameworkUtilities/Public/MediaPlayerTimeSynchronizationSource.h

Include

#include "MediaPlayerTimeSynchronizationSource.h"

Syntax

UCLASS(EditInlineNew)
class UMediaPlayerTimeSynchronizationSource : public UTimeSynchronizationSource

Remarks

Synchronization Source using the Media Player framework

Variables

Name Description

Public variable UProperty Category, EditAnywhere

UMediaSource &#...

 

MediaSource

Media source asset of this input

Public variable UProperty Category, EditAnywhere

UMediaTexture &...

 

MediaTexture

Texture linked to the media player

Overridden from UTimeSynchronizationSource

Name Description

Public function Virtual

void

 

Close()

Called when synchronization has been completed. The source may discard any unnecessary frames.

Public function Virtual Const

FString

 

GetDisplayName()

Name to used when displaying an error message or to used in UI.

Public function Virtual Const

FFrameRate

 

GetFrameRate()

Get the source actual FrameRate

Public function Virtual Const

FFrameTime

 

GetNewestSampleTime()

Get the time of the newest available sample (relative to this source's frame rate).

Public function Virtual Const

FFrameTime

 

GetOldestSampleTime()

Get the time of the oldest available sample (relative to this source's frame rate).

Public function Virtual Const

TSharedRef< ...

 

GetVisualWidget()

Get Visual Widget of this source to display in UI

Public function Virtual Const

bool

 

IsReady()

Used to know if the source is ready to be used for synchronization.

Public function Virtual

bool

 

Open

(
    const FTimeSynchronizationOpenData ...
)

Called when synchronization is started to notify this source to begin buffering frames.

Public function Virtual

void

 

Start

(
    const FTimeSynchronizationStartData...
)

Start playing samples.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally