Navigation
API > API/Runtime > API/Runtime/Media
Interface for media players.
| Name | IMediaPlayer |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaPlayer.h |
| Include Path | #include "IMediaPlayer.h" |
Syntax
class IMediaPlayer
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaPlayer() |
Virtual destructor. | IMediaPlayer.h |
Interfaces
| Name | Remarks |
|---|---|
| IAsyncResourceReleaseNotification |
Enums
Public
| Name | Remarks |
|---|---|
| EFeatureFlag |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| IAsyncResourceReleaseNotificationRef | TSharedRef< IAsyncResourceReleaseNotification, ESPMode::ThreadSafe > | IMediaPlayer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Close () |
Close a previously opened media source. | IMediaPlayer.h | |
virtual bool FlushOnSeekCompleted() |
Flush sinks when seek ends | IMediaPlayer.h | |
virtual bool FlushOnSeekStarted() |
Flush sinks when seek begins | IMediaPlayer.h | |
IMediaCache & GetCache () |
Get the player's cache controls. | IMediaPlayer.h | |
| Get the player's playback controls. | IMediaPlayer.h | ||
FString GetInfo () |
Get debug information about the player and currently opened media. | IMediaPlayer.h | |
virtual FVariant GetMediaInfo
(
FName InfoName |
Get information about the media that is playing. | IMediaPlayer.h | |
virtual TSharedPtr< TMap< FString, TArray< TUniquePtr< IMediaMetadataItem > > >, ESPMode::ThreadSafe > GetMediaMetadata () |
Gets the current metadata of the media source. | IMediaPlayer.h | |
virtual FText GetMediaName () |
Get the human readable name of the currently loaded media source. | IMediaPlayer.h | |
virtual uint32 GetNewResourcesOnOpen() |
Return IMediaPlayerLifecycleManagerDelegate::ResourceFlags bitmask to indicate resource types recreated on a open call | IMediaPlayer.h | |
virtual bool GetPlayerFeatureFlag
(
EFeatureFlag |
IMediaPlayer.h | ||
| Get the GUID for this player plugin. | IMediaPlayer.h | ||
IMediaSamples & GetSamples () |
Get the player's sample queue. | IMediaPlayer.h | |
FString GetStats () |
Get playback statistics information. | IMediaPlayer.h | |
IMediaTracks & GetTracks () |
Get the player's track collection. | IMediaPlayer.h | |
FString GetUrl() |
Get the URL of the currently loaded media. | IMediaPlayer.h | |
IMediaView & GetView () |
Get the player's view settings. | IMediaPlayer.h | |
bool Open
(
const FString& Url, |
Open a media source from a URL with optional parameters. | IMediaPlayer.h | |
bool Open
(
const TSharedRef< FArchive, ESPMode::ThreadSafe >& Archive, |
Open a media source from a file or memory archive with optional parameters. | IMediaPlayer.h | |
virtual bool Open
(
const FString& Url, |
Open a media source from a URL with optional asset and player parameters. | IMediaPlayer.h | |
virtual bool SetAsyncResourceReleaseNotification
(
IAsyncResourceReleaseNotificationRef AsyncDestructNotification |
Set async resource release notification for use with IMediaPlayerLifecycleManagerDelegate | IMediaPlayer.h | |
virtual void SetGuid
(
const FGuid& Guid |
Set the player's globally unique identifier. | IMediaPlayer.h | |
virtual void SetLastAudioRenderedSampleTime
(
FTimespan SampleTime |
Notify player of last sample time of audio used. | IMediaPlayer.h | |
virtual bool SetNativeVolume
(
float Volume |
Set the player's native volume if supported. | IMediaPlayer.h | |
virtual void TickAudio () |
Tick the player's audio related code. | IMediaPlayer.h | |
| Tick the player in the Fetch phase. | IMediaPlayer.h | ||
| Tick the player in the Input phase. | IMediaPlayer.h |