API header files

As a user of the WebRTC library, you may use headers and build files in the following directories:

API directoryIncluding subdirectories?
apiYes

For now, you may also use headers and build files in the following legacy API directories—but see the disclaimer below.

Legacy API directoryIncluding subdirectories?
common_audio/includeNo
media/baseNo
media/engineNo
modules/audio_coding/includeNo
modules/audio_device/includeNo
modules/audio_processing/includeNo
modules/bitrate_controller/includeNo
modules/congestion_controller/includeNo
modules/includeNo
modules/remote_bitrate_estimator/includeNo
modules/rtp_rtcp/includeNo
modules/rtp_rtcp/sourceNo
modules/utility/includeNo
modules/video_coding/codecs/h264/includeNo
modules/video_coding/codecs/i420/includeNo
modules/video_coding/codecs/vp8/includeNo
modules/video_coding/codecs/vp9/includeNo
modules/video_coding/includeNo
pcNo
rtc_baseNo
system_wrappers/includeNo

While the files, types, functions, macros, build targets, etc. in the API and legacy API directories will sometimes undergo incompatible changes, such changes will be announced in advance to discuss-webrtc@googlegroups.com, and a migration path will be provided.

In the directories not listed in the tables above, incompatible changes may happen at any time, and are not announced.

The legacy API directories contain some things you shouldn’t use

The legacy API directories, in addition to things that genuinely should be part of the API, also contain things that should not be part of the API. We are in the process of moving the good stuff to the api directory tree, and will remove directories from the legacy list once they no longer contain anything that should be in the API.

In other words, if you find things in the legacy API directories that don’t seem like they belong in the WebRTC native API, don’t grow too attached to them.

All these worlds are yours—except Europa

In the API headers, or in files included by the API headers, there are types, functions, namespaces, etc. that have impl or internal in their names (in various styles, such as CamelCaseImpl, snake_case_impl). They are not part of the API, and may change incompatibly at any time; do not use them.