Screens and outputs / Integrations

Integrations

Connect AutoSermon to ProPresenter, to other AutoSermon computers, and to your own scripts through the HTTP API.

ProPresenter

Standard and above. AutoSermon writes what is on screen into four text files in a folder, and ProPresenter can show any of them in a text element.

  1. In Settings → Integrations → Services, turn on ProPresenter.
  2. Next to Output folder, click Browse and choose a folder the ProPresenter computer can read. Nothing is written until a folder is set. Open shows the folder.
  3. In ProPresenter, point a text element at each file you want to show.
  • autosermon-text.txt: the words on screen now.
  • autosermon-reference.txt: the verse reference, the slide title or the AI note type.
  • autosermon-translation.txt: the translation, for scripture only.
  • autosermon-status.txt: live or clear.

The files are emptied whenever nothing is showing: after a clear, while off air and during a blackout.

Sync between computers

AutoSermon computers on the same network can share what is on screen: the slide or verse, the media layer, props, messages, the stage message, blackout and the timer. Each computer still goes live on its own; libraries and settings are not shared.

  1. On every computer, press Start server in Settings → Network.
  2. On the computer that leads, set Sync mode to Master.
  3. On each computer that follows, set Sync mode to Slave, click Add peer and enter the leader’s address, such as http://192.168.1.24:9876.
  4. Check that the peer shows connected.
  • Peer is two-way: set both computers to Peer and add each one’s address to the other.
  • Each peer shows its state, such as connected or not reachable. Remove takes it off the list.
  • A computer in the Peers list can load this computer’s schedule with Load schedule → From network, whatever the sync mode.

HTTP API

Scripts and other programs on the network can drive AutoSermon over HTTP. The local server must be running.

  1. In Settings → Network → HTTP API, turn on Enable API.
  2. Click Generate to make a token, then copy it. Regenerate makes a new one, and the old token stops working.
  3. Send requests to the Base URL shown on the same card, with the header Authorization: Bearer followed by your token.

The API refuses requests from web pages served by other sites. Call it from a script or a program instead.

http://192.168.1.24:9876/api/v1

Endpoints

Paths are relative to the Base URL. POST bodies are JSON.

  • GET /status: whether the output is live or blacked out, what is on screen, the props and messages up, the timer and transcription.
  • GET /library: playlists, items, media and props, with the ids the other calls take.
  • POST /output/slide with {"itemId": "…", "slideIndex": 0} shows a slide and runs its actions. Slides are numbered from 0, in the song’s order.
  • POST /output/scripture with {"ref": "John 3:16", "translation": "KJV"} shows a passage. The translation is optional.
  • POST /output/message with {"text": "…"} shows a line of text.
  • POST /output/next and /output/previous step the slide on screen in the song’s order, roll into the next or previous item of the playlist open in the app, or go verse by verse during a reading. At either end of the playlist, or the first or last verse of the book, they answer 409.
  • POST /output/media with {"type": "image", "assetId": "…"} puts a background on the media layer. Use "video" for a video, or "solid", "gradient" or "none" with a value.
  • POST /output/clear, /output/clear-slide and /output/clear-media clear every layer, the slide, or the background.
  • POST /output/prop with {"id": "…", "on": true} puts a prop up or takes it down; with no on, it toggles. POST /output/clear-props takes every prop down.
  • GET /messages: every message, with its id, name, text, the fill-ins it needs (fields) and whether it is up.
  • POST /messages/show with {"id": "…", "values": {"Child": "Sam"}} shows a message. Give one value per fill-in; with no values, the ones typed last are used. A fill-in left empty is refused.
  • POST /messages/hide with {"id": "…"} takes a message down. POST /output/clear-messages takes every message down and leaves the props.
  • POST /output/blackout with {"on": true} or {"on": false}. With no body, it toggles blackout.
  • GET /timer returns the timer. POST /timer/start, /timer/pause and /timer/reset control it; start and reset take an optional {"seconds": 300}. POST /timer/session with {"sessionId": "…"} starts a schedule item.
  • GET /schedule: the schedule loaded on the Timer screen.
  • GET /bible/verses?ref=John%203:16 reads verses, and GET /bible/search?q=… searches the Bible. Both take an optional translation; search also takes a limit (25 by default, up to 100).
  • GET /transcript?limit=100: the latest transcript lines, up to 500.

The API cannot turn the output on, so do that in the app. Each address can make up to 20 requests a second.

Example

Every answer is JSON with ok set to true or false; a failure also includes an error message.

curl -X POST http://192.168.1.24:9876/api/v1/output/scripture \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref": "John 3:16"}'

Live updates

To follow changes as they happen, open a WebSocket to /ws on the same port and subscribe to program, timer or transcript. The feed needs no token and is read-only. Each message names its channel in ch and carries the update in data. Send {"unsub": […]} to stop a channel.

ws://192.168.1.24:9876/ws
{"sub": ["program", "timer", "transcript"]}