External Image key/value pair group | NAGRAVISION Documentation Portal

Overview

An External Image key/value pair group indicates to the client this is a group containing information for an externally-hosted image accessed via a URL.

Example extendedAttributes block

For a rail or custom component that has a External Image key/value pair group instance attached to it, the extendedAttributes block will look like this:

JSON

...
"extendedAttributes": [
  {
    "instance": "ION Logo",
    "alt_text": "Logo",
    "type": "external_image",
    "blueprintId": "5bfe650f-04ca-4ea2-b671-8a6096f1c91b",
    "url": "https://www.nagra.com/sites/default/files/2023-01/OpenTV%20Video%20Platform%20Streaming%20Devices%20%28C%29.jpeg",
    "image_type": "logo",
    "scale_factor": ""    
  }
],
...

Fields

The fields for the External Image key/value group are as follows:

Keys	Type	Values	Description
`instance`	String	N/A	The name of the instance of the KVP group
`alt_text`	string		The `alt_text` field provides alternative text for the logo, intended to describe the logo for users who rely on screen readers, such as TalkBack. This ensures accessibility for visually impaired users by providing a meaningful description of the logo's content or purpose. The text should be clear, concise, and relevant to the brand or application, allowing users to understand what the logo represents. For localisation, use the format `"i18n.alt_text.{locale}"` in the `client_context` field to define translations for each locale. The `client_context` array should include entries like `"i18n.alt_text.en_GB": "Spotify logo"` and `"i18n.alt_text.ja_JP": "スポティファイロゴ"`, ensuring the alt text is appropriately localised across regions and languages.
`type`	static	`external_image`	The `type` field defines the category of KVP group. The `external_image` value indicates to the client this is a group containing information for images accessed via externally hosted URLs rather than being stored within the platform’s internal image service
`blueprintId`	String	N/A	The blueprint ID for the KVP group that this is an instance of
`url`	image		Specifies the direct URL to an externally hosted image. This is the default image for the `image_type` unless specific light or dark variants are provided.
`image_type`	enum	`logo,` `banner,` `background`	The `image_type` field specifies the category of image being defined within the group. This helps differentiate between various visual elements used within the UI. logo – Represents a logo, typically used as a small, recognisable mark placed within the rail or on content tiles. banner – Represents a wider branding element, often spanning across sections of the screen rail to provide stronger brand association. background – Represents a full-background image, used to set the overall visual theme behind the rail’s content.
`scale_factor`	numeric (-100 to +100)		Values other than 0 mean the client must provide the specified level of scaling on the image.