Articles in this section

See more

Using XML Control

  • Updated
Follow

Videon devices can be remotely configured using an XML file hosted on an HTTP server. XML Control allows you to define device settings in an XML configuration file and have the device periodically retrieve and apply changes from that file.

This can be useful when managing devices remotely or when you need to apply a consistent configuration across multiple devices.

Important: XML Control requires the XML configuration file to be hosted on an HTTP server that the Videon device can access. The device retrieves the XML file from the URL you provide and periodically checks the file for changes, depending on the poll interval set within the XML file.

How XML Control Works

The basic workflow is:

  1. Create or modify an XML configuration file using the provided example and XML schema.
  2. Host the XML file on an HTTP server accessible to the Videon device.
  3. Configure the Videon device with the URL of the hosted XML file.
  4. Enable XML Control on the device.
  5. Modify the hosted XML file whenever you need to change the device configuration.
  6. The device retrieves the updated file during its next polling interval and applies the changes.

XML Configuration Files

You can use the following files as references when creating your XML configuration. These files can also be downloaded for offline reference:

  • XML Schema — Defines the available configuration fields and the data type expected for each field.
  • Example XML File — Provides an example XML configuration containing many of the available settings.

When creating your configuration, start with the Example XML File and modify it for your specific application. Remove any settings you do not want to configure, as the example file contains example values for many of the available fields.

Important: For software versions > V10.2.1, a component such as an input, encoder, or output cannot be created if its Name field is blank. For example, <Name></Name> will cause the entire component to be rejected.

Known Behaviors — LiveEdge® Max

The following behaviors apply specifically to LiveEdge® Max:

  • XML Control is enabled by default on LiveEdge Max devices shipped with software version > V10.1.0.
  • If a LiveEdge Max device was shipped with a local software version < V10.1.0, contact Videon Support to have XML Control enabled.
  • XML files stored on an SD card do not function with XML Control on LiveEdge Max. The XML file must be hosted on an HTTP server.
  • Changes made through XML Control may take up to 90 seconds to be applied.

Host the XML File

Before configuring the Videon device, upload your XML configuration file to an HTTP server that the device can access.

There are several ways to host an XML file. For example, you can:

  • Host the file on a computer running a simple HTTP server.
  • Host the file remotely, such as in an AWS S3 bucket configured to provide access to the XML file.

The important requirement is that the Videon device must be able to retrieve the XML file from the URL you provide.

For local testing, you can use Python's Simple HTTP Server. For remote hosting, you can use Amazon S3 or another service that provides an HTTP-accessible URL.

Configure XML Control

Once your XML file is hosted, configure the Videon device to retrieve it.

Using the Local Web UI

  1. Open the Videon device's local web interface.

  2. Navigate to Device Settings.

  3. Select XML.

  4. Enter the URL of the hosted XML file in the URL field.
  5. Click Test URL to verify that the device can access the file.
  6. Enable Configure Using XML.

  7. Click Save.

If the server hosting the XML file requires Digest Authentication:

  1. Enable Authentication.
  2. Enter the required Digest Authentication credentials.
  3. Save the configuration.

Once XML Control is enabled, the device will use the settings defined in the XML file as part of its configuration.

Note: Settings that are not defined in the XML file can still be configured through the Videon web interface. If a setting is defined in the XML file, the XML configuration takes precedence for that setting. The web interface may display a warning when a setting configured in the UI conflicts with the XML configuration.

Using LiveEdge® Cloud Control

You can also configure XML Control through LiveEdge Cloud Control.

For instructions, see Using XML Control with LiveEdge® Cloud Control.

Control the Device Using the XML File

Once XML Control is configured, you can change the device configuration by modifying the hosted XML file.

  1. Modify the desired value in the XML file.
  2. Save the updated XML file on the HTTP server.
  3. The Videon device retrieves the updated file during its next polling interval.
  4. The device applies the updated configuration.

The XML polling interval can be configured in the XML file or through the Videon web interface. The default polling interval is 10 seconds.

Example: Configuring an RTMP Output

For example, the following XML configuration enables an output and specifies an RTMP destination:

<Output id="3">
    <Enable>true</Enable>
    <AudioSource>
        <AudioEncoderID>0</AudioEncoderID>
    </AudioSource>
    <VideoSource>
        <VideoEncoderID>0</VideoEncoderID>
    </VideoSource>
    <OutputType>
        <RTMP>
            <URL>rtmp://my.rtmp.com/live/mystream</URL>
        </RTMP>
    </OutputType>
</Output>

In this example, the Enable value is set to true, and the RTMP destination is defined in the URL field.

The basic XML structure for a setting follows this format:

<Element>value</Element>

To change a setting, modify the value between the opening and closing elements.

Understanding XML Configuration Behavior

You do not need to define every device setting in your XML file. XML Control only manages the settings that are defined in the configuration.

Settings that are not defined in the XML file remain available for configuration through the Videon web interface or other supported control methods.

If a setting is defined in the XML file, however, the XML configuration takes precedence for that setting. Changes made through the web interface that conflict with the XML configuration may be overwritten when the device retrieves the XML file again.

Troubleshooting

If you encounter problems configuring or applying an XML file, see the XML Troubleshooting guide.

When troubleshooting, verify that:

  • The XML file is hosted on an HTTP server.
  • The Videon device can reach the server over the network.
  • The URL configured on the device points to the correct XML file.
  • Test URL succeeds when configuring the device.
  • The XML file is valid and follows the provided XML schema.
  • Any required authentication credentials are configured correctly.
  • The settings you want to control are actually defined in the XML file.

For additional help, contact Videon Support.

Additional Resources

Related articles