7#include "../macros.hpp"
8#include "audio_direction.hpp"
12hi_export_module(hikogui.audio.audio_channel);
14hi_export
namespace hi {
inline namespace v1 {
35 [[nodiscard]] audio_direction
direction() const noexcept;
39 [[nodiscard]]
std::
string id() const noexcept;
43 [[nodiscard]]
std::
string name() const noexcept;
51 [[nodiscard]]
float peak() noexcept;
58 [[nodiscard]]
float rms(
std::
size_t num_samples) noexcept;
The HikoGUI namespace.
Definition array_generic.hpp:20
DOXYGEN BUG.
Definition algorithm_misc.hpp:20
Definition audio_channel.hpp:16
std::string name() const noexcept
The name of the audio channel according to the system.
std::size_t clip_count() noexcept
The number of times the audio clipped since last read.
bool enabled
If the channel is enabled by the user.
Definition audio_channel.hpp:26
audio_direction direction() const noexcept
The direction of audio.
float rms(std::size_t num_samples) noexcept
Get the running-RMS over the given number of samples.
std::size_t index() const noexcept
The index of the audio channel.
float peak() noexcept
The maximum peak sample value since last read.