Mistakes, omissions in the API doc

[Buy One]

Either bug or a lacking description

GetLastMarkerAndCurRegion()

As per the description:

Get the last project marker before time, and/or the project region that includes time

but the region end time isn't included.

[Buy One]

GetMediaItemInfo_Value()

D_FADEINLEN_AUTO : double * : item auto-fadein length in seconds, -1=no auto-fadein
D_FADEOUTLEN_AUTO : double * : item auto-fadeout length in seconds, -1=no auto-fadeout

When there's no autofade i consistently get 0.0. Haven't been able to make the function return -1. So either i'm not using it correctly, there's a specific situation in which it returns -1 i'm unaware of or this is an error.

Haven't checked the doc for the latest build.

[Buy One]

GetTakeEnvelopeByName()

TakeFX_GetEnvelope()

The return value is listed as TrackEnvelope

C: TrackEnvelope* GetTakeEnvelopeByName(MediaItem_Take* take, const char* envname)

EEL2: TrackEnvelope GetTakeEnvelopeByName(MediaItem_Take take, "envname")

Lua: TrackEnvelope reaper.GetTakeEnvelopeByName(MediaItem_Take take, string envname)

Python: TrackEnvelope RPR_GetTakeEnvelopeByName(MediaItem_Take take, String envname)

[X-Raym]

Missing space in lua between reaper and variable name:

Lua: integerr.left, integerr.top, integerr.right, integerr.bot = reaper.EnsureNotCompletelyOffscreen(integerr.left, integerr.top, integerr.right, integerr.bot)

Also:
get_action_context doc HTML code is very dirty.


non of the <li> are closes

there is element inbetween <ul> and <li>

<br> tags instead of </li>

text after </ul> but not in a <p>

[Buy One]

gfx.showmenu

Missing info about ampersand as a special character, because it's employed as a quick access shortcut and therefore not displayed in the menu.


Take/TakeFX_GetIOSize()

Info about plugin type code can be found in t=277103

[Buy One]

TrackFX_GetPreset()
TakeFX_GetPreset()

Originally Posted by API

Returns false if the current FX parameters do not exactly match the preset (in other words, if the user loaded the preset but moved the knobs afterward)

As per Schwa's explanation, the description is incorrect

Originally Posted by schwa

It looks like this is an error in the documentation. There's nothing in the implementation that suggests the function ever worked this way.

Originally Posted by schwa

For now, the function always returns true if the inputs are valid.

[Meo-Ada Mespotine]

Originally Posted by Buy One

GetTakeEnvelopeByName()

TakeFX_GetEnvelope()

The return value is listed as TrackEnvelope

Yeah, this is for all take-envelope-functions returning an envelope, I guess a leftover from a time, where takes may not have had envelopes(?).

Maybe it's better to rename them consequently to Envelope.

[Buy One]

Didn't include this when explanation was provided by Schwa

RenderFileSection()

Regarding bitrate (and probably sample rate as well)

Originally Posted by schwa

This API function follows the project setting "format for apply fx, glue, freeze, etc" (File > Project settings > Media).

With that said

Originally Posted by Buy One

At the default setting

'Automatic .wav (recommended)"
(not set)

a file created with the function is 24 bit, but the glued one is 16 bit.
The source file is 16 bit as well.

So to be consistent it apparently needs to be set to anything other than default.

[Buy One]

SetThemeColor()

The list of supported keys includes blendmode keys even though they're not supported for both getting and setting, which is misleading.

Originally Posted by X-Raym

Hi,

reaper.GetThemeColor( ini_key, flags ) doesnt seems to work on the blendmode value, I only got -1.... can someone confirm ?

for eg with

reaper.GetThemeColor("toolbararmed_drawmode", 0)

Do I miss something ?

Originally Posted by schwa

as far as I know reaper.GetThemeColor has only ever been supported for colors, not for other theme elements.

[Buy One]

SetTrackMIDINoteNameEx()

Applies to both functions, with or without the Ex

As per the doc

channel < 0 assigns note name to all channels.

In fact only negative value of -1 results in change in note name assignment to all channels. Which seems logical because it's -1 which indicates Omni assignment in the MIDINOTENAMES section of the track chunk.

Other negative values do get written into the chunk but since they're unsupported no visible change occurs in the UI. With other negative values the function still returns true.


For Get functions any negative value indeed works.
.
.
.

[Buy One]

MIDI_GetGrid()

Originally Posted by API doc

Swing is between 0 and 1

In fact the swing value range is between -1 and 1

[Edgemeal]

Documentation for Get/SetMediaTrackInfo_Value, B_HEIGHTLOCK is on the same line as I_SPACER,..

I_SPACER : int * : 1=TCP track spacer above this trackB_HEIGHTLOCK : bool * : track height lock (must set I_HEIGHTOVERRIDE before locking)

[Buy One]

And in general it would be useful to have the doc at https://www.reaper.fm/sdk/reascript/reascripthelp.html updated to the latest version especially after the release of REAPER 7

[X-Raym]

reaper.SetMouseMapAction
example reaper.SetMouseMapAction("MIDI piano roll left drag", 0, "Paint notes")

This is in reascript IDE autocomplete but not in generated doc.

[Buy One]

GetSetProjectInfo_String()

The function description doesn't detail syntax applicable to user defined tags, which is

to get: [scheme]:USER:[user key]

to set: [scheme]:USER:[user key]|value

[user key] is the string displayed in the Description column of the Project Render Matadata window
the ID of the user defined tag USER:[user key] appears in the ID column


The online doc has been updated to v7.06