1. Epic GamesDeveloper
  3. UMediaSource

UMediaSource

Abstract base class for media sources.

API > API/Runtime > API/Runtime/MediaAssets

Abstract base class for media sources.

Media sources describe the location and/or settings of media objects that can be played in a media player, such as a video file on disk, a video stream on the internet, or a web cam attached to or built into the target device. The location is encoded as a media URL string, whose URI scheme and optional file extension will be used to locate a suitable media player.

   
Name UMediaSource
Type class
Header File /Engine/Source/Runtime/MediaAssets/Public/MediaSource.h
Include Path #include "MediaSource.h"

Syntax

UCLASS (Abstract, EditInlineNew, BlueprintType, HideCategories=(Object), MinimalAPI)  
class UMediaSource :  
    public UObject ,  
    public IMediaOptions

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Typedefs

Name Type Remarks Include Path
FInfoElement TTuple< FText, FText, FText >   MediaSource.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
MediaOptionsMap TMap< FName, FVariant > Holds our media options. MediaSource.h  
MediaSourceRenderer TObjectPtr< UObject > Renders thumnbnails for us. MediaSource.h
  • Transient
ThumbnailImage TObjectPtr< UTexture > The thumbnail image. MediaSource.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GenerateThumbnail()

 Starts the process to generate a thumbnail. MediaSource.h  

virtual FString GetDescriptionString()

 Gets a string that sums up the media source's description for UI purposes MediaSource.h  

virtual void GetDetailsPanelInfoElements ( TArray< FInfoElement >& OutInfoElements
) const

 Gets a list of text containing the media source's configuration and description for UI purposes MediaSource.h  

UTexture * GetThumbnail()

 Gets our thumbnail texture, if any. MediaSource.h  

virtual FString GetUrl ()

 Get the media source's URL string (must be implemented in child classes). MediaSource.h
  • BlueprintCallable
  • Category="Media|MediaSource"

void SetMediaOptionBool ( const FName& Key,
bool Value
)

 Set a boolean parameter to pass to the player. MediaSource.h
  • BlueprintCallable
  • Meta=(DisplayName="SetMediaOption (boolean)")
  • Category="Media|MediaSource"

void SetMediaOptionDouble ( const FName& Key,
double Value
)

 Set a double parameter to pass to the player. MediaSource.h  

void SetMediaOptionFloat ( const FName& Key,
float Value
)

 Set a float parameter to pass to the player. MediaSource.h
  • BlueprintCallable
  • Meta=(DisplayName="SetMediaOption (float)")
  • Category="Media|MediaSource"

void SetMediaOptionInt64 ( const FName& Key,
int64 Value
)

 Set an integer64 parameter to pass to the player. MediaSource.h
  • BlueprintCallable
  • Meta=(DisplayName="SetMediaOption (integer64)")
  • Category="Media|MediaSource"

void SetMediaOptionString ( const FName& Key,
const FString& Value
)

 Set a string parameter to pass to the player. MediaSource.h
  • BlueprintCallable
  • Meta=(DisplayName="SetMediaOption (string)")
  • Category="Media|MediaSource"

void SetThumbnail ( UTexture* InTexture
)

 Sets what the thumbnail texture should be. MediaSource.h  

virtual bool Validate()

 Validate the media source settings (must be implemented in child classes). MediaSource.h
  • BlueprintCallable
  • Category="Media|MediaSource"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MediaSource.h  

Overridden from IMediaOptions

Name Remarks Include Path Unreal Specifiers

virtual FName GetDesiredPlayerName()

   MediaSource.h  

virtual FString GetMediaOption ( const FName& Key,
const FString& DefaultValue
) const

   MediaSource.h  

virtual int64 GetMediaOption ( const FName& Key,
int64 DefaultValue
) const

   MediaSource.h  

virtual double GetMediaOption ( const FName& Key,
double DefaultValue
) const

   MediaSource.h  

virtual bool GetMediaOption ( const FName& Key,
bool DefaultValue
) const

   MediaSource.h  

virtual FText GetMediaOption ( const FName& Key,
const FText& DefaultValue
) const

   MediaSource.h  

virtual TSharedPtr< FDataContainer, ESPMode::ThreadSafe > GetMediaOption ( const FName& Key,
const TSharedPtr< FDataContainer, ESPMode::ThreadSafe >& DefaultValue
) const

   MediaSource.h  

virtual bool HasMediaOption ( const FName& Key
) const

   MediaSource.h  

virtual const UObject * ToUObject()

   MediaSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static TMap< FString, FMediaSourceSpawnDelegate > & GetSpawnFromFileExtensionDelegates()

 Get a mapping of file extensions to spawn delegates. MediaSource.h  

static void RegisterSpawnFromFileExtension ( const FString& Extension,
FMediaSourceSpawnDelegate InDelegate
)

 Call this to register a callback when someone calls SpawnMediaSourceForString. MediaSource.h  

static UMediaSource * SpawnMediaSourceForString ( const FString& MediaPath,
UObject* Outer
)

 Call this to try and create a media source appropriate for the media. MediaSource.h  

static void UnregisterSpawnFromFileExtension ( const FString& Extension
)

 Call this to unregister a callback set with RegisterSpawnFromFileExtension. MediaSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page