HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
audio_channel.hpp
1// Copyright Take Vos 2021.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
4
5#pragma once
6
7#include "audio_direction.hpp"
8
9namespace tt {
10
12public:
21 bool enabled;
22
26 [[nodiscard]] size_t index() const noexcept;
27
30 [[nodiscard]] audio_direction direction() const noexcept;
31
34 [[nodiscard]] std::string id() const noexcept;
35
38 [[nodiscard]] std::string name() const noexcept;
39
42 [[nodiscard]] size_t clip_count() noexcept;
43
46 [[nodiscard]] float peak() noexcept;
47
53 [[nodiscard]] float rms(size_t num_samples) noexcept;
54
55};
56
57}
58
STL namespace.
Definition audio_channel.hpp:11
size_t clip_count() noexcept
The number of times the audio clipped since last read.
std::string name() const noexcept
The name of the audio channel according to the system.
bool enabled
If the channel is enabled by the user.
Definition audio_channel.hpp:21
float rms(size_t num_samples) noexcept
Get the running-RMS over the given number of samples.
float peak() noexcept
The maximum peak sample value since last read.
audio_direction direction() const noexcept
The direction of audio.
size_t index() const noexcept
The index of the audio channel.