Repository navigation
An Unreal Engine 5.3 Media Framework player for live RTSP streams, built on FFmpeg.
Downloads
- IPStreamMediaDemo-v0.1.3-beta-Shipping-Win64.zip: packaged demo (Shipping build). Run
IPStreamMediaDemo.exe, enter an RTSP URL and press Open. - IPStreamMediaDemo-v0.1.3-beta-Development-Win64.zip: the same demo as a Development build, for profiling with Unreal Insights (tracing isn't available in Shipping). See Profiling below.
- IPStreamMedia-v0.1.3-beta-UE5.3-Win64.zip: the plugin. Unzip it into your project's
Pluginsfolder.
What's new since v0.1.2-beta
- Latency profiling with Unreal Insights: the decode thread has trace scopes, and four counters record each frame's timing from packet to GPU upload.
- The log prints the decoder's reorder buffer size (
has_b_frames) and thread settings on the first frame and every 250 frames. - Results and method: Docs/Latency.md. In short: the plugin takes about 10 ms from packet to GPU upload on a stream without B-frames, and about 1 ms of that is actual work. B-frames add about 80 ms in the decoder.
Profiling
Run the Development demo with:
IPStreamMediaDemo.exe -trace=default,counters -tracefile=<path>.utrace
Open the trace in Unreal Insights. The counters are under IPStream/ (DecoderDelayMs, ConvertMs, QueueWaitMs, OursMs).
Usage
- Select the IPStreamMedia player, either in a Media Source's player overrides or with Set Desired Player Name (
IPStreamMedia) before Open Url. Otherwise the Windows Media Foundation player may take thertsp://URL. - Optional, on a Media Source: set the reconnect limit with SetMediaOption (integer64), key
MaxReconnectAttempts, before opening. The default is3, and0retries forever. A stream that has never played gives up after 2 attempts either way.
Requirements
- Unreal Engine 5.3, Windows 64-bit.
Known limitations
- Video only, no audio.
- Tested with one IP camera (H.265, 1280×720, 25 fps) and OBS (H.264, 1280×720, 25 fps).
- In Development builds and the editor, on NVIDIA graphics cards, memory use grows by about 10 MB a minute, with or without a stream playing. It isn't the plugin: the graphics driver holds on to Unreal's GPU profiling markers (PIX) while D3D12's lightweight DRED is on. Shipping builds aren't affected. To avoid it in a Development build, launch with
-dpcvars=r.D3D12.LightweightDRED=0. - When a stream doesn't state its colour formula, BT.709 is assumed, so an SD stream in that situation may look slightly off.
- No pause.
Licence
- Plugin code: MIT.
- Includes unmodified FFmpeg shared libraries (LGPL v3). Licence texts and source details are in
ThirdParty/FFmpeg/.