> For the complete documentation index, see [llms.txt](https://docs.routeeffect.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.routeeffect.com/import-and-export/port-metadata.md).

# Port Metadata

Port metadata is all that extra information that RouteEffect layers on top of your Videohub. This includes short labels, icons, badges, colors, and notes for your input sources and output destinations.

RouteEffect allows you to export your port metadata from simulated and real Videohubs and transfer them to other Videohub instances.

{% hint style="danger" %}
Replacing port metadata is an operation that cannot be undone. You'll want to backup your data before performing a restore so that if there's a problem, you can restore to a known, stable state.
{% endhint %}

## Exporting port metadata to the clipboard

To export the port metadata for a Videohub to the clipboard, follow these steps:

1. Navigate to the video router or simulator that you wish to export the port info metadata from
2. In the content section, scroll down to the `Port Metadata` section
3. Tap `Copy Port Metadata to Clipboard`

This will place a JSON file in your clipboard that has all the metadata for your inputs and outputs. A sample file looks like this for an ATEM Mini Pro:

```
{"colorChoiceRaw":"green","colorHex":"30D158","isHidden":false,"label":"Webcam Out","portIndex":1,"portTypeRaw":"output","shortLabel":"Web cam"}
{"colorChoiceRaw":"purple","colorHex":"BF5AF2","isHidden":false,"label":"Program","notes":"Red","portIndex":2,"portTypeRaw":"output","shortLabel":"PGM"}
{"colorChoiceRaw":"red","colorHex":"FF453A","icon":"rectangle.inset.filled","isHidden":false,"label":"Program","portIndex":11,"portTypeRaw":"input","shortLabel":"PGM"}
{"colorChoiceRaw":"red","colorHex":"FF453A","icon":"point.topright.filled.arrow.triangle.backward.to.point.bottomleft.scurvepath","isHidden":false,"label":"VideoHub Direct","portIndex":13,"portTypeRaw":"input","shortLabel":"DIRECT"}
{"colorChoiceRaw":"blue","colorHex":"0A84FF","isHidden":false,"label":"Output","portIndex":0,"portTypeRaw":"output","shortLabel":"OUT"}
{"colorChoiceRaw":"green","colorHex":"30D158","icon":"camera.fill","isHidden":false,"label":"5D Mark IV","portIndex":3,"portTypeRaw":"input","shortLabel":"5D4"}
{"colorChoiceRaw":"green","colorHex":"30D158","icon":"rectangle.inset.filled","isHidden":false,"label":"Preview","portIndex":12,"portTypeRaw":"input","shortLabel":"PRV"}
{"colorChoiceRaw":"purple","colorHex":"BF5AF2","icon":"rectangle.split.3x3.fill","isHidden":false,"label":"Multi View","portIndex":10,"portTypeRaw":"input","shortLabel":"MV"}
{"colorChoiceRaw":"purple","colorHex":"BF5AF2","icon":"mediastick","iconBadge":"2","isHidden":false,"label":"Media Player 1 Key","portIndex":9,"portTypeRaw":"input","shortLabel":"MP2"}
{"colorChoiceRaw":"orange","colorHex":"FF9F0A","icon":"mediastick","iconBadge":"1","isHidden":false,"label":"Media Player 1","portIndex":8,"portTypeRaw":"input","shortLabel":"MP1"}
{"colorChoiceRaw":"yellow","colorHex":"FFD60A","icon":"rectangle.fill","iconBadge":"2","isHidden":false,"label":"Color 2","portIndex":7,"portTypeRaw":"input","shortLabel":"COL2"}
{"colorChoiceRaw":"green","colorHex":"30D158","icon":"circle.fill","iconBadge":"1","isHidden":false,"label":"Color 1","portIndex":6,"portTypeRaw":"input","shortLabel":"COL1"}
{"colorChoiceRaw":"red","colorHex":"FF453A","icon":"barcode","isHidden":false,"label":"Color Bars","portIndex":5,"portTypeRaw":"input","shortLabel":"BARS"}
{"colorChoiceRaw":"blue","colorHex":"0A84FF","icon":"ipad.homebutton","isHidden":false,"label":"iPad","portIndex":4,"portTypeRaw":"input","shortLabel":"iPad"}
{"colorChoiceRaw":"red","colorHex":"FF453A","icon":"keyboard.fill","isHidden":false,"label":"ATEM","portIndex":2,"portTypeRaw":"input","shortLabel":"ATEM"}
{"colorChoiceRaw":"custom","colorHex":"00FFFF","icon":"server.rack","isHidden":false,"label":"VideoHub","portIndex":1,"portTypeRaw":"input","shortLabel":"VHUB"}
{"colorChoiceRaw":"custom","colorHex":"BF5AF2","icon":"rectangle.fill","isHidden":true,"label":"Black","portIndex":0,"portTypeRaw":"input","shortLabel":"BLK"}
{"colorChoiceRaw":"purple","colorHex":"BF5AF2","isHidden":false,"label":"Preview","portIndex":3,"portTypeRaw":"output","shortLabel":"PRV"}
{"isHidden":false,"label":"Output 20","portIndex":19,"portTypeRaw":"output"}
{"isHidden":false,"portIndex":-1,"portTypeRaw":"input"}
{"isHidden":false,"label":"Output 19","portIndex":18,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 18","portIndex":17,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 17","portIndex":16,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 16","portIndex":15,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 15","portIndex":14,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 14","portIndex":13,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 13","portIndex":12,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 12","portIndex":11,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 11","portIndex":10,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 10","portIndex":9,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 9","portIndex":8,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 8","portIndex":7,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 7","portIndex":6,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 6","portIndex":5,"portTypeRaw":"output"}
{"isHidden":false,"label":"Output 5","portIndex":4,"portTypeRaw":"output"}
```

<figure><img src="/files/hnoZZNMabbwMCk5kCTTU" alt=""><figcaption></figcaption></figure>

## Importing port metadata

To import port metadata from one Videohub to another, perform the following:

1. Navigate to the video router or simulator that you want to import the port metadata to
2. In the content section, scroll down to the `Port Metadata` section
3. Tap `Import Port Metadata…`
4. In the sheet that appears, paste the port metadata text blog into the text editing field
5. Tap `Import`
6. Confirm your action to import the metadata. Note that this is an undoable operation

Now the simulated ATEM Mini Pro's inputs and outputs match the physical ATEM Mini Pro's look and feel in RouteEffect. Here are before and after shots:

<div><figure><img src="/files/Wfq9Uk31t3Wh6a6pnXVH" alt=""><figcaption><p>Before port metadata import</p></figcaption></figure> <figure><img src="/files/DaZ1rT6bjR7697romyQ6" alt=""><figcaption><p>After port metadata import</p></figcaption></figure></div>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.routeeffect.com/import-and-export/port-metadata.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
