Language:
Discover
By Skill Level
By Category

IMediaPlayer

Choose your OS:

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

bool

 

FlushOnSeekCompleted()

Flush sinks when seek ends

true if sinks should be flushed when a seek finishes

Public function Virtual

bool

 

FlushOnSeekStarted()

Flush sinks when seek begins

true if sinks should be flushed when a seek starts

Public function

IMediaCache ...

 

GetCache()

Get the player's cache controls.

Public function

IMediaContro ...

 

GetControls()

Get the player's playback controls.

Public function

FString

 

GetInfo()

Get debug information about the player and currently opened media.

Information string.

Public function Virtual

FText

 

GetMediaName()

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

Public function

FName

 

GetPlayerName()

Get the name of this player.

Media player name, i.e. 'AndroidMedia' or 'WmfMedia'.

Public function

IMediaSample ...

 

GetSamples()

Get the player's sample queue.

Public function

FString

 

GetStats()

Get playback statistics information.

Information string.

Public function

IMediaTracks ...

 

GetTracks()

Get the player's track collection.

Public function

FString

 

GetUrl()

Get the URL of the currently loaded media.

Media URL.

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

 

SetGuid

(
    const FGuid & Guid
)

Set the player's globally unique identifier.

Public function Virtual

bool

 

SetNativeVolume

(
    float Volume
)

Set the player's native volume if supported.

true on success, false otherwise.

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.

See Also

References

Module

Media

Header

Runtime/Media/Public/IMediaPlayer.h