IMediaPlayerProxyInterface Class Reference

#include <MediaPlayerProxyInterface.h>

Public Member Functions
virtual float	GetProxyRate () const =0
virtual bool	SetProxyRate (float Rate)=0
virtual bool	IsExternalControlAllowed ()=0
virtual const FMediaSourceCacheSettings &	GetCacheSettings () const =0
virtual UMediaSource *	ProxyGetMediaSourceFromIndex (int32 Index) const =0
virtual UMediaTexture *	ProxyGetMediaTexture (int32 LayerIndex, int32 TextureIndex)=0
virtual void	ProxyReleaseMediaTexture (int32 LayerIndex, int32 TextureIndex)=0
virtual bool	ProxySetAspectRatio (UMediaPlayer *InMediaPlayer)=0
virtual void	ProxySetTextureBlend (int32 LayerIndex, int32 TextureIndex, float Blend)=0

Member Function Documentation

GetCacheSettings()

virtual const FMediaSourceCacheSettings & IMediaPlayerProxyInterface::GetCacheSettings ( ) const

pure virtual

Gets the cache settings for the player.

GetProxyRate()

virtual float IMediaPlayerProxyInterface::GetProxyRate ( ) const

pure virtual

Get the desired playback rate. Note that this is not necessarily the actual rate of the player, merely the desired rate the user wants.

IsExternalControlAllowed()

virtual bool IMediaPlayerProxyInterface::IsExternalControlAllowed ( )

pure virtual

Call this to see if you can control the media player, or if the owning object is using it.

Returns

True if you can control the player.

ProxyGetMediaSourceFromIndex()

virtual UMediaSource * IMediaPlayerProxyInterface::ProxyGetMediaSourceFromIndex ( int32  Index ) const

pure virtual

Get the media source for a given index.

ProxyGetMediaTexture()

virtual UMediaTexture * IMediaPlayerProxyInterface::ProxyGetMediaTexture ( int32  LayerIndex, int32  TextureIndex  )

pure virtual

Get a media texture that we can assign a media player to.

ProxyReleaseMediaTexture()

virtual void IMediaPlayerProxyInterface::ProxyReleaseMediaTexture ( int32  LayerIndex, int32  TextureIndex  )

pure virtual

Release a media texture that was retrieved from ProxyGetMediaTexture.

ProxySetAspectRatio()

virtual bool IMediaPlayerProxyInterface::ProxySetAspectRatio ( UMediaPlayer *  InMediaPlayer )

pure virtual

Sets the aspect ratio of the proxy based on what the media player is playing.

This should be called every frame until it returns true. It might take a few frames to discover what the aspect ratio is. Also some proxies might not support aspect ratios, so they will also return true so you do not call this endlessly.

Returns

True if you no longer need to call this.

ProxySetTextureBlend()

virtual void IMediaPlayerProxyInterface::ProxySetTextureBlend ( int32  LayerIndex, int32  TextureIndex, float  Blend  )

pure virtual

Set the blend value for a texture that was retrieved from ProxyGetMediaTexture.

SetProxyRate()

virtual bool IMediaPlayerProxyInterface::SetProxyRate ( float  Rate )

pure virtual

Changes the desired playback rate.

Parameters

Rate	The playback rate to set.

Returns

True on success, false otherwise.

---

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

• Engine/Source/Runtime/MediaAssets/Public/MediaPlayerProxyInterface.h