UFileMediaSource

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MediaAssets

Header

/Engine/Source/Runtime/MediaAssets/Public/FileMediaSource.h

Include

#include "FileMediaSource.h"

Syntax

class UFileMediaSource : public UBaseMediaSource

Variables

Name Description

Public variable

FString

 

FilePath

The path to the media file to be played.

Public variable

bool

 

PrecacheFile

Load entire media file into memory and play from there (if possible).

Functions

Name Description

Public function Const

const FStrin...

 

GetFilePath()

Get the path to the media file to be played.

Public function Const

FString

 

GetFullPath()

Get the full path to the file.

Public function

void

 

SetFilePath

(
    const FString& Path
)

Set the path to the media file that this source represents.

Overridden from UMediaSource

Name Description

Public function Virtual Const

FString

 

GetUrl()

Get the media source's URL string (must be implemented in child classes).

Public function Virtual Const

bool

 

Validate()

Validate the media source settings (must be implemented in child classes).

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Overridden from IMediaOptions

Name Description

Public function Virtual Const

bool

 

GetMediaOption

(
    const FName& Key,
    bool DefaultValue
)

Get a Boolean media option.

Public function Virtual Const

bool

 

HasMediaOption

(
    const FName& Key
)

Check whether the specified option is set.

Constants

Name

Description

PrecacheFileOption

Name of the PrecacheFile media option.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss