RouteEffect
  • Welcome to RouteEffect!
    • Which version is right for you?
  • What is a Video Router
  • Using RouteEffect
    • Adding a Video Router
    • Connecting to a Video Router
    • Video Router Landing Page
    • Routing
      • Button View
      • Split View
      • List View
      • Wheel View
      • Crosspoint View
      • Virtual Output View
      • Inspector
      • Take Mode
    • Input Labels
    • Output Labels
    • Output Locks
    • Virtual Outputs
    • Presets
    • Multiview
  • Simulator
  • Dashboard
  • Shortcuts
    • Find Port Info
    • Find Simulator
    • Find Video Router
    • Run Preset
    • Send Videohub Command
    • Export Configuration
    • Change Lock Status
    • Get Lock Status
    • Get Port Metadata
    • Set Port Metadata
    • Change Route
    • Change Virtual Route
    • Get Current Route
    • Control Simulator
    • Control Video Router
    • Get Active Video Router
  • Import and Export
    • Backing up a Videohub
    • Exporting Configuration
    • Port Metadata
  • Settings
  • Support
    • Frequently Asked Questions
  • Privacy and EULA
  • Version History
  • RouteEffect Pro
Powered by GitBook
On this page
  • Port Type
  • Input
  • Output
  • Label
  • Short Label
  • Icon
  • Icon Badge
  • Color (Hex)
  • Notes
  • Is Hidden
  • Target
  • Video Router
  1. Shortcuts

Set Port Metadata

Sets metadata for a given port.

Port Type

The type of port to receive metadata from. Currently only Input and Output port types are supported.

Input

The input source if the port type is set to Input.

Output

The output destination if the port type is set to Output.

Label

The long name for the port.

Short Label

The short name for the port.

Icon

An SF Symbol representing the port.

Icon Badge

A number from 0-50 or a letter from A-Z.

Color (Hex)

The color value in hexadecimal for the port.

Notes

Additional notes about the port.

Is Hidden

Whether or not the port should be hidden.

Target

Target the currently selected video router or the focused video router.

Video Router

If the target is selected, the video router to query.

PreviousGet Port MetadataNextChange Route

Last updated 1 month ago