Navigation
API > API/Runtime > API/Runtime/MediaAssets
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMediaSource
- UBaseMediaSource
- UFileMediaSource
References
| Module | MediaAssets |
| Header | /Engine/Source/Runtime/MediaAssets/Public/FileMediaSource.h |
| Include | #include "FileMediaSource.h" |
Syntax
class UFileMediaSource : public UBaseMediaSource
Variables
| Type | Name | Description | |
|---|---|---|---|
| FString | FilePath | The path to the media file to be played. | |
| bool | PrecacheFile | Load entire media file into memory and play from there (if possible). |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const FString & | GetFilePath () |
Get the path to the media file to be played. | |
| FString | GetFullPath () |
Get the full path to the file. | |
| void | SetFilePath
(
const FString& Path |
Set the path to the media file that this source represents. |
Overridden from UMediaSource
| Type | Name | Description | |
|---|---|---|---|
| FString | GetUrl () |
Get the media source's URL string (must be implemented in child classes). | |
| bool | Validate () |
Validate the media source settings (must be implemented in child classes). |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
Overridden from IMediaOptions
| Type | Name | Description | |
|---|---|---|---|
| bool | GetMediaOption
(
const FName& Key, |
Get a Boolean media option. | |
| bool | HasMediaOption
(
const FName& Key |
Check whether the specified option is set. |
Constants
| Name | Description |
|---|---|
| PrecacheFileOption | Name of the PrecacheFile media option. |