This document contains references for the settings of several basic Media assets. For capture cards, refer instead to the Professional Video I/O documentation.
Player Overrides
Many of the Media Source assets provide Player Override settings, which you can use to control which player to use to play the asset. Each platform has its own options which you can set separately using a dropdown menu. In all cases, the Automatic option means playback uses the UE default player. Refer to the Electra Protron Player documentation for more information on setting the default player.
Capture card players (AJA and Blackmagic) are only available when the associated capture card hardware is installed and the plugin is enabled. Similarly, NDI is only available when the associated plugin is enabled.
| Platform | Options |
|---|---|
Android |
|
iOS |
|
Linux |
|
Mac |
|
tvOS |
|
VisionOS |
|
Windows |
|
Player Details
A Media Player asset's settings control basic aspects of the media playback. Media Source assets have a Player Details panel with the same settings, which are used by the Media Player when playing back those Media Source assets. For more information on Media Player settings, see the Media Editor Reference
File Media Source
Uses the Player Details panel. For step-by-step instructions for using a File Media Source, see the Play a Video File tutorial.
| Setting | Description |
|---|---|
File Path | The path to the media file. If the media file is not in the |
Precache File | When enabled, the entire media file is loaded into memory for playback (when possible). |
Player Overrides | See Player Overrides above. |
File Media Output
| Setting | Description |
|---|---|
Format | Options are:
|
Compression Quality | Format specific.
|
Overwrite File | When enabled, overwrites the image if it already exists. |
Async | When enabled, the image is saved asynchronously. When disabled, the game thread is blocked until saving is complete. |
File Path | Defines where to save the image output. |
Base File Name | The base file name for the images. The frame number will be appended. |
Desired Size | When enabled, you can specify the X and Y dimensions for the image output. When disabled, the default back buffer size is used. |
Desired Pixel Format | When enabled, specify a pixel format. Options are:
When disabled, the default back buffer pixel format is used. |
Invert Alpha | When enabled, inverts the alpha for formats that support alpha. |
Number of Texture Buffers | The number of textures used to transfer the texture from the GPU to the system memory.
Only works with captures that use the GPU. |
Img Media Source
Uses the Player Details panel. For step-by-step instructions for using an Img Media Source, see the Play an Image Sequence tutorial.
| Setting | Description |
|---|---|
Player Overrides | See Player Overrides above. |
Fill Gaps in Sequence | When enabled, any gaps in the sequence are filled with blank frames. |
Sequence Path | The path to the image sequence. If the image sequence is not in the |
Frame Rate Override | Overrides the default frame rate stored in the image sequence. Defaults to no override. Options are:
|
Proxy Override | Provide the name of the proxy directory. Defaults to no proxy. |
Encoding Override | Overrides the source encoding of the image sequence. Options are:
|
Color Space Override | Overrides the color space of the image sequence. Options are:
|
Red/Green/Blue/White Chromaticity Coordinate | Four separate fields that define the chromaticity. Each Color Space Override option provides specific values for these fields. These values are editable when the source white point differs from the working color space white point, and when the Color Space Override is set to Custom. |
Chromatic Adaptation Method | Determines the chromatic adaptation method applied if the source white point differs from the working color space white point. Not always modifiable, depending on the value of the Color Space Override. Options are:
|
Start Timecode | Specifies a timecode associated with the start of the sequence. |
For more information on Color Space Overrides, refer to the Working Color Space documentation.
Media Playlist
For step-by-step instructions for using a Media Playlist, see the Using Media Playlists tutorial.
| Setting | Description |
|---|---|
Playlist (Array) | Each element in the Playlist array is a separate media source selected from the Content Browser. You can create new media assets directly from the playlist, and then populate them with media according to the type of media asset. |
Platform Media Source
Uses the Player Details panel. For step-by-step instructions for using a Platform Media Source, see the Playing Platform Specific Media tutorial.
| Setting | Description |
|---|---|
Player Overrides | See Player Overrides above. |
Stream Media Source
Uses the Player Details panel. For step-by-step instructions for using a Stream Media Source, see the Play a Video Stream tutorial.
| Setting | Description |
|---|---|
Player Overrides | See Player Overrides above. |
Stream URL | Defines the URL sending the media stream. |