Image

Overview

Displays a simple image (or animated gif).

The Image face view is a simple face which all vAtoms are recommended to support. This face is is an embedded face (included by default in the SDKs).

Registering the face

This example below shows how to register the image face onto your vAtom's template.

POST /v1/publisher/face

{
  "template": "MyTemplateName",
  "display_url": "native://image",
  "package_url": ".",
  "constraints": {
    "bluetooth_le": false,
    "contact_list": false,
    "gps": false,
    "three_d": true,
    "view_mode": "icon",
    "platform": "generic",
    "quality": "high"
  },
  "config": {
    "image": "ActivatedImage",
    "scale": "fit"
  }
}

Face configuration

All fields in the face's config object are optional.

Field name	Type	Default value	Description
`image`	string	`"ActivatedImage"`	The name of the image resource to be displayed.
`scale`	string	`"fit"`	Describes how the image should be scaled. `fit` will aspect-scale the image to fit into the view area, `fill` will aspect-scale it up to cover the entire view area, possibly clipping parts of the image out.

Info