zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve the audio codec factory documentation.

Browse Source 
Bug: none
Change-Id: Iefddb49d515bde0c8c5b7fb0d5c8dc79399b03a0
Reviewed-on: https://webrtc-review.googlesource.com/c/113802
Reviewed-by: Niels Moller <nisse@webrtc.org>
Commit-Queue: Karl Wiberg <kwiberg@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#25969}
This commit is contained in:
Karl Wiberg
2018-12-10 11:50:55 +01:00
committed by Commit Bot
parent 5d4740170a
commit ad858d1231
2 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
api/audio_codecs/audio_decoder_factory.h
View File

@ -29,11 +29,14 @@ class AudioDecoderFactory : public rtc::RefCountInterface {
virtual bool IsSupportedDecoder(const SdpAudioFormat& format) = 0; virtual bool IsSupportedDecoder(const SdpAudioFormat& format) = 0;
// Create a new decoder instance. The `codec_pair_id` argument is used to // Create a new decoder instance. The `codec_pair_id` argument is used to link
// link encoders and decoders that talk to the same remote entity; if a // encoders and decoders that talk to the same remote entity: if a
// MakeAudioEncoder() and a MakeAudioDecoder() call receive non-null IDs that // AudioEncoderFactory::MakeAudioEncoder() and a
// AudioDecoderFactory::MakeAudioDecoder() call receive non-null IDs that
// compare equal, the factory implementations may assume that the encoder and // compare equal, the factory implementations may assume that the encoder and
// decoder form a pair. // decoder form a pair. (The intended use case for this is to set up
// communication between the AudioEncoder and AudioDecoder instances, which is
// needed for some codecs with built-in bandwidth adaptation.)
// //
// Note: Implementations need to be robust against combinations other than // Note: Implementations need to be robust against combinations other than
// one encoder, one decoder getting the same ID; such decoders must still // one encoder, one decoder getting the same ID; such decoders must still

15
api/audio_codecs/audio_encoder_factory.h
View File

@ -34,12 +34,15 @@ class AudioEncoderFactory : public rtc::RefCountInterface {
virtual absl::optional<AudioCodecInfo> QueryAudioEncoder( virtual absl::optional<AudioCodecInfo> QueryAudioEncoder(
const SdpAudioFormat& format) = 0; const SdpAudioFormat& format) = 0;
// Creates an AudioEncoder for the specified format. The encoder will tags // Creates an AudioEncoder for the specified format. The encoder will tags its
// its payloads with the specified payload type. The `codec_pair_id` argument // payloads with the specified payload type. The `codec_pair_id` argument is
// is used to link encoders and decoders that talk to the same remote entity; // used to link encoders and decoders that talk to the same remote entity: if
// if a MakeAudioEncoder() and a MakeAudioDecoder() call receive non-null IDs // a AudioEncoderFactory::MakeAudioEncoder() and a
// that compare equal, the factory implementations may assume that the // AudioDecoderFactory::MakeAudioDecoder() call receive non-null IDs that
// encoder and decoder form a pair. // compare equal, the factory implementations may assume that the encoder and
// decoder form a pair. (The intended use case for this is to set up
// communication between the AudioEncoder and AudioDecoder instances, which is
// needed for some codecs with built-in bandwidth adaptation.)
// //
// Note: Implementations need to be robust against combinations other than // Note: Implementations need to be robust against combinations other than
// one encoder, one decoder getting the same ID; such encoders must still // one encoder, one decoder getting the same ID; such encoders must still