Update a control app's animation state

Update control app animation state

PATCH https://app.singular.live/apiv2/controlapps/:appToken/control

Animates an overlay to its In or Out state.

Path Parameters

Name	Type	Description
appToken*	String	The shared app token for the app. This is a unique token for this app instance. How to find the shared app token.

Request Body

Name	Type	Description
subCompositionId*	String	The sub-composition ID. Either the subCompositionID or the subCompositionName must be included in the request. Get them from the payload of the Get control app model request.
state*	String	Animates an overlay to its In or Out state. Supported values: In, Out1, Out2
subCompositionName*	String	The name of the sub-composition. Either the subCompositionID or the subCompositionName must be included in the request. Get them from the payload of the Get control app model request.

200: OK Success

{
    "success": true
}

Example request bodies by sub-composition name or ID

Subcomposition Name

[
    {
        "subCompositionName": "<subCompositionName>",
        "state": "<toState>"
    }
]

Subcomposition Id

[
    {
        "subCompositionId": "< string >",
        "state": "< toState >"
    },
    {
        "subCompositionId": "<...>",
        "state": "<...>"
    }
]

Animation state

Animation state	Description
In	Sends an overlay to its In state.
Out	Sends an overlay to its Out state. This is the default Out animation.
Out1	When there are multiple timelines, Out1 animates an overlay Out in reverse of the In animation.
Out2	When there are multiple timelines, Out2 defines an independent Out animation.