Files
platform-external-webrtc/api
Ilya Nikolaevskiy 9455c305e6 Remove deprecation notice for VideoFrame::ntp_time_ms
Ntp timestamps are used for end-to-end delay measurements and can never
go away. The naming and number of timestamp fields in VideoFrame could
change in the future, but capture time in local clock will always be
there on the receive side.

Bug: none
Change-Id: I358689cd8a44b1da8503136b3dd898b936f2d693
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/144542
Reviewed-by: Erik Språng <sprang@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Commit-Queue: Ilya Nikolaevskiy <ilnik@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#28498}
2019-07-05 18:37:41 +00:00
..
2019-06-03 08:15:09 +00:00
2019-01-25 20:29:58 +00:00
2019-02-01 13:24:47 +00:00

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 “.h and .cc files come in pairs” rule, so if you declare something in api/path/to/foo.h, it should be defined in api/path/to/foo.cc.
  • Headers in api/ should, if possible, not #include headers outside api/. 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.
  • .cc files in api/, on the other hand, are free to #include headers outside api/.

That is, 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.