AirframeDocs
View as Markdown

Your first graphic on air

From an empty workspace to a lower third on air in OBS, in about ten minutes.

1. Build a composition

  1. In Airframe, choose New composition and name it after the show.
  2. Add a component for a lower third. Draw a box and two text elements on it.
  3. Add two fields, name and title, and bind each text element to one.
  4. Animate its In and Out on the timeline, or ask Assist to.

2. Publish it

Choose Publish in the editor, with a note like First version. That saves it as version 1, which never changes.

3. Add an output

  1. Open Outputs and choose New output.
  2. Choose your composition and its version.
  3. Copy the Browser source URL and add it to OBS. Add an output to OBS Studio has the settings.

4. Take it

  1. Open the output's control room.
  2. Select the lower third, fill in the name and title, and press Take. It plays its In, on air in OBS.
  3. Press Clear to take everything off.

5. Drive it from code

Make an API key, then send the same take as a command:

Shell
curl -X POST https://api.airframe.tv/v1/outputs/OUTPUT_ID/commands \
  -H "Authorization: Bearer $AIRFRAME_KEY" \
  -H "Content-Type: application/json" \
  -d '{"commands":[{"command":"in","component":"lower-third","data":{"name":"Jane Doe","title":"Head coach"}}]}'