ra8_audio_frame_t Struct Reference

Immutable view of one interleaved PCM frame. More...

#include <ra8_audio.h>

Data Fields
const void *	data
	Borrowed interleaved PCM bytes.
uint32_t	bytes
	Valid byte count.
uint32_t	sample_count
	Sample frames per channel.
uint32_t	sample_rate_hz
	Sample frames per second.
uint32_t	timestamp_ms
	Capture-start monotonic milliseconds.
uint8_t	channels
	Interleaved channel count.
uint8_t	valid_bits
	Significant bits per sample.
ra8_audio_format_t	format
	PCM container layout.

Detailed Description

Immutable view of one interleaved PCM frame.

Invariant

bytes == sample_count * channels * container_bytes.

valid_bits does not exceed the selected container width.

Since

0.1.0

Definition at line 56 of file ra8_audio.h.

Field Documentation

bytes

uint32_t ra8_audio_frame_t::bytes

Valid byte count.

Definition at line 58 of file ra8_audio.h.

Referenced by internal_audio_frame_matches_info(), internal_memory_capture(), internal_memory_get_info(), and ra8_audio_frame_validate().

channels

uint8_t ra8_audio_frame_t::channels

Interleaved channel count.

Definition at line 62 of file ra8_audio.h.

Referenced by internal_audio_frame_matches_info(), internal_memory_get_info(), and ra8_audio_frame_validate().

data

const void* ra8_audio_frame_t::data

Borrowed interleaved PCM bytes.

Definition at line 57 of file ra8_audio.h.

Referenced by internal_c6_cam_audio_on_frame(), internal_memory_capture(), ra8_audio_frame_validate(), and ra8_audio_source_capture().

format

ra8_audio_format_t ra8_audio_frame_t::format

PCM container layout.

Definition at line 64 of file ra8_audio.h.

Referenced by internal_audio_frame_matches_info(), internal_c6_cam_audio_on_frame(), internal_memory_get_info(), and ra8_audio_frame_validate().

sample_count

uint32_t ra8_audio_frame_t::sample_count

Sample frames per channel.

Definition at line 59 of file ra8_audio.h.

Referenced by internal_audio_frame_matches_info(), internal_c6_cam_audio_on_frame(), internal_memory_get_info(), pdm_demo_run_window(), and ra8_audio_frame_validate().

sample_rate_hz

uint32_t ra8_audio_frame_t::sample_rate_hz

Sample frames per second.

Definition at line 60 of file ra8_audio.h.

Referenced by internal_audio_frame_matches_info(), internal_memory_get_info(), and ra8_audio_frame_validate().

timestamp_ms

uint32_t ra8_audio_frame_t::timestamp_ms

Capture-start monotonic milliseconds.

Definition at line 61 of file ra8_audio.h.

Referenced by internal_c6_cam_audio_on_frame(), and pdm_demo_run_window().

valid_bits

uint8_t ra8_audio_frame_t::valid_bits

Significant bits per sample.

Definition at line 63 of file ra8_audio.h.

Referenced by internal_audio_frame_matches_info(), internal_memory_get_info(), and ra8_audio_frame_validate().

---

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

• libs/ra8_audio/inc/ra8_audio.h