6e956053b7
Add a StartShortCircuiting() callback to allow clients which have configured Encoded Transforms when creating a PeerConnection to have all frames skip the transform. This offers a zero cost path for streams which don't need transforms. This is preferable to uninstalling/not installing the transform to allow implementing the behaviour in https://w3c.github.io/webrtc-encoded-transform/#stream-creation - giving web apps a chance to configure transforms within a short window (before the next JS event loop run, so usually sub-millisecond) after stream creation, without any untransformed frames passing. Usage in Chromium: crrev.com/c/5040731 Bug: chromium:1502781 Change-Id: I803477db1df51e80bdedf6c84d2d3695b088de83 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/327601 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Commit-Queue: Tony Herre <herre@google.com> Cr-Commit-Position: refs/heads/main@{#41184}
How to write code in the api/ directory
Mostly, just follow the regular style guide, but:
- Note that
api/code is not exempt from the “.hand.ccfiles come in pairs” rule, so if you declare something inapi/path/to/foo.h, it should be defined inapi/path/to/foo.cc. - Headers in
api/should, if possible, not#includeheaders outsideapi/. It’s not always possible to avoid this, but be aware that it adds to a small mountain of technical debt that we’re trying to shrink. .ccfiles inapi/, on the other hand, are free to#includeheaders outsideapi/.- Avoid structs in api, prefer classes.
The preferred way for api/ code to access non-api/ code is to call
it from a .cc file, so that users of our API headers won’t transitively
#include non-public headers.
For headers in api/ that need to refer to non-public types, forward
declarations are often a lesser evil than including non-public header files. The
usual rules still apply, though.
.cc files in api/ should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public
code, and just call it from the api/ .cc file.
Avoid defining api with structs as it makes harder for the api to evolve. Your struct may gain invariant, or change how it represents data. Evolving struct from the api is particular challenging as it is designed to be used in other code bases and thus needs to be updated independetly from its usage. Class with accessors and setters makes such migration safer. See Google C++ style guide for more.
If you need to evolve existent struct in api, prefer first to convert it into a class.