test/pc/e2e/metric_metadata_keys.h

/*
 *  Copyright (c) 2022 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 TEST_PC_E2E_METRIC_METADATA_KEYS_H_
#define TEST_PC_E2E_METRIC_METADATA_KEYS_H_

#include <string>

namespace webrtc {
namespace webrtc_pc_e2e {

// All metadata fields are present only if applicable for particular metric.
class MetricMetadataKey {
 public:
  // Represents on peer with whom the metric is associated.
  static constexpr char kPeerMetadataKey[] = "peer";
  // Represents sender of the media stream.
  static constexpr char kSenderMetadataKey[] = "sender";
  // Represents receiver of the media stream.
  static constexpr char kReceiverMetadataKey[] = "receiver";
  // Represents name of the audio stream.
  static constexpr char kAudioStreamMetadataKey[] = "audio_stream";
  // Represents name of the video stream.
  static constexpr char kVideoStreamMetadataKey[] = "video_stream";
  // Represents name of the sync group to which stream belongs.
  static constexpr char kPeerSyncGroupMetadataKey[] = "peer_sync_group";
  // Represents the test name (without any peer and stream data appended to it
  // as it currently happens with the webrtc.test_metrics.Metric.test_case
  // field). This metadata is temporary and it will be removed once this
  // information is moved to webrtc.test_metrics.Metric.test_case.
  // TODO(bugs.webrtc.org/14757): Remove kExperimentalTestNameMetadataKey.
  static constexpr char kExperimentalTestNameMetadataKey[] =
      "experimental_test_name";
  // Represents index of a video spatial layer to which metric belongs.
  static constexpr char kSpatialLayerMetadataKey[] = "spatial_layer";

 private:
  MetricMetadataKey() = default;
};

// All metadata fields are presented only if applicable for particular metric.
class SampleMetadataKey {
 public:
  // Represents a frame ID with which data point is associated.
  static constexpr char kFrameIdMetadataKey[] = "frame_id";

 private:
  SampleMetadataKey() = default;
};

}  // namespace webrtc_pc_e2e
}  // namespace webrtc

#endif  // TEST_PC_E2E_METRIC_METADATA_KEYS_H_