Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

ArkAudioUnit Class Reference

#import <ArkAudioUnit.h>

List of all members.

Public Member Functions

(id) - initWithComponent:
(id) - initWithDescription:
(id) - initWithType:subType:manufacturer:
(id) - initWithAudioUnit:componentDesc:isInitialized:
(id) - duplicate
(Component) - audioUnit
(ComponentDescription) - audioUnitDescription
(AudioUnit) - audioUnitInstance
(NSString *) - name
(void) - setName:
(NSString *) - info
(BOOL) - isOutput
(BOOL) - isInstrument
(BOOL) - isMixer
(BOOL) - isEffect
(OSStatus) - open
(void) - close
(BOOL) - isOpen
(OSStatus) - initialize
(void) - uninitialize
(BOOL) - isInitialized
(void) - reset
(OSStatus) - setParameter:forScope:element:toValue:
(Float32) - parameter:forScope:element:
(OSStatus) - setInputParameter:element:toValue:
(Float32) - inputParameter:element:
(OSStatus) - setOutputParameter:element:toValue:
(Float32) - outputParameter:element:
(NSArray *) - parameterList
(OSStatus) - getParameterInfo:forScope:infoStruct:
(OSStatus) - setProperty:forScope:element:toValue:size:
(OSStatus) - setProperty:forScope:element:toUInt32Value:
(OSStatus) - setProperty:forScope:element:toFloat32Value:
(OSStatus) - setProperty:forScope:element:toFloat64Value:
(OSStatus) - getProperty:forScope:element:buffer:
(UInt32) - UInt32Property:forScope:element:
(Float32) - Float32Property:forScope:element:
(Float64) - Float64Property:forScope:element:
(UInt32) - propertySize:forScope:element:
(BOOL) - isPropertyWritable:forScope:element:
(OSStatus) - setBypassing:
(BOOL) - isBypassing
(Float64) - latency
(Float64) - tailTime
(OSStatus) - setBusCount:forScope:
(UInt32) - busCountForScope:
(BOOL) - isBusCountWritableForScope:
(OSStatus) - setStreamFormat:forScope:bus:
(OSStatus) - getStreamFormatForScope:bus:formatDescription:
(Float64) - sampleRateForScope:bus:
(AUChannelInfo) - supportedChannels
(OSStatus) - setMaxCPULoad:
(Float32) - maxCPULoad
(OSStatus) - setRenderQuality:
(UInt32) - renderQuality
(OSStatus) - setHostCallback:
(OSStatus) - setMaxFramesPerSlice:
(UInt32) - maxFramesPerSlice
(OSStatus) - setExternalBuffer:
(OSStatus) - useDefaultBuffer
(OSStatus) - setRenderCallback:forElement:withRefCon:
(BOOL) - hasRenderCallback
(OSStatus) - removeRenderCallbackForElement:
(NSArray *) - presets
(OSStatus) - selectPreset:
(OSStatus) - selectPresetAtIndex:
(OSStatus) - savePreset:toFile:
(NSDictionary *) - savePreset:
(OSStatus) - loadPresetFromFile:
(OSStatus) - loadPresetFromDictionary:
(OSStatus) - registerResult:
(OSStatus) - lastResult
(NSError *) - lastError
(OSStatus) - lastRenderError:

Static Public Member Functions

(ArkAudioUnit *) + audioUnitWithComponent:
(ArkAudioUnit *) + audioUnitWithDescription:
(ArkAudioUnit *) + audioUnitWithType:subType:manufacturer:

Public Attributes

NSMutableDictionary * additions

Protected Attributes

ComponentDescription _auDesc
Component _component
AudioUnit _audioUnit
NSString * _ident
NSString * _name
NSString * _info
NSArray * _presets
BOOL _isOpen
BOOL _initialized
BOOL _hasRenderCallback
OSStatus _lastResult
OSStatus _lastError

Member Function Documentation

- (Component) audioUnit  
 

- (ComponentDescription) audioUnitDescription  
 

- (AudioUnit) audioUnitInstance  
 

+ (ArkAudioUnit *) audioUnitWithComponent: (Component)  au  
 

+ (ArkAudioUnit *) audioUnitWithDescription: (ComponentDescription)  desc  
 

+ (ArkAudioUnit *) audioUnitWithType: (OSType)  type
subType: (OSType)  subtype
manufacturer: (OSType)  man
 
 

