1. Epic GamesDeveloper
  3. UMediaPlateComponent

UMediaPlateComponent

This is a component for [AMediaPlate](API\Plugins\MediaPlate\AMediaPlate) that can play and show media in the world.

API > API/Plugins > API/Plugins/MediaPlate

Inheritance Hierarchy

References

   
Module MediaPlate
Header /Engine/Plugins/Media/MediaPlate/Source/MediaPlate/Public/MediaPlateComponent.h
Include #include "MediaPlateComponent.h"

Syntax

UCLASS&40;&41;  
class UMediaPlateComponent :  
    public UActorComponent,  
    public IMediaPlayerProxyInterface

Remarks

This is a component for AMediaPlate that can play and show media in the world.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bAutoPlay If set then start playing when this object is active.
Public variable UProperty Category, EditAnywhere bool bEnableAudio If set then enable audio.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bPlayOnOpen If set then play when opening the media.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay FMediaSourceCacheSettings CacheSettings Override the default cache settings.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay TArray< TObjectPtr< UStaticMeshComponent > > Letterboxes Holds the component for the mesh.
Public variable UProperty Category BlueprintReadWrite TObjectPtr< UMediaPlaylist > MediaPlaylist What media playlist to play.
Public variable UProperty Category BlueprintReadWrite int32 PlaylistIndex The current index of the source in the play list being played.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay TObjectPtr< UMediaSoundComponent > SoundComponent Holds the component to play sound.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float StartTime What time to start playing from (in seconds).
Public variable UProperty Category, EditAnywhere, AdvancedDisplay TObjectPtr< UStaticMeshComponent > StaticMeshComponent Holds the component for the mesh.

Constructors

  Type Name Description
Public function  

UMediaPlateComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

Close ()

 Call this to close the media.
Public function float Call this to get the aspect ratio of the mesh.
Public function Static float

GetForwardRate ( UMediaPlayer* MediaPlayer
)

 Get the rate to use when we press the forward button.
Public function Const UFunction BlueprintCallable, Category bool Gets whether automatic aspect ratio is enabled.
Public function UFunction BlueprintCallable, Category float Call this to get the aspect ratio of the screen.
Public function UFunction blueprintgetter bool

GetLoop ()

 Call this to see if we want to loop.
Public function UFunction BlueprintCallable, Category UMediaPlayer * Call this get our media player.
Public function UFunction BlueprintCallable, Category UMediaTexture *

GetMediaTexture ( int32 Index
)

 Call this get our media texture.
Public function Const UFunction BlueprintCallable, Category FVector2D Return the arc size in degrees used for visible mips and tiles calculations, specific to the sphere.
Public function Static float

GetReverseRate ( UMediaPlayer* MediaPlayer
)

 Get the rate to use when we press the reverse button.
Public function Const EMediaTextureVisibleMipsTiles Call this to get the mip tile calculations mesh mode.
Public function Const bool Call this to see if this plate wants to play when it becomes visible.
Public function Const UFunction blueprintgetter bool Call this to see if the media plate is playing.
Public function bool

Next ()

 Play the next item in the playlist.returns True if it played something.
Public function UFunction BlueprintCallable, Category void

Open ()

 Call this to open the media.
Public function UFunction BlueprintCallable, Category void

Pause ()

 Call this to pause playback. Play can be called to resume playback.
Public function UFunction BlueprintCallable, Category void

Play ()

 Call this to start playing. Open must be called before this.
Public function bool Play the previous item in the playlist.returns True if it played something.
Public function UFunction BlueprintCallable, Category bool

Rewind ()

 Rewinds the media to the beginning.This is the same as seeking to zero time.
Public function UFunction BlueprintCallable, Category bool

Seek ( const FTimespan& Time
)

 Call this to seek to the specified playback time.
Public function void

SetAspectRatio ( float AspectRatio
)

 Call this to set the aspect ratio of the mesh.
Public function UFunction BlueprintCallable, Category void

SetIsAspectRatioAuto ( bool bInIsAspectRatioAuto
)

 Sets whether automatic aspect ratio is enabled.
Public function UFunction BlueprintCallable, Category void

SetLetterboxAspectRatio ( float AspectRatio
)

 Call this to set the aspect ratio of the screen.
Public function UFunction blueprintsetter void

SetLoop ( bool bInLoop
)

 Call this enable/disable looping.
Public function UFunction BlueprintCallable, Category void

SetMeshRange ( FVector2D InMeshRange
)

 Set the arc size in degrees used for visible mips and tiles calculations, specific to the sphere.
Public function void

SetNumberOfTextures ( int32 NumTextures
)

 Called from AMediaPlate to set how many media textures the material needs.
Public function UFunction BlueprintCallable, Category void

SetPlayOnlyWhenVisible ( bool bInPlayOnlyWhenVisible
)

 Call this to set bPlayOnlyWhenVisible.
Public function void

SetVisibleMipsTilesCalculations ( EMediaTextureVisibleMipsTiles InVisibleMipsTilesCalculations
)

 Call this to set the mip tile calculations mesh mode. (Note: restarts playback to apply changes.)
Public function void Called whenever a button was pressed locally or on a remote endpoint.
Public function void Called from the media clock.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Begins Play for the component.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from IMediaPlayerProxyInterface

  Type Name Description
Public function Virtual Const const FMediaSourceCacheSettings & Gets the cache settings for the player.
Public function Virtual Const float Get the desired playback rate.
Public function Virtual bool Call this to see if you can control the media player, or if the owning object is using it.
Public function Virtual Const UMediaSource * Get the media source for a given index.
Public function Virtual UMediaTexture *

ProxyGetMediaTexture ( int32 LayerIndex,
int32 TextureIndex
)

 Get a media texture that we can assign a media player to.
Public function Virtual void

ProxyReleaseMediaTexture ( int32 LayerIndex,
int32 TextureIndex
)

 Release a media texture that was retrieved from ProxyGetMediaTexture.
Public function Virtual bool

ProxySetAspectRatio ( UMediaPlayer* InMediaPlayer
)

 Sets the aspect ratio of the proxy based on what the media player is playing.
Public function Virtual void

ProxySetTextureBlend ( int32 LayerIndex,
int32 TextureIndex,
float Blend
)

 Set the blend value for a texture that was retrieved from ProxyGetMediaTexture.
Public function Virtual bool

SetProxyRate ( float Rate
)

 Changes the desired playback rate.

Constants

Name Description
MediaComponentName Name for our media component.
MediaPlaylistName Name for our playlist.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page