Jamoma API  0.6.0.a19

Various enumerations used in Jamoma. More...

+ Collaboration diagram for Enumerations:

Enumerations

enum  TTOscSocketConnectionFlag {
  kOscSocketConnectionTrying = 0,
  kOscSocketConnectionSucceeded = 1,
  kOscSocketConnectionFailed = 2
}
 Connection flag used to know if the OSC socket manage to connect to a port. More...
 
enum  TTAddressComparisonFlag {
  kAddressLower = -1,
  kAddressDifferent = 0,
  kAddressEqual = 1,
  kAddressUpper = 2
}
 Comparison flags between address returned by address1->compare(address2). More...
 
enum  TTAddressNotificationFlag {
  kAddressDestroyed = 0,
  kAddressCreated = 1
}
 Notification flags to notify observers of a directory. More...
 
enum  TTAddressType {
  kAddressRelative = 0,
  kAddressAbsolute = 1
}
 Type flags to state about absolute or relative address. More...
 
enum  TTDataType { ,
  kTypeFloat32,
  kTypeFloat64,
  kTypeInt8,
  kTypeUInt8,
  kTypeInt16,
  kTypeUInt16,
  kTypeInt32,
  kTypeUInt32,
  kTypeInt64,
  kTypeUInt64,
  kTypeBoolean,
  kTypeSymbol,
  kTypeObject,
  kTypePointer,
  kTypeString,
  kTypeLocalValue,
  kTypeMatrix,
  kTypeDictionary,
  kTypeError
}
 TTBlue Data Types Enumeration of data types used through out TTBlue, including the TTValue class and declaring the types of TTAttribute objects. More...
 
enum  TTErr {
  kTTErrNone = 0,
  kTTErrGeneric,
  kTTErrAllocFailed,
  kTTErrFreeFailed,
  kTTErrInvalidType,
  kTTErrInvalidAttribute,
  kTTErrInvalidValue,
  kTTErrWrongNumValues,
  kTTErrMethodNotFound,
  kTTErrValueNotFound,
  kTTErrBadChannelConfig,
  kTTErrReadOnly,
  kTTErrOutOfBounds,
  kTTErrInstantiateFailed,
  kTTErrInvalidFilepath
}
 Jamoma Error Codes Enumeration of error codes that might be returned by any of the TTBlue functions and methods. More...
 
enum  TTMessageFlags {
  kTTMessageDefaultFlags = 0,
  kTTMessagePassNone = 1,
  kTTMessagePassValue = 2,
  kTTMessagePassNameAndValue = 4
}
 Flags that determine the behavior of messages. More...
 
enum  TTAttributeFlags {
  kTTAttrDefaultFlags = 0,
  kTTAttrPassValueOnly = 1,
  kTTAttrPassObject = 2
}
 Flags that determine the behavior of messages. More...
 
enum  TTAudioGraphProcessStatus {
  kTTAudioGraphProcessUnknown = 0,
  kTTAudioGraphProcessNotStarted,
  kTTAudioGraphProcessingCurrently,
  kTTAudioGraphProcessComplete
}
 [doxygenAppendixC_enumExample] More...
 
enum  TTAudioGraphDescriptionStatus {
  kTTAudioGraphDescriptionUnknown = 0,
  kTTAudioGraphDescriptionNotStarted,
  kTTAudioGraphDescriptionHasStarted
}
 [doxygenAppendixC_enumExample] More...
 

Detailed Description

Various enumerations used in Jamoma.

Enumeration Type Documentation

Comparison flags between address returned by address1->compare(address2).

The comparison function doesn't compare attribute part.

Enumerator
kAddressLower 

this flag means that address1 refers to a node at a lower level than address2 in the tree structure

kAddressDifferent 

this flag means that address1 an address2 refer to nodes which are in a different branch in the tree structure

kAddressEqual 

this flag means that address1 an address2 refer to the same node in the tree structure

kAddressUpper 

this flag means that address1 refers to a node at a upper level than address2 in the tree structure

Definition at line 45 of file TTAddressBase.h.

Notification flags to notify observers of a directory.

Enumerator
kAddressDestroyed 

this flag means that a TTNode have been destroyed in the tree structure

kAddressCreated 

this flag means that a TTNode have been created in the tree structure

Definition at line 55 of file TTAddressBase.h.

Type flags to state about absolute or relative address.

Enumerator
kAddressRelative 

this flag means that an address have no leading slash

kAddressAbsolute 

this flag means that an address have a leading slash

Definition at line 63 of file TTAddressBase.h.

Flags that determine the behavior of messages.

Enumerator
kTTAttrDefaultFlags 

The default set of flags will be used if this is specified. At this time the default is kTTAttrPassValueOnly.

kTTAttrPassValueOnly 

Attribute accessors will only be passed a reference to the attribute's value.

kTTAttrPassObject 

Attribute accessors will first be passed a reference to the TTAttribute object, then it will be passed a reference to the attribute's value.

