Csound Csound-dev Csound-tekno Search About

[Csnd] About manual documentation for OSCsend

Date2010-10-21 13:33
FromLouis Cohen
Subject[Csnd] About manual documentation for OSCsend
One of the parameters of the OSCsend opcode is explained in the manual  
as:

"kwhen -- a message is sent whenever this value changes. A message  
will always be sent on the first call."

This is certainly clear enough, but because the parameter is named  
"kwhen" I thought I already knew what it meant -- namely, how many  
seconds csound should wait to send the message. Since I always wanted  
the message to be sent immediately, I left the value of kwhen always  
at zero. The result was that the message got sent once and never again.

This drove me crazy for a few days until in a brief email discussion  
with Andres he made a comment that caused me to read the manual more  
carefully. Now the problem is fixed and of course there is nothing  
wrong with the opcode.

However, I suggest that in the manual the parameter be renamed to  
something like "ktrig."

Note that "kwhen" is used to indicate delay seconds in the example  
code for "event". The generic name for the parameter in that case is  
"kdelay."

In some other confusing cases, the manual pages for opcodes  
"schedkwhen", "schedkwhennamed" and "schedwhen" refer to a parameter  
called "ktrigger."

best,
Lou Cohen


Send bugs reports to the Sourceforge bug tracker
            https://sourceforge.net/tracker/?group_id=81968&atid=564599
Discussions of bugs and features can be posted here
To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound"