Image

Display simple images or animated GIFs in your vAtoms using the embedded Image face. Learn configuration options for scaling and resource selection.

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

Code

{
  "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.