ReaScript API
From CockosWiki
Line 6: | Line 6: | ||
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. | 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.''' | '''Using these functions.''' | ||
Line 20: | Line 16: | ||
Specific Reaper type pointers like MediaItem* are not considered modifiable by ReaScript. | Specific Reaper type pointers like MediaItem* are not considered modifiable by ReaScript. | ||
+ | |||
+ | ''Anything in the API documentation that is marked with a '?' is an assumption or something I'm just not sure about. If you happen to know whatever it is for certain - please correct or confirm the entry. | ||
+ | |||
+ | ''Anything you see that's wrong or incomplete - and there's certainly plenty incomplete - please add a brief note saying what needs to be done. Someone will be along in a while with the time to make the change look good if you don't have the time. | ||
{|"class=wikitable" | {|"class=wikitable" | ||
Line 126: | Line 126: | ||
|- | |- | ||
| [[RPR_GetOutputChannelName|GetOutputChannelName()]] | | [[RPR_GetOutputChannelName|GetOutputChannelName()]] | ||
+ | | [[RPR_GetOutputLatency|GetOutputLatency()]] | ||
| [[RPR_GetPeakFileName|GetPeakFileName()]] | | [[RPR_GetPeakFileName|GetPeakFileName()]] | ||
| [[RPR_GetPeaksBitmap|GetPeaksBitmap()]] | | [[RPR_GetPeaksBitmap|GetPeaksBitmap()]] |
Revision as of 05:31, 5 November 2009
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.
Anything in the API documentation that is marked with a '?' is an assumption or something I'm just not sure about. If you happen to know whatever it is for certain - please correct or confirm the entry.
Anything you see that's wrong or incomplete - and there's certainly plenty incomplete - please add a brief note saying what needs to be done. Someone will be along in a while with the time to make the change look good if you don't have the time.