> For the complete documentation index, see [llms.txt](https://docs.ndi.video/all/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ndi.video/all/developing-with-ndi/ndi-metadata/metadata-and-xml.md).

# Metadata & XML

## NDI Metadata and XML

While NDI metadata is formatted as XML, there are some differences between XML used for NDI metadata frames and a more conventional stand-alone XML file. This section discusses how XML standards apply to NDI metadata frames.

## XML Prolog

NDI metadata frames should not contain an XML prolog. Each NDI Metadata frame can be assumed to have the following prolog, indicating XML version 1.0 compliance and UTF-8 encoding.

```xml
<?xml version="1.0" encoding="UTF-8"?>
```

## XML Syntax

NDI metadata frames should be "Well Formed" XML documents with correct syntax. Please check the following:

* [x] Metadata should have one and only one root element
* [x] XML elements must have a closing tag
* [x] XML tags are case sensitive
* [x] XML elements must be properly nested
* [x] XML attribute values must be quoted

## XML Root Element

As a "Well Formed" XML document, an NDI metadata frame can only have one root element. If there is a need to pass more than one XML element in an NDI metadata frame, the root element should be set to `<ndi_metadata_group>` and the required XML elements can be passed as children to this root element.

{% hint style="info" %}
See the documentation for the `<ndi_metadata_group>` element, below, for example usage.
{% endhint %}

## XML Comments

XML comments are allowed but **discouraged** in NDI metadata frames.

## XML Namespaces

XML namespaces are **not supported** in NDI metadata frames.

## XML Element Names

With the exception of element names defined in this document, no XML element passed in a metadata frame to the NDI SDK should begin with the string `ndi` or `ntk` (or any permutation of capitalization,eg: `Ndi`).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ndi.video/all/developing-with-ndi/ndi-metadata/metadata-and-xml.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.