EnvelopeString class public functions


Creates the object with no initial contents.
EnvelopeString(const char* aString);
Calls setEnvelope(aString);

~EnvelopeString(char* aString);
Deletes internal objects such as the envelope string when object is deleted.

const char* getEnvelope(void);
Returns the internal envelope of a string. The form of the returned string depends on the envelope syntax being used. See the setSyntax functions for how to change envelope syntax.

void print(void);
Prints out the internal configuration of the envelope for debugging purposes.

void setEnvelope(const char* aString, int stringType = UNKNOWN_ENV);
Reads in an envelope string. The syntax can be MusicKit, LISP, or sig. The output syntax is automatically set to the input envelope syntax. If the input type of envelope is not specified, then the EnvelopeString object will try to identify what syntax it it written in.

void setStickIndex(int anIndex);
You can move or create a stickpoint in the envelope with this function. Stickpoints cannot be placed at the end of an envelope.

void setStickSamples(void);
If there is a stickpoint in the envelope, then the time values are interpreted at sample numbers. This is the default option for sig envelopes.

void setStickSeconds(void);
If there is a stickpoint in the envelope, then the time values are interpreted at time in seconds. This is the default option for MusicKit envelopes.

void setSyntax(int syntaxType);
Each envelope type has a certain integer associated with it. This function can be used directly if you know those numbers, or you can use the setSyntaxXXX set of functions below. The syntax is the form which an envelope will be written in when it is printed. The syntax is only used for outputing an envelope string with the getString function.

void setSyntaxMK(void);
Sets the output syntax to MusicKit syntax. Example: [(1, 1)(2, 2)(3, 0)] .

void setSyntaxLISP(void);
Sets the output syntax to LISP syntax. Example: ((1 1)(2 2)(3 0)) .

void setSyntaxSIG(void);
Sets the output syntax to SIG syntax. Example: (1 1; 2 2; 3 0) .