- (UInt32) busCountForScope: (AudioUnitScope)  scope  
 

- (void) close  
 

close

Note:
AudioUnits are automatically closed on destruction, if you wish to close but not discard an AudioUnit, consider -uninitialize instead.

- (id) duplicate  
 

duplicate Returns a copy of this AudioUnit, including state. This is a non-NSCopying method to avoid accidental copying (in NSCell for instance), which could be very expensive.

Returns:
A copy of self

- (Float32) Float32Property: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
 
 

- (Float64) Float64Property: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
 
 

- (OSStatus) getParameterInfo: (AudioUnitParameterID)  paramID
forScope: (AudioUnitScope)  scope
infoStruct: (AudioUnitParameterInfo *)  pinfo
 
 

parameterInfo:forScope: 

                struct AudioUnitParameterInfo {
                        char                    name[60];
                        CFStringRef             cfNameString;
                        AudioUnitParameterUnit  unit;
                        Float32                 minValue;
                        Float32                 maxValue;
                        Float32                 defaultValue;
                        UInt32                  flags;
                };

- (OSStatus) getProperty: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
buffer: (void *)  buf
 
 

- (OSStatus) getStreamFormatForScope: (AudioUnitScope)  scope
bus: (AudioUnitElement)  busNum
formatDescription: (AudioStreamBasicDescription *)  desc
 
 

- (BOOL) hasRenderCallback  
 

- (NSString *) info  
 

info Returns an information string, generally useful for debugging.

- (OSStatus) initialize  
 

- (id) initWithAudioUnit: (AudioUnit)  au
componentDesc: (ComponentDescription)  compDesc
isInitialized: (BOOL)  inited
 
 

- (id) initWithComponent: (Component)  au  
 

- (id) initWithDescription: (ComponentDescription)  desc  
 

- (id) initWithType: (OSType)  type
subType: (OSType)  subtype
manufacturer: (OSType)  man
 
 

- (Float32) inputParameter: (AudioUnitParameterID)  param
element: (AudioUnitElement)  elem
 
 

- (BOOL) isBusCountWritableForScope: (AudioUnitScope)  scope  
 

- (BOOL) isBypassing  
 

- (BOOL) isEffect  
 

- (BOOL) isInitialized  
 

- (BOOL) isInstrument  
 

- (BOOL) isMixer  
 

- (BOOL) isOpen  
 

- (BOOL) isOutput  
 

- (BOOL) isPropertyWritable: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
 
 

- (NSError *) lastError  
 

- (OSStatus) lastRenderError: (OSStatus *)  res  
 

- (OSStatus) lastResult  
 

- (Float64) latency  
 

- (OSStatus) loadPresetFromDictionary: (NSDictionary *)  dictionary  
 

- (OSStatus) loadPresetFromFile: (NSString *)  filePath  
 

- (Float32) maxCPULoad  
 

- (UInt32) maxFramesPerSlice  
 

- (NSString *) name  
 

- (OSStatus) open  
 

open

Note:
AudioUnits are opened, but not initialized by default.
Returns:
noErr if successful

- (Float32) outputParameter: (AudioUnitParameterID)  param
element: (AudioUnitElement)  elem
 
 

- (Float32) parameter: (AudioUnitParameterID)  param
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
 
 

- (NSArray *) parameterList  
 

parameterList

Returns:
An array of NSNumbers. Cast from intValue to AudioUnitParameterID.

- (NSArray *) presets  
 

- (UInt32) propertySize: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
 
 

- (OSStatus) registerResult: (OSStatus)  err  
 

- (OSStatus) removeRenderCallbackForElement: (AudioUnitElement)  elem  
 

- (UInt32) renderQuality  
 

renderQuality Range for renderQuality is 0-127.

- (void) reset  
 

- (Float64) sampleRateForScope: (AudioUnitScope)  scope
bus: (AudioUnitElement)  busNum
 
 

- (NSDictionary *) savePreset: (NSString *)  name  
 

- (OSStatus) savePreset: (NSString *)  name
toFile: (NSString *)  filePath
 
 

- (OSStatus) selectPreset: (AUPreset)  preset  
 

- (OSStatus) selectPresetAtIndex: (unsigned int)  index  
 

- (OSStatus) setBusCount: (UInt32)  busCount
forScope: (AudioUnitScope)  scope
 
 

- (OSStatus) setBypassing: (BOOL)  bypass  
 

