Documentation Archive

Developer

Asset Catalog Format Reference

On This Page

Sticker Sequence Type

An animated sticker for a sticker pack. The sticker uses a series of images to generate the animation.

Extension

.stickersequence

Folder Contents

An image for each frame of the sequence.

Contents.json File

Metadata, animation information, accessibility text, and filenames for the sticker sequence. For values, see (Table 28-1).

Table 28-1Sticker sequence tags

Key

Type

Description

info

Dictionary

Versioning information for the asset catalog.

   author

String

The application that authored the asset catalog.

   version

Number

The version of the asset catalog.

properties

Dictionary

Properties for the sprite atlas.

   accessibility-label

String

A custom string used by Voice Over. The sticker name is used if no string is provided.

   duration

Number

Determines the length of the animation cycle as a fixed duration or as a number of frames per second.

The interpretation is controlled by the duration-type key.

   duration-type

String

Determines how the number for duration is used. For the values, see duration-type below.

   repetitions

Number

The number of times the animation repeats in addition to the initial animation.

Use 0 for continuous animation.

frames

Array of dictionaries

The array of frames in the animation. The order of the animation is the same as the order of the array.

   filename

String

The name of the image file containing the sticker for a frame.

Values for Enumerated Tags

duration-type

The type of duration. The value determines how the duration key is used. Values are shown in (Table 28-2).

Table 28-2duration-type values

Value

Description

fixed

duration is the number of seconds for one animation cycle.

fps

duration is the target frame rate for the animation.

Sample Contents.json File

  1. {
  2. "properties" : {
  3.       "accessibility-label" : "The llama is winking at you.",
  4.       "repetions" : 0,
  5.       "duration-type" : "fps",
  6.       "duration" : 15
  7. },
  8.    "frames" : [
  9.       {
  10.          "filename" : "001_llamaWink.png"
  11.       },
  12.       {
  13.          "filename" : "002_llamaWink.png"
  14.       },
  15.       {
  16.          "filename" : "015_llamaWink.png"
  17.       }
  18.    ],
  19.   "info" : {
  20.       "author" : "com.developerName",
  21.       "version" : 1
  22.    }
  23. }