Max Wrapper Module
+ Collaboration diagram for Max Wrapper Module:

Functions

void max_jit_attr_set (void *x, t_symbol *s, short ac, t_atom *av)
 Sets attribute value.
t_jit_err max_jit_attr_get (void *x, t_symbol *s, long *ac, t_atom **av)
 Retrieves attribute value.
void max_jit_attr_getdump (void *x, t_symbol *s, short argc, t_atom *argv)
 Retrieves attribute value and sends out dump outlet.
long max_jit_attr_args_offset (short ac, t_atom *av)
 Determines argument offset to first attribute argument.
void max_jit_attr_args (void *x, short ac, t_atom *av)
 Processes attribute arguments.
void max_jit_classex_standard_wrap (void *mclass, void *jclass, long flags)
 Adds standard Jitter methods, as well as public methods and attributes of the specified Jitter class.
void max_addmethod_defer (method m, char *s)
 Adds method to Max class that calls defer rather than the method directly.
void max_addmethod_defer_low (method m, char *s)
 Adds method to Max class that calls defer_low rather than the method directly.
void max_addmethod_usurp (method m, char *s)
 Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.
void max_addmethod_usurp_low (method m, char *s)
 Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.
void * max_jit_classex_setup (long oboffset)
 Allocates and initializes special t_max_jit_classex data, used by the Max wrapper class.
t_jit_err max_jit_classex_addattr (void *x, void *attr)
 Adds an attribute to the Max wrapper class.
void * max_jit_obex_new (void *mc, t_symbol *classname)
 Allocates an initializes a new Max wrapper object instance.
void max_jit_obex_free (void *x)
 Frees additional resources for the Max wrapper object instance.
t_jit_err max_jit_obex_attr_set (void *x, t_symbol *s, long ac, t_atom *av)
 Sets an attribute of the Max wrapper or the wrapped Jitter object.
t_jit_err max_jit_obex_attr_get (void *x, t_symbol *s, long *ac, t_atom **av)
 Retrienves an attribute of the Max wrapper or the wrapped Jitter object.
void * max_jit_obex_jitob_get (void *x)
 Retrieves the wrapped Jitter object from a Max wrapper object.
void max_jit_obex_jitob_set (void *x, void *jitob)
 Sets the wrapped Jitter object for a Max wrapper object.
long max_jit_obex_inletnumber_get (void *x)
 Retrieves the current inlet number used by inlet proxies.
void max_jit_obex_inletnumber_set (void *x, long inletnumber)
 Sets the current inlet number used by inlet proxies.
t_jit_err max_jit_obex_proxy_new (void *x, long c)
 Creates a new proxy inlet.
void max_jit_obex_dumpout_set (void *x, void *outlet)
 Sets the Max wrapper object's dump outlet's outlet pointer.
void * max_jit_obex_dumpout_get (void *x)
 Retrieves the Max wrapper object's dump outlet's outlet pointer.
void max_jit_obex_dumpout (void *x, t_symbol *s, short argc, t_atom *argv)
 Sends a message and arguments out the dump outlet.
void * max_jit_obex_adornment_get (void *x, t_symbol *classname)
 Retrieves Max wrapper object adornment specified by class name.
void max_jit_obex_gimmeback (void *x, t_symbol *s, long ac, t_atom *av)
 Calls gimmeback methods and frees any return value.
void max_jit_obex_gimmeback_dumpout (void *x, t_symbol *s, long ac, t_atom *av)
 Calls gimmeback methods and outputs any return value through the Max wrapper class' dump outlet.

Function Documentation

void max_addmethod_defer ( method  m,
char *  s 
)

Adds method to Max class that calls defer rather than the method directly.

To prevent sequencing problems which arize through the use of defer, rather than defer_low, you should instead use the max_addmethod_defer_low function.

Parameters:
mmethod (function pointer)
smethod name
void max_addmethod_defer_low ( method  m,
char *  s 
)

Adds method to Max class that calls defer_low rather than the method directly.

Parameters:
mmethod (function pointer)
smethod name
void max_addmethod_usurp ( method  m,
char *  s 
)

Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.

Equivalent to max_addmethod_usurp_low function.

Parameters:
mmethod (function pointer)
smethod name
void max_addmethod_usurp_low ( method  m,
char *  s 
)

Adds method to Max class that uses the usurp mechanism to execute method at low priority without backlog.

Parameters:
mmethod (function pointer)
smethod name
void max_jit_attr_args ( void *  x,
short  ac,
t_atom av 
)

Processes attribute arguments.

Parameters:
xMax wrapper object pointer
acargument count
avargument vector
long max_jit_attr_args_offset ( short  ac,
t_atom av 
)

Determines argument offset to first attribute argument.

Parameters:
acargument count
avargument vector
Returns:
argument offset
t_jit_err max_jit_attr_get ( void *  x,
t_symbol s,
long *  ac,
t_atom **  av 
)

Retrieves attribute value.

Parameters:
xMax wrapper object pointer
sattribute name
acpointer atom count
avpointer atom vector
Returns:
t_jit_err error code
void max_jit_attr_getdump ( void *  x,
t_symbol s,
short  argc,
t_atom argv 
)

Retrieves attribute value and sends out dump outlet.

Parameters:
xMax wrapper object pointer
sattribute name
argcargument count (ignored)
argvargument vector (ignored)
void max_jit_attr_set ( void *  x,
t_symbol s,
short  ac,
t_atom av 
)

Sets attribute value.

Parameters:
xMax wrapper object pointer
sattribute name
acatom count
avatom vector
long max_jit_classex_addattr ( void *  x,
void *  attr 
)

Adds an attribute to the Max wrapper class.

Parameters:
xpointer to t_max_jit_classex data (opaque)
attrattribute object pointer
Returns:
t_jit_err error code
void * max_jit_classex_setup ( long  oboffset)

Allocates and initializes special t_max_jit_classex data, used by the Max wrapper class.

Parameters:
oboffsetobject struct byte offset to obex pointer
Returns:
pointer to t_max_jit_classex data (opaque)
void max_jit_classex_standard_wrap ( void *  mclass,
void *  jclass,
long  flags 
)

Adds standard Jitter methods, as well as public methods and attributes of the specified Jitter class.

This includes the following public methods: getattributes, getstate, summary, importattrs, exportattrs; and the following private methods: dumpout, quickref, attr_getnames, attr_get, attr_gettarget, and attrindex.

Parameters:
mclassMax wrapper class pointer
jclassjitter class pointer
flagsreserved for future use (currently ignored)
void* max_jit_obex_adornment_get ( void *  x,
t_symbol classname 
)

Retrieves Max wrapper object adornment specified by class name.

Typcially used for accessing the jit_mop adornment for MOP Max wrapper objects.

Parameters:
xMax wrapper object pointer
classnameadornment classname
Returns:
adornment pointer
t_jit_err max_jit_obex_attr_get ( void *  x,
t_symbol s,
long *  ac,
t_atom **  av 
)

Retrienves an attribute of the Max wrapper or the wrapped Jitter object.

Parameters:
xMax wrapper object pointer
sattribute name
acpointer to atom count
avpointer to atom vector
Returns:
t_jit_error error code
t_jit_err max_jit_obex_attr_set ( void *  x,
t_symbol s,
long  ac,
t_atom av 
)

Sets an attribute of the Max wrapper or the wrapped Jitter object.

Parameters:
xMax wrapper object pointer
sattribute name
acatom count
avatom vector
Returns:
t_jit_error error code
void max_jit_obex_dumpout ( void *  x,
t_symbol s,
short  argc,
t_atom argv 
)

Sends a message and arguments out the dump outlet.

This message is equivalent to calling outlet_anything with the outlet returned by max_jit_obex_dumpout_get.

Parameters:
xMax wrapper object pointer
smessage symbol
argcargument count
argvargument vector
void* max_jit_obex_dumpout_get ( void *  x)

Retrieves the Max wrapper object's dump outlet's outlet pointer.

Parameters:
xMax wrapper object pointer
Returns:
dump outlet pointer
void max_jit_obex_dumpout_set ( void *  x,
void *  outlet 
)

Sets the Max wrapper object's dump outlet's outlet pointer.

Parameters:
xMax wrapper object pointer
outletdump outlet pointer
void max_jit_obex_free ( void *  x)

Frees additional resources for the Max wrapper object instance.

Parameters:
xMax wrapper object pointer
void max_jit_obex_gimmeback ( void *  x,
t_symbol s,
long  ac,
t_atom av 
)

Calls gimmeback methods and frees any return value.

Parameters:
xMax wrapper object pointer
smethod name
acargument count
avargument vector
void max_jit_obex_gimmeback_dumpout ( void *  x,
t_symbol s,
long  ac,
t_atom av 
)

Calls gimmeback methods and outputs any return value through the Max wrapper class' dump outlet.

Parameters:
xMax wrapper object pointer
smethod name
acargument count
avargument vector
long max_jit_obex_inletnumber_get ( void *  x)

Retrieves the current inlet number used by inlet proxies.

Parameters:
xMax wrapper object pointer
Returns:
current inlet index
void max_jit_obex_inletnumber_set ( void *  x,
long  inletnumber 
)

Sets the current inlet number used by inlet proxies.

Warning:
Typically not used outside jitlib.
Parameters:
xMax wrapper object pointer
inletnumberinlet index
void* max_jit_obex_jitob_get ( void *  x)

Retrieves the wrapped Jitter object from a Max wrapper object.

Parameters:
xMax wrapper object pointer
Returns:
Jitter object pointer
void max_jit_obex_jitob_set ( void *  x,
void *  jitob 
)

Sets the wrapped Jitter object for a Max wrapper object.

Parameters:
xMax wrapper object pointer
jitobJitter object pointer
void * max_jit_obex_new ( void *  mc,
t_symbol classname 
)

Allocates an initializes a new Max wrapper object instance.

This is used in place of the newobject function.

Parameters:
mcMax class pointer
classnameJitter class name to wrap
Returns:
pointer to new Max wrapper object instance
t_jit_err max_jit_obex_proxy_new ( void *  x,
long  c 
)

Creates a new proxy inlet.

Parameters:
xMax wrapper object pointer
cinlet index
Returns:
t_jit_err error code