Localizing Player Error Messages

Applies to Roles
Developer
Version
Brightcove 4
Modules
Player API
Edition
Pro, Enterprise

When Brightcove players are unable to load, whether because of geographic or domain restrictions, content unavailability, or otherwise, the page displays an appropriate error message. By default, these error messages are in English. If you want to localize your player error messages:

Creating a customized error message file

The default English error message file looks like this:

<errors>
  <domainRestricted>
      The video you are trying to watch cannot be viewed from this website.
  </domainRestricted>
  <geoRestricted>
      The video you are trying to watch cannot be viewed from your current country or location.
  </geoRestricted>
  <invalidID>
      The video you are trying to watch is no longer available from this website.
  </invalidID>
  <default>
      The video you are trying to watch is currently unavailable. Please check back soon.
  </default>
</errors>

You can modify the text within the error message tags as you like, using whatever language or character set works best for you.

Setting the error message URL in the publishing code

To configure your player to use a different set of error messages than the default English error messages, set the localizedErrorXML player configuration parameter in your player's publishing code. To set this parameter using JavaScript/HTML, use a parameter like this in the <object>element of the publishing code:

<param name="localizedErrorXML" value="http://myserver.com/klingon/localizedError.xml" />

To set this parameter using ActionScript, use a parameter like this in the init function of the publishing code:

config["localizedErrorXML"] = "http://myserver.com/klingon/localizedError.xml";

Note that the URL must be an absolute URL, not a relative one.

Tags
language, localization