Repository navigation
docs: write the guides in shorter sentences - #595
Merged
Merged
Conversation
Same content: long sentences split, sequences as numbered lists, rules as bullet lists.
Same content: platforms and measurements as tables, rules as lists, and the page names its client API counterpart.
Same content: long sentences split, rules and failure cases as lists.
Long sentences split. Also corrects which factories offer H.265: the hardware factories on every platform where the GPU handles it, not only on Macs.
Same content, with one point made exact: a video track without a key frame within three seconds starts the new segment at its next key frame.
Same content: long table cells and rules moved into lists below the tables.
Also corrects the audio of a media file: it is pushed audio, which works in every audio mode, not only CUSTOM and HEADLESS.
Same content: recovery rules and JSON rules as lists.
Same content: rules as lists, long paragraphs split.
Same content: the rules of disposal as a list.
Same content: the exceptions of the thread table as a list below it, and screens() and windows() named as asking the system on every call.
Same content: the memory rules of the video views and the speech detection settings as lists.
Same content, long paragraphs split.
Same content, long sentences split.
Since #571 every audio sender gets the audio of its own track, so captured audio no longer reaches an injecting sender.
Same content: the client API first, the core API after it, and the rules of starting, stopping and feedback as lists.
Same content: content hints and layers as lists.
Same content, rules about buffers as a list.
Same content, long paragraphs split.
Same content, long table cells and paragraphs split.
Same content, long paragraphs split.
Same content, long sentences split.
Same content, the effects of the old capture path as a list.
Same content, long paragraphs split.
Same content, long paragraphs split.
Same content.
Same content, the receive limit and message previews as lists.
Same content.
Same content.
A failed device query, also for an unavailable audio backend, throws MediaException; it does not come back empty. Also names screens() and windows() as asking the system on every call, and lists the blocking calls below the thread table.
They restated the page. The advice two of them held stays as Best Practices, and the CPU note of audio processing joins its Best Practices.
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.
Builds on #594. Rewrites the guides in shorter sentences, with sequences as numbered lists and rules as bullet lists. One commit per page; code blocks are unchanged. The conclusion sections, which restated the page, are gone; the advice two of them held stays as Best Practices.
Corrections found along the way:
CUSTOMandHEADLESS.RTCRtpSender: since feat: send device-captured and pushed audio from one factory #571 every audio sender gets the audio of its own track.MediaExceptionrather than coming back empty (Client API Design).