Document plugin video configuration fields - #239
Open
gabek wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR expands the plugin API reference documentation to fully describe Owncast’s video configuration surface (VideoConfig) so plugin authors can read and partially update the same fields exposed in the admin UI.
Changes:
- Documented the full
VideoConfigcontract, including supportedautoplaymodes and videocodecnames. - Documented the complete
StreamVariantshape, replacing per-variant audio bitrate withcpuUsageLevel. - Updated JavaScript and Python
videoConfig.writepartial-update examples and clarified that audio settings are preserved and not plugin-addressable.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expand the plugin API reference to cover the complete video configuration contract.
The English production site build passed, and the generated plugin API page contains the new fields and values.
Related to owncast/owncast#5114 and owncast/plugin-sdk#14.