LogoLogo
๐Ÿ› ๏ธ Tools๐Ÿ—‚๏ธ SDK๐Ÿ“„ White Paper
  • Getting Started
    • ๐ŸŸฃWhat is NDI?
    • ๐Ÿ†•Release Notes
    • ๐Ÿ“„White Paper
      • Discovery & Registration
        • mDNS
        • Discovery Service
        • Manual Connection
        • NDI Groups
      • NDI Protocols
        • Reliable UDP - NDI 5
        • Multipath TCP - NDI 4
        • UDP with Forward Error Correction โ€“ NDI 3
        • Single TCP โ€“ NDI 1
      • NDI Related Network Ports
      • Getting video across the network
      • Network Layout
      • Bandwidth
        • NDI High Bandwidth based on SpeedHQ2 (8bit 4:2:2)
        • NDI High Bandwidth based on SpeedHQ7 (8bit 4:2:2:4)
        • NDI HX2 h.264 (8bit 4:2:0)
        • NDI HX2 h.265 (8bit 4:2:0)
        • NDI HX3 h.264 (8bit 4:2:0)
        • NDI HX3 h.265 (8bit 4:2:0)
        • NDI Proxy and bandwidth optimization
      • Network Interface Settings
      • NIC Selection
      • Encoding and Decoding
      • Multicast
      • NDI Administrative Settings
      • Synchronization
      • NDI in the Cloud
    • Glossary
      • NDI Terminology
      • Industry Terminology
  • Using NDI
    • Introduction
    • NDI for Video
      • Digital Video Basics
      • NDI Video Codecs and Format Matrix
      • NDI Encoding Support Matrix
        • Practical NDI Receivers Format Support
        • Practical NDI Transmitters Support
        • Summary Table
      • Interoperability Scenarios
    • NDI for Audio
      • Digital Audio Fundamentals
      • Audio Over IP
      • Technical Facts About NDI for Audio
      • Use Cases
      • Products Using NDI for Audio
    • โš’๏ธNDI Tools
      • Release Notes
      • Installing NDI Tools
        • Software License Agreement
        • Privacy Policy
      • NDI Tools Launcher
      • NDI Tools for Windows
        • Access Manager
        • Bridge
          • NDI Bridge automation
          • Configuring Port Forwarding
          • Bridge Tool Logging
        • Remote
        • Router
        • Screen Capture
        • Screen Capture HX
        • Studio Monitor
        • Test Patterns
        • Webcam Input
      • NDI Tools for Mac
        • Access Manager
        • Scan Converter
        • Router
        • Test Patterns
        • Video Monitor
        • Virtual Input
      • Plugins
        • NDI for After Effects
        • NDI for Premiere Pro
        • NDI Output for Final Cut Pro
        • NDI for VLC
        • Audio Direct
        • OBS
    • Utilities
      • Analysis
    • Using NDI with Software
      • Getting Started with NDI in OBS for Windows or Mac
      • Using OBS Studio as a Commentary System
      • Using NDI Tools as a virtual camera in Mac
      • Using NDI and Dante on the same Network
      • Use OBS video + audio on Zoom with macOS
    • Using NDI with Hardware
      • NDI HX upgrades for cameras
      • How to Activate Panasonic Cameras for NDI HX1 โ€” Step-by-Step
      • Recommended Network Switch Settings for NDI
  • Developing with NDI
    • Introduction
    • ๐Ÿ“‚SDK
      • Release Notes
      • Licensing
      • Software Distribution
        • Header Files
        • Binary Files
        • Redistributables
        • Content Files
        • Libraries
        • NDI-SEND
        • NDI-FIND
        • NDI-RECEIVE
        • Utilities
        • Command Line Tools
      • CPU Requirements
      • Dynamic Loading of NDI Libraries
      • Performance and Implementation
      • Startup and Shutdown
      • Example Code
      • Port Numbers
      • ๐Ÿ”งConfiguration Files
      • Platform Considerations
      • NDI-SEND
      • NDI-FIND
      • NDI-RECV
      • NDI Routing
      • HDR
      • Command Line Tools
      • Frame Types
        • Video Frames
        • Audio Frames
        • Metadata Frames
      • Windows DirectShow Filter
      • 3rd Party Rights
      • Support
    • Advanced SDK
      • Release Notes
      • Licensing
      • Overview
      • Configuration Files
      • NDI SDK Review
        • Sending
          • Asynchronous Sending Completions
          • NDI Sending On High Latency Connections
        • Receiving
          • Custom Allocators
            • Video Allocators
            • Audio Allocators
          • Dynamic Bandwidth Adjustment
        • Finding
        • Video Formats
          • Receiver Codec Support Level
          • Frame Synchronization
      • Genlock
      • AV Sync
        • Guidelines
        • Creating and Destroying Devices
        • Recovering Audio
      • Using H.264, H.265, and AAC Codecs
        • Sending Audio Frames
        • Sending Video Frames
        • H.264 Support
        • H.265 Support
        • AAC Support
        • OPUS Support
        • Latency of Compressed Streams
        • Stream Validation
      • External Tally Support
      • KVM Support
      • NDI Advanced SDK FPGA Example Designs
        • Prebuilt uSD Images
        • NDI FPGA Reference Design
          • FPGA Projects
            • Changelog
          • C++ Application Code
            • Changelog
          • linux_kernel
            • Changelog
          • uSD Image Builder
            • Changelog
        • Changelog
    • Utilities
      • Unreal Engine SDK
        • Release Notes
        • Licensing
        • NDI Plugin Installation
        • Simple Setup of Broadcast and Receivers
        • NDI Broadcast Actor
        • NDI Receiver Actor
        • NDI Media Assets
        • Getting Started with Example Blueprint Projects
        • Advanced
      • Free Audio
      • Bridge Service
        • Installation
          • Silent Installation
        • Configuration
          • Web UI
          • Configuration File
          • Manual API Key Management
        • Webhooks
        • WebSockets
        • API
    • NDI Certified
      • Certification Guidelines
        • Interoperability Requirements
        • Technical Requirements
      • Certification Process
        • Pre-certification Checklist
        • Device Testing Methods
          • Camera
          • HDMI Encoder
          • SDI Encoder
          • Decoder
          • NDI Controller
          • NDI Monitor
          • Multicast Testing
        • Detailed process
    • Metadata
      • Metadata Sources
      • Metadata for XML
      • XML Validation
      • Metadata Elements
      • Proposed New Metadata Messages
      • PTZ and Control Messages
      • Undocumented Mysteries
  • Developer Guides
    • Decoding with NDI
    • NDI Bridge Deployment
  • FAQ
    • Index
    • NDI Tools
      • What is the NDI Analysis Tool and where do I get it from?
      • Why does my NDI connection stay active once the source is offline?
      • Why are my changes to the NDI JSON configuration file not being saved?
      • Why is the license for my Panasonic camera not active?
      • How does registration for NDI Tools work?
      • The time code on my file is incorrect, how do I change it?
      • How can I make NDI Tools launch automatically?
      • What is the NDI ECCN?
      • How do I use NDI output with Microsoft Teams
      • Where is Screen Capture (HX) for Mac?
    • NDI Certified
      • What is the NDI Certification Program?
      • Why did you start this certification program?โ€‹
      • What happens to my device after it's certified?
      • Is certification mandatory to be a partner of NDI?โ€‹
      • I am an OEM manufacturer, can my products be certified?โ€‹
      • How long does the certification process take?
      • How do I become certified?โ€‹
      • What happens if my product doesnโ€™t meet the requirements for Certification?โ€‹
      • Are there any fees to become NDI Certified?
    • Common Issues
      • I'm having trouble getting multicast set up.
      • I'm having trouble with my NDI HX License
      • Why can't I find my Android 14-based NDI devices on my network?
      • Why wonโ€™t NDI Tools install on my Windows PC?
      • How do I enable NDI in โ€œNewโ€ Microsoft Teams (Windows only)?
      • Why canโ€™t HX Capture display the full resolution of my iPad or iPhone?
      • The NDI HX Camera app won't launch on older phones and iOS
      • Why won't MacOS Sonoma (14.1) recognize NDI Tools as a virtual camera?
      • I'm having issues with Virtual Input for macOS
      • I'm having issues with Final Cut Pro
      • NDI Camera App Issue
    • SDK
      • Where can I find the source code for the FPGA board?
      • What system resources are required to support a design including the NDI FPGA Codecs?
      • Why canโ€™t my h264/265 video be received by an NDI receiver when using the embedded SDK?
      • Can I use the Unreal SDK on Mac?
      • What are the Differences Between the NDI SDK and the NDI Advanced SDK
    • โœจNDI 6
      • Do I need to upgrade to NDI 6 if I'm not using the new features?
      • Is there a fee to upgrade to NDI 6
      • Why doesn't my existing Vendor ID work with NDI 6?
      • How can I get a previous version of NDI Tools or the SDK?
    • NDI HX License Upgrades
      • What is happening with NDI HX Upgrades?
      • Will my existing HX-upgraded camera be affected?
      • I bought a camera before June 30, 2025, but didn't buy an HX license. Can I still get one?
      • I bought a license and a camera but didn't redeem it until after. Can I still get an HX license?
      • If my HX upgrade fails can I transfer the license?
      • Can I sell my upgraded HX camera and keep the license?
      • Will my NDI version work with my current HX license?
      • What does the HX upgrade sunset program mean for camera manufacturers?
      • What will NDI Support do for licenses after the sunset date?
      • I factory reset my camera and forgot the license. Can you help me get it back?
