Get a composition's sub-composition IDs and names and their payload structures
To update graphics in a control app, you need their sub-composition IDs and payload structures.
There are two ways to get them:
Get a composition's sub-composition IDs and names and their payload structures in Composer
Open the app's composition in Composer. If the app is from a template and doesn't have an associated composition, you'll need to extract a composition from the app.
Navigate to the composition tree and click into each sub-composition you'd like to update.
In the lower right quadrant of Composer, click on the wrench icon to open a pop-up that shows the sub-composition's ID and payload structure.
Get a composition's sub-composition IDs and names and their payload structures using the API
Get the API token for the particular app instance that contains the sub-composition ID and payload structure you're looking for.
Send a
GET
request to the endpoint for Get a control app's control datahttps://app.singular.live/apiv2/controlapps/:appToken/control
replacing:appToken
with the actual app token for the app instance.In the response, locate
subCompositionId
andsubCompositionName
and the payload structure of each sub-composition you'd like to update.
Last updated