libtinyalsa-mixer(3)

📦 version 2.0.0, in alpine 3.24

🎀 libtinyalsa-mixer(3) 🎀

okay so bestie, this is the libtinyalsa-mixer page from the Library Functions Manual — it's literally the mixer interface tea ☕✨.

💖 NAME 💖

libtinyalsa-mixer — Mixer Interface 💅

all the macros, structures, and functions that make up the mixer interface, no cap 🫶

✨ SYNOPSIS ✨

okay so here's the cast list, main character energy only 👑

🧸 Data Structures

struct mixer_ctl — a mixer control 🎛️
struct mixer — a mixer handle ✋

🌸 Enumerations

enum mixer_ctl_type — mixer control type.

enum mixer_ctl_type { MIXER_CTL_TYPE_BOOL, MIXER_CTL_TYPE_INT,
           MIXER_CTL_TYPE_ENUM, MIXER_CTL_TYPE_BYTE, MIXER_CTL_TYPE_IEC958,
           MIXER_CTL_TYPE_INT64, MIXER_CTL_TYPE_UNKNOWN, MIXER_CTL_TYPE_MAX }

⭐ Functions

void mixer_close (struct mixer *mixer) — closes a mixer that came from mixer_open — bye-bye handle 💨
struct mixer * mixer_open (unsigned int card) — opens a mixer for a given card 🎴
const char * mixer_get_name (const struct mixer *mixer) — gets the name of the mixer's card 🏷️
unsigned int mixer_get_num_ctls (const struct mixer *mixer) — gets the number of mixer controls for a given mixer 🔢
unsigned int mixer_get_num_ctls_by_name (const struct mixer *mixer, const char *name) — gets the number of mixer controls that go by a specified name, for a given mixer — count 'em 👀
int mixer_subscribe_events (struct mixer *mixer, int subscribe) — subscribes for the mixer events 📬
int mixer_wait_event (struct mixer *mixer, int timeout) — waits for mixer events, lowkey patient vibes ⏳
int mixer_consume_event (struct mixer *mixer) — consumes a mixer event 🍽️
int mixer_read_event (struct mixer *mixer, struct mixer_ctl_event *event) — reads a mixer control event 📖
const struct mixer_ctl * mixer_get_ctl_const (const struct mixer *mixer, unsigned int id) — gets a mixer control handle by the mixer control's id 🔎
struct mixer_ctl * mixer_get_ctl (struct mixer *mixer, unsigned int id) — gets a mixer control handle by the mixer control's id 🔍
struct mixer_ctl * mixer_get_ctl_by_name (struct mixer *mixer, const char *name) — gets the first instance of a mixer control handle by the mixer control's name 🥇
struct mixer_ctl * mixer_get_ctl_by_name_and_index (struct mixer *mixer, const char *name, unsigned int index) — gets an instance of a mixer control handle by the mixer control's name and index 🎯
void mixer_ctl_update (struct mixer_ctl *ctl) — updates the control's info 🔄
int mixer_ctl_is_access_tlv_rw (const struct mixer_ctl *ctl) — checks the control for TLV Read/Write access 🕵️
unsigned int mixer_ctl_get_id (const struct mixer_ctl *ctl) — gets the control's ID 🆔
const char * mixer_ctl_get_name (const struct mixer_ctl *ctl) — gets the name of the control 🏷️
enum mixer_ctl_type mixer_ctl_get_type (const struct mixer_ctl *ctl) — gets the value type of the control 🧬
const char * mixer_ctl_get_type_string (const struct mixer_ctl *ctl) — gets the string that describes the value type of the control 🔤
unsigned int mixer_ctl_get_num_values (const struct mixer_ctl *ctl) — gets the number of values in the control 🔢
int mixer_ctl_get_percent (const struct mixer_ctl *ctl, unsigned int id) — gets a percentage representation of a specified control value 💯
int mixer_ctl_set_percent (struct mixer_ctl *ctl, unsigned int id, int percent) — sets the value of a control by percent, specified by the value id 🎚️
int mixer_ctl_get_value (const struct mixer_ctl *ctl, unsigned int id) — gets the value of a control 🎛️
int mixer_ctl_get_array (const struct mixer_ctl *ctl, void *array, size_t count) — gets the contents of a control's value array 🧺
int mixer_ctl_set_value (struct mixer_ctl *ctl, unsigned int id, int value) — sets the value of a control, specified by the value id 🎚️
int mixer_ctl_set_array (struct mixer_ctl *ctl, const void *array, size_t count) — sets the contents of a control's value array 🧺
int mixer_ctl_get_range_min (const struct mixer_ctl *ctl) — gets the minimum value of a control ⬇️
int mixer_ctl_get_range_max (const struct mixer_ctl *ctl) — gets the maximum value of a control ⬆️
unsigned int mixer_ctl_get_num_enums (const struct mixer_ctl *ctl) — gets the number of enumerated items in the control 🔢
const char * mixer_ctl_get_enum_string (struct mixer_ctl *ctl, unsigned int enum_id) — gets the string representation of an enumerated item 🔤
int mixer_ctl_set_enum_by_string (struct mixer_ctl *ctl, const char *string) — sets an enumeration value by string value 🪄

