Links

Get a control app's model

get
https://app.singular.live/apiv2/controlapps/:appToken/model
Get control app model

Response definitions

The following table describes the top level key-value pairs for a sub-composition in the Get control app model request.
Response item
Description
Data type
id
Composition ID or sub-composition ID, depending where it is in the hierarchy.
String
name
Composition name or sub-composition name, depending where it is in the hierarchy.
String
state
The in/out state of a sub-composition. Supported values: In, Out, Out1, Out2. In and Out are default. When there are multiple timelines, Out1 plays in reverse of the In animation. Out2 defines a separate Out animation.
String
model
The sub-composition's model. It contains a defaultValue, id, immediateUpdate, index, resetValue, title, and type. See the model content table below for descriptions.
Array
logicLayer
The sub-compositions assigned logic layer, if any; default is null. See the logicLayer content table below for a description of its content.
Object
snapshot
The URL of the snapshot shown when hovering over a sub-composition in the composition tree in Composer. Generate and invoke them from camera icon in Composer's preview toolbar.
URL
subcompositions
An array of sub-compositions (if any) nested within a composition or sub-composition.
Array

Model content

The key-value pairs within the model array.
defaultValue
The sub-composition's default value. Defined in the overlay's composition.
String, Integer, Object
id
The Model ID.
String
immediateUpdate
A flag used by control applications to immediately send data.
Boolean
index
Defines the control node field's position in the hierarchy of control nodes fields. 0 is the top position.
Number
resetValue
The sub-composition's reset value. Defined in the overlay's composition.
String, Integer, Object
title
The title of the control node field in Composer.
String
type
Field type. Supported values: text, textarea, number, image, color, checkbox, audio, json, timecontrol, button.
String
Field types
Type
Description
Data type
text
The field type for a single of text.
String
textarea
The field type for multi-line text.
String
number
The field type for a number.
Integer
image
The field type for an image.
URL
color
The field type for a color.
Object, String
checkbox
The field type for a checkbox.
Boolean
audio
The field type for an audio file.
URL
json
The field type for JSON data.
Object
timecontrol
The field type for a timer.
Object
button
The field type for a button.
Object

logicLayer content

The content within the logicLayer object.
Response item
Description
Data type
name
The logic layer's name.
String
delay
The logic later's delay type as defined in the composition. Supported values: none, auto, custom.
String
tag
The hex color value assigned to the logic layer. Example: #e53935
String