-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Add example requests to API Reference #775
Conversation
docs/pages/api/inputs/rtp.md
Outdated
"audio": { | ||
"decoder": "opus" | ||
}, | ||
"required": true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that we should emphasize in docs, that setting required
to true
for failable streams will stop the entire processing of the LiveCompositor once such input fails/stops sending data and avoid setting it to true
in example requests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree, but I don't think setting it to true is the issue here, specifying this field at all in the example is more of a problem
@brzep BTW you don't have to assign the entire team for review. Usually assigning 1 or 2 team members should be enough. |
I know I don't have to assign everyone (normally I don't do that), but I assumed it's a very simple change and reviewing it will take like 2 minutes, so more people can do it. I think with the docs the more people see them, possibly the more feedback I'll receive so they'll be more user friendly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example requests should include stuff that is required, or optional fields that most use will need to specify. Stuff like offset/required/ffmpeg_options do not help here
PR for #752
Added example requests to RTP/MP4/DeckLink pages to make going to HTTP Routes page not necessary.
Requests are split into two code blocks to make copying request json easier.