1. Epic GamesDeveloper
  3. UMediaSource

UMediaSource

Abstract base class for media sources.

API > API/Runtime > API/Runtime/MediaAssets

Inheritance Hierarchy

References

   
Module MediaAssets
Header /Engine/Source/Runtime/MediaAssets/Public/MediaSource.h
Include #include "MediaSource.h"

Syntax

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

Remarks

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.

Functions

  Type Name Description
Public function Virtual void  
Public function void Starts the process to generate a thumbnail.
Public function Virtual Const FName  
Public function Virtual Const FString

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

  
Public function Virtual Const int64

GetMediaOption ( const FName& Key,
int64 DefaultValue
)

  
Public function Virtual Const double

GetMediaOption ( const FName& Key,
double DefaultValue
)

  
Public function Virtual Const bool

GetMediaOption ( const FName& Key,
bool DefaultValue
)

  
Public function Virtual Const FText

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

  
Public function Virtual Const TSharedPtr< FDataContainer, ESPMode::ThreadSafe >

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

  
Public function Const UTexture * Gets our thumbnail texture, if any.
Public function Virtual Const UFunction BlueprintCallable, Category FString

GetUrl ()

 Get the media source's URL string (must be implemented in child classes).
Public function Virtual Const bool

HasMediaOption ( const FName& Key
)

  
Public function Static void Call this to register a callback when someone calls SpawnMediaSourceForString.
Public function UFunction BlueprintCallable, Category, Meta void

SetMediaOptionBool ( const FName& Key,
bool Value
)

 Set a boolean parameter to pass to the player.
Public function void

SetMediaOptionDouble ( const FName& Key,
double Value
)

 Set a double parameter to pass to the player.
Public function UFunction BlueprintCallable, Category, Meta void

SetMediaOptionFloat ( const FName& Key,
float Value
)

 Set a float parameter to pass to the player.
Public function UFunction BlueprintCallable, Category, Meta void

SetMediaOptionInt64 ( const FName& Key,
int64 Value
)

 Set an integer64 parameter to pass to the player.
Public function UFunction BlueprintCallable, Category, Meta void

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

 Set a string parameter to pass to the player.
Public function void

SetThumbnail ( UTexture* InTexture
)

 Sets what the thumbnail texture should be.
Public function Static UMediaSource *

SpawnMediaSourceForString ( const FString& MediaPath,
UObject* Outer
)

 Call this to try and create a media source appropriate for the media.
Public function Virtual Const const UObject *  
Public function Static void Call this to unregister a callback set with RegisterSpawnFromFileExtension.
Public function Virtual Const UFunction BlueprintCallable, Category bool Validate the media source settings (must be implemented in child classes).

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page