#include <IMediaView.h>

Public Member Functions
virtual bool	GetViewField (float &OutHorizontal, float &OutVertical) const

virtual bool	GetViewOrientation (FQuat &OutOrientation) const

virtual bool	SetViewField (float Horizontal, float Vertical, bool Absolute)

virtual bool	SetViewOrientation (const FQuat &Orientation, bool Absolute)

virtual bool	IsViewFocusEnabled () const

virtual bool	SetViewFocusEnabled (bool Enabled)

virtual bool	SetViewFocusField (float Horizontal, float Vertical)

virtual bool	SetViewFocusOffImportance (float Importance)

virtual bool	SetViewFocusOrientation (const FQuat &Orientation)

virtual bool	SetInteroccularDistance (float Distance)

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool	GetVisibleTiles (TMap< int32, TSet< FMediaTileCoordinate > > &OutTiles) const

virtual bool	SetVisibleTiles (TMap< int32, TSet< FMediaTileCoordinate > > &&InTiles)

virtual	~IMediaView ()

Detailed Description

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.

See also: IMediaCache, IMediaControls, IMediaPlayer, IMediaSamples, IMediaTracks

Constructor & Destructor Documentation

◆ ~IMediaView()

virtual IMediaView::~IMediaView ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ GetViewField()

virtual bool IMediaView::GetViewField	(	float &	OutHorizontal,
		float &	OutVertical
	)		const

inlinevirtual

Get the field of view.

Parameters

OutHorizontal	Will contain the horizontal field of view.
OutVertical	Will contain the vertical field of view.

Returns: true on success, false if feature is not available or if field of view has never been set.

See also: GetViewOrientation, SetViewField

◆ GetViewOrientation()

virtual bool IMediaView::GetViewOrientation ( FQuat & OutOrientation ) const

inlinevirtual

Get the view's orientation.

Parameters

OutOrientation Will contain the view orientation.

Returns: true on success, false if feature is not available or if orientation has never been set.

See also: GetViewField, SetViewOrientation

◆ GetVisibleTiles()

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool IMediaView::GetVisibleTiles ( TMap< int32, TSet< FMediaTileCoordinate > > & OutTiles ) const

inlinevirtual

Get the visible tiles per mip-level.

Parameters

OutTiles Map of visible tile sets per mip level index.

Returns: true on success, false if feature is not available.

See also: SetVisibleTiles

◆ IsViewFocusEnabled()

virtual bool IMediaView::IsViewFocusEnabled ( ) const

inlinevirtual

Whether the view focus is enabled.

Returns: true if enabled, false otherwise.

◆ SetInteroccularDistance()

virtual bool IMediaView::SetInteroccularDistance ( float Distance )

inlinevirtual

Set the inter-ocular distance.

Parameters

Distance The inter-ocular distance (in centimeters).

Returns: true on success, false otherwise.

◆ SetViewField()

virtual bool IMediaView::SetViewField	(	float	Horizontal,
		float	Vertical,
		bool	Absolute
	)

inlinevirtual

Set the field of view.

Parameters

Horizontal	Horizontal field of view (in Euler degrees).
Vertical	Vertical field of view (in Euler degrees).
Whether	the field of view change should be absolute (true) or relative (false).

Returns: true on success, false otherwise.

See also: GetViewField, SetViewFocusField, SetViewOrientation

◆ SetViewFocusEnabled()

virtual bool IMediaView::SetViewFocusEnabled ( bool Enabled )

inlinevirtual

Enable or disable view focus.

Parameters

Enabled true to enable, false to disable.

Returns: true on success, false otherwise.

See also: IsViewFocusEnabled, SetViewFocusField, SetViewFocusOffImportance, SetViewFocusOrientation

◆ SetViewFocusField()

virtual bool IMediaView::SetViewFocusField	(	float	Horizontal,
		float	Vertical
	)

inlinevirtual

Set the view's focused field of view.

Parameters

Horizontal	Horizontal field of view (in Euler degrees).
Vertical	Vertical field of view (in Euler degrees).

Returns: true on success, false otherwise.

See also: SetViewFocusEnabled, SetViewFocusOffImportance, SetViewField, SetViewFocusOrientation

◆ SetViewFocusOffImportance()

virtual bool IMediaView::SetViewFocusOffImportance ( float Importance )

inlinevirtual

Set the importance of the area that is not in focus.

Parameters

Importance Off-area importance (0.0 = no importance, 1.0 = important).

Returns: true on success, false otherwise.

See also: SetViewFocusEnabled, SetViewFocusField, SetViewFocusOrientation

◆ SetViewFocusOrientation()

virtual bool IMediaView::SetViewFocusOrientation ( const FQuat & Orientation )

inlinevirtual

Set the view's focused orientation.

Parameters

Orientation Quaternion representing the viewer's orientation.

Returns: true on success, false otherwise.

See also: SetViewFocusEnabled, SetViewFocusOffImportance, SetViewFocusField, SetViewField

◆ SetViewOrientation()

virtual bool IMediaView::SetViewOrientation	(	const FQuat &	Orientation,
		bool	Absolute
	)

inlinevirtual

Set the view's orientation.

Parameters

Orientation	Quaternion representing the orientation.
Whether	the orientation change should be absolute (true) or relative (false).

Returns: true on success, false otherwise.

See also: GetViewOrientation, SetViewField

◆ SetVisibleTiles()

virtual bool IMediaView::SetVisibleTiles ( TMap< int32, TSet< FMediaTileCoordinate > > && InTiles )

inlinevirtual

Set the visible tiles per mip-level.

Parameters

InTiles Map of visible tile sets per mip level index.

Returns: true on success, false if feature is not available.

See also: GetVisibleTiles

The documentation for this class was generated from the following file:

Engine/Source/Runtime/Media/Public/IMediaView.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMediaView()

Member Function Documentation

◆ GetViewField()

◆ GetViewOrientation()

◆ GetVisibleTiles()

◆ IsViewFocusEnabled()

◆ SetInteroccularDistance()

◆ SetViewField()

◆ SetViewFocusEnabled()

◆ SetViewFocusField()

◆ SetViewFocusOffImportance()

◆ SetViewFocusOrientation()

◆ SetViewOrientation()

◆ SetVisibleTiles()