Jamoma API  0.6.0.a19
TTAudioObject Class Reference

Wrap audio objects for convenience. More...

#include <TTAudioObject.h>

+ Inheritance diagram for TTAudioObject:
+ Collaboration diagram for TTAudioObject:

Public Member Functions

 TTAudioObject (const TTObject &anOtherObject)
 like a copy constructor – but from TTObject to TTAudioObject
 
TTErr setSampleRate (const TTUInt32 &newSampleRate)
 Set the object's sample rate. More...
 
TTErr adaptMaxChannelCount (const TTUInt16 aNewChannelCount)
 Allocate neccessary memory and make configuration adjustments so the object is able to process additional channels of audio. More...
 
TTErr calculate (const TTFloat64 &x, TTFloat64 &y)
 Calculate a single sample of output for a single sample of input. More...
 
TTErr calculate (const TTValue &x, TTValue &y)
 Calculate a single sample of output for a single sample of input. More...
 
- Public Member Functions inherited from TTObject
 TTObject (const TTSymbol aClassName, const TTValue arguments)
 Constructor. More...
 
 TTObject (const TTSymbol aClassName)
 Constructor to create an empyt container which will be assigned/copied-to at a later point.
 
 TTObject ()
 Constructor to create an empyt container which will be assigned/copied-to at a later point.
 
 TTObject (TTObjectBase *anObjectBase)
 Special constructor to create new object that wraps an existing TTObjectBase pointer. More...
 
 TTObject (const TTObject &anObjectToCopy)
 Copy constructor.
 
virtual ~TTObject ()
 Destructor.
 
TTObjectoperator= (TTObject object)
 Assign a TTObject instance to another TTObject.
 
TTObjectBaseinstance () const
 Return a direct pointer to the internal instance. More...
 
template<class T >
TTErr set (const TTSymbol aName, T aValue)
 Set an attribute value for an object. More...
 
template<class T >
TTErr get (const TTSymbol aName, T &aReturnedValue) const
 Get an attribute value for an object. More...
 
void attributes (TTValue &returnedAttributeNames) const
 Return a list of names of the available attributes. More...
 
TTSymbol attributeType (const TTSymbol aName)
 Return the type of an attribute as a symbol. More...
 
void messages (TTValue &returnedMessageNames) const
 Return a list of names of the available messages. More...
 
TTSymbol name () const
 Return the name of this class. More...
 
TTErr send (const TTSymbol aName)
 Send a message to this object with no arguments. More...
 
TTValue send (const TTSymbol aName, const TTValue &anInputValue)
 Send a message to this object with arguments. More...
 
TTErr registerObserverForNotifications (const TTObject &anObservingObject)
 Register an observer. More...
 
TTErr unregisterObserverForNotifications (const TTObject &anObservingObject)
 Unregister an observer for notifications. More...
 
TTBoolean valid () const
 Determine if the object contained by this TTObject is truly ready for use. More...
 
void track (TTBoolean newTrackingValue)
 Enable/Disable reference count tracking of the instance. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TTObject
static TTErr GetRegisteredClassNames (TTValue &classNames)
 Query TTEnvironment for names of all registered TTObjectBase classes. More...
 
static TTErr GetRegisteredClassNamesForTags (TTValue &classNames, const TTValue &searchTags)
 Query TTEnvironment for names of all registered TTObjectBase classes that share specific tags. More...
 
static TTErr GetRegisteredTags (TTValue &tags)
 Query TTEnvironment for all registered tags used by TTObjectBase classes. More...
 

Detailed Description

Wrap audio objects for convenience.

Definition at line 155 of file TTAudioObject.h.

Member Function Documentation

TTErr TTAudioObject::adaptMaxChannelCount ( const TTUInt16  aNewChannelCount)
inline

Allocate neccessary memory and make configuration adjustments so the object is able to process additional channels of audio.

Definition at line 179 of file TTAudioObject.h.

References TTAudioObjectBase::adaptMaxNumChannels().

Referenced by TTAudioGraphObjectBase::process().

+ Here is the call graph for this function:

TTErr TTAudioObject::calculate ( const TTFloat64 x,
TTFloat64 y 
)
inline

Calculate a single sample of output for a single sample of input.

Parameters
xThe input to the function.
yThe output of the function.
Returns
TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 221 of file TTAudioObject.h.

References TTAudioObjectBase::calculate().

+ Here is the call graph for this function:

TTErr TTAudioObject::calculate ( const TTValue x,
TTValue y 
)
inline

Calculate a single sample of output for a single sample of input.

Parameters
xThe input to the function.
yThe output of the function.
Returns
TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 232 of file TTAudioObject.h.

References TTAudioObjectBase::calculate().

+ Here is the call graph for this function:

TTErr TTAudioObject::setSampleRate ( const TTUInt32 newSampleRate)
inline

Set the object's sample rate.

Definition at line 171 of file TTAudioObject.h.

References TTAudioObjectBase::setSampleRate().

Referenced by TTAudioGraphObjectBase::process().

+ Here is the call graph for this function:


The documentation for this class was generated from the following file: