StartObject

Starts an object so the Juggler will play it.

Synopsis

Err StartObject( CObject *obj, uint32 time, int32 nrep,CObject *par )

Description

This is a method macro that is part of the Juggler object-oriented toolbox. An object's method can be called explicitly through the class structure function pointer or with one of the defined method macros.

This method macro starts an object at the given time. Once an object is started, it's added to the active object list so that the Juggler will play it when the Juggler is bumped. The "nrep" argument sets an object to be played a set number of repetitions.

Arguments

obj
A pointer to the CObject data structure for the object.
time
A value indicating the time in audio clock ticks to start the object.
nrep
A value indicating the number of occurrences of the object.
par
A pointer to the CObject data structure that is the parent of this object.

Return Value

This macro returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Macro implemented in cobj.h V20.

Associated Files

cobj.h, music.lib

See Also

SetObjectInfo(), GetObjectInfo(), StopObject(), AllocObject(), FreeObject(), GetNthFromObject(), RemoveNthFromObject(), PrintObject()