FMediaPlateResource | Unreal Engine 5.6 Documentation

Helper struct to wrap source selection functionality, and enabling the usage of media source properties for places like Remote Control.

This struct allows to choose between Asset, External File, Playlist options. It's mainly conceived to be used by MediaPlateComponent.

See FMediaPlayerResourceCustomization class for its customization.


Name	FMediaPlateResource
Type	struct
Header File	/Engine/Plugins/Media/MediaPlate/Source/MediaPlate/Public/MediaPlateResource.h
Include Path	#include "MediaPlateResource.h"

Syntax

USTRUCT (BlueprintType )  
struct FMediaPlateResource

Name	Remarks	Include Path	Unreal Specifiers
PRAGMA_DISABLE_DEPRECATION_WARNINGS FMediaPlateResource ()		MediaPlateResource.h
FMediaPlateResource ( const FMediaPlateResource& InOther )		MediaPlateResource.h
FMediaPlateResource ( FMediaPlateResource&& InOther )		MediaPlateResource.h

Name	Type	Remarks	Include Path	Unreal Specifiers
ExternalMediaPath	FString	A path pointing to an external media resource	MediaPlateResource.h	EditAnywhere Category="MediaPlateResource"
MediaAsset	TSoftObjectPtr< UMediaSource >	Media source coming from MediaSource asset	MediaPlateResource.h	EditAnywhere Category="MediaPlateResource"
SourcePlaylist	TSoftObjectPtr< UMediaPlaylist >	User facing Playlist asset	MediaPlateResource.h	EditAnywhere Category="MediaPlateResource"
Type	EMediaPlateResourceType	Media Source Type	MediaPlateResource.h	EditAnywhere Category="MediaPlateResource"

Name	Remarks	Include Path
UMediaPlaylist * GetActivePlaylist()		MediaPlateResource.h
FStringView GetExternalMediaPath()	Returns the current external media path, if any	MediaPlateResource.h
UMediaSource * GetMediaAsset()	Returns the current asset-based Media Source, if any	MediaPlateResource.h
EMediaPlateResourceType GetResourceType()	Return current resource type	MediaPlateResource.h
UMediaSource * GetSelectedMedia()		MediaPlateResource.h
UMediaPlaylist * GetSourcePlaylist()	Returns the current source playlist, if any	MediaPlateResource.h
void LoadExternalMedia ( const FString& InFilePath )	Loads the external source at the specified path, creating a media source with the specified outer.	MediaPlateResource.h
void LoadExternalMedia ( const FString& InFilePath, UObject* InOuter )		MediaPlateResource.h
void Modify()		MediaPlateResource.h
void SelectAsset ( const UMediaSource* InMediaSource, UObject* InOuter )		MediaPlateResource.h
void SelectAsset ( const UMediaSource* InMediaSource )	Select asset based media source. Will also update source type to Asset	MediaPlateResource.h
void SelectPlaylist ( const UMediaPlaylist* InPlaylist )	Select the specified playlist. Will also update source type to Playlist	MediaPlateResource.h
void SetResourceType ( EMediaPlateResourceType InType )	Set current resource type	MediaPlateResource.h

Name	Remarks	Include Path	Unreal Specifiers
FMediaPlateResource & operator= ( FMediaPlateResource&& )		MediaPlateResource.h
FMediaPlateResource & operator= ( const FMediaPlateResource& )		MediaPlateResource.h