Build a read-along player
Say you have a recording of Psalm 23 and want listeners to tap a verse and hear it, with each word lit as it is read.
- Upload the recording with
POST /v1/uploadsand start an alignment withPOST /v1/alignments. For a Bible reading you can leave outsegments, and the passage and its verses are found for you. For your own text (a sermon outline, a liturgy), send it assegmentswith your own ids. - Poll
GET /v1/jobs/{id}every few seconds untilstatusisdoneorfailed. - Store the result next to the recording in your own system. Each segment's
startMsandendMslet your player seek to a verse in the file you already host;wordsgives the times to light each word. - If you asked for
clips, download each clip fromGET /v1/jobs/{id}/files/{clip}with your key and host it yourself. Clips are there for 7 days after the job finishes, so fetch them when the job is done; the timings in the result stay.
Align each recording once, when it is published, and serve the timings from your own storage after that. Listeners never wait on an alignment.
Fetch clips when the job is done: they are kept for 7 days for live keys or 1 day for test keys. The timings stay in the job result, so your player can keep using them.
Need the contract? Download OpenAPI. Manage keys and account access in the developer console.