apple.audiotoolbox

Class AUParameterNode

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.audiotoolbox.AUParameterNode

All Implemented Interfaces:

NSObject

Direct Known Subclasses:

AUParameter, AUParameterGroup

public class AUParameterNode
extends NSObject

AUParameterNode

A node in an audio unit's tree of parameters.

Nodes are instances of either AUParameterGroup or AUParameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AUParameterNode.Block_implementorDisplayNameWithLengthCallback_ret
static interface	AUParameterNode.Block_implementorStringFromValueCallback_ret
static interface	AUParameterNode.Block_implementorValueFromStringCallback_ret
static interface	AUParameterNode.Block_implementorValueObserver_ret
static interface	AUParameterNode.Block_implementorValueProvider_ret
static interface	AUParameterNode.Block_setImplementorDisplayNameWithLengthCallback
static interface	AUParameterNode.Block_setImplementorStringFromValueCallback
static interface	AUParameterNode.Block_setImplementorValueFromStringCallback
static interface	AUParameterNode.Block_setImplementorValueObserver
static interface	AUParameterNode.Block_setImplementorValueProvider
static interface	AUParameterNode.Block_tokenByAddingParameterAutomationObserver
static interface	AUParameterNode.Block_tokenByAddingParameterObserver
static interface	AUParameterNode.Block_tokenByAddingParameterRecordingObserver

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AUParameterNode(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static AUParameterNode	alloc()
static AUParameterNode	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
java.lang.String	displayName() [@property] displayName
java.lang.String	displayNameWithLength(long maximumLength) displayNameWithLength:
static long	hash_static()
java.lang.String	identifier() [@property] identifier
AUParameterNode.Block_implementorDisplayNameWithLengthCallback_ret	implementorDisplayNameWithLengthCallback() Called to obtain an abbreviated version of a parameter or group name.
AUParameterNode.Block_implementorStringFromValueCallback_ret	implementorStringFromValueCallback() Called to provide string representations of parameter values.
AUParameterNode.Block_implementorValueFromStringCallback_ret	implementorValueFromStringCallback() Called to convert string to numeric representations of parameter values.
AUParameterNode.Block_implementorValueObserver_ret	implementorValueObserver() Called when a parameter changes value.
AUParameterNode.Block_implementorValueProvider_ret	implementorValueProvider() Called when a value of a parameter in the tree is known to have a stale value needing to be refreshed.
AUParameterNode	init()
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
java.lang.String	keyPath() [@property] keyPath
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
static AUParameterNode	new_objc()
void	removeParameterObserver(org.moe.natj.general.ptr.VoidPtr token) removeParameterObserver:
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setImplementorDisplayNameWithLengthCallback(AUParameterNode.Block_setImplementorDisplayNameWithLengthCallback value) Called to obtain an abbreviated version of a parameter or group name.
void	setImplementorStringFromValueCallback(AUParameterNode.Block_setImplementorStringFromValueCallback value) Called to provide string representations of parameter values.
void	setImplementorValueFromStringCallback(AUParameterNode.Block_setImplementorValueFromStringCallback value) Called to convert string to numeric representations of parameter values.
void	setImplementorValueObserver(AUParameterNode.Block_setImplementorValueObserver value) Called when a parameter changes value.
void	setImplementorValueProvider(AUParameterNode.Block_setImplementorValueProvider value) Called when a value of a parameter in the tree is known to have a stale value needing to be refreshed.
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
org.moe.natj.general.ptr.VoidPtr	tokenByAddingParameterAutomationObserver(AUParameterNode.Block_tokenByAddingParameterAutomationObserver observer) tokenByAddingParameterAutomationObserver:
org.moe.natj.general.ptr.VoidPtr	tokenByAddingParameterObserver(AUParameterNode.Block_tokenByAddingParameterObserver observer) tokenByAddingParameterObserver:
org.moe.natj.general.ptr.VoidPtr	tokenByAddingParameterRecordingObserver(AUParameterNode.Block_tokenByAddingParameterRecordingObserver observer) tokenByAddingParameterRecordingObserver:
static long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AUParameterNode

protected AUParameterNode(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static AUParameterNode alloc()

allocWithZone

public static AUParameterNode allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static AUParameterNode new_objc()

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

version_static

public static long version_static()

displayName

public java.lang.String displayName()

[@property] displayName

A localized name to display for the parameter.

displayNameWithLength

public java.lang.String displayNameWithLength(long maximumLength)

displayNameWithLength:

A version of displayName possibly abbreviated to the given desired length, in characters.

The default implementation simply returns displayName.

identifier

public java.lang.String identifier()

[@property] identifier

A non-localized, permanent name for a parameter or group.

The identifier must be unique for all child nodes under any given parent. From release to release, an audio unit must not change its parameters' identifiers; this will invalidate any hosts' documents that refer to the parameters.

implementorDisplayNameWithLengthCallback

public AUParameterNode.Block_implementorDisplayNameWithLengthCallback_ret implementorDisplayNameWithLengthCallback()

Called to obtain an abbreviated version of a parameter or group name.

implementorStringFromValueCallback

public AUParameterNode.Block_implementorStringFromValueCallback_ret implementorStringFromValueCallback()

Called to provide string representations of parameter values. If value is nil, the callback uses the current value of the parameter.

implementorValueFromStringCallback

public AUParameterNode.Block_implementorValueFromStringCallback_ret implementorValueFromStringCallback()

Called to convert string to numeric representations of parameter values.

implementorValueObserver

public AUParameterNode.Block_implementorValueObserver_ret implementorValueObserver()

Called when a parameter changes value.

This block, used only in an audio unit implementation, receives all externally-generated changes to parameter values. It should store the new value in its audio signal processing state (assuming that that state is separate from the AUParameter object).

implementorValueProvider

public AUParameterNode.Block_implementorValueProvider_ret implementorValueProvider()

Called when a value of a parameter in the tree is known to have a stale value needing to be refreshed.

The audio unit should return the current value for this parameter; the AUParameterNode will store the value.

init

public AUParameterNode init()

Overrides:

init in class NSObject

keyPath

public java.lang.String keyPath()

[@property] keyPath

Generated by concatenating the identifiers of a node's parents with its own.

Unless an audio unit specifically documents that its parameter addresses are stable and persistent, hosts, when recording parameter values, should bind to the keyPath.

The individual node identifiers in a key path are separated by periods. (".")

Passing a node's keyPath to -[tree valueForKeyPath:] should return the same node.

removeParameterObserver

public void removeParameterObserver(org.moe.natj.general.ptr.VoidPtr token)

removeParameterObserver:

Remove an observer created with tokenByAddingParameterObserver, tokenByAddingParameterRecordingObserver, or tokenByAddingParameterAutomationObserver.

This call will remove the callback corresponding to the supplied token. Note that this will block until any callbacks currently in flight have completed.

setImplementorDisplayNameWithLengthCallback

public void setImplementorDisplayNameWithLengthCallback(AUParameterNode.Block_setImplementorDisplayNameWithLengthCallback value)

Called to obtain an abbreviated version of a parameter or group name.

setImplementorStringFromValueCallback

public void setImplementorStringFromValueCallback(AUParameterNode.Block_setImplementorStringFromValueCallback value)

Called to provide string representations of parameter values. If value is nil, the callback uses the current value of the parameter.

setImplementorValueFromStringCallback

public void setImplementorValueFromStringCallback(AUParameterNode.Block_setImplementorValueFromStringCallback value)

Called to convert string to numeric representations of parameter values.

setImplementorValueObserver

public void setImplementorValueObserver(AUParameterNode.Block_setImplementorValueObserver value)

Called when a parameter changes value.

This block, used only in an audio unit implementation, receives all externally-generated changes to parameter values. It should store the new value in its audio signal processing state (assuming that that state is separate from the AUParameter object).

setImplementorValueProvider

public void setImplementorValueProvider(AUParameterNode.Block_setImplementorValueProvider value)

Called when a value of a parameter in the tree is known to have a stale value needing to be refreshed.

The audio unit should return the current value for this parameter; the AUParameterNode will store the value.

tokenByAddingParameterAutomationObserver

public org.moe.natj.general.ptr.VoidPtr tokenByAddingParameterAutomationObserver(AUParameterNode.Block_tokenByAddingParameterAutomationObserver observer)

tokenByAddingParameterAutomationObserver:

Add a recording observer for a parameter or all parameters in a group/tree.

An audio unit host can use an AUParameterAutomationObserver or AUParameterRecordingObserver to capture a series of changes to a parameter value, including the timing of the events, as generated by a UI gesture in a view, for example.

Unlike AUParameterObserver, these callbacks are not throttled.

This block is called in an arbitrary thread context. It is responsible for thread-safety. It must not make any calls to add or remove other observers, including itself; this will deadlock.

An audio unit's engine should interact with the parameter object via implementorValueObserver and implementorValueProvider.

Parameters:

observer - A block to call to record the changing of a parameter value.

Returns:

A token which can be passed to removeParameterObserver: or to -[AUParameter setValue:originator:]

tokenByAddingParameterObserver

public org.moe.natj.general.ptr.VoidPtr tokenByAddingParameterObserver(AUParameterNode.Block_tokenByAddingParameterObserver observer)

tokenByAddingParameterObserver:

Add an observer for a parameter or all parameters in a group/tree.

An audio unit view can use an AUParameterObserver to be notified of changes to a single parameter, or to all parameters in a group/tree.

These callbacks are throttled so as to limit the rate of redundant notifications in the case of frequent changes to a single parameter.

This block is called in an arbitrary thread context. It is responsible for thread-safety. It must not make any calls to add or remove other observers, including itself; this will deadlock.

An audio unit's implementation should interact with the parameter object via implementorValueObserver and implementorValueProvider.

Parameter observers are bound to a specific parameter instance. If this parameter is destroyed, e.g. if the parameter tree is re-constructed, the previously set parameter observers will no longer be valid. Clients can observe changes to the parameter tree via KVO. See the discussion of -[AUAudioUnit parameterTree].

Parameters:

observer - A block to call after the value of a parameter has changed.

Returns:

A token which can be passed to removeParameterObserver: or to -[AUParameter setValue:originator:]

tokenByAddingParameterRecordingObserver

public org.moe.natj.general.ptr.VoidPtr tokenByAddingParameterRecordingObserver(AUParameterNode.Block_tokenByAddingParameterRecordingObserver observer)

tokenByAddingParameterRecordingObserver:

Add a recording observer for a parameter or all parameters in a group/tree.

This is a variant of tokenByAddingParameterAutomationObserver where the callback receives AURecordedParameterEvents instead of AUParameterAutomationEvents.

This will be deprecated in favor of tokenByAddingParameterAutomationObserver in a future release.