NDI

https://docs.ndi.video/all/
Admin
NDI is a video and audio transmission technology that enables real-time, low-latency streaming of...
Tokens:163,109
Snippets:2,194
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Build and Install C++ Applications

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/ndi-advanced-sdk-fpga-example-reference-design/ndi-advanced-sdk-fpga-ip/c%2B%2B-application-code.md

Commands to compile and install the example applications from the source directory.

```bash
cd <NDI_SDK>/fpga_reference_design/src/cpp
make
sudo make install
```

--------------------------------

### JSON Configuration File Example

Source: https://docs.ndi.video/all/developing-with-ndi/sdk/command-line-tools.md

Example structure for the NDI Discovery Service configuration file.

```json
{
    "binding": "127.0.0.1",
    "port_no": "5959"
}
```

--------------------------------

### GET /getting-started/white-paper/discovery-and-registration/manual-connection.md

Source: https://docs.ndi.video/all/getting-started/white-paper/discovery-and-registration/manual-connection.md

Perform an HTTP GET request on the documentation page URL to query information dynamically.

```APIDOC
## GET /getting-started/white-paper/discovery-and-registration/manual-connection.md

### Description
Queries the documentation dynamically by asking a specific question related to the content.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/discovery-and-registration/manual-connection.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Run NDI Embedded Bridge with Command Line Arguments

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/embedded-bridge.md

Example of starting the bridge process by specifying a target host address and port.

```bash
./ndi-embedded-bridge -address "NiceCamera@192.168.0.42:5990"
```

--------------------------------

### Run NDI Embedded Bridge with JSON Configuration

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/embedded-bridge.md

Example of starting the bridge using a JSON configuration file and the structure of the configuration file itself.

```bash
./ndi-bridge "/etc/config/bridge.json"
```

```json
{
	"ndi": {
		"machinename": " Hello World",
		"groups": {
			"recv": "Public"
		},
		"networks": {
			"discovery": "192.168.20.2:5959"
		},
		"vendor": {
			"name": "XXX",
			"id": "YYY"
		}
	},
	
	"bridge": {
		"address": "192.168.0.42",
		"port": 5990,
		"secure": "123abc",
		"diag": "info",
		"id": "NiceCamera"
	}
}
```

--------------------------------

### Switch FPGA Example Designs on ZCU104

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/ndi-advanced-sdk-fpga-example-reference-design/fpga-quick-start-guide.md

Commands to copy the required design files to the boot directory for switching between Decode and Encode examples.

```sh
# Use the Decode example
sudo cp /boot/ZCU104-Dec/* /boot/

# Use the Encode example
sudo cp /boot/ZCU104-Enc/* /boot/
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/av-sync/guidelines.md

Perform an HTTP GET request to query the documentation dynamically using the ask and goal parameters.

```http
GET https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/av-sync/guidelines.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Build and install ndi-python library

Source: https://docs.ndi.video/all/developing-with-ndi/ndi-metadata/xml-validation.md

Commands to clone, build, and install the ndi-python library from source, including setting the NDI SDK directory path on Linux.

```sh
# Build and install ndi-python library from source

# Linux users may need to provide a path to the NDI SDK directory
export NDI_SDK_DIR="/path/to/NDI SDK Directory"

# Download the source code from github and populate git submodules
git clone --recursive https://github.com/buresu/ndi-python.git

# Build the wheel package for installation
cd ndi-python
python3 setup.py bdist_wheel

# Install the wheel package
python3 -m pip install dist/ndi_python-*.whl
```

--------------------------------

### GET /all/getting-started.md

Source: https://docs.ndi.video/all/getting-started

Queries the documentation page dynamically to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /all/getting-started.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is used when information is not explicitly present or clarification is needed.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### Perform Silent Installation

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/installation/silent-installation.md

Example command line arguments for a silent installation of the Bridge Service.

```bash
/verysilent /web=true /ssl=true /port=443 /binding=0.0.0.0 /cert=mycertificate.local
```

--------------------------------

### GET /all/getting-started/release-notes.md

Source: https://docs.ndi.video/all/getting-started/release-notes.md

Queries the documentation dynamically by providing a natural language question and an optional goal.

```APIDOC
## GET /all/getting-started/release-notes.md

### Description
Performs an HTTP GET request on the current page URL to retrieve a direct answer to a question based on the documentation content.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/release-notes.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /api/unsubscribe

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/webhooks.md

Unsubscribes from an existing change subscription using the provided GUID.

```APIDOC
## GET /api/unsubscribe

### Description
Cancels an active change subscription using the GUID received during registration.

### Method
GET

### Endpoint
/api/unsubscribe

### Parameters
#### Query Parameters
- **id** (string) - Required - The GUID received from the subscribe response.
```

--------------------------------

### GET /all/getting-started/what-is-ndi.md

Source: https://docs.ndi.video/all/getting-started/what-is-ndi.md

Queries the documentation dynamically by providing a specific question and an optional end goal.

```APIDOC
## GET /all/getting-started/what-is-ndi.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/what-is-ndi.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Send Authenticated Requests in C#

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Example methods for performing GET and POST requests with an API key header when SSL is enabled.

```csharp
static async Task<string> PostAsync(string uri, Dictionary<string, string> values)
{
var client = new HttpClient(); client.DefaultRequestHeaders.Add("x-api-key", API_KEY);
var content = JsonContent.Create(values);
var result = await client.PostAsync(uri, content); return await result.Content.ReadAsStringAsync();
}
static async Task<string> GetAsync(string uri)
{
var client = new HttpClient(); client.DefaultRequestHeaders.Add("x-api-key", API_KEY);
var result = await client.GetAsync(uri);
return await result.Content.ReadAsStringAsync();
}
```

--------------------------------

### Windows Service Management Commands

Source: https://docs.ndi.video/all/developing-with-ndi/sdk/command-line-tools.md

Commands to install, remove, start, and stop the NDI Discovery Service on Windows with administrative privileges.

```bash
“NDI Discovery Service.exe” install
“NDI Discovery Sevice.exe” remove
“NDI Discovery Service.exe” start
“NDI Discovery Service.exe” stop
```

--------------------------------

### GET /getting-started/glossary.md

Source: https://docs.ndi.video/all/getting-started/glossary.md

Performs a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /getting-started/glossary.md

### Description
Performs an HTTP GET request to query the documentation dynamically. This allows users to ask specific questions and provide an optional goal to receive tailored answers with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/glossary.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Create PetaLinux Project

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/ndi-advanced-sdk-fpga-example-reference-design/ndi-advanced-sdk-fpga-ip/linux-kernel-and-boot-loader.md

Initializes a new PetaLinux project.

```bash
$ petalinux-create -t project <project_name>
```

--------------------------------

### GET /all/getting-started/white-paper.md

Source: https://docs.ndi.video/all/getting-started/white-paper.md

Performs a natural language query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /all/getting-started/white-paper.md

### Description
Performs a natural language query against the current documentation page to retrieve a direct answer and relevant source excerpts.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /all/getting-started/white-paper/bandwidth.md

Source: https://docs.ndi.video/all/getting-started/white-paper/bandwidth.md

Queries the documentation dynamically by providing a question and an optional goal to receive a direct answer with relevant excerpts.

```APIDOC
## GET /all/getting-started/white-paper/bandwidth.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page. The response includes a direct answer and relevant excerpts from the documentation.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/bandwidth.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### GET /api/join/status_message

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Gets the current join status message.

```APIDOC
## GET /api/join/status_message

### Description
Gets the current join status message.

### Method
GET

### Endpoint
http://localhost:8080/api/join/status_message
```

--------------------------------

### GET /api/join/bandwidth_message

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Gets the current join bandwidth message.

```APIDOC
## GET /api/join/bandwidth_message

### Description
Gets the current join bandwidth message.

### Method
GET

### Endpoint
http://localhost:8080/api/join/bandwidth_message
```

--------------------------------

### GET /api/host/status_message

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Gets the current host status message.

```APIDOC
## GET /api/host/status_message

### Description
Gets the current host status message.

### Method
GET

### Endpoint
http://localhost:8080/api/host/status_message
```

--------------------------------

### GET /getting-started/white-paper/nic-selection.md

Source: https://docs.ndi.video/all/getting-started/white-paper/nic-selection.md

Queries the documentation page for specific information using a natural language question and an optional goal context.

```APIDOC
## GET /getting-started/white-paper/nic-selection.md

### Description
Perform a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/nic-selection.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /api/join/gpu_limit

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Gets the join GPU encoding limit status.

```APIDOC
## GET /api/join/gpu_limit

### Description
Gets a boolean to represent if the join has reached its GPU encoding limits or not.

### Method
GET

### Endpoint
http://localhost:8080/api/join/gpu_limit
```

--------------------------------

### GET /all/getting-started/white-paper/discovery-and-registration/discovery-server.md

Source: https://docs.ndi.video/all/getting-started/white-paper/discovery-and-registration/discovery-server.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /all/getting-started/white-paper/discovery-and-registration/discovery-server.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/discovery-and-registration/discovery-server.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /using-ndi/introduction.md

Source: https://docs.ndi.video/all/using-ndi/introduction.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /using-ndi/introduction.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/using-ndi/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started/white-paper/ndi-administrative-settings.md

Source: https://docs.ndi.video/all/getting-started/white-paper/ndi-administrative-settings.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /getting-started/white-paper/ndi-administrative-settings.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/ndi-administrative-settings.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Example CHAT Metadata Frame

Source: https://docs.ndi.video/all/developing-with-ndi/metadata-labs/chat-over-ndi-v1.0.md

A complete example of a single session containing a single text message.

```xml
<ndi_metadata type="chat" version="1.0"><Session id="session_production_A" scope="point_to_point"><Message><MessageId>msg_0001</MessageId><SenderId>director_room</SenderId><MessageType>text</MessageType><Text>Hello, ready on CAM 3?</Text><Lang>en</Lang><Format>plain</Format><Priority>normal</Priority><TimestampUtc>2025-12-06T10:15:30.123Z</TimestampUtc></Message></Session></ndi_metadata>
```

--------------------------------

### GET /using-ndi/ndi-tools/ndi-tools-for-mac/discovery/getting-started-with-discovery-service.md

Source: https://docs.ndi.video/all/using-ndi/ndi-tools/ndi-tools-for-mac/discovery/getting-started-with-discovery-service.md

Queries the documentation page for specific information by providing a question and an optional goal.

```APIDOC
## GET /using-ndi/ndi-tools/ndi-tools-for-mac/discovery/getting-started-with-discovery-service.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/using-ndi/ndi-tools/ndi-tools-for-mac/discovery/getting-started-with-discovery-service.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Perform Silent Installation

Source: https://docs.ndi.video/all/using-ndi/ndi-tools/ndi-tools-for-windows/discovery/discovery-server-additional-information.md

Executes the installer without UI prompts, specifying the port and binding address.

```bash
setup.exe /verysilent /port=1234 /binding=127.0.0.1
```

--------------------------------

### GET /using-ndi/ndi-tools/installing-ndi-tools.md

Source: https://docs.ndi.video/all/using-ndi/ndi-tools/installing-ndi-tools.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /using-ndi/ndi-tools/installing-ndi-tools.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.ndi.video/all/using-ndi/ndi-tools/installing-ndi-tools.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Configure NDI Discovery Service on init.d

Source: https://docs.ndi.video/all/using-ndi/ndi-tools/ndi-tools-for-windows/discovery/discovery-server-additional-information.md

Commands to set up, register, and manage the NDI discovery service on Linux systems without systemd.

```bash
sudo chmod +x /etc/init.d/ndi-discovery
```

```bash
sudo update-rc.d ndi-discovery defaults
```

```bash
sudo service ndi-discovery start
```

```bash
sudo update-rc.d ndi-discovery enable
```

--------------------------------

### GET /developing-with-ndi/ndi-certified/certified-products/audio-mixer.md

Source: https://docs.ndi.video/all/developing-with-ndi/ndi-certified/certified-products/audio-mixer.md

Perform a query against the documentation page to retrieve information not explicitly listed or to get clarification on the content.

```APIDOC
## GET /developing-with-ndi/ndi-certified/certified-products/audio-mixer.md

### Description
Queries the documentation page dynamically to retrieve specific information or context regarding NDI audio mixer products.

### Method
GET

### Endpoint
https://docs.ndi.video/all/developing-with-ndi/ndi-certified/certified-products/audio-mixer.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask regarding the documentation content.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GPIO Metadata Frame Example

Source: https://docs.ndi.video/all/developing-with-ndi/metadata-labs/gpio-over-ndi-v1.0.md

A complete example of a metadata frame containing a single device with two channel commands.

```xml
<ndi_metadata type="gpio" version="1.0">

<Device id="gpio_device_1" controllerId="panel_A">

<Channel>

<Id>GPO_1</Id>

<Direction>output</Direction>

<Action>set</Action>

<State>on</State>

<Value>1</Value>

<DurationMs>0</DurationMs>

<TimestampUtc>2025-12-03T10:15:30.123Z</TimestampUtc>

</Channel>

<Channel>

<Id>GPO_2</Id>

<Direction>output</Direction>

<Action>set</Action>

<State>off</State>

<Value>0</Value>

<DurationMs>0</DurationMs>

<TimestampUtc>2025-12-03T10:15:30.123Z</TimestampUtc>

</Channel>

</Device>

</ndi_metadata>
```

--------------------------------

### Registry Key Path for Unreal Engine

Source: https://docs.ndi.video/all/faq/common-issues/im-having-issues-installing-version-x-of-unreal-engine.md

The path checked by the NDI Unreal Engine SDK installer to verify the engine installation.

```text
HKEY_LOCAL_MACHINE\SOFTWARE\EpicGames\Unreal Engine<version>\InstalledDirectory.
```

--------------------------------

### Build and Package Project

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/ndi-advanced-sdk-fpga-example-reference-design/ndi-advanced-sdk-fpga-ip/linux-kernel-and-boot-loader.md

Compiles the project and packages the resulting images for deployment.

```bash
$ petalinux-build
$ petalinux-package <options>
```

--------------------------------

### Install Cross-Compiler Toolchains

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/ndi-advanced-sdk-fpga-example-reference-design/ndi-advanced-sdk-fpga-ip/linux-kernel-and-boot-loader.md

Install the necessary cross-compiler packages on Debian-based systems to build the Linux kernel and U-Boot for Altera targets.

```bash
sudo apt-get install cpp-aarch64-linux-gnu
sudo apt-get install gcc-arm-linux-gnueabihf
```

--------------------------------

### GET /getting-started/white-paper/bandwidth/ndi-hx3-h.264-8bit-4-2-0.md

Source: https://docs.ndi.video/all/getting-started/white-paper/bandwidth/ndi-hx3-h.264-8bit-4-2-0

Performs a query against the documentation page to retrieve information or clarification regarding the content.

```APIDOC
## GET /getting-started/white-paper/bandwidth/ndi-hx3-h.264-8bit-4-2-0.md

### Description
Queries the documentation page dynamically to receive an answer to a specific question, optionally providing a broader goal to tailor the response.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/bandwidth/ndi-hx3-h.264-8bit-4-2-0.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Import Hardware Definition

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/ndi-advanced-sdk-fpga-example-reference-design/ndi-advanced-sdk-fpga-ip/linux-kernel-and-boot-loader.md

Configures the project with the hardware description file exported from Vivado.

```bash
$ cd <project_name>
$ petalinux-config --get-hw-description <path-to-vivado-project>
```

--------------------------------

### GET /all/faq/troubleshooting-guide.md

Source: https://docs.ndi.video/all/faq/troubleshooting-guide.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a user question and optional goal.

```APIDOC
## GET /all/faq/troubleshooting-guide.md

### Description
Perform a dynamic query on the documentation page to retrieve information not explicitly present in the static content.

### Method
GET

### Endpoint
https://docs.ndi.video/all/faq/troubleshooting-guide.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### Managing NDI Sender Listener Lifecycle

Source: https://docs.ndi.video/all/developing-with-ndi/sdk/ndi-sender-discovery-and-monitor/ndi-sender-event-monitoring.md

Example demonstrating the creation of a sender listener, enumeration of senders, subscription to events, and subsequent unsubscription.

```cpp
// Create an instance of the sender listener. 
NDIlib_send_listener_instance_t pNDI_sender_listener = NDIlib_send_listener_create_ex(nullptr, p_ndi_config); 
if (!pNDI_sender_listener) { 
    // Handle error 
} 

// Get the list of advertised senders. 
uint32_t num_senders = 0; 
const NDIlib_sender_t* p_senders = NDIlib_send_listener_get_senders(pNDI_send_listener, &num_senders); 

// Display the found senders. 
printf("Network senders (%u found).\n", num_senders); 
for (uint32_t i = 0; i < num_senders; i++) { 
printf("%u. %s\n", i + 1, p_senders[i].p_name); 

// If the sender is not currently subscribed, subscribe to it. 
if (!p_sender[i].events_subscribed) { 
        NDIlib_send_listener_subscribe_events(pNDI_send_listener, p_senders[i].p_uuid); 
    } 

// Perform operations with the subscribed sender... 
… 
// Unsubscribe from the sender after processing. 
   NDIlib_send_listener_unsubscribe_events(pNDI_send_listener, p_senders[i].p_uuid); 
}
```

--------------------------------

### POST /api/host/start

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Starts the host.

```APIDOC
## POST /api/host/start

### Description
Starts the host and returns if the operation succeeded.

### Method
POST

### Endpoint
http://localhost:8080/api/host/start

### Request Example
{}
```

--------------------------------

### GET /api/is_running

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Checks if Bridge is running.

```APIDOC
## GET /api/is_running

### Description
Returns true if Bridge is running in Host or Join mode.

### Method
GET

### Endpoint
http://localhost:8080/api/is_running
```

--------------------------------

### GET /getting-started/white-paper/discovery-and-registration.md

Source: https://docs.ndi.video/all/getting-started/white-paper/discovery-and-registration.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /getting-started/white-paper/discovery-and-registration.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.ndi.video/all/getting-started/white-paper/discovery-and-registration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Configure NDI Discovery Service via Command Line

Source: https://docs.ndi.video/all/using-ndi/ndi-tools/ndi-tools-for-windows/discovery/discovery-server-additional-information.md

Examples of using command-line flags to specify network interface binding and port numbers for the NDI Discovery Service executable.

```bash
"NDI Discovery Service.exe" -bind 192.168.1.100
```

```bash
"NDI Discovery Service.exe" -port 5400
```

```bash
"NDI Discovery Service.exe" -bind <ip_address> -port <port_number> -config <json path> -help
```

--------------------------------

### POST /api/join/start

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Starts the join operation.

```APIDOC
## POST /api/join/start

### Description
Starts the join and returns if the operation succeeded or not.

### Method
POST

### Endpoint
http://localhost:8080/api/join/start
```

--------------------------------

### Display NDI Free Audio Help and Device List

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/free-audio.md

Run the application without arguments to view available command-line options and a list of detected audio input and output devices.

```text
NDI Free Audio v5.0.0.0
Copyright (C)2014-2021, NewTek, inc.

Options:
-input "audio device name" or -input 1
or -input default
-input_name "Some Source"
-input_gain +10dB

-output "audio device name" or -output 3
or -output default
-output_name "My Computer (NDI-STREAM)"
-output_gain -15dB

Input Devices:
1 : Microphone (Jabra BIZ 2300) [default]
2 : FrontMic (Realtek High Definition Audio)
3 : Line (NewTek NDI Audio)
4 : Microphone (HuddleCamHD)

Output Devices:
1 :G276HL (NVIDIA High Definition Audio)
2 : Speakers (Jabra BIZ 2300) [default]
3 : Speakers (Realtek High Definition Audio)
4 : G276HL (NVIDIA High Definition Audio)
5 : Realtek Digital Output (Realtek High Definition Audio)
```

--------------------------------

### GET /api/gpu_list

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Retrieves the list of available GPUs.

```APIDOC
## GET /api/gpu_list

### Description
Gets the list of available GPUs.

### Method
GET

### Endpoint
http://localhost:8080/api/gpu_list
```

--------------------------------

### GET /all/developing-with-ndi/advanced-sdk/kvm-support.md

Source: https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/kvm-support.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /all/developing-with-ndi/advanced-sdk/kvm-support.md

### Description
Queries the documentation dynamically by asking a question. This is useful when information is not explicitly present in the current page or when clarification is needed.

### Method
GET

### Endpoint
https://docs.ndi.video/all/developing-with-ndi/advanced-sdk/kvm-support.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET/POST /api/local/hx_gpu

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Get or set the local HX GPU.

```APIDOC
## GET/POST /api/local/hx_gpu

### Description
Get or set the local HX GPU. Will always return the latest local HX GPU.

### Method
GET, POST

### Endpoint
http://localhost:8080/api/local/hx_gpu

### Parameters
#### Request Body
- **value** (String) - Required - The name of the GPU. Use 'Auto' to automatically select a GPU.
```

--------------------------------

### GET/POST /api/local/groups

Source: https://docs.ndi.video/all/developing-with-ndi/utilities/bridge-service/api.md

Get or set the local groups to share.

```APIDOC
## GET/POST /api/local/groups

### Description
Get or set the local groups to share. Will always return the latest local groups.

### Method
GET, POST

### Endpoint
http://localhost:8080/api/local/groups

### Parameters
#### Request Body
- **value** (String) - Required - A comma delineated list of group names.
```
Tokens:
Raw