Navigation
API > API/Runtime > API/Runtime/Media
Interface for a media player's viewing settings.
This interface is used to control viewing parameters in media players that support 360-degree or stereoscopic video output, or spatial audio output. There are currently three sets of configurable parameters: view, view focus and user settings.
The view is the area that the user is looking at. Media players may use it to optimize the decoding of the media, i.e. only decode the sub-section of the video that is actually visible.
The view focus is an optional area that allows for specifying which area the user is or should be focusing on. Media players may use it for foveated video rendering or for making the focused area more audible.
The user settings can be used by media players to customize the generated audio or video output for specific users.
Note: This view class has now been extended to also support tiled media sources such as tiled exr image sequences. Sets of visible tiles can be specified per mip level.
| Name | IMediaView |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaView.h |
| Include Path | #include "IMediaView.h" |
Syntax
class IMediaView
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaView() |
Virtual destructor. | IMediaView.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetViewField
(
float& OutHorizontal, |
Get the field of view. | IMediaView.h | |
virtual bool GetViewOrientation
(
FQuat& OutOrientation |
Get the view's orientation. | IMediaView.h | |
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool GetVisibleTiles
(
TMap< int32, TSet< FMediaTileCoordinate > >& OutTiles |
Get the visible tiles per mip-level. | IMediaView.h | |
virtual bool IsViewFocusEnabled() |
Whether the view focus is enabled. | IMediaView.h | |
virtual bool SetInteroccularDistance
(
float Distance |
Set the inter-ocular distance. | IMediaView.h | |
virtual bool SetViewField
(
float Horizontal, |
Set the field of view. | IMediaView.h | |
virtual bool SetViewFocusEnabled
(
bool Enabled |
Enable or disable view focus. | IMediaView.h | |
virtual bool SetViewFocusField
(
float Horizontal, |
Set the view's focused field of view. | IMediaView.h | |
virtual bool SetViewFocusOffImportance
(
float Importance |
Set the importance of the area that is not in focus. | IMediaView.h | |
virtual bool SetViewFocusOrientation
(
const FQuat& Orientation |
Set the view's focused orientation. | IMediaView.h | |
virtual bool SetViewOrientation
(
const FQuat& Orientation, |
Set the view's orientation. | IMediaView.h | |
virtual bool SetVisibleTiles
(
TMap< int32, TSet< FMediaTileCoordinate > >&& InTiles |
Set the visible tiles per mip-level. | IMediaView.h |