Powered by GitBook

2024 @ NDI Vizrt AB.

On this page
  • NDI Media Sender Asset
  • NDI Media Receiver Asset
  • NDI Media Receiver and Media IO Framework
  • NDI Timecode Provider

Was this helpful?

Export as PDF
  1. Developing with NDI
  2. Utilities
  3. Unreal Engine SDK

NDI Media Assets

Last updated 2 months ago

Was this helpful?

NDI streams are represented as assets in the . This allows the same stream to be used by multiple . Furthermore, if a sending stream were to be a component or actor instead, problems could occur due to Unreal Engine creating multiple copies during gameplay.

NDI Media Sender Asset

A media sender is an NDI stream going out of the Unreal Engine. An NDI Broadcast Actor typically uses it to send out rendered views. Only one broadcast actor should be using a given NDI Media Sender asset.

Broadcast Settings

The Source Name is the name of the stream. It should be unique to avoid confusion.

The Frame Size is the desired width and height in pixels of the stream. If the stream is supplied by (for example) an with frames of a size different than this, the frames will be scaled (preserving aspect ratio) to fit the specified size.

The Frame Rate specifies the desired framerate of the stream. Due to the nature of real-time rendering with Unreal Engine, it is not guaranteed that frames will be rendered and broadcast at this rate. Generally, it should be set to no more than what Unreal Engine can manage for the scene.

