Audio codecs API: Remove some weasel words in the docs
These things are no longer brand new, so it makes even less sense than it once did to warn users that they may change at any time. Bug: none Change-Id: I43a6915d9e00fbfef30fdb89869873b129297c8d No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/106980 Reviewed-by: Fredrik Solenberg <solenberg@webrtc.org> Commit-Queue: Karl Wiberg <kwiberg@webrtc.org> Cr-Commit-Position: refs/heads/master@{#25283}
This commit is contained in:
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// L16 decoder API for use as a template parameter to
|
||||
// CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioDecoderL16 {
|
||||
struct Config {
|
||||
bool IsOk() const {
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// L16 encoder API for use as a template parameter to
|
||||
// CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioEncoderL16 {
|
||||
struct Config {
|
||||
bool IsOk() const {
|
||||
|
@ -23,7 +23,6 @@
|
||||
namespace webrtc {
|
||||
|
||||
// A factory that creates AudioDecoders.
|
||||
// NOTE: This class is still under development and may change without notice.
|
||||
class AudioDecoderFactory : public rtc::RefCountInterface {
|
||||
public:
|
||||
virtual std::vector<AudioCodecSpec> GetSupportedDecoders() = 0;
|
||||
|
@ -112,8 +112,6 @@ class AudioDecoderFactoryT : public AudioDecoderFactory {
|
||||
// decoder types in the order they were specified in the template argument
|
||||
// list, stopping at the first one that claims to be able to do the job.
|
||||
//
|
||||
// NOTE: This function is still under development and may change without notice.
|
||||
//
|
||||
// TODO(kwiberg): Point at CreateBuiltinAudioDecoderFactory() for an example of
|
||||
// how it is used.
|
||||
template <typename... Ts>
|
||||
|
@ -23,7 +23,6 @@
|
||||
namespace webrtc {
|
||||
|
||||
// A factory that creates AudioEncoders.
|
||||
// NOTE: This class is still under development and may change without notice.
|
||||
class AudioEncoderFactory : public rtc::RefCountInterface {
|
||||
public:
|
||||
// Returns a prioritized list of audio codecs, to use for signaling etc.
|
||||
|
@ -131,8 +131,6 @@ class AudioEncoderFactoryT : public AudioEncoderFactory {
|
||||
// encoders in the order they were specified in the template argument list,
|
||||
// stopping at the first one that claims to be able to do the job.
|
||||
//
|
||||
// NOTE: This function is still under development and may change without notice.
|
||||
//
|
||||
// TODO(kwiberg): Point at CreateBuiltinAudioEncoderFactory() for an example of
|
||||
// how it is used.
|
||||
template <typename... Ts>
|
||||
|
@ -20,7 +20,6 @@
|
||||
namespace webrtc {
|
||||
|
||||
// SDP specification for a single audio codec.
|
||||
// NOTE: This class is still under development and may change without notice.
|
||||
struct SdpAudioFormat {
|
||||
using Parameters = std::map<std::string, std::string>;
|
||||
|
||||
|
@ -17,7 +17,6 @@
|
||||
namespace webrtc {
|
||||
|
||||
// Creates a new factory that can create the built-in types of audio decoders.
|
||||
// NOTE: This function is still under development and may change without notice.
|
||||
rtc::scoped_refptr<AudioDecoderFactory> CreateBuiltinAudioDecoderFactory();
|
||||
|
||||
} // namespace webrtc
|
||||
|
@ -17,7 +17,6 @@
|
||||
namespace webrtc {
|
||||
|
||||
// Creates a new factory that can create the built-in types of audio encoders.
|
||||
// NOTE: This function is still under development and may change without notice.
|
||||
rtc::scoped_refptr<AudioEncoderFactory> CreateBuiltinAudioEncoderFactory();
|
||||
|
||||
} // namespace webrtc
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// G711 decoder API for use as a template parameter to
|
||||
// CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioDecoderG711 {
|
||||
struct Config {
|
||||
enum class Type { kPcmU, kPcmA };
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// G711 encoder API for use as a template parameter to
|
||||
// CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioEncoderG711 {
|
||||
struct Config {
|
||||
enum class Type { kPcmU, kPcmA };
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// G722 decoder API for use as a template parameter to
|
||||
// CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioDecoderG722 {
|
||||
struct Config {
|
||||
bool IsOk() const { return num_channels == 1 || num_channels == 2; }
|
||||
|
@ -25,8 +25,6 @@ namespace webrtc {
|
||||
|
||||
// G722 encoder API for use as a template parameter to
|
||||
// CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioEncoderG722 {
|
||||
using Config = AudioEncoderG722Config;
|
||||
static absl::optional<AudioEncoderG722Config> SdpToConfig(
|
||||
|
@ -13,7 +13,6 @@
|
||||
|
||||
namespace webrtc {
|
||||
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct AudioEncoderG722Config {
|
||||
bool IsOk() const {
|
||||
return frame_size_ms > 0 && frame_size_ms % 10 == 0 && num_channels >= 1;
|
||||
|
@ -23,8 +23,6 @@ namespace webrtc {
|
||||
|
||||
// ILBC decoder API for use as a template parameter to
|
||||
// CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct AudioDecoderIlbc {
|
||||
struct Config {}; // Empty---no config values needed!
|
||||
static absl::optional<Config> SdpToConfig(const SdpAudioFormat& audio_format);
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// ILBC encoder API for use as a template parameter to
|
||||
// CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct AudioEncoderIlbc {
|
||||
using Config = AudioEncoderIlbcConfig;
|
||||
static absl::optional<AudioEncoderIlbcConfig> SdpToConfig(
|
||||
|
@ -13,7 +13,6 @@
|
||||
|
||||
namespace webrtc {
|
||||
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct AudioEncoderIlbcConfig {
|
||||
bool IsOk() const {
|
||||
return (frame_size_ms == 20 || frame_size_ms == 30 || frame_size_ms == 40 ||
|
||||
|
@ -23,8 +23,6 @@ namespace webrtc {
|
||||
|
||||
// iSAC decoder API (fixed-point implementation) for use as a template
|
||||
// parameter to CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct AudioDecoderIsacFix {
|
||||
struct Config {}; // Empty---no config values needed!
|
||||
static absl::optional<Config> SdpToConfig(const SdpAudioFormat& audio_format);
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// iSAC decoder API (floating-point implementation) for use as a template
|
||||
// parameter to CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioDecoderIsacFloat {
|
||||
struct Config {
|
||||
bool IsOk() const {
|
||||
|
@ -23,8 +23,6 @@ namespace webrtc {
|
||||
|
||||
// iSAC encoder API (fixed-point implementation) for use as a template
|
||||
// parameter to CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct AudioEncoderIsacFix {
|
||||
struct Config {
|
||||
bool IsOk() const { return frame_size_ms == 30 || frame_size_ms == 60; }
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// iSAC encoder API (floating-point implementation) for use as a template
|
||||
// parameter to CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioEncoderIsacFloat {
|
||||
struct Config {
|
||||
bool IsOk() const {
|
||||
|
@ -24,8 +24,6 @@ namespace webrtc {
|
||||
|
||||
// Opus decoder API for use as a template parameter to
|
||||
// CreateAudioDecoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioDecoderOpus {
|
||||
struct Config {
|
||||
int num_channels;
|
||||
|
@ -25,8 +25,6 @@ namespace webrtc {
|
||||
|
||||
// Opus encoder API for use as a template parameter to
|
||||
// CreateAudioEncoderFactory<...>().
|
||||
//
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioEncoderOpus {
|
||||
using Config = AudioEncoderOpusConfig;
|
||||
static absl::optional<AudioEncoderOpusConfig> SdpToConfig(
|
||||
|
@ -20,7 +20,6 @@
|
||||
|
||||
namespace webrtc {
|
||||
|
||||
// NOTE: This struct is still under development and may change without notice.
|
||||
struct RTC_EXPORT AudioEncoderOpusConfig {
|
||||
static constexpr int kDefaultFrameSizeMs = 20;
|
||||
|
||||
|
Reference in New Issue
Block a user