UMediaPlayer::OpenFile

Opens the specified media file path.

Windows
MacOS
Linux

References

Module

MediaAssets

Header

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

Include

#include "MediaPlayer.h"

Source

/Engine/Source/Runtime/MediaAssets/Private/Assets/MediaPlayer.cpp

Syntax

bool OpenFile
(
    const FString & FilePath
)

Remarks

Opens the specified media file path.

A return value of true indicates that the player will attempt to open the media, but it may fail to do so later for other reasons, i.e. if a connection to the media server timed out. Use the OnMediaOpened and OnMediaOpenFailed delegates to detect if and when the media is ready!

Returns

true if the file path will be opened, false otherwise.

Parameters

Parameter

Description

FilePath

The file path to open.

See Also

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