Package apple.audiotoolbox

Class 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. API-Since: 9.0

    • Constructor Detail

      • AUParameterNode

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

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

      • classFallbacksForKeyedArchiver

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

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull 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()

      • 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

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

      • 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

        @NotNull
public @NotNull java.lang.String displayName()
        [@property] displayName A localized name to display for the parameter.

      • displayNameWithLength

        @NotNull
public @NotNull 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

        @NotNull
public @NotNull 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.

      • implementorValueObserver

        @NotNull
public @NotNull 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

        @NotNull
public @NotNull 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.

      • keyPath

        @NotNull
public @NotNull 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​(@NotNull
                                    @NotNull 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.

      • setImplementorStringFromValueCallback

        public void setImplementorStringFromValueCallback​(@NotNull
                                                  @NotNull 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.

      • setImplementorValueObserver

        public void setImplementorValueObserver​(@NotNull
                                        @NotNull 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​(@NotNull
                                        @NotNull 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

        @NotNull
public @NotNull org.moe.natj.general.ptr.VoidPtr tokenByAddingParameterAutomationObserver​(@NotNull
                                                                                          @NotNull 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:] API-Since: 10.0

      • tokenByAddingParameterObserver

        @NotNull
public @NotNull org.moe.natj.general.ptr.VoidPtr tokenByAddingParameterObserver​(@NotNull
                                                                                @NotNull 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

        @NotNull
public @NotNull org.moe.natj.general.ptr.VoidPtr tokenByAddingParameterRecordingObserver​(@NotNull
                                                                                         @NotNull 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.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.