Navigation
API > API/Runtime > API/Runtime/Media > API/Runtime/Media/IMediaPlayer
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Open
(
const FString& Url, |
Open a media source from a URL with optional parameters. | IMediaPlayer.h | |
bool Open
(
const TSharedRef< FArchive, ESPMode::ThreadSafe >& Archive, |
Open a media source from a file or memory archive with optional parameters. | IMediaPlayer.h | |
virtual bool Open
(
const FString& Url, |
Open a media source from a URL with optional asset and player parameters. | IMediaPlayer.h |
Open(const FString &, const IMediaOptions *)
Description
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.
| Name | Open |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaPlayer.h |
| Include Path | #include "IMediaPlayer.h" |
bool Open
(
const FString & Url,
const IMediaOptions * Options
)
true if the media is being opened, false otherwise.
Parameters
| Name | Remarks |
|---|---|
| Url | The URL of the media to open (file name or web address). |
| Options | Optional media parameters. |
See Also
-
IsReady
-
OnOpen
-
OnOpenFailed
Open(const TSharedRef< FArchive, ESPMode::ThreadSafe > &, const FString &, const IMediaOptions *)
Description
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.
| Name | Open |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaPlayer.h |
| Include Path | #include "IMediaPlayer.h" |
bool Open
(
const TSharedRef < FArchive , ESPMode::ThreadSafe > & Archive,
const FString & OriginalUrl,
const IMediaOptions * Options
)
true if the media is being opened, false otherwise.
Parameters
| Name | Remarks |
|---|---|
| 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
Open(const FString &, const IMediaOptions , const FMediaPlayerOptions )
Description
Open a media source from a URL with optional asset and player parameters.
| Name | Open |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaPlayer.h |
| Include Path | #include "IMediaPlayer.h" |
virtual bool Open
(
const FString & Url,
const IMediaOptions * Options,
const FMediaPlayerOptions * PlayerOptions
)