webrtc_m130/api/voip/voip_statistics.h
Tim Na b223cb60e9 Defining API result types on VoIP API
Bug: webrtc:12193
Change-Id: I6f5ffd82cc838e6982257781f225f9d8159e6b82
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/193720
Commit-Queue: Tim Na <natim@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#32656}
2020-11-20 18:02:05 +00:00

47 lines
1.5 KiB
C++

/*
* Copyright (c) 2020 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef API_VOIP_VOIP_STATISTICS_H_
#define API_VOIP_VOIP_STATISTICS_H_
#include "api/neteq/neteq.h"
#include "api/voip/voip_base.h"
namespace webrtc {
struct IngressStatistics {
// Stats included from api/neteq/neteq.h.
NetEqLifetimeStatistics neteq_stats;
// Represents the total duration in seconds of all samples that have been
// received.
// https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-totalsamplesduration
double total_duration = 0.0;
};
// VoipStatistics interface provides the interfaces for querying metrics around
// the jitter buffer (NetEq) performance.
class VoipStatistics {
public:
// Gets the audio ingress statistics by |ingress_stats| reference.
// Returns following VoipResult;
// kOk - successfully set provided IngressStatistics reference.
// kInvalidArgument - |channel_id| is invalid.
virtual VoipResult GetIngressStatistics(ChannelId channel_id,
IngressStatistics& ingress_stats) = 0;
protected:
virtual ~VoipStatistics() = default;
};
} // namespace webrtc
#endif // API_VOIP_VOIP_STATISTICS_H_