Navigation
API > API/Runtime > API/Runtime/Media
Interface for controlling media playback.
| Name | IMediaControls |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaControls.h |
| Include Path | #include "IMediaControls.h" |
Syntax
class IMediaControls
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaControls() |
Virtual destructor. | IMediaControls.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanControl
(
EMediaControl Control |
Whether the specified control is currently available. | IMediaControls.h | |
| Get the media's duration. | IMediaControls.h | ||
virtual TRange< FTimespan > GetPlaybackTimeRange
(
EMediaTimeRangeType InRangeToGet |
IMediaControls.h | ||
float GetRate () |
Get the nominal playback rate, i.e. 1.0 for real time. | IMediaControls.h | |
| Get the state of the media. | IMediaControls.h | ||
EMediaStatus GetStatus() |
Get media player status flags. | IMediaControls.h | |
TRangeSet< float > GetSupportedRates
(
EMediaRateThinning Thinning |
Get the supported playback rates. | IMediaControls.h | |
| Get the player's current playback time. | IMediaControls.h | ||
bool IsLooping () |
Check whether playback is currently looping. | IMediaControls.h | |
bool Pause () |
Pause media playback.This is the same as setting the playback rate to 0.0. | IMediaControls.h | |
bool Play () |
Start media playback at the default rate of 1.0. | IMediaControls.h | |
| Change the media's playback time. | IMediaControls.h | ||
virtual bool Seek
(
const FTimespan& InNewTime, |
Same as Seek(), but with additional options. | IMediaControls.h | |
bool Seek
(
const FTimespan& TimeOffset, |
Change the playback time of the media by a relative offset in the given direction. | IMediaControls.h | |
virtual void SetBlockingPlaybackHint
(
bool bFacadeWillUseBlockingPlayback |
Hint for player indicating that blocked playback mode will be used / not used | IMediaControls.h | |
bool SetLooping
(
bool Looping |
Set whether playback should be looping. | IMediaControls.h | |
| IMediaControls.h | |||
bool SetRate
(
float Rate |
Set the current playback rate. | IMediaControls.h |