💫 Detailed Description 💫

okay so fr fr, this is all the macros, structures, and functions that make up the mixer interface — the whole friend group, together 💜.

🌈 Enumeration Type Documentation 🌈

🦋 enum mixer_ctl_type 🦋

mixer control type, periodt. the way that this enum just labels every control vibe? iconic 💅

🍓 Enumerator

MIXER_CTL_TYPE_BOOL — boolean control type ✅
MIXER_CTL_TYPE_INT — integer control type 🔢
MIXER_CTL_TYPE_ENUM — an enumerated control type 📋
MIXER_CTL_TYPE_INT64 — a 64 bit integer control type 🧮
MIXER_CTL_TYPE_UNKNOWN — unknown control type ❓
MIXER_CTL_TYPE_MAX — end of the enumeration (not a control type) 🛑

🌸 Function Documentation 🌸

okay bestie, this is the function-by-function tour. every signature, parameter, return value, and weird little typo is staying exactly where it belongs — we're just making it cute 💅

🧹 `mixer_close`

void mixer_close (struct mixer * mixer)

Closes a mixer returned by mixer_open. she's done, she's logging off, bye 👋

mixer — A mixer handle.

Returns: nothing, it's void — she just leaves.

🎧 `mixer_consume_event`

int mixer_consume_event (struct mixer * mixer)

Consume a mixer event. If mixer_subscribe_events has been called, mixer_wait_event will identify when a control value has changed. This function will clear a single event from the mixer so that further events can be alerted. one event at a time, no cap ✨

mixer — A mixer handle.

Returns: 1 on success. 0, if no pending event. -errno on failure.

🍓 `mixer_ctl_get_array`

int mixer_ctl_get_array (const struct mixer_ctl * ctl, void * array, size_t count)

Gets the contents of a control's value array. very "give me the whole squad" energy 🫶

ctl — An initialized control handle.
array — A pointer to write the array data to. The size of this array must be equal to the number of items in the array multiplied by the size of each item.
count — The number of items in the array. This parameter must match the number of items in the control. The number of items in the control may be accessed via mixer_ctl_get_num_values.

Returns: On success, zero. On failure, non-zero.

🌈 `mixer_ctl_get_enum_string`

const char * mixer_ctl_get_enum_string (struct mixer_ctl * ctl, unsigned int enum_id)

Gets the string representation of an enumerated item. it's giving "translate the enum for me please" 💖

ctl — An initialized control handle.
enum_id — The index of the enumerated value.

Returns: A string representation of the enumerated item.

🎀 `mixer_ctl_get_id`

unsigned int mixer_ctl_get_id (const struct mixer_ctl * ctl)

Gets the control's ID. every control needs a little name tag, iykyk ✨

ctl — An initialized control handle.

Returns: On success, the control's ID is returned. On error, UINT_MAX is returned instead.

🦋 `mixer_ctl_get_name`

const char * mixer_ctl_get_name (const struct mixer_ctl * ctl)

Gets the name of the control. main character identification moment 👑

ctl — An initialized control handle.

Returns: On success, the name of the control. On error, NULL.

💜 `mixer_ctl_get_num_enums`

unsigned int mixer_ctl_get_num_enums (const struct mixer_ctl * ctl)

Get the number of enumerated items in the control. counting the enum girlies one by one 🔢

ctl — An initialized control handle.

Returns: The number of enumerated items in the control.

🧚 `mixer_ctl_get_num_values`

unsigned int mixer_ctl_get_num_values (const struct mixer_ctl * ctl)

Gets the number of values in the control. how many little values are we working with? let's find out 💫

ctl — An initialized control handle.

Returns: The number of values in the mixer control.

🌸 `mixer_ctl_get_percent`

int mixer_ctl_get_percent (const struct mixer_ctl * ctl, unsigned int id)

Gets a percentage representation of a specified control value. turning the vibe into a %, iconic 📈

ctl — An initialized control handle.
id — The index of the value within the control.

Returns: On success, the percentage representation of the control value. On failure, -EINVAL is returned.

🔥 `mixer_ctl_get_range_max`

int mixer_ctl_get_range_max (const struct mixer_ctl * ctl)

Gets the maximum value of an control. The control must have an integer type. The type of the control can be checked with mixer_ctl_get_type. yes, "an control" — she said what she said 💀

ctl — An initialized control handle.

Returns: On success, the maximum value of the control. On failure, -EINVAL.

🌈 `mixer_ctl_get_range_min`

int mixer_ctl_get_range_min (const struct mixer_ctl * ctl)

Gets the minimum value of an control. The control must have an integer type. The type of the control can be checked with mixer_ctl_get_type. the lower bound bestie, the floor, the starting line ✨

ctl — An initialized control handle.

Returns: On success, the minimum value of the control. On failure, -EINVAL.

🎀 `mixer_ctl_get_type`

enum mixer_ctl_type mixer_ctl_get_type (const struct mixer_ctl * ctl)

Gets the value type of the control. type check, but make it mixer 💅

ctl — An initialized control handle.

Returns: On success, the type of mixer control. On failure, it returns MIXER_CTL_TYPE_UNKNOWN.

🦋 `mixer_ctl_get_type_string`

const char * mixer_ctl_get_type_string (const struct mixer_ctl * ctl)

Gets the string that describes the value type of the control. same type info, but in a string outfit 🎀

ctl — An initialized control handle.

Returns: On success, a string describing type of mixer control.

⭐ `mixer_ctl_get_value`

int mixer_ctl_get_value (const struct mixer_ctl * ctl, unsigned int id)

Gets the value of a control. the moment we've all been waiting for: the actual value 🔥

ctl — An initialized control handle.
id — The index of the control value.

Returns: On success, the specified value is returned. On failure, -EINVAL is returned.

💀 `mixer_ctl_is_access_tlv_rw`

int mixer_ctl_is_access_tlv_rw (const struct mixer_ctl * ctl)

Checks the control for TLV Read/Write access. is she TLV read/write coded? let's check 👀

ctl — An initialized control handle.

Returns: On success, non-zero. On failure, zero.

🍓 `mixer_ctl_set_array`

int mixer_ctl_set_array (struct mixer_ctl * ctl, const void * array, size_t count)

Sets the contents of a control's value array. dropping the whole array in, no crumbs left behind 🫶

ctl — An initialized control handle.
array — The array containing control values.
count — The number of values in the array. This must match the number of values in the control. The number of values in a control may be accessed via mixer_ctl_get_num_values.

Returns: On success, zero. On failure, non-zero.

🎀 `mixer_ctl_set_enum_by_string`

int mixer_ctl_set_enum_by_string (struct mixer_ctl * ctl, const char * string)

Set an enumeration value by string value. name the enum and set it, cute and direct ✨

ctl — An enumerated mixer control.
string — The string representation of an enumeration.

Returns: On success, zero. On failure, zero. yes bestie, both zero — that's literally what the page says 💀

🌸 `mixer_ctl_set_percent`

int mixer_ctl_set_percent (struct mixer_ctl * ctl, unsigned int id, int percent)

Sets the value of a control by percent, specified by the value index. setting the vibe level from 0 to 100 🎚️

ctl — An initialized control handle.
id — The index of the value to set.
percent — A percentage value between 0 and 100.

Returns: On success, zero is returned. On failure, non-zero is returned.

🔥 `mixer_ctl_set_value`

int mixer_ctl_set_value (struct mixer_ctl * ctl, unsigned int id, int value)

Sets the value of a control, specified by the value index. one value, one index, one moment 💅

ctl — An initialized control handle.
id — The index of the value within the control.
value — The value to set. This must be in a range specified by mixer_ctl_get_range_min and mixer_ctl_get_range_max.

Returns: On success, zero is returned. On failure, non-zero is returned.

🧚 `mixer_ctl_update`

void mixer_ctl_update (struct mixer_ctl * ctl)

Updates the control's info. This is useful for a program that may be idle for a period of time. refresh her info, she's been sitting here for a minute 🕰️

ctl — An initialized control handle.

Returns: nothing, void era.

