UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMediaControls.h File Reference
#include "Math/Range.h"
#include "Math/RangeSet.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/Timespan.h"
#include "Misc/Optional.h"

Go to the source code of this file.

Classes

struct  FMediaSeekParams
 
class  IMediaControls
 

Enumerations

enum class  EMediaControl {
  BlockOnFetch , Pause , Resume , Scrub ,
  Seek , PlaybackRange
}
 
enum class  EMediaSeekDirection { Backward , Beginning , End , Forward }
 
enum class  EMediaRateThinning { Thinned , Unthinned }
 
enum class  EMediaState {
  Closed , Error , Paused , Playing ,
  Preparing , Stopped
}
 
enum class  EMediaStatus { None = 0x0 , Buffering = 0x1 , Connecting = 0x2 }
 
enum class  EMediaTimeRangeType { Absolute , Current }
 

Functions

 ENUM_CLASS_FLAGS (EMediaStatus)
 

Enumeration Type Documentation

◆ EMediaControl

enum class EMediaControl
strong

Available media controls.

Enumerator
BlockOnFetch 

Block on fetch.

Pause 

Pause playback.

Resume 

Resume playback.

Scrub 

Seek to playback position (while updating output).

Seek 

Seek to playback position.

PlaybackRange 

Playback of a range.

◆ EMediaRateThinning

enum class EMediaRateThinning
strong

Thinning modes for playback rates.

Enumerator
Thinned 

Frames will be skipped to accommodate play rate.

Unthinned 

No frames will be skipped.

◆ EMediaSeekDirection

enum class EMediaSeekDirection
strong

Directions for seeking in media.

Enumerator
Backward 

Seek backwards from current position.

Beginning 

Seek from the beginning of the media.

End 

Seek from the end of the media.

Forward 

Seek forward from current position.

◆ EMediaState

enum class EMediaState
strong

Possible states of media playback.

Enumerator
Closed 

Media has been closed and cannot be played again.

Error 

Unrecoverable error occurred during playback.

Paused 

Playback has been paused, but can be resumed.

Playing 

Media is currently playing.

Preparing 

Media is being prepared for playback.

Stopped 

Playback has been stopped, but can be restarted.

◆ EMediaStatus

enum class EMediaStatus
strong

Available media player status flags.

Enumerator
None 

No flags set.

Buffering 

Player is buffering data.

Connecting 

Player is connecting to a media source.

◆ EMediaTimeRangeType

enum class EMediaTimeRangeType
strong

Different types of media timeline ranges.

Enumerator
Absolute 

Total absolute time range as defined by the media.

Current 

Current time range of the media, set by media internal means or through API calls.

Function Documentation

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( EMediaStatus  )