IMediaPlayer

Interface for media players.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMediaPlayer

FMediaIOCorePlayerBase

References

Module

Media

Header

/Engine/Source/Runtime/Media/Public/IMediaPlayer.h

Include

#include "IMediaPlayer.h"

Syntax

class IMediaPlayer

Remarks

Interface for media players.

Destructors

Name Description

Public function Virtual

~IMediaPlayer()

Virtual destructor.

Functions

Name Description

Public function

void

 

Close()

Close a previously opened media source.

Public function Virtual Const

bool

 

FlushOnSeekCompleted()

Flush sinks when seek ends

Public function Virtual Const

bool

 

FlushOnSeekStarted()

Flush sinks when seek begins

Public function

IMediaCache ...

 

GetCache()

Get the player's cache controls.

Public function

IMediaContro...

 

GetControls()

Get the player's playback controls.

Public function Const

FString

 

GetInfo()

Get debug information about the player and currently opened media.

Public function Virtual Const

FText

 

GetMediaName()

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

Public function Virtual Const

uint32

 

GetNewResourcesOnOpen()

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

Public function Virtual Const

bool

 

GetPlayerFeatureFlag

(
    EFeatureFlag
)

Public function Const

FGuid

 

GetPlayerPluginGUID()

Get the GUID for this player plugin.

Public function

IMediaSample...

 

GetSamples()

Get the player's sample queue.

Public function Const

FString

 

GetStats()

Get playback statistics information.

Public function

IMediaTracks...

 

GetTracks()

Get the player's track collection.

Public function Const

FString

 

GetUrl()

Get the URL of the currently loaded media.

Public function

IMediaView &

 

GetView()

Get the player's view settings.

Public function

bool

 

Open

(
    const FString& Url,
    const IMediaOptions* Options
)

Open a media source from a URL with optional parameters.

Public function

bool

 

Open

(
    const TSharedRef< FArchive, ESPMode...,
    const FString& OriginalUrl,
    const IMediaOptions* Options
)

Open a media source from a file or memory archive with optional parameters.

Public function Virtual

bool

 

Open

(
    const FString& Url,
    const IMediaOptions* Options,
    const FMediaPlayerOptions* Pla...
)

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

Public function Virtual

void

 

ProcessVideoSamples()

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

Public function Virtual

bool

 

SetAsyncResourceReleaseNotification

Set async resource release notification for use with IMediaPlayerLifecycleManagerDelegate

Public function Virtual

void

 

SetGuid

(
    const FGuid& Guid
)

Set the player's globally unique identifier.

Public function Virtual

void

 

SetLastAudioRenderedSampleTime

(
    FTimespan SampleTime
)

Notify player of last sample time of audio used.

Public function Virtual

bool

 

SetNativeVolume

(
    float Volume
)

Set the player's native volume if supported.

Public function Virtual

void

 

TickAudio()

Tick the player's audio related code.

Public function Virtual

void

 

TickFetch

(
    FTimespan DeltaTime,
    FTimespan Timecode
)

Tick the player in the Fetch phase.

Public function Virtual

void

 

TickInput

(
    FTimespan DeltaTime,
    FTimespan Timecode
)

Tick the player in the Input phase.

Classes

Enums

Name

Description

Public enum

EFeatureFlag

Typedefs

See Also