Skip to contentSkip to conversation

Mixer programming - is there any documentation available?

DISCUSSION Kevin Conder 3 participants 3 messages Jul 15, 2002 – Jul 16, 2002 1 message not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw
Quoted 5 lines

Michal Kochanowicz wrote:
I'm trying to setup mixer using ALSA but I find it painull due to lack of documentation. Yes, there is so-called API documentation but in fact it's worthless. It contains little more than function names and argument types.

Merely saying something is worthless doesn't help improve it at all. So could you tell us what you expect from API documentation? What is ALSA's API documentation missing?

Please be specific as possible (examples? searchable? alphabetical index?). Have you read any other API documentation that you thought was good? If you can point out any examples that can be freely viewed or downloaded from the Internet, that would be especially helpful.

=====
-- kwconder at yahoo dot com

__________________________________________________
Do You Yahoo!?
Yahoo! Autos - Get free new car price quotes
http://autos.yahoo.com

-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

#2 lore raw
Quoted 3 lines · Kevin Conder

Merely saying something is worthless doesn't help improve it at all. So could you tell us what you expect from API documentation? What is ALSA's API documentation missing?

Please tak a look at these descriptions. For example:
------------------------------------------------------------------------
snd_mixer_class_register

Register mixer element class.

Parameters:
class Mixer element class
mixer Mixer handle

Returns:
0 on success otherwise a negative error code

For use by mixer element class specific code.
------------------------------------------------------------------------

I really don't know what these classes are...

Quoted 1 line

Please be specific as possible (examples? searchable? alphabetical

Better explanation what for is given function. Some short howtos: to use mixer you need to call function a(), pass it's result to function b() and you will get handle which you can pass to function c() to set volume or d() to get current volume.

Quoted 3 lines

index?). Have you read any other API documentation that you thought was good? If you can point out any examples that can be freely viewed or downloaded from the Internet, that would be especially helpful.

I think Java APIs are well commented (note that they use javadoc which, I think, is similar to doxygene). Take a look at this:
http://java.sun.com/j2se/1.4/docs/api/index.html
or this:
http://java.sun.com/j2ee/sdk_1.3/techdocs/api/index.html
or at tutorials:
http://java.sun.com/j2ee/tutorial/1_3-fcs/index.html

Also QT documentation is well written:
http://doc.trolltech.com/3.0/

Please understand me: I've got SB Live! for two days, I wanted to make mixer for it (none of mixers I know fully support it). And I spent almost entire day reverse-engineering alsamixer. This is simply wrong... If I had better documentation, I'm sure I could write that mixer in two days...

One more thing... what good is for even best library, if it's so hard to use...

Regards

Signature · 9 lines
--= Michal [email protected] =--
--= finger me for PGP public key or visit http://michal.waw.pl/PGP =--
--==--==--==--==--==-- Vodka. Connecting people.--==--==--==--==--==--
A chodzenie po górach SSIE!!!



-------------------------------------------------------
This sf.net email is sponsored by: Jabber - The world's fastest growing real-time communications platform! Don't just IM. Build it in! http://www.jabber.com/osdn/xim
#3 lore raw
Quoted 3 lines · Michal Kochanowicz

Please understand me: I've got SB Live! for two days, I wanted to make mixer for it (none of mixers I know fully support it). And I spent almost entire day reverse-engineering alsamixer. This is simply wrong...

I did the same. Just with alsactl. It is working nice. Example source code is not a bad documentation.

I have to agree that often the only way to understand how to use alsa-lib is to read the source code of it. It's OK for me.

Best regards,
--
Tomasz Motylewski

-------------------------------------------------------
This sf.net email is sponsored by: Jabber - The world's fastest growing real-time communications platform! Don't just IM. Build it in!
http://www.jabber.com/osdn/xim