Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated as per DOCS-1399

Expand
titleTable of Contents
Table of Contents
minLevel1
maxLevel3
outlinefalse
indent20px
typelist
printablefalse

...

 The API described below requires firmware version 7.0 or later.

Support Overview

Player Models, MPCDI Levels, and MPCDI Version

Series 4 (XTx44, XDx34, HDx24) and Series 3 (XTx43, XDx33, HDx23, HO523) models players support all levels of the MPCDI 2D Media profile.

The 4Kx42 models players also support MPCDI, but at Level 1 and Level 2 only. We recommend Series 4 or Series 3 models 3 or 4 players for optimal rendering speeds.

MPCDI Version 1a is implemented on Series 3 and 4 players. It’s not supported on Series 5 players.

Media Types

MPCDI is supported with graphics objects such as roImageWidget, roHtmlWidget, and roTextWidget. It does not support the roVideoPlayer object; to apply MPCDI to a video, display the video as part of an HTML page.

...

Enables MPCDI using an associative array of parameters. This method returns true if MPCDI has been enabled and false if it could not be enabled. The associative array must contain the following parameters:

  • region roAssociativeArray: An associative array of parameters containing region data:

    • xresolution int: The viewport width, which corresponds to the <XResolution> attribute in the <region> tag of the mpcdi.xml configuration file

    • yresolution int: The viewport height, which corresponds to the <YResolution> attribute in the <region> tag of the mpcdi.xml configuration file

    • x float: The region coordinate horizontal position, which corresponds to the <x> attribute in the <region> tag of the mpcdi.xml configuration file

    • y float: The region coordinate vertical position, which corresponds to the <y> attribute in the <region> tag of the mpcdi.xml configuration file

    • xsize float: The region coordinate width, which corresponds to the <xsize> attribute in the <region> tag of the mpcdi.xml configuration file

    • ysize float: The region coordinate hieght, which corresponds to the <ysize> attribute in the <region> tag of the mpcdi.xml configuration file

  • blendmaps roArray: An array containing one or two entries describing blend map data. The array must contain an entry describing alpha map parameters, and may contain a second entry describing beta map parameters. Each entry must have the following parameters:

    • mapname string: The map name, which can be either "alpha" or "beta"

    • width int: The map width, as provided in the map .png file

    • height int: The map height, as provided in the map .png file

    • comdepth int: The number of components held in the map, which corresponds to the <alphaMap> or <betaMap> tag in the mpcdi.xml configuration file

    • size int: The size of the decoded .png file data (in bytes)

    • gammacorrection float: The gamma correction value, which corresponds to the <gammaEmbedded> attribute in the <alphaMap> tag of the mpcid.xml configuration file (this setting does not apply to a beta map)

    • data roByteArray: The decoded .png data

  • warp roAssociativeArray: An associative array of parameters containing warp data:

    • width int: The width of the geometry warp map, which is provided in the .pfm file

    • height int: The height of the geometry warp map, which is provied in the .pfm file

    • data roArray: The extracted .pfm file data as an array of float values

...

Code Block
[mpcdi_enabled, widget_count, filename.mpcdi, mode, ip_media_filename]
  • mpcdi_enabled string: A flag that determines whether MPCDI is enabled ("on") or disabled ("off")

  • widget_count int: The number of widgets to display on screen (1, 2, or 3). If you specify a single widget, the image/video widget will be displayed as full screen.

  • filename.mpcdi string: The name of the .mpcdi file

  • mode string: The mode of the image/video widget ("image" or "video")

  • ip_media_filename string: The name of the media file to display in the image/video widget.

...