Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::audio::PcmTraits Struct Reference

PCM format meta-information. More...

#include <pcm_format.h>

Public Attributes

bool is_valid
 If traits are valid. More...
 
bool is_integer
 True for integers, false for floating point. More...
 
bool is_signed
 True for signed integers and floating point. More...
 
bool is_little
 True for little-endian formats. More...
 
PcmFormat canon_id
 Canonical identifier of the same format. More...
 
size_t bit_depth
 Number of significant bits per sample. More...
 
size_t bit_width
 Number of stored bits per sample in packed form. More...
 

Detailed Description

PCM format meta-information.

Definition at line 201 of file pcm_format.h.

Member Data Documentation

◆ bit_depth

size_t roc::audio::PcmTraits::bit_depth

Number of significant bits per sample.

Definition at line 218 of file pcm_format.h.

◆ bit_width

size_t roc::audio::PcmTraits::bit_width

Number of stored bits per sample in packed form.

Definition at line 221 of file pcm_format.h.

◆ canon_id

PcmFormat roc::audio::PcmTraits::canon_id

Canonical identifier of the same format.

Definition at line 215 of file pcm_format.h.

◆ is_integer

bool roc::audio::PcmTraits::is_integer

True for integers, false for floating point.

Definition at line 206 of file pcm_format.h.

◆ is_little

bool roc::audio::PcmTraits::is_little

True for little-endian formats.

Definition at line 212 of file pcm_format.h.

◆ is_signed

bool roc::audio::PcmTraits::is_signed

True for signed integers and floating point.

Definition at line 209 of file pcm_format.h.

◆ is_valid

bool roc::audio::PcmTraits::is_valid

If traits are valid.

Definition at line 203 of file pcm_format.h.


The documentation for this struct was generated from the following file: