Struct audiofile_format¶

`struct` audiofile_format audio ¶

struct audiofile_format { … }

Represents the format of an audio file.

`variable` container ¶

audiofile_container container   = audiofile_container::unknown

Container format.

Fully qualified name: kfr::audiofile_format::container

Declared at audio/data.hpp:359

`variable` codec ¶

audiofile_codec codec           = audiofile_codec::unknown

Audio codec.

Fully qualified name: kfr::audiofile_format::codec

Declared at audio/data.hpp:360

`variable` endianness ¶

audiofile_endianness endianness = audiofile_endianness::little

Endianness of the audio data.

Fully qualified name: kfr::audiofile_format::endianness

Declared at audio/data.hpp:361

`variable` bit_depth ¶

uint8_t bit_depth               = 0

Bits per sample.

Fully qualified name: kfr::audiofile_format::bit_depth

Declared at audio/data.hpp:362

`variable` channels ¶

uint32_t channels            = 0

Number of channels.

Fully qualified name: kfr::audiofile_format::channels

Declared at audio/data.hpp:364

`variable` sample_rate ¶

uint32_t sample_rate         = 0

Sample rate in Hz.

Fully qualified name: kfr::audiofile_format::sample_rate

Declared at audio/data.hpp:365

`variable` speakers ¶

speaker_arrangement speakers = speaker_arrangement::None

Speaker arrangement.

Fully qualified name: kfr::audiofile_format::speakers

Declared at audio/data.hpp:366

`variable` total_frames ¶

uint64_t total_frames = 0

Fully qualified name: kfr::audiofile_format::total_frames

Declared at audio/data.hpp:368

`variable` metadata ¶

metadata_map metadata

Key-value metadata pairs.

Fully qualified name: kfr::audiofile_format::metadata

Declared at audio/data.hpp:369

`function` bytes_per_pcm_frame() ¶

size_t bytes_per_pcm_frame() const noexcept

Fully qualified name: kfr::audiofile_format::bytes_per_pcm_frame()

Declared at audio/data.hpp:371

`function` valid() ¶

bool valid() const noexcept

Fully qualified name: kfr::audiofile_format::valid()

Declared at audio/data.hpp:373

`function` sample_type() ¶

audio_sample_type sample_type() const

Fully qualified name: kfr::audiofile_format::sample_type()

Declared at audio/data.hpp:375

`function` sample_type_lpcm() ¶

audio_sample_type sample_type_lpcm() const

Fully qualified name: kfr::audiofile_format::sample_type_lpcm()

Declared at audio/data.hpp:376

`function` operator==(const audiofile_format &) ¶

bool operator==(const audiofile_format& other) const noexcept = default

Fully qualified name: kfr::audiofile_format::operator==(const audiofile_format &)

Declared at audio/data.hpp:378

Fully qualified name: kfr::audiofile_format

Declared at audio/data.hpp:357

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.

Struct audiofile_format¶