FMediaIOCorePlayerBase::Open

Open a media source from a URL with optional parameters.

Windows
MacOS
Linux

Override Hierarchy

IMediaPlayer::Open()

FMediaIOCorePlayerBase::Open()

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.

See Also

Close

IsReady

OnOpen

OnOpenFailed

References

Module

MediaIOCore

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback