Commons Heavy API methods

heavy_api_common.c

/** Returns the sample rate with which this patch has been configured. */
double hv_getSampleRate(Heavy *c);

/** Returns the number of input channels with which this patch has been configured. */
int hv_getNumInputChannels(Heavy *c);

/** Returns the number of output channels with which this patch has been configured. */
int hv_getNumOutputChannels(Heavy *c);

/** Set the print hook. The function is called whenever a message is sent to a print object. */
void hv_setPrintHook(Heavy *c,
    void (*f)(double timestamp, const char *printName, const char *message, void *userData));

/**
 * Set the send hook. The function is called whenever a message is sent to any send object.
 * Messages returned by this function should NEVER be freed. If the message must persist, call
 * hv_msg_copy() first.
 */
void hv_setSendHook(Heavy *c, void (*f)(const char *receiverName, HvMessage *m, void *userData));

void hv_vscheduleMessageForReceiver(Heavy *c, const char *receiverName, double delayMs, const char *format, ...);

void hv_scheduleMessageForReceiver(Heavy *c, const char *receiverName, double delayMs, HvMessage *m);

/** Cancels a previously scheduled message. */
void hv_cancelMessage(Heavy *c, HvMessage *m);

/** Returns a table object given its name. NULL if no table with that name exists. */
PdTable *hv_getTableForName(Heavy *c, const char *tableName);

/** Returns the current patch time in milliseconds. */
double hv_getCurrentTime(Heavy *c);

/** Sets a user-definable value. This value is never manipulated by Heavy. */
void hv_setUserData(Heavy *c, void *userData);

/** Returns the user-defined data. */
void *hv_getUserData(Heavy *c);

/** Define the base path of the patch. Used as the root path to locate assets. */
void hv_setBasePath(Heavy *c, const char *basePath);