Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MediaIOCore > FMediaIOCorePlayerBase > Open > FMediaIOCorePlayerBase::Open

Light Theme

Dark Theme

FMediaIOCorePlayerBase::Open

Open a media source from a URL with optional parameters.

Windows

MacOS

Linux

Override Hierarchy

IMediaPlayer::Open()

FMediaIOCorePlayerBase::Open()

References

Module	MediaIOCore
Header	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCorePlayerBase.h
Include	#include "MediaIOCorePlayerBase.h"
Source	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Private/Player/MediaIOCorePlayerBase.cpp

Syntax

virtual bool Open
(
const FString & Url,
const IMediaOptions * Options
)

Remarks

Open a media source from a URL with optional parameters.

The media may not necessarily be opened after this function succeeds, because opening may happen asynchronously. Subscribe to the MediaOpened and MediaOpenFailed events to detect when the media finished or failed to open. These events are only triggered if Open returns true.

The optional parameters can be used to configure aspects of media playback and are specific to the type of media source and the underlying player. Check their documentation for available keys and values.

Returns

true if the media is being opened, false otherwise.

Parameters

Parameter	Description
Url	The URL of the media to open (file name or web address).
Options	Optional media parameters.