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 > Runtime > MediaAssets > UMediaPlayer > UMediaPlayer::OpenSourceWithOptions

Light Theme

Dark Theme

UMediaPlayer::OpenSourceWithOptions

Open the specified media source with supplied options applied.

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 OpenSourceWithOptions
(
UMediaSource * MediaSource,
const FMediaPlayerOptions & Options
)

Remarks

Open the specified media source with supplied options applied.

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 source will be opened, false otherwise.

Parameters

Parameter	Description
MediaSource	The media source to open.
Options	The media player options to apply.