ReaScript API
From CockosWiki
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.
These functions each map onto a C++ function. C++ allows "pass by reference", which lets you pass a variable to a function in the parameter list and have the function change that parameter, so after this function call:
x = MyFunc(&var);
the var variable might have a different value...
Perl and Python don't have compatible pass by reference mechanisms so when ReaScript sees a modifiable variable in the parameter list it returns all the values in the parameter list and the return value (if there is one) in an array, as in this example.
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)
