PHASEDucker (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.phase.PHASEDucker

All Implemented Interfaces:

NSObject
```
public class PHASEDucker
extends NSObject
```
[@interface] PHASEDucker
A PHASEDucker is used to describe ducking behavior across different groups.

Nested Class Summary
- Nested classes/interfaces inherited from class apple.NSObject
  NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors
Modifier Constructor and Description

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

Constructors
Modifier	Constructor and Description
`protected`	`PHASEDucker(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`accessInstanceVariablesDirectly()`
`void`	`activate()` activate
`static PHASEDucker`	`alloc()`
`static PHASEDucker`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`long`	`attackCurve()` [@property] attackCurve
`double`	`attackTime()` [@property] attackTime
`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()`
`void`	`deactivate()` deactivate
`static java.lang.String`	`debugDescription_static()`
`static java.lang.String`	`description_static()`
`double`	`gain()` [@property] gain
`static long`	`hash_static()`
`java.lang.String`	`identifier()` [@property] identifier
`PHASEDucker`	`init()`
`PHASEDucker`	`initWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve(PHASEEngine engine, NSSet<? extends PHASEGroup> sourceGroups, NSSet<? extends PHASEGroup> targetGroups, double gain, double attackTime, double releaseTime, long attackCurve, long releaseCurve)` initWithSourceGroups:targetGroups:attenuation:attackTime:releaseTime:
`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)`
`boolean`	`isActive()` [@property] active
`static boolean`	`isSubclassOfClass(org.moe.natj.objc.Class aClass)`
`static NSSet<java.lang.String>`	`keyPathsForValuesAffectingValueForKey(java.lang.String key)`
`static PHASEDucker`	`new_objc()`
`long`	`releaseCurve()` [@property] releaseCurve
`double`	`releaseTime()` [@property] releaseTime
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`static void`	`setVersion_static(long aVersion)`
`NSSet<? extends PHASEGroup>`	`sourceGroups()` [@property] sourceGroups
`static org.moe.natj.objc.Class`	`superclass_static()`
`NSSet<? extends PHASEGroup>`	`targetGroups()` [@property] targetGroups
`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
  - PHASEDucker
```
protected PHASEDucker(org.moe.natj.general.Pointer peer)
```
- Method Detail
  - accessInstanceVariablesDirectly
```
public static boolean accessInstanceVariablesDirectly()
```
  - activate
```
public void activate()
```
    activate
    Activates the ducker
  - alloc
```
public static PHASEDucker alloc()
```
  - allocWithZone
```
public static PHASEDucker allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
```
  - attackCurve
```
public long attackCurve()
```
    [@property] attackCurve
    The type of curve function to use during the attack phase of gain reduction.
  - attackTime
```
public double attackTime()
```
    [@property] attackTime
    The time for the attenuation gain to ramp into effect. [@note] The attack time is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.
  - 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()
```
  - deactivate
```
public void deactivate()
```
    deactivate
    Deactivates the ducker
  - debugDescription_static
```
public static java.lang.String debugDescription_static()
```
  - description_static
```
public static java.lang.String description_static()
```
  - gain
```
public double gain()
```
    [@property] gain
    Linear gain scalar. [@note] Values are clamped to the range [0, 1]. Default value is 1.
  - hash_static
```
public static long hash_static()
```
  - identifier
```
public java.lang.String identifier()
```
    [@property] identifier
    The identifier that uniquely represents this ducker.
  - init
```
public PHASEDucker init()
```
    Overrides:
    
    init in class NSObject
  - initWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve
```
public PHASEDucker initWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve(PHASEEngine engine,
                                                                                                          NSSet<? extends PHASEGroup> sourceGroups,
                                                                                                          NSSet<? extends PHASEGroup> targetGroups,
                                                                                                          double gain,
                                                                                                          double attackTime,
                                                                                                          double releaseTime,
                                                                                                          long attackCurve,
                                                                                                          long releaseCurve)
```
    initWithSourceGroups:targetGroups:attenuation:attackTime:releaseTime:
    Whenever a generator node from any source group plays, all the generator nodes in the target groups will be ducked by the given gain using the given attack and release times. [@note] The ducker is initialially inactive. The client must call activate() to make it active. Once a ducker is active, it will listen for generator nodes to start playback in source groups. Once triggered, it will duck its target groups. Deactivating a ducker will make it stop listening. Furthermore, it will enter the release phase if it has been previously triggered. Dealloc'ing a ducker will force the ducker into its release phase if it is actively ducking and remove it from the system when it finishes.
    
    Parameters:
    
    engine - The engine to register this ducker with.
    
    sourceGroups - The source groups that will trigger the ducker when a sound in one of the source groups starts playback.
    
    targetGroups - The target groups that will be ducked when a sound in one of the source groups triggers the ducker.
    
    gain - The linear gain scalar to apply when the ducker is engaged. 0 means full attenuation. 1 is no attenuation. Values are clamped to the range [0, 1].
    
    attackTime - The time for the attenuation gain to ramp into effect. This value is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.
    
    releaseTime - The time for the ducked sounds to ramp back to their original level. This value is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.
    
    attackCurve - The type of curve function to use during the attack phase of gain reduction.
    
    releaseCurve - The type of curve function to use during the release phase of gain reduction.
  - 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)
```
  - isActive
```
public boolean isActive()
```
    [@property] active
    YES if the ducker is active; otherwise, NO.
  - 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 PHASEDucker new_objc()
```
  - releaseCurve
```
public long releaseCurve()
```
    [@property] releaseCurve
    The type of curve function to use during the release phase of gain reduction.
  - releaseTime
```
public double releaseTime()
```
    [@property] releaseTime
    The time for the ducked sounds to ramp back to their original level. [@note] The release time is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.
  - 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)
```
  - sourceGroups
```
public NSSet<? extends PHASEGroup> sourceGroups()
```
    [@property] sourceGroups
    The source groups that will trigger the ducker when a sound in one of the source groups starts playback.
  - superclass_static
```
public static org.moe.natj.objc.Class superclass_static()
```
  - targetGroups
```
public NSSet<? extends PHASEGroup> targetGroups()
```
    [@property] targetGroups
    The target groups that will be ducked when a sound in one of the source groups triggers the ducker.
  - version_static
```
public static long version_static()
```

Class PHASEDucker

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary

Method Summary

Methods inherited from class apple.NSObject

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

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

Methods inherited from class java.lang.Object

Constructor Detail

PHASEDucker

Method Detail

accessInstanceVariablesDirectly

activate

alloc

allocWithZone

attackCurve

attackTime

automaticallyNotifiesObserversForKey

cancelPreviousPerformRequestsWithTarget

cancelPreviousPerformRequestsWithTargetSelectorObject

classFallbacksForKeyedArchiver

classForKeyedUnarchiver

deactivate

debugDescription_static

description_static

gain

hash_static

identifier

init

initWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve

instanceMethodForSelector

instanceMethodSignatureForSelector

instancesRespondToSelector

isActive

isSubclassOfClass

keyPathsForValuesAffectingValueForKey

new_objc

releaseCurve

releaseTime

resolveClassMethod

resolveInstanceMethod

setVersion_static

sourceGroups

superclass_static

targetGroups

version_static