The stream can optionally include an alpha channel. If the stream outputs alpha values, then Alpha Remap can control how the alpha values in the Unreal Engine-generated frame are translated to alpha values in the NDI stream. The min value is the Unreal Engine rendered alpha value mapped to an NDI stream alpha value of 0, while the max is the value mapped to a stream alpha of 1. All other alpha values are linearly interpolated from those. The min value can be set larger than the max value.

PTZ control through the stream can be enabled and disabled for the NDI Media Sender Asset. This has a slightly different effect than enabling or disabling the NDI PTZ Controller on an . The toggle in the NDI Media Asset tells the NDI receivers of the stream whether or not PTZ is enabled (which in turn, for example, will cause to display PTZ controls). The toggle in the broadcast actor PTZ controller component determines if the actor should use the PTZ commands.

The NDI Media Sender and Receiver assets allow the transmission of metadata alongside video and audio streams. This can be useful for passing additional data such as timestamps, event triggers, or custom information between Unreal Engine and external NDI applications.

Content

The Render Target contains the texture that will be encoded and sent over NDI. Typically it will be provided by the viewport capture component of the using this sender, so there is no need to set it manually.

NDI Media Receiver Asset

A media receiver asset is a stream coming into Unreal Engine. It is used by to receive decoded frames from an NDI stream. Multiple receiver actors can use the receiver asset.

Settings

The connection information specifies how to connect to an NDI stream. The stream's name can be specified either as a Source Name (using the โ€œMachine Name (Stream Name)โ€ format) or as an NDI URL.

The Bandwidth controls what components of the stream the receiver requests. Audio and video can be (temporarily) muted.

When muted, the data is still received but not processed by the receiver asset.

Content

The Video Texture is the texture to which a received frame is decoded. It is optional. If not set, then an internally generated video texture is used.

NDI Media Receiver and Media IO Framework

NDI Media Receivers can be used with the Unreal Engine Media IO Framework. They can be added to Media Bundles, and the Media Player can play NDIยฎ streams.

The URL for playing an NDI stream in the Media Player looks like this: ndiio://MachineName (StreamName)

Existing NDI Media Receiver assets can also be used in the Media Player and added to playlists.

NDI Media Receivers can also be created in Media Bundles, which can then be used to create media bundle actors in the level. This provides an alternative to adding NDI Receiver Actors directly to the level.

NDI Timecode Provider

The NDI IO Plugin contains a timecode provider class, which can present the timecodes of an NDI stream to Unreal. The NDI Timecode Provider uses an NDI Media Receiver asset as the source of the timecodes. In order to work, the receiver's video stream must contain timecodes. NDI does not guarantee that all video streams will have valid timecode values. The timecodes produced by the provider are those of the most recently obtained frame.

Unreal Engine
NDI Receiver Actors
NDI Broadcast Actor
NDI Broadcast Actor
Studio Monitor
NDI Broadcast Actor
NDI Media Receiver Actors