ReaScript API
From CockosWiki
| Line 1: | Line 1: | ||
[[ReaScript|Back to main ReaScript page]] | [[ReaScript|Back to main ReaScript page]] | ||
| + | [[REAPER API|Back to main REAPER API page]] | ||
'''ReaScript API Documentation''' | '''ReaScript API Documentation''' | ||
Revision as of 00:28, 13 November 2009
Back to main ReaScript page Back to main REAPER API page
ReaScript API Documentation
Don't forget - Call API functions using RPR_functionname() - Don't forget the RPR_
Functions that cannot return information in the parameter list will return a single value, functions that can return information in the parameter list will return a list of values.
Using these functions.
If a function takes a void* argument in the parameter list, which ReaScript thinks (correctly) is a modifiable variable, or any other modifiable variables in the parameter list, the function will return an array (return, parm1, parm2, ...).
This is a little counter-intuitive to Perl programmers but stick with me and read the example please.
e.g GetUserInputs()
Specific Reaper type pointers like MediaItem* are not considered modifiable by ReaScript when deciding whether to return a scalar or array from a particular function.
Anything in the API documentation that is marked with a '?' is an assumption or something the writer just isn't sure about. If you happen to know whatever it is for certain - please correct or confirm the entry.
Please add a brief note or correction if you see anything that's wrong or incomplete . Don't worry about making it look good if you don't have the time; someone will be along in a while with the time. Of course, don't hesitate to make it look cool if you *do* have the time... :o)
