UCM: comment fixes and fix myvalue initialization fix in add_values()

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2011-03-19 00:54:43 +01:00
parent ae0a44c628
commit 60397387ef
2 changed files with 30 additions and 20 deletions

View file

@ -80,9 +80,10 @@ extern "C" {
*
* o Query the supported use case verbs, devices and modifiers for the machine.
* o Set and Get use case verbs, devices and modifiers for the machine.
* o Get the ALSA PCM playback and capture device PCMs for use case verb and
* o Get the ALSA PCM playback and capture device PCMs for use case verb,
* use case device and modifier.
* o Get the TQ parameter for each use case verb, use case device and
* modifier.
* o Get the TQ parameter for each use case verb and modifier.
* o Get the ALSA master playback and capture volume/switch kcontrols
* for each use case.
*/
@ -111,7 +112,7 @@ extern "C" {
* Use Case Device.
*
* Physical system devices the render and capture audio. Devices can be OR'ed
* together to support audio on similtanious devices.
* together to support audio on simultaneous devices.
*/
#define SND_USE_CASE_DEV_NONE "None"
#define SND_USE_CASE_DEV_SPEAKER "Speaker"
@ -135,13 +136,13 @@ extern "C" {
* e.g. to record a voice call :-
* 1. Set verb to SND_USE_CASE_VERB_VOICECALL (for voice call)
* 2. Set modifier SND_USE_CASE_MOD_CAPTURE_VOICE when capture required.
* 3. Call snd_use_case_get("_pcm_/_cdevice") to get ALSA source PCM name
* 3. Call snd_use_case_get("CapturePCM") to get ALSA source PCM name
* with captured voice pcm data.
*
* e.g. to play a ring tone when listenin to MP3 Music :-
* 1. Set verb to SND_USE_CASE_VERB_HIFI (for MP3 playback)
* 2. Set modifier to SND_USE_CASE_MOD_PLAY_TONE when incoming call happens.
* 3. Call snd_use_case_get("_pcm_/_pdevice") to get ALSA PCM sink name for
* 3. Call snd_use_case_get("PlaybackPCM") to get ALSA PCM sink name for
* ringtone pcm data.
*/
#define SND_USE_CASE_MOD_CAPTURE_VOICE "Capture Voice"
@ -221,21 +222,29 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* deallocate this string.
*
* Known identifiers:
* NULL - return current card
* _verb - return current verb
* TQ[/<modifier>] - Tone Quality [for given modifier]
* PlaybackPCM[/<modifier>] - full PCM playback device name
* CapturePCM[/<modifier>] - full PCM capture device name
* PlaybackCTL[/<modifier>] - playback control device name
* PlaybackVolume[/<modifier>] - playback control volume ID string
* PlaybackSwitch[/<modifier>] - playback control switch ID string
* CaptureCTL[/<modifier>] - capture control device name
* CaptureVolume[/<modifier>] - capture control volume ID string
* CaptureSwitch[/<modifier>] - capture control switch ID string
* PlaybackMixer[/<modifier>] - name of playback mixer
* PlaybackMixerID[/<modifier>] - mixer playback ID
* CaptureMixer[/<modifier>] - name of capture mixer
* CaptureMixerID[/<modifier>] - mixer capture ID
* NULL - return current card
* _verb - return current verb
*
* <NAME>[/<modifier>|</device>]
* - value identifier <NAME> for
* given modifier or device
* - Examples: "PlaybackPCM/Play Music",
* "CapturePCM/SPDIF"
*
* Recommended names for values:
* TQ - Tone Quality
* PlaybackPCM - full PCM playback device name
* CapturePCM - full PCM capture device name
* PlaybackCTL - playback control device name
* PlaybackVolume - playback control volume ID string
* PlaybackSwitch - playback control switch ID string
* CaptureCTL - capture control device name
* CaptureVolume - capture control volume ID string
* CaptureSwitch - capture control switch ID string
* PlaybackMixer - name of playback mixer
* PlaybackMixerID - mixer playback ID
* CaptureMixer - name of capture mixer
* CaptureMixerID - mixer capture ID
*/
int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
const char *identifier,