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