Use backticks not vertical bars to denote variables in comments for /modules/audio_coding
Bug: webrtc:12338 Change-Id: I02613d9fca45d00e2477f334b7a0416e7912e26b Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/227037 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Commit-Queue: Artem Titov <titovartem@webrtc.org> Cr-Commit-Position: refs/heads/master@{#34621}
This commit is contained in:
committed by
WebRTC LUCI CQ
parent
0146a34b3f
commit
d00ce747c7
@ -80,15 +80,15 @@ class DecoderDatabase {
|
||||
// Returns true if the decoder's format is RED.
|
||||
bool IsRed() const { return subtype_ == Subtype::kRed; }
|
||||
|
||||
// Returns true if the decoder's format is named |name|.
|
||||
// Returns true if the decoder's format is named `name`.
|
||||
bool IsType(const char* name) const;
|
||||
// Returns true if the decoder's format is named |name|.
|
||||
// Returns true if the decoder's format is named `name`.
|
||||
bool IsType(const std::string& name) const;
|
||||
|
||||
const std::string& get_name() const { return name_; }
|
||||
|
||||
private:
|
||||
// TODO(ossu): |name_| is kept here while we retain the old external
|
||||
// TODO(ossu): `name_` is kept here while we retain the old external
|
||||
// decoder interface. Remove this once using an
|
||||
// AudioDecoderFactory has supplanted the old functionality.
|
||||
const std::string name_;
|
||||
@ -143,26 +143,26 @@ class DecoderDatabase {
|
||||
virtual int RegisterPayload(int rtp_payload_type,
|
||||
const SdpAudioFormat& audio_format);
|
||||
|
||||
// Removes the entry for |rtp_payload_type| from the database.
|
||||
// Removes the entry for `rtp_payload_type` from the database.
|
||||
// Returns kDecoderNotFound or kOK depending on the outcome of the operation.
|
||||
virtual int Remove(uint8_t rtp_payload_type);
|
||||
|
||||
// Remove all entries.
|
||||
virtual void RemoveAll();
|
||||
|
||||
// Returns a pointer to the DecoderInfo struct for |rtp_payload_type|. If
|
||||
// no decoder is registered with that |rtp_payload_type|, NULL is returned.
|
||||
// Returns a pointer to the DecoderInfo struct for `rtp_payload_type`. If
|
||||
// no decoder is registered with that `rtp_payload_type`, NULL is returned.
|
||||
virtual const DecoderInfo* GetDecoderInfo(uint8_t rtp_payload_type) const;
|
||||
|
||||
// Sets the active decoder to be |rtp_payload_type|. If this call results in a
|
||||
// change of active decoder, |new_decoder| is set to true. The previous active
|
||||
// Sets the active decoder to be `rtp_payload_type`. If this call results in a
|
||||
// change of active decoder, `new_decoder` is set to true. The previous active
|
||||
// decoder's AudioDecoder object is deleted.
|
||||
virtual int SetActiveDecoder(uint8_t rtp_payload_type, bool* new_decoder);
|
||||
|
||||
// Returns the current active decoder, or NULL if no active decoder exists.
|
||||
virtual AudioDecoder* GetActiveDecoder() const;
|
||||
|
||||
// Sets the active comfort noise decoder to be |rtp_payload_type|. If this
|
||||
// Sets the active comfort noise decoder to be `rtp_payload_type`. If this
|
||||
// call results in a change of active comfort noise decoder, the previous
|
||||
// active decoder's AudioDecoder object is deleted.
|
||||
virtual int SetActiveCngDecoder(uint8_t rtp_payload_type);
|
||||
@ -176,26 +176,26 @@ class DecoderDatabase {
|
||||
// exists.
|
||||
|
||||
// Returns a pointer to the AudioDecoder object associated with
|
||||
// |rtp_payload_type|, or NULL if none is registered. If the AudioDecoder
|
||||
// `rtp_payload_type`, or NULL if none is registered. If the AudioDecoder
|
||||
// object does not exist for that decoder, the object is created.
|
||||
AudioDecoder* GetDecoder(uint8_t rtp_payload_type) const;
|
||||
|
||||
// Returns if |rtp_payload_type| is registered with a format named |name|.
|
||||
// Returns if `rtp_payload_type` is registered with a format named `name`.
|
||||
bool IsType(uint8_t rtp_payload_type, const char* name) const;
|
||||
|
||||
// Returns if |rtp_payload_type| is registered with a format named |name|.
|
||||
// Returns if `rtp_payload_type` is registered with a format named `name`.
|
||||
bool IsType(uint8_t rtp_payload_type, const std::string& name) const;
|
||||
|
||||
// Returns true if |rtp_payload_type| is registered as comfort noise.
|
||||
// Returns true if `rtp_payload_type` is registered as comfort noise.
|
||||
bool IsComfortNoise(uint8_t rtp_payload_type) const;
|
||||
|
||||
// Returns true if |rtp_payload_type| is registered as DTMF.
|
||||
// Returns true if `rtp_payload_type` is registered as DTMF.
|
||||
bool IsDtmf(uint8_t rtp_payload_type) const;
|
||||
|
||||
// Returns true if |rtp_payload_type| is registered as RED.
|
||||
// Returns true if `rtp_payload_type` is registered as RED.
|
||||
bool IsRed(uint8_t rtp_payload_type) const;
|
||||
|
||||
// Returns kOK if all packets in |packet_list| carry payload types that are
|
||||
// Returns kOK if all packets in `packet_list` carry payload types that are
|
||||
// registered in the database. Otherwise, returns kDecoderNotFound.
|
||||
int CheckPayloadTypes(const PacketList& packet_list) const;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user