Definition at line 94 of file TTObjectBase.h.

[doxygenAppendixC_enumExample]

Enumeration recording the state of each node when the graph is asked to describe itself.

Enumerator
kTTAudioGraphDescriptionUnknown 

The current status of the node is unknown with respect to describing itself as a member of a graph.

kTTAudioGraphDescriptionNotStarted 

The process of describing this node in the graph has not yet begun.

kTTAudioGraphDescriptionHasStarted 

The process of describing this node in the graph has begun.

Definition at line 59 of file TTAudioGraph.h.

[doxygenAppendixC_enumExample]

Enumeration recording the audio processing state of each node of the graph.

Enumerator
kTTAudioGraphProcessUnknown 

The current processing status of the node is unknown.

kTTAudioGraphProcessNotStarted 

Audio processing has not yet started for this node.

kTTAudioGraphProcessingCurrently 

This node is currently processing audio.

kTTAudioGraphProcessComplete 

This node has completed processing audio for now.

Definition at line 48 of file TTAudioGraph.h.

enum TTDataType

TTBlue Data Types Enumeration of data types used through out TTBlue, including the TTValue class and declaring the types of TTAttribute objects.

Enumerator
kTypeFloat32 

32-bit floating point

kTypeFloat64 

64-bit floating point

kTypeInt8 

8-bit signed integer, range is -128 through 127.

kTypeUInt8 

8-bit unsigned integer, range is 0 through 255.

kTypeInt16 

16-bit signed integer, range is −32,768 through 32,767.

kTypeUInt16 

16-bit unsigned integer, range is 0 through 65,535.

kTypeInt32 

32-bit signed integer, range is -2,147,483,648 through 2,147,483,647.

kTypeUInt32 

32-bit unsigned integer, range is 0 through 4,294,967,295.

kTypeInt64 

64-bit signed integer, ragne is −9,223,372,036,854,775,808 through 9,223,372,036,854,775,807

kTypeUInt64 

64-bit unsigned integer, range is 0 through 18,446,744,073,709,551,615.

kTypeBoolean 

Boolean (1/0) or (true/false) flag.

kTypeSymbol 

Symbol type.

kTypeObject 

Object type.

kTypePointer 

Pointer type.

kTypeString 

String type.

kTypeLocalValue 

This is a special type used by TTAttribute to indicate that a value is a TTValue and is locally maintained.

kTypeMatrix 

An instance of a TTMatrix object.

kTypeDictionary 

Dictionary type.

kTypeError 

An error represented by TTErr.

Definition at line 269 of file TTBase.h.

enum TTErr

Jamoma Error Codes Enumeration of error codes that might be returned by any of the TTBlue functions and methods.

Enumerator
kTTErrNone 

No Error.

kTTErrGeneric 

Something went wrong, but what exactly is not known. Typically used for context-specific problems.

kTTErrAllocFailed 

Couldn't get memory.

kTTErrFreeFailed 

Couldn't free memory.

kTTErrInvalidType 

Bad DataType for the context.

kTTErrInvalidAttribute 

Bad Attribute specified.

kTTErrInvalidValue 

An inappropriate value was specified for an attribute or variable.

kTTErrWrongNumValues 

The wrong number of values were passed to a method or attribute.

kTTErrMethodNotFound 

Method not found. Typically returned by the TTObject::sendMessage() function.

kTTErrValueNotFound 

A value was not found when doing a look up for it (in a TTHash, TTList, or other class).

kTTErrBadChannelConfig 

An invalid number of audio channels for a given context was encountered.

kTTErrReadOnly 

Attempted a write to a read-only entity.

kTTErrOutOfBounds 

Attempted to access memory outside a matrix or array (in a TTMatrix & TTSampleMatrix).

kTTErrInstantiateFailed 

Couldn't instantiate the Jamoma object requested.

kTTErrInvalidFilepath 

Couldn't resolve the filepath as submitted.

Definition at line 342 of file TTBase.h.

Flags that determine the behavior of messages.

Enumerator
kTTMessageDefaultFlags 

The default set of flags will be used if this is specified. At this time the default is #kTTMethodPassValue.

kTTMessagePassNone 

Set this flag if the method you are binding to this message is prototyped to accept no arguments.

kTTMessagePassValue 

Set this flag if the method you are binding to this message is prototyped with a single TTValue& argument.

kTTMessagePassNameAndValue 

Set this flag if the method you are binding to this message is prototyped with two arguments: a const TTSymbol and a TTValue&.

Definition at line 84 of file TTObjectBase.h.

Connection flag used to know if the OSC socket manage to connect to a port.

Enumerator
kOscSocketConnectionTrying 

this flag means the OSC socket is trying to connect

kOscSocketConnectionSucceeded 

this flag means the OSC socket connection succeeded

kOscSocketConnectionFailed 

this flag means the OSC socket failed to connect

Definition at line 31 of file TTOscSocket.h.