Use backticks not vertical bars to denote variables in comments for /api
Bug: webrtc:12338 Change-Id: Ib97b2c3d64dbd895f261ffa76a2e885bd934a87f Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/226940 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Commit-Queue: Artem Titov <titovartem@webrtc.org> Cr-Commit-Position: refs/heads/master@{#34554}
This commit is contained in:
committed by
WebRTC LUCI CQ
parent
7750d802a5
commit
0e61fdd27c
@ -72,9 +72,9 @@ class VideoQualityAnalyzerInterface : public StatsObserverInterface {
|
||||
~VideoQualityAnalyzerInterface() override = default;
|
||||
|
||||
// Will be called by framework before test.
|
||||
// |test_case_name| is name of test case, that should be used to report all
|
||||
// `test_case_name` is name of test case, that should be used to report all
|
||||
// video metrics.
|
||||
// |threads_count| is number of threads that analyzer can use for heavy
|
||||
// `threads_count` is number of threads that analyzer can use for heavy
|
||||
// calculations. Analyzer can perform simple calculations on the calling
|
||||
// thread in each method, but should remember, that it is the same thread,
|
||||
// that is used in video pipeline.
|
||||
@ -83,57 +83,57 @@ class VideoQualityAnalyzerInterface : public StatsObserverInterface {
|
||||
int max_threads_count) {}
|
||||
|
||||
// Will be called when frame was generated from the input stream.
|
||||
// |peer_name| is name of the peer on which side frame was captured.
|
||||
// `peer_name` is name of the peer on which side frame was captured.
|
||||
// Returns frame id, that will be set by framework to the frame.
|
||||
virtual uint16_t OnFrameCaptured(absl::string_view peer_name,
|
||||
const std::string& stream_label,
|
||||
const VideoFrame& frame) = 0;
|
||||
// Will be called before calling the encoder.
|
||||
// |peer_name| is name of the peer on which side frame came to encoder.
|
||||
// `peer_name` is name of the peer on which side frame came to encoder.
|
||||
virtual void OnFramePreEncode(absl::string_view peer_name,
|
||||
const VideoFrame& frame) {}
|
||||
// Will be called for each EncodedImage received from encoder. Single
|
||||
// VideoFrame can produce multiple EncodedImages. Each encoded image will
|
||||
// have id from VideoFrame.
|
||||
// |peer_name| is name of the peer on which side frame was encoded.
|
||||
// `peer_name` is name of the peer on which side frame was encoded.
|
||||
virtual void OnFrameEncoded(absl::string_view peer_name,
|
||||
uint16_t frame_id,
|
||||
const EncodedImage& encoded_image,
|
||||
const EncoderStats& stats) {}
|
||||
// Will be called for each frame dropped by encoder.
|
||||
// |peer_name| is name of the peer on which side frame drop was detected.
|
||||
// `peer_name` is name of the peer on which side frame drop was detected.
|
||||
virtual void OnFrameDropped(absl::string_view peer_name,
|
||||
EncodedImageCallback::DropReason reason) {}
|
||||
// Will be called before calling the decoder.
|
||||
// |peer_name| is name of the peer on which side frame was received.
|
||||
// `peer_name` is name of the peer on which side frame was received.
|
||||
virtual void OnFramePreDecode(absl::string_view peer_name,
|
||||
uint16_t frame_id,
|
||||
const EncodedImage& encoded_image) {}
|
||||
// Will be called after decoding the frame.
|
||||
// |peer_name| is name of the peer on which side frame was decoded.
|
||||
// `peer_name` is name of the peer on which side frame was decoded.
|
||||
virtual void OnFrameDecoded(absl::string_view peer_name,
|
||||
const VideoFrame& frame,
|
||||
const DecoderStats& stats) {}
|
||||
// Will be called when frame will be obtained from PeerConnection stack.
|
||||
// |peer_name| is name of the peer on which side frame was rendered.
|
||||
// `peer_name` is name of the peer on which side frame was rendered.
|
||||
virtual void OnFrameRendered(absl::string_view peer_name,
|
||||
const VideoFrame& frame) {}
|
||||
// Will be called if encoder return not WEBRTC_VIDEO_CODEC_OK.
|
||||
// All available codes are listed in
|
||||
// modules/video_coding/include/video_error_codes.h
|
||||
// |peer_name| is name of the peer on which side error acquired.
|
||||
// `peer_name` is name of the peer on which side error acquired.
|
||||
virtual void OnEncoderError(absl::string_view peer_name,
|
||||
const VideoFrame& frame,
|
||||
int32_t error_code) {}
|
||||
// Will be called if decoder return not WEBRTC_VIDEO_CODEC_OK.
|
||||
// All available codes are listed in
|
||||
// modules/video_coding/include/video_error_codes.h
|
||||
// |peer_name| is name of the peer on which side error acquired.
|
||||
// `peer_name` is name of the peer on which side error acquired.
|
||||
virtual void OnDecoderError(absl::string_view peer_name,
|
||||
uint16_t frame_id,
|
||||
int32_t error_code) {}
|
||||
// Will be called every time new stats reports are available for the
|
||||
// Peer Connection identified by |pc_label|.
|
||||
// Peer Connection identified by `pc_label`.
|
||||
void OnStatsReports(
|
||||
absl::string_view pc_label,
|
||||
const rtc::scoped_refptr<const RTCStatsReport>& report) override {}
|
||||
|
||||
Reference in New Issue
Block a user