Navigation
API > API/Plugins > API/Plugins/MediaIOCore > API/Plugins/MediaIOCore/FMediaIOCorePlayerBase > API/Plugins/MediaIOCore/FMediaIOCorePlayerBase/Open
- 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 |
virtual bool Open
&40;
const TSharedRef< FArchive, ESPMode::ThreadSafe > & Archive,
const FString & OriginalUrl,
const IMediaOptions &42; Options
&41;
Remarks
Open a media source from a file or memory archive 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. true if the media is being opened, false otherwise.
Parameters
| Name | Description |
|---|---|
| Archive | The archive holding the media data. |
| OriginalUrl | The original URL of the media that was loaded into the buffer. |
| Options | Optional media parameters. |
See Also
IsReady
OnOpen
OnOpenFailed