hikogui/0.8.1/a00629_source.html

// Copyright Take Vos 2021.

// Distributed under the Boost Software License, Version 1.0.

// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)


#pragma once


#include "../macros.hpp"

#include "audio_direction.hpp"


hi_export_module(hikogui.audio.audio_channel);


namespace hi { inline namespace v1 {


hi_export class audio_channel {

public:

    bool enabled;


    [[nodiscard]] std::size_t index() const noexcept;


    [[nodiscard]] audio_direction direction() const noexcept;


    [[nodiscard]] std::string id() const noexcept;


    [[nodiscard]] std::string name() const noexcept;


    [[nodiscard]] std::size_t clip_count() noexcept;


    [[nodiscard]] float peak() noexcept;


    [[nodiscard]] float rms(std::size_t num_samples) noexcept;

};


}} // namespace hi::inline v1

std
STL namespace.

v1
DOXYGEN BUG.
Definition algorithm.hpp:16

hi
geometry/margins.hpp
Definition lookahead_iterator.hpp:5

hi::v1::narrow_cast
constexpr Out narrow_cast(In const &rhs) noexcept
Cast numeric values without loss of precision.
Definition cast.hpp:377

hi::audio_channel
Definition audio_channel.hpp:14

hi::v1::audio_channel::name
std::string name() const noexcept
The name of the audio channel according to the system.

hi::v1::audio_channel::clip_count
std::size_t clip_count() noexcept
The number of times the audio clipped since last read.

hi::v1::audio_channel::enabled
bool enabled
If the channel is enabled by the user.
Definition audio_channel.hpp:24

hi::v1::audio_channel::direction
audio_direction direction() const noexcept
The direction of audio.

hi::v1::audio_channel::rms
float rms(std::size_t num_samples) noexcept
Get the running-RMS over the given number of samples.

hi::v1::audio_channel::index
std::size_t index() const noexcept
The index of the audio channel.

hi::v1::audio_channel::peak
float peak() noexcept
The maximum peak sample value since last read.

std::size_t