tree: 917e6c26173ab34748f251145710443425d3bb90 [path history] [tgz]
  1. adaptation/
  2. audio/
  3. audio_codecs/
  4. call/
  5. crypto/
  6. neteq/
  7. numerics/
  8. rtc_event_log/
  9. stats/
  10. task_queue/
  11. test/
  12. transport/
  13. units/
  14. video/
  15. video_codecs/
  16. voip/
  17. array_view.h
  18. array_view_unittest.cc
  19. async_resolver_factory.h
  20. audio_options.cc
  21. audio_options.h
  22. BUILD.gn
  23. candidate.cc
  24. candidate.h
  25. create_peerconnection_factory.cc
  26. create_peerconnection_factory.h
  27. crypto_params.h
  28. data_channel_interface.cc
  29. data_channel_interface.h
  30. DEPS
  31. DESIGN.md
  32. dtls_transport_interface.cc
  33. dtls_transport_interface.h
  34. dtmf_sender_interface.h
  35. fec_controller.h
  36. fec_controller_override.h
  37. frame_transformer_interface.h
  38. function_view.h
  39. function_view_unittest.cc
  40. ice_transport_factory.cc
  41. ice_transport_factory.h
  42. ice_transport_interface.h
  43. jsep.cc
  44. jsep.h
  45. jsep_ice_candidate.cc
  46. jsep_ice_candidate.h
  47. jsep_session_description.h
  48. media_stream_interface.cc
  49. media_stream_interface.h
  50. media_stream_proxy.h
  51. media_stream_track_proxy.h
  52. media_types.cc
  53. media_types.h
  54. network_state_predictor.h
  55. notifier.h
  56. OWNERS
  57. packet_socket_factory.h
  58. peer_connection_factory_proxy.h
  59. peer_connection_interface.cc
  60. peer_connection_interface.h
  61. peer_connection_proxy.h
  62. priority.h
  63. proxy.cc
  64. proxy.h
  65. README.md
  66. ref_counted_base.h
  67. rtc_error.cc
  68. rtc_error.h
  69. rtc_error_unittest.cc
  70. rtc_event_log_output.h
  71. rtc_event_log_output_file.cc
  72. rtc_event_log_output_file.h
  73. rtc_event_log_output_file_unittest.cc
  74. rtp_headers.cc
  75. rtp_headers.h
  76. rtp_packet_info.cc
  77. rtp_packet_info.h
  78. rtp_packet_info_unittest.cc
  79. rtp_packet_infos.h
  80. rtp_packet_infos_unittest.cc
  81. rtp_parameters.cc
  82. rtp_parameters.h
  83. rtp_parameters_unittest.cc
  84. rtp_receiver_interface.cc
  85. rtp_receiver_interface.h
  86. rtp_sender_interface.cc
  87. rtp_sender_interface.h
  88. rtp_transceiver_direction.h
  89. rtp_transceiver_interface.cc
  90. rtp_transceiver_interface.h
  91. scoped_refptr.h
  92. scoped_refptr_unittest.cc
  93. sctp_transport_interface.cc
  94. sctp_transport_interface.h
  95. set_local_description_observer_interface.h
  96. set_remote_description_observer_interface.h
  97. stats_types.cc
  98. stats_types.h
  99. turn_customizer.h
  100. uma_metrics.h
  101. video_track_source_proxy.h
api/README.md

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.