mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-12 21:30:45 +01:00
0e61fdd27c
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}
64 lines
2.4 KiB
C++
64 lines
2.4 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_VOLUME_CONTROL_H_
|
|
#define API_VOIP_VOIP_VOLUME_CONTROL_H_
|
|
|
|
#include "api/voip/voip_base.h"
|
|
|
|
namespace webrtc {
|
|
|
|
struct VolumeInfo {
|
|
// https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats-audiolevel
|
|
double audio_level = 0;
|
|
// https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats-totalaudioenergy
|
|
double total_energy = 0.0;
|
|
// https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats-totalsamplesduration
|
|
double total_duration = 0.0;
|
|
};
|
|
|
|
// VoipVolumeControl interface.
|
|
//
|
|
// This sub-API supports functions related to the input (microphone) and output
|
|
// (speaker) device.
|
|
//
|
|
// Caller must ensure that ChannelId is valid otherwise it will result in no-op
|
|
// with error logging.
|
|
class VoipVolumeControl {
|
|
public:
|
|
// Mute/unmutes the microphone input sample before encoding process. Note that
|
|
// mute doesn't affect audio input level and energy values as input sample is
|
|
// silenced after the measurement.
|
|
// Returns following VoipResult;
|
|
// kOk - input source muted or unmuted as provided by `enable`.
|
|
// kInvalidArgument - `channel_id` is invalid.
|
|
virtual VoipResult SetInputMuted(ChannelId channel_id, bool enable) = 0;
|
|
|
|
// Gets the microphone volume info via `volume_info` reference.
|
|
// Returns following VoipResult;
|
|
// kOk - successfully set provided input volume info.
|
|
// kInvalidArgument - `channel_id` is invalid.
|
|
virtual VoipResult GetInputVolumeInfo(ChannelId channel_id,
|
|
VolumeInfo& volume_info) = 0;
|
|
|
|
// Gets the speaker volume info via `volume_info` reference.
|
|
// Returns following VoipResult;
|
|
// kOk - successfully set provided output volume info.
|
|
// kInvalidArgument - `channel_id` is invalid.
|
|
virtual VoipResult GetOutputVolumeInfo(ChannelId channel_id,
|
|
VolumeInfo& volume_info) = 0;
|
|
|
|
protected:
|
|
virtual ~VoipVolumeControl() = default;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // API_VOIP_VOIP_VOLUME_CONTROL_H_
|