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
  • Web UI
  • Configuration File
  • Manual API Key Management

Was this helpful?

Export as PDF
  1. Developing with NDI
  2. Utilities
  3. Bridge Service

Configuration

Last updated 2 months ago

Was this helpful?

The NDI Bridge Service web page provides an API reference, runtime status information, webhook management, WebSocket management, and API key management if SSL is enabled.

Web UI

Status Information

The upper left-hand corner of the web page includes the status pane, which provides information about the current status of NDI Bridge Service.

  • Version: This indicates the version of NDI Bridge Service that is installed and running.

  • Uptime: This indicates the length of time NDI Bridge Service has been running. This is not the length of time Bridge is running. NDI Bridge Service can be running without Bridge itself running in Host or Join mode.

  • Is Running: This indicates whether Bridge is running in either Host or Join mode.

  • Runtime Mode: This indicates which mode Bridge is running in: HOST for Host mode or JOIN for Join mode.

  • Discovery Server Status: This indicates that the NDI Discovery Server, a component required for Bridge to function properly, is running in the background.

API Keys

If SSL is enabled and properly configured, you will see an API Keys section on the left-hand navigation menu. On this page, you can add and remove API keys required for accessing the API when SSL is enabled.

To add an API key, click on the add button in the upper right-hand corner of the API Keys section on the page. You will be presented with a dialog where you can add a memo to help distinguish the purpose of this API key and set an expiration date.

After selecting Create, you will be prompted with another dialog to copy the generated API key. You will not be able to retrieve this API key again, so save it somewhere before dismissing the dialog. For information on how to use the API key in a request, see the API section of this document.

Configuration File

NDI Bridge Service uses a JSON configuration file to store settings, similar to the desktop Bridge application. The file is installed under:

ProgramData\NDI\NDI Bridge Service\service_settings.json

At the very top of this file are the same five fields that were present on the configuration page of the installer. You can manually modify these settings by following the rules below. Changes to these settings do not take effect until the NDI Bridge Service is restarted, either by restarting the machine or by restarting the NDI Bridge Service manually inside the Windows Service Console. Any invalid configuration, whether syntactic or semantic, will result in the configuration file being reset to its default when the service restarts, or a failure to start the service.

"port": 8080, "useHttps": false,

"enableWebContent": true, "certificateSubject": "cn=", "hostBinding": "127.0.0.1",

  • port: This is the port that the web server uses to provide access to the web interface and APIs. This is not the port used by Bridge in Host or Join mode; that is configured via the API along with all other Bridge settings.

  • useHttps: true or false, this field enables or disables SSL. If set to true, you must also provide a valid value for the certificateSubject field.

  • enableWebContent: true or false, this field determines if the web interface should be accessible. If set to false, only the API will be accessible and no web content will be presented at the URL.

  • certificateSubject: If useHttps is set to true, you must also provide a valid certificate subject in Common Name format (CN=). SSL certificates must be installed in the local machine certificate store under the logical store path ’Personal/Certificates’, as this is the only location NDI Bridge Service looks to find your certificate with a matching CN subject.

To install an SSL certificate on your machine, simply double click the certificate file to open the import wizard. Be sure to select the ’Local Machine’ option before proceeding.

When prompted to select a certificate store, either use the automatic option, or manually select the personal certificate store.

  • hostBinding: This is the interface that the web server listens on. You can change this to target any particular interface on the machine or use 0.0.0.0 to target all interfaces. If you use 127.0.0.1 then the web interface and API will only be accessible on the local machine.

Manual API Key Management

If you are using SSL and have the web interface disabled, you will have to use the command line to is-

sue and invalidate API keys. Navigate to the install directory and locate Application.NDI.Bridge.Service.exe. This application takes the following command line arguments to manage API keys.

NOTE: The service must be stopped before modifying API keys, you can stop it in the Windows Service Console.

  • newkey This argument will prompt you to provide a memo to help identify the purpose of this API key, and the number of days this key will be valid from the current UTC time.

  • listkeys This argument will provide a list of all API keys that have been issued.

  • removekey This argument will prompt you to enter in the ID corresponding to the API key you with to invalidate.

Figure 6: Main page
Figure 7: Status pane
Figure 8: API key management
Figure 9: API key creation
Figure 10: API key copy
Figure 11: Certificate import
Figure 12: Certificate store
Figure 13: Command line interface