Skip to content

add enhancements: speech doc - #737

Merged
TimLeenaers merged 4 commits into
mainfrom
captions-translations
Oct 7, 2026
Merged

TimLeenaers merged 4 commits into
mainfrom
captions-translations

Conversation

@TimLeenaers

Copy link
Copy Markdown
Member

No description provided.

@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://THEOplayer.github.io/documentation/pr-preview/pr-737/

Built to branch gh-pages at 2026-07-14 08:05 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@wjoosen
wjoosen self-requested a review September 22, 2026 15:49
@wjoosen
wjoosen force-pushed the captions-translations branch from 20006b1 to 3ea0d9b Compare September 22, 2026 16:21
@wjoosen
wjoosen requested a review from a team as a code owner September 22, 2026 16:22
@theoplayer-bot

This comment has been minimized.

Comment thread theolive/contribution/enhancements/speech.mdx Outdated

@christopher-dolby christopher-dolby left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked this page against the API on development (the ingest validators and the SpeechEnhancement schema) and the engine's HLS output while working on the SyncWords e2e test (OLIVE-809). The structure reads well, but a few statements no longer match the API, and some fields that are already in the public API reference are missing here. Details are inline.

Two things that don't fit on a single line:

  • Nothing links to this page yet. Readers will look on the Closed captions page (contribution/closed-captions.mdx) first, and the changelog entry "Added the ability to auto-generate captions and translations" could point here too.
  • Usage is reported in minutes through /v2/enhancements/speech/analytics/captioned-minutes and /translated-minutes (also per channel and per ingest under …/analytics/captions/…). A short usage section would help customers reconcile what they're billed.

Comment thread theolive/contribution/enhancements/speech.mdx Outdated
Comment thread theolive/contribution/enhancements/speech.mdx
Comment thread theolive/contribution/enhancements/speech.mdx Outdated
Comment thread theolive/contribution/enhancements/speech.mdx Outdated
Comment thread theolive/contribution/enhancements/speech.mdx Outdated
Comment thread theolive/contribution/enhancements/speech.mdx
Comment thread theolive/contribution/enhancements/speech.mdx Outdated
Comment thread theolive/contribution/enhancements/speech.mdx Outdated
- use shared premium-feature callout
- link to generated API reference pages instead of describing every field
- fix targetTextTracks semantics (source language always included, must not be listed)
- document latencyMode, extraPrompt, position, region requirement, engine_playing
- cover srt-push/srt-pull connection details, viewer output, dashboard, usage analytics
- add missing error codes; link from the Closed captions page

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@TimLeenaers
TimLeenaers merged commit 7535d43 into main Oct 7, 2026
2 checks passed
@MattiasBuelens
MattiasBuelens deleted the captions-translations branch October 7, 2026 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants