How to Switch Between NDI® Sources Using APIs for Pro Convert IP to USB

Overview

The Magewell Pro Convert IP to USB is a portable device that converts a wide range of IP streams into software via a USB port. No additional drivers or utilities are required. Users can configure settings and select IP sources through the web-based GUI. In addition, the device exposes a set of HTTP-based APIs for integration with third-party applications and control systems.

Purpose

This guide describes how to use the HTTP APIs to switch between NDI sources. Developers are advised to familiarize themselves with the Web GUI of the device prior to implementation in order to understand the source selection workflow.

Procedure

1. Obtain Source List

Retrieve the list of available NDI sources by calling:

api/source/list?type=dynamic

Code examples could be found here.

2. Add Preset Sources (Optional)

NDI streams can be discovered automatically. Alternatively, sources can be manually added by URL or by NDI name, particularly when located across VLANs. Use the following endpoint:

api/source/add

Refer to Add a source for details. This method also applies to other IP feeds.

3. Select Source

After sources have been added, switch between them using:

api/source/select

Additional usage information is available in the Select a source section.

Integration with Control Platforms

Magewell provides plugins for Crestron and Q-SYS platforms to streamline integration. Contact support@magewell.net for further information.