1. Epic GamesDeveloper
  3. IMediaPlayer

IMediaPlayer

Interface for media players.

Unreal Engine C++ API Reference > Runtime > Media

Inheritance Hierarchy

References

   
Module Media
Header /Engine/Source/Runtime/Media/Public/IMediaPlayer.h
Include #include "IMediaPlayer.h"

Syntax

class IMediaPlayer

Remarks

Interface for media players.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

Close ()

 Close a previously opened media source.
Public function Virtual Const bool Flush sinks when seek ends
Public function Virtual Const bool Flush sinks when seek begins
Public function IMediaCache & Get the player's cache controls.
Public function IMediaControls & 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 FVariant

GetMediaInfo ( FName InfoName
)

 Get information about the media that is playing.
Public function Virtual Const TSharedPtr< TMap< FString, TArray< TUniquePtr< IMediaMetadataItem > > >, ESPMode::ThreadSafe > Gets the current metadata of the media source.
Public function Virtual Const FText Get the human readable name of the currently loaded media source.
Public function Virtual Const uint32 Return IMediaPlayerLifecycleManagerDelegate::ResourceFlags bitmask to indicate resource types recreated on a open call
Public function Virtual Const bool  
Public function Const FGuid Get the GUID for this player plugin.
Public function IMediaSamples & Get the player's sample queue.
Public function Const FString Get playback statistics information.
Public function IMediaTracks & 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::ThreadSafe >& Archive,
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* PlayerOptions
)

 Open a media source from a URL with optional asset and player parameters.
Public function Virtual void Any extra processing that the player should do when FMediaPlayerFacade::ProcessVideoSamples is run should be put here.
Public function Virtual bool 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 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 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

  Type Name Description
Public class IAsyncResourceReleaseNotification    

Enums

  Type Name Description
Public enum EFeatureFlag    

Typedefs

Name Description
IAsyncResourceReleaseNotificationRef  

See Also

IMediaPlayerFactory

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page