cubeb: cubeb_stream_params Struct Reference

cubeb 0.0.0

Loading...
Searching...
No Matches
cubeb_stream_params Struct Reference

Stream format initialization parameters. More...

`#include <cubeb.h>`

## Data Fields
cubeb_sample_format | format
| Requested sample format.
uint32_t | rate
| Requested sample rate.
uint32_t | channels
| Requested channel count.
cubeb_channel_layout | layout
| Requested channel layout.
cubeb_stream_prefs | prefs
| Requested preferences.
cubeb_input_processing_params | input_params
| Requested input processing params.

## Detailed Description

Stream format initialization parameters.

## Field Documentation

## ◆ format

cubeb_sample_format cubeb_stream_params::format

Requested sample format.

One of cubeb_sample_format.

## ◆ rate

uint32_t cubeb_stream_params::rate

Requested sample rate.

Valid range is [1000, 384000].

## ◆ channels

uint32_t cubeb_stream_params::channels

Requested channel count.

Valid range is [1, 8].

## ◆ layout

cubeb_channel_layout cubeb_stream_params::layout

Requested channel layout.

This must be consistent with the provided channels. CUBEB_LAYOUT_UNDEFINED if unknown

## ◆ input_params

cubeb_input_processing_params cubeb_stream_params::input_params

Requested input processing params.

Ignored for output streams. At present, only supported on the WASAPI backend; others should use cubeb_set_input_processing_params.

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

- /build/cubeb-git/src/cubeb/include/cubeb/cubeb.h