Detailed Description
Includes various functions for version management and for conversions. The number of version functions is due to historical reasons.
Function Documentation
Gives the library version number as three integers.
Version number format is MAJOR.MINOR.SUB
- Returns:
- a GuidoVersion structure.
GuidoErrCode checkVersionNums |
( |
int |
major, |
|
|
int |
minor, |
|
|
int |
sub |
|
) |
| [inherited] |
Checks a required library version number.
- Parameters:
-
major | the major revision number. |
minor | the minor revision number. |
sub | the sub revision number. |
- Returns:
- noErr if the library version number is greater or equal to the version number passed as argument.
-
otherwise guidoErrActionFailed.
float getLineSpace |
( |
) |
[inherited] |
Gives the distance between two staff lines.
This value is constant (= 50). It does not depend on the context, it will probably never change in future versions of the library.
- Returns:
- the distance between two lines of staff, in Guido internal units.
Gives a color to all notes of a voice between a given time interval.
- Note:
- Introduced for GUIDO/MIR; Allows the user to see where a musical theme appears in a voice.
- Parameters:
-
inHandleAR | a Guido opaque handle to an AR structure. |
voicenum | index of the voice to mark, starting from 1 |
date | the date where the color-marking must begin (whole note = 1) |
duration | the duration that must be covered by the color marking. |
red | the red component of the marking color, from 0 to 255. |
green | green color component. |
blue | blue color component. |
- Returns:
- a Guido error code.
GuidoErrCode setSymbolPath |
( |
ARHandler |
inHandleAR, |
|
|
const std::vector< std::string > & |
inPaths |
|
) |
| [inherited] |
Makes the correspondance between an ARMusic and a path.
- Parameters:
-
inHandleAR | the destination ARHandler. |
inPaths | the path to associate. |
- Returns:
- noErr if the association has been made with success
-
otherwise guidoErrActionFailed.
std::vector<std::string> getSymbolPath |
( |
const ARHandler |
inHandleAR ) |
[inherited] |
Returns the path corresponding to an AR.
- Parameters:
-
inHandleAR | the handle given to extract its path. |
- Returns:
- the vector of path.