Navigation
API > API/Runtime > API/Runtime/MediaAssets
| Name | UFileMediaSource |
| Type | class |
| Header File | /Engine/Source/Runtime/MediaAssets/Public/FileMediaSource.h |
| Include Path | #include "FileMediaSource.h" |
Syntax
UCLASS (BlueprintType, MinimalAPI)
class UFileMediaSource : public UBaseMediaSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaSource → UBaseMediaSource → UFileMediaSource
Implements Interfaces
Derived Classes
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrecacheFileOption | FName | Name of the PrecacheFile media option. | FileMediaSource.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FilePath | FString | The path to the media file to be played. | FileMediaSource.h |
|
| PrecacheFile | bool | Load entire media file into memory and play from there (if possible). | FileMediaSource.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ResolvedFullPath | FString | FileMediaSource.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FString & GetFilePath () |
Get the path to the media file to be played. | FileMediaSource.h | |
FString GetFullPath() |
Get the full path to the file. | FileMediaSource.h | |
void SetFilePath
(
const FString& Path |
Set the path to the media file that this source represents. | FileMediaSource.h |
|
Overridden from UMediaSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetDetailsPanelInfoElements
(
TArray< FInfoElement >& OutInfoElements |
Gets a list of text containing the media source's configuration and description for UI purposes | FileMediaSource.h | |
| Get the media source's URL string (must be implemented in child classes). | FileMediaSource.h | ||
virtual bool Validate() |
Validate the media source settings (must be implemented in child classes). | FileMediaSource.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
FileMediaSource.h |
Overridden from IMediaOptions
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetMediaOption
(
const FName& Key, |
FileMediaSource.h | ||
virtual bool HasMediaOption
(
const FName& Key |
FileMediaSource.h |