- (OSStatus) setExternalBuffer: (AudioUnitExternalBuffer)  buff  
 

setExternalBuffer: 

                struct AudioUnitExternalBuffer {
                        Byte *  buffer;
                        UInt32  size;
                };

- (OSStatus) setHostCallback: (HostCallbackInfo)  info  
 

setHostCallback: 

                struct HostCallbackInfo {
                        void *                                                          hostUserData;   // MUST be non-null
                        HostCallback_GetBeatAndTempo                    beatAndTempoProc;
                        HostCallback_GetMusicalTimeLocation   musicalTimeLocationProc;
                };
   
                typedef OSStatus (*HostCallback_GetBeatAndTempo)(
                        void *     inHostUserData,
                        Float64 *  outCurrentBeat,
                        Float64 *  outCurrentTempo);
   
                typedef OSStatus (*HostCallback_GetMusicalTimeLocation)(
                        void *     inHostUserData,
                        UInt32 *   outDeltaSampleOffsetToNextBeat,
                        Float32 *  outTimeSig_Numerator,
                        UInt32 *   outTimeSig_Denominator,
                        Float64 *  outCurrentMeasureDownBeat);

- (OSStatus) setInputParameter: (AudioUnitParameterID)  param
element: (AudioUnitElement)  elem
toValue: (Float32)  val
 
 

- (OSStatus) setMaxCPULoad: (Float32)  load  
 

- (OSStatus) setMaxFramesPerSlice: (UInt32)  maxFrames  
 

- (void) setName: (NSString *)  newName  
 

- (OSStatus) setOutputParameter: (AudioUnitParameterID)  param
element: (AudioUnitElement)  elem
toValue: (Float32)  val
 
 

- (OSStatus) setParameter: (AudioUnitParameterID)  param
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
toValue: (Float32)  val
 
 

- (OSStatus) setProperty: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
toFloat32Value: (Float32)  val
 
 

- (OSStatus) setProperty: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
toFloat64Value: (Float64)  val
 
 

- (OSStatus) setProperty: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
toUInt32Value: (UInt32)  val
 
 

- (OSStatus) setProperty: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
toValue: (void *)  val
size: (UInt32)  size
 
 

Properties

- (OSStatus) setRenderCallback: (AURenderCallback)  callback
forElement: (AudioUnitElement)  elem
withRefCon: (void *)  refCon
 
 

setRenderCallback:withRefCon: 

                OSStatus renderCallback (
                        void                                                    *inRefCon, 
                        AudioUnitRenderActionFlags      *ioActionFlags,
                        const AudioTimeStamp            *inTimeStamp, 
                        UInt32                          inBusNumber,
                        UInt32                          inNumFrames, 
                        AudioBufferList                 *ioData)

- (OSStatus) setRenderQuality: (UInt32)  renderQuality  
 

setRenderQuality: Range for renderQuality is 0-127.

- (OSStatus) setStreamFormat: (AudioStreamBasicDescription *)  desc
forScope: (AudioUnitScope)  scope
bus: (AudioUnitElement)  busNum
 
 

- (AUChannelInfo) supportedChannels  
 

supportedChannels 

                struct AUChannelInfo {
                        SInt16 inChannels;  // kAudioUnitScope_Input
                        SInt16 outChannels; // kAudioUnitScope_Output
                };

- (Float64) tailTime  
 

- (UInt32) UInt32Property: (AudioUnitPropertyID)  prop
forScope: (AudioUnitScope)  scope
element: (AudioUnitElement)  elem
 
 

- (void) uninitialize  
 

- (OSStatus) useDefaultBuffer  
 

Member Data Documentation

- (ComponentDescription) _auDesc [protected]
 

- (AudioUnit) _audioUnit [protected]
 

- (Component) _component [protected]
 

- (BOOL) _hasRenderCallback [protected]
 

- (NSString*) _ident [protected]
 

- (NSString*) _info [protected]
 

- (BOOL) _initialized [protected]
 

- (BOOL) _isOpen [protected]
 

- (OSStatus) _lastError [protected]
 

- (OSStatus) _lastResult [protected]
 

- (NSString*) _name [protected]
 

- (NSArray*) _presets [protected]
 

- (NSMutableDictionary*) additions
 

The documentation for this class was generated from the following files:
Generated on Tue Sep 6 14:54:37 2005 for Arkonnekt Sound by  doxygen 1.4.4