Language:
Discover
By Skill Level
By Category

IMediaView

Choose your OS:

Syntax

class IMediaView

Remarks

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.

Destructors

Name Description

Public function Virtual

~IMediaView()

Virtual destructor.

Functions

Name Description

Public function Virtual

bool

 

GetViewField

(
    float& OutHorizontal,
    float& OutVertical
)

Get the field of view.

Public function Virtual

bool

 

GetViewOrientation

(
    FQuat & OutOrientation
)

Get the view's orientation.

Public function Virtual

bool

 

IsViewFocusEnabled()

Whether the view focus is enabled.

true if enabled, false otherwise.

Public function Virtual

bool

 

SetInteroccularDistance

(
    float Distance
)

Set the inter-ocular distance.

true on success, false otherwise.

Public function Virtual

bool

 

SetViewField

(
    float Horizontal,
    float Vertical,
    bool Absolute
)

Set the field of view.

true on success, false otherwise.

Public function Virtual

bool

 

SetViewFocusEnabled

(
    bool Enabled
)

Enable or disable view focus.

true on success, false otherwise.

Public function Virtual

bool

 

SetViewFocusField

(
    float Horizontal,
    float Vertical
)

Set the view's focused field of view.

true on success, false otherwise.

Public function Virtual

bool

 

SetViewFocusOffImportance

(
    float Importance
)

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

true on success, false otherwise.

Public function Virtual

bool

 

SetViewFocusOrientation

(
    const FQuat & Orientation
)

Set the view's focused orientation.

true on success, false otherwise.

Public function Virtual

bool

 

SetViewOrientation

(
    const FQuat & Orientation,
    bool Absolute
)

Set the view's orientation.

true on success, false otherwise.

See Also

References

Module

Media

Header

Runtime/Media/Public/IMediaView.h