7#include "../macros.hpp"
8#include "audio_direction.hpp"
10hi_export_module(hikogui.audio.audio_channel);
12namespace hi {
inline namespace v1 {
33 [[nodiscard]] audio_direction
direction() const noexcept;
37 [[nodiscard]]
std::
string id() const noexcept;
41 [[nodiscard]]
std::
string name() const noexcept;
49 [[nodiscard]]
float peak() noexcept;
56 [[nodiscard]]
float rms(
std::
size_t num_samples) noexcept;
geometry/margins.hpp
Definition lookahead_iterator.hpp:5
The HikoGUI API version 1.
Definition lookahead_iterator.hpp:6
Definition audio_channel.hpp:14
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:24
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.