control-names.rst

  1===========================
  2Standard ALSA Control Names
  3===========================
  4
  5This document describes standard names of mixer controls.
  6
  7Standard Syntax
  8---------------
  9Syntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
 10
 11
 12DIRECTION
 13~~~~~~~~~
 14================	===============
 15<nothing>		both directions
 16Playback		one direction
 17Capture			one direction
 18Bypass Playback		one direction
 19Bypass Capture		one direction
 20================	===============
 21
 22FUNCTION
 23~~~~~~~~
 24========	=================================
 25Switch		on/off switch
 26Volume		amplifier
 27Route		route control, hardware specific
 28========	=================================
 29
 30CHANNEL
 31~~~~~~~
 32============	==================================================
 33<nothing>	channel independent, or applies to all channels
 34Front		front left/right channels
 35Surround	rear left/right in 4.0/5.1 surround
 36CLFE		C/LFE channels
 37Center		center channel
 38LFE		LFE channel
 39Side		side left/right for 7.1 surround
 40============	==================================================
 41
 42LOCATION (Physical location of source)
 43~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 44============	=====================
 45Front		front position
 46Rear		rear position
 47Dock		on docking station
 48Internal	internal
 49============	=====================
 50
 51SOURCE
 52~~~~~~
 53===================	=================================================
 54Master
 55Master Mono
 56Hardware Master
 57Speaker			internal speaker
 58Bass Speaker		internal LFE speaker
 59Headphone
 60Line Out
 61Beep			beep generator
 62Phone
 63Phone Input
 64Phone Output
 65Synth
 66FM
 67Mic
 68Headset Mic		mic part of combined headset jack - 4-pin
 69			headphone + mic
 70Headphone Mic		mic part of either/or - 3-pin headphone or mic
 71Line			input only, use "Line Out" for output
 72CD
 73Video
 74Zoom Video
 75Aux
 76PCM
 77PCM Pan
 78Loopback
 79Analog Loopback		D/A -> A/D loopback
 80Digital Loopback	playback -> capture loopback -
 81			without analog path
 82Mono
 83Mono Output
 84Multi
 85ADC
 86Wave
 87Music
 88I2S
 89IEC958
 90HDMI
 91SPDIF			output only
 92SPDIF In
 93Digital In
 94HDMI/DP			either HDMI or DisplayPort
 95===================	=================================================
 96
 97Exceptions (deprecated)
 98-----------------------
 99
100=====================================	=======================
101[Analogue|Digital] Capture Source
102[Analogue|Digital] Capture Switch	aka input gain switch
103[Analogue|Digital] Capture Volume	aka input gain volume
104[Analogue|Digital] Playback Switch	aka output gain switch
105[Analogue|Digital] Playback Volume	aka output gain volume
106Tone Control - Switch
107Tone Control - Bass
108Tone Control - Treble
1093D Control - Switch
1103D Control - Center
1113D Control - Depth
1123D Control - Wide
1133D Control - Space
1143D Control - Level
115Mic Boost [(?dB)]
116=====================================	=======================
117
118PCM interface
119-------------
120
121===================	========================================
122Sample Clock Source	{ "Word", "Internal", "AutoSync" }
123Clock Sync Status	{ "Lock", "Sync", "No Lock" }
124External Rate		external capture rate
125Capture Rate		capture rate taken from external source
126===================	========================================
127
128IEC958 (S/PDIF) interface
129-------------------------
130
131============================================	======================================
132IEC958 [...] [Playback|Capture] Switch		turn on/off the IEC958 interface
133IEC958 [...] [Playback|Capture] Volume		digital volume control
134IEC958 [...] [Playback|Capture] Default		default or global value - read/write
135IEC958 [...] [Playback|Capture] Mask		consumer and professional mask
136IEC958 [...] [Playback|Capture] Con Mask	consumer mask
137IEC958 [...] [Playback|Capture] Pro Mask	professional mask
138IEC958 [...] [Playback|Capture] PCM Stream	the settings assigned to a PCM stream
139IEC958 Q-subcode [Playback|Capture] Default	Q-subcode bits
140
141IEC958 Preamble [Playback|Capture] Default	burst preamble words (4*16bits)
142============================================	======================================