🎧 `mixer_get_ctl`

struct mixer_ctl * mixer_get_ctl (struct mixer * mixer, unsigned int id)

Gets a mixer control handle, by the mixer control's id. For const access, see mixer_get_ctl_const. ID girlies rise 🫶

mixer — An initialized mixer handle.
id — The control's id in the given mixer.

Returns: A handle to the mixer control.

🦋 `mixer_get_ctl_by_name`

struct mixer_ctl * mixer_get_ctl_by_name (struct mixer * mixer, const char * name)

Gets the first instance of mixer control handle, by the mixer control's name. first match only, bestie — don't get it twisted ✨

mixer — An initialized mixer handle.
name — The control's name in the given mixer.

Returns: A handle to the mixer control.

💜 `mixer_get_ctl_by_name_and_index`

struct mixer_ctl * mixer_get_ctl_by_name_and_index (struct mixer * mixer, const char * name, unsigned int index)

Gets an instance of mixer control handle, by the mixer control's name and index. For instance, if two controls have the name of 'Volume', then and index of 1 would return the second control. (yes, "then and index" — the page said it, not me 😭)

mixer — An initialized mixer handle.
name — The control's name in the given mixer.
index — The control's index.

Returns: A handle to the mixer control.

🎀 `mixer_get_ctl_const`

const struct mixer_ctl * mixer_get_ctl_const (const struct mixer * mixer, unsigned int id)

Gets a mixer control handle, by the mixer control's id. For non-const access, see mixer_get_ctl. const-correct queen 👑

mixer — An initialized mixer handle.
id — The control's id in the given mixer.

Returns: A handle to the mixer control.

🌈 `mixer_get_name`

const char * mixer_get_name (const struct mixer * mixer)

Gets the name of the mixer's card. not the control, the card — read her properly 💳

mixer — An initialized mixer handle.

Returns: The name of the mixer's card.

⭐ `mixer_get_num_ctls`

unsigned int mixer_get_num_ctls (const struct mixer * mixer)

Gets the number of mixer controls for a given mixer. counting the controls like they're限量 edition 👀

mixer — An initialized mixer handle.

Returns: The number of mixer controls for the given mixer.

🍓 `mixer_get_num_ctls_by_name`

unsigned int mixer_get_num_ctls_by_name (const struct mixer * mixer, const char * name)

Gets the number of mixer controls, that go by a specified name, for a given mixer. all the same-name girlies accounted for 💅

mixer — An initialized mixer handle.
name — The name of the mixer control.

Returns: The number of mixer controls, specified by name, for the given mixer.

🔥 `mixer_open`

struct mixer * mixer_open (unsigned int card)

Opens a mixer for a given card. new mixer, new me, let's gooo ✨

card — The card to open the mixer for.

Returns: An initialized mixer handle.

🎧 `mixer_read_event`

int mixer_read_event (struct mixer * mixer, struct mixer_ctl_event * event)

Read a mixer control event. Try to read an control event from mixer. event output goes into the event parameter — if there is an event read form the mixer, this function will fill the event data into it. "form" is their word, we're keeping it 💀

mixer — A mixer handle.
event — Output parameter. If there is an event read form the mixer, this function will fill the event data into it.

Returns: 1 on success. 0, if no pending event. -errno on failure.

🌸 `mixer_subscribe_events`

int mixer_subscribe_events (struct mixer * mixer, int subscribe)

Subscribes for the mixer events. get on the event list, bestie 📬

mixer — A mixer handle.
subscribe — value indicating subscribe or unsubscribe for events.

Returns: On success, zero. On failure, non-zero.

🦋 `mixer_wait_event`

int mixer_wait_event (struct mixer * mixer, int timeout)

Wait for mixer events. the waiting room, but for mixer events ⏳

mixer — A mixer handle.
timeout — timout value (their spelling, not mine).

Returns: On success, 1. On failure, -errno. On timeout, 0.

👑 Author 👑

Generated automatically by Doxygen for TinyALSA from the source code. automated icon behavior, honestly 🤖✨

source/version: TinyALSA, Version 1.1.0 · page: libtinyalsa-mixer(3) · date: not in this footer, so we're calling her timeless 💜

stay hydrated, go check your mixer controls, and remember: every event deserves to be consumed responsibly 🎀💖

📦 where this page comes from

alpine 3.24: tinyalsa-doc 2.0.0-r4 · BSD-3-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms

libtinyalsa-mixer(3)