phase

func (Acl_entry_id_t) String ¶

func (e Acl_entry_id_t) String() string

func (Acl_flag_t) String ¶

func (e Acl_flag_t) String() string

func (Acl_perm_t) String ¶

func (e Acl_perm_t) String() string

func (Acl_tag_t) String ¶

func (e Acl_tag_t) String() string

func (Acl_type_t) String ¶

func (e Acl_type_t) String() string

func (CGLCPContextPriorityRequest) String ¶

func (e CGLCPContextPriorityRequest) String() string

func (Clockid_t) String ¶

func (e Clockid_t) String() string

func (Dispatch_autorelease_frequency_t) String ¶

func (e Dispatch_autorelease_frequency_t) String() string

func (Dispatch_block_flags_t) String ¶

func (e Dispatch_block_flags_t) String() string

func (EvCmd) String ¶

func (e EvCmd) String() string

func (Filesec_property_t) String ¶

func (e Filesec_property_t) String() string

func (Idtype_t) String ¶

func (e Idtype_t) String() string

func (Ipc_info_object_type_t) String ¶

func (e Ipc_info_object_type_t) String() string

func (Launch_data_type_t) String ¶

func (e Launch_data_type_t) String() string

func (MDLabelDomain) String ¶

func (e MDLabelDomain) String() string

func (MDQueryOptionFlags) String ¶

func (e MDQueryOptionFlags) String() string

func (MDQuerySortOptionFlags) String ¶

func (e MDQuerySortOptionFlags) String() string

func (Mach_vm_range_flags_t) String ¶

func (e Mach_vm_range_flags_t) String() string

func (Mach_vm_range_flavor_t) String ¶

func (e Mach_vm_range_flavor_t) String() string

func (Mach_vm_range_tag_t) String ¶

func (e Mach_vm_range_tag_t) String() string

func (Mpo_flags_t) String ¶

func (e Mpo_flags_t) String() string

func (NXMouseButton) String ¶

func (e NXMouseButton) String() string

func (Os_clockid_t) String ¶

func (e Os_clockid_t) String() string

func (*PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientation ¶

func (o *PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientation(layout *avfaudio.AVAudioChannelLayout, orientation unsafe.Pointer) *PHASEAmbientMixerDefinition

@method initWithChannelLayout:orientation @abstract Create a new PHASEAmbientMixerDefinition @param layout The input channel layout for this channel mixer node. Any connected sampler must match this channel layout. @param orientation The orientation of the speaker layout, relative to scene root, as a quaternion. @return A new PHASEAmbientMixerDefinition object

func (*PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientationIdentifier ¶

func (o *PHASEAmbientMixerDefinition) InitWithChannelLayoutOrientationIdentifier(layout *avfaudio.AVAudioChannelLayout, orientation unsafe.Pointer, identifier *foundation.NSString) *PHASEAmbientMixerDefinition

@method initWithChannelLayout:orientation:identifier @abstract Create a new PHASEAmbientMixerDefinition @param layout The input channel layout for this ambient mixer node. Any connected sampler must match this channel layout. @param orientation The orientation of the speaker layout, relative to scene root, as a quaternion. @param identifier An optional custom identifier to give to this object @return A new PHASEAmbientMixerDefinition object

func (*PHASEAmbientMixerDefinition) InputChannelLayout ¶

func (o *PHASEAmbientMixerDefinition) InputChannelLayout() *avfaudio.AVAudioChannelLayout

@property inputChannelLayout @abstract A readonly value of the input channel layout this mixer was initialized with.

func (*PHASEAmbientMixerDefinition) Orientation ¶

func (o *PHASEAmbientMixerDefinition) Orientation() unsafe.Pointer

@property orientation @abstract A readonly value of the ambient source's orientation relative to the scene root.

func (*PHASEAsset) Identifier ¶

func (o *PHASEAsset) Identifier() *foundation.NSString

func (PHASEAssetError) String ¶

func (e PHASEAssetError) String() string

func (*PHASEAssetRegistry) AssetForIdentifier ¶

func (o *PHASEAssetRegistry) AssetForIdentifier(identifier *foundation.NSString) *PHASEAsset

@method assetForIdentifier @abstract Finds an asset in the asset registry, given an identifier. @param identifier The identifier of this asset @return A PHASEAsset object, or nil if one could not be found.

func (*PHASEAssetRegistry) GlobalMetaParameters ¶

func (o *PHASEAssetRegistry) GlobalMetaParameters() *foundation.NSDictionary[*foundation.NSString, *PHASEMetaParameter]

func (*PHASEAssetRegistry) RegisterGlobalMetaParameterError ¶

func (o *PHASEAssetRegistry) RegisterGlobalMetaParameterError(metaParameterDefinition *PHASEMetaParameterDefinition) (*PHASEGlobalMetaParameterAsset, error)

@method registerGlobalMetaParameter:error @abstract Register a global metaparameter with the asset registry. @note This function is synchronous and thread-safe. Clients can safely run this function to register multiple global metaparameters from multiple threads, if required. @param metaParameterDefinition The metaparameter object to register. @param error The error object in case of an error. @return A PHASEGlobalMetaParameterAsset object.

func (*PHASEAssetRegistry) RegisterSoundAssetAtURLIdentifierAssetTypeChannelLayoutNormalizationModeError ¶

func (o *PHASEAssetRegistry) RegisterSoundAssetAtURLIdentifierAssetTypeChannelLayoutNormalizationModeError(url *foundation.NSURL, identifier *foundation.NSString, assetType PHASEAssetType, channelLayout *avfaudio.AVAudioChannelLayout, normalizationMode PHASENormalizationMode) (*PHASESoundAsset, error)

@method registerSoundAssetAtURL:identifier:assetType:channelLayout:normalizationMode:error @abstract Register an audio file as a sound asset in the system. @note This function is synchronous and thread-safe. Clients can safely run this function to register multiple sound assets from multiple threads, if required. @param url The URL of the audio file. @param identifier An identifier that uniquely represents this sound event asset. Nil generates an automatic identifier. @param assetType The asset type for this sound asset. @param channelLayout The audio channel layout for this sound asset. If a valid channel layout definition is read from the file being registered, this will override it. If nil is passed as a value for this property, the file must either be mono or stereo, or already contain a vaild channel layout definition. This channel layout must have the same channel count as the audio file being loaded. @param normalizationMode The normalization mode. @param error The error object in case of an error @return A PHASESoundAsset object

func (*PHASEAssetRegistry) RegisterSoundAssetWithDataIdentifierFormatNormalizationModeError ¶

func (o *PHASEAssetRegistry) RegisterSoundAssetWithDataIdentifierFormatNormalizationModeError(data *foundation.NSData, identifier *foundation.NSString, format *avfaudio.AVAudioFormat, normalizationMode PHASENormalizationMode) (*PHASESoundAsset, error)

@method registerSoundAssetWithData:identifier:format:normalizationMode:error @abstract Register audio data as a sound asset in the system. @note This function is synchronous and thread-safe. Clients can safely run this function to register multiple sound assets from multiple threads, if required. @param data A buffer containing the audio data to register as a sound asset. Audio data must either be a single PCM buffer of interleaved channels or multiple deinterleaved PCM buffers per channel packed back to back. @param identifier The identifier to assign to this sound asset. Nil generates an automatic identifier. @param format The AVAudioFormat object that describes the audio data in the buffer. @param normalizationMode The normalization mode. @param error The error object in case of an error. @return A PHASESoundAsset object.

func (*PHASEAssetRegistry) RegisterSoundEventAssetWithRootNodeIdentifierError ¶

func (o *PHASEAssetRegistry) RegisterSoundEventAssetWithRootNodeIdentifierError(rootNode *PHASESoundEventNodeDefinition, identifier *foundation.NSString) (*PHASESoundEventNodeAsset, error)

@method registerSoundEventAssetWithRootNode:identifier:error @abstract Register a sound event asset with the asset registry. @note This function is synchronous and thread-safe. Clients can safely run this function to register multiple sound event assets from multiple threads, if required. @param rootNode The root node of the sound event asset to register. @param identifier An identifier that uniquely represents this sound event asset. Nil generates an automatic identifier. @param error The error object in case of an error @return A PHASESoundEventNodeAsset object

func (*PHASEAssetRegistry) UnregisterAssetWithIdentifierCompletion ¶

func (o *PHASEAssetRegistry) UnregisterAssetWithIdentifierCompletion(identifier *foundation.NSString, handler func(bool))

@method unregisterAssetWithIdentifier:completion: @abstract Unregister and unload an asset. @param identifier The identifier of the PHASEAsset object to unregister @param handler An optional completion block that will be called when the asset has been unregistered. Once you receive this callback, it's safe to deallocate external resources, if applicable.

func (PHASEAssetType) String ¶

func (e PHASEAssetType) String() string

func (PHASEAutomaticHeadTrackingFlags) String ¶

func (e PHASEAutomaticHeadTrackingFlags) String() string

func (*PHASEBlendNodeDefinition) AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree ¶

func (o *PHASEBlendNodeDefinition) AddRangeForInputValuesAboveFullGainAtValueFadeCurveTypeSubtree(value float64, fullGainAtValue float64, fadeCurveType PHASECurveType, subtree *PHASESoundEventNodeDefinition)

@method addRangeForInputValuesAbove:fullGainAtValue:fadeCurveType:subtree @abstract Create a blend range that is active for all values above a given threshold. @param value The value for which the range will be active if the blend node's input value is above this threshold. @param fullGainAtValue This value defines a threshold for which a fade curve will be applied to the gain, when the input value is between "value" and "fullGainAtValue". @param fadeCurveType A curve type that defines which kind of fade curve to apply. @param subtree A PHASESoundEventNodeDefinition subtree that will be active for this range.

func (*PHASEBlendNodeDefinition) AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree ¶

func (o *PHASEBlendNodeDefinition) AddRangeForInputValuesBelowFullGainAtValueFadeCurveTypeSubtree(value float64, fullGainAtValue float64, fadeCurveType PHASECurveType, subtree *PHASESoundEventNodeDefinition)

@method addRangeForInputValuesBelow:fullGainAtValue:fadeCurveType:subtree @abstract Create a blend range that is active for all values below a given threshold. @param value The value for which the range will be active if the blend node's input value is below this threshold. @param fullGainAtValue This value defines a threshold for which a fade curve will be applied to the gain, when the input value is between "value" and "fullGainAtValue". @param fadeCurveType A curve type that defines which kind of fade curve to apply. @param subtree A PHASESoundEventNodeDefinition subtree that will be active for this range.

func (*PHASEBlendNodeDefinition) AddRangeForInputValuesBetweenHighValueFullGainAtLowValueFullGainAtHighValueLowFadeCurveTypeHighFadeCurveTypeSubtree ¶

func (o *PHASEBlendNodeDefinition) AddRangeForInputValuesBetweenHighValueFullGainAtLowValueFullGainAtHighValueLowFadeCurveTypeHighFadeCurveTypeSubtree(lowValue float64, highValue float64, fullGainAtLowValue float64, fullGainAtHighValue float64, lowFadeCurveType PHASECurveType, highFadeCurveType PHASECurveType, subtree *PHASESoundEventNodeDefinition)

@method addRangeForInputValuesBetween:highValue:fullGainAtLowValue:fullGainAtHighValue:lowFadeCurveType:highFadeCurveType:subtree @abstract Create a blend range that is active for all input values between lowValue and highValue @param lowValue The lower bound for which this range is active. @param highValue The upper bound for which this range is active. @param fullGainAtLowValue The threshold for which a fade curve defined by lowFadeCurveType will be applied to the gain when the input value is between lowValue and fullGainAtLowValue @param fullGainAtHighValue The threshold for which a fade curve defined by highFadeCurveType will be applied to the gain when the input value is between highValue and fullGainAtHighValue @param lowFadeCurveType A curve type that defines which kind of fade curve to apply for the low fade range. @param highFadeCurveType A curve type that defines which kind of fade curve to apply for the high fade range.. @param subtree A PHASESoundEventNodeDefinition subtree that will be active for this range.

func (*PHASEBlendNodeDefinition) AddRangeWithEnvelopeSubtree ¶

func (o *PHASEBlendNodeDefinition) AddRangeWithEnvelopeSubtree(envelope *PHASEEnvelope, subtree *PHASESoundEventNodeDefinition)

@method addRangeWithEnvelope:subtree @abstract Create a blend range defined by a PHASEEnvelope object. @param envelope The PHASEEnvelope object that defines the output gain for a range. @param subtree A PHASESoundEventNodeDefinition subtree that will be active for this range.

func (*PHASEBlendNodeDefinition) BlendParameterDefinition ¶

func (o *PHASEBlendNodeDefinition) BlendParameterDefinition() *PHASENumberMetaParameterDefinition

func (*PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinition ¶

func (o *PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinition(spatialMixerDefinition *PHASESpatialMixerDefinition) *PHASEBlendNodeDefinition

@method initDistanceBlendWithSpatialMixerDefinition @abstract Create a blend node definition @param spatialMixerDefinition A PHASESpatialMixerDefinition that will bind the blend parameter to the distance between the source and listener. @return A new PHASEBlendNodeDefinition object

func (*PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinitionIdentifier ¶

func (o *PHASEBlendNodeDefinition) InitDistanceBlendWithSpatialMixerDefinitionIdentifier(spatialMixerDefinition *PHASESpatialMixerDefinition, identifier *foundation.NSString) *PHASEBlendNodeDefinition

@method initDistanceBlendWithSpatialMixerDefinition:identifier @abstract Create a blend node definition @param spatialMixerDefinition A PHASESpatialMixerDefinition that will bind the blend parameter to the distance between the source and listener. @param identifier An optional custom identifier to give to this object @return A new PHASEBlendNodeDefinition object

func (*PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinition ¶

func (o *PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinition(blendMetaParameterDefinition *PHASENumberMetaParameterDefinition) *PHASEBlendNodeDefinition

@method initWithBlendMetaParameterDefinition @abstract Create a blend node definition @param blendMetaParameterDefinition A metaparameter definition that wil be used to control the parameter of the blend node at runtime. @return A new PHASEBlendNodeDefinition object

func (*PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinitionIdentifier ¶

func (o *PHASEBlendNodeDefinition) InitWithBlendMetaParameterDefinitionIdentifier(blendMetaParameterDefinition *PHASENumberMetaParameterDefinition, identifier *foundation.NSString) *PHASEBlendNodeDefinition

@method initWithBlendMetaParameterDefinition:identifier @abstract Create a blend node definition @param blendMetaParameterDefinition A metaparameter definition that wil be used to control the parameter of the blend node at runtime. @param identifier An optional custom identifier to give to this object @return A new PHASEBlendNodeDefinition object

func (*PHASEBlendNodeDefinition) SpatialMixerDefinitionForDistance ¶

func (o *PHASEBlendNodeDefinition) SpatialMixerDefinitionForDistance() *PHASESpatialMixerDefinition

func (PHASECalibrationMode) String ¶

func (e PHASECalibrationMode) String() string

func (*PHASECardioidDirectivityModelParameters) InitWithSubbandParameters ¶

func (o *PHASECardioidDirectivityModelParameters) InitWithSubbandParameters(subbandParameters *foundation.NSArray[*PHASECardioidDirectivityModelSubbandParameters]) *PHASECardioidDirectivityModelParameters

func (*PHASECardioidDirectivityModelParameters) SubbandParameters ¶

func (o *PHASECardioidDirectivityModelParameters) SubbandParameters() *foundation.NSArray[*PHASECardioidDirectivityModelSubbandParameters]

func (*PHASECardioidDirectivityModelSubbandParameters) Frequency ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) Frequency() float64

@property frequency @abstract The frequency of the subband, in hertz. @note Values are clamped to the range [20.0, 20000.0]. Default value is 1000.0.

func (*PHASECardioidDirectivityModelSubbandParameters) Init ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) Init() *PHASECardioidDirectivityModelSubbandParameters

func (*PHASECardioidDirectivityModelSubbandParameters) Pattern ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) Pattern() float64

@property pattern @abstract The directivity pattern. @note Values are clamped to the range [0.0, 1.0]. Default value is 0.0. 0.0 is omnidirectional. 0.5 is cardioid. 1.0 is dipole.

func (*PHASECardioidDirectivityModelSubbandParameters) SetFrequency ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) SetFrequency(frequency float64)

func (*PHASECardioidDirectivityModelSubbandParameters) SetPattern ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) SetPattern(pattern float64)

func (*PHASECardioidDirectivityModelSubbandParameters) SetSharpness ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) SetSharpness(sharpness float64)

func (*PHASECardioidDirectivityModelSubbandParameters) Sharpness ¶

func (o *PHASECardioidDirectivityModelSubbandParameters) Sharpness() float64

@property sharpness @abstract The sharpness of the directivity pattern. @note Values are clamped to the range [1.0, DBL_MAX]. Default value is 1.0. Values > 1.0 increase sharpness.

func (*PHASEChannelMixerDefinition) InitWithChannelLayout ¶

func (o *PHASEChannelMixerDefinition) InitWithChannelLayout(layout *avfaudio.AVAudioChannelLayout) *PHASEChannelMixerDefinition

@method initWithChannelLayout @abstract Create a new PHASEChannelMixerDefinition @note Any connected sampler must match this channel layout. @param layout The input channel layout. Any connected sampler must match this channel layout. @return A new PHASEChannelMixerDefinition object

func (*PHASEChannelMixerDefinition) InitWithChannelLayoutIdentifier ¶

func (o *PHASEChannelMixerDefinition) InitWithChannelLayoutIdentifier(layout *avfaudio.AVAudioChannelLayout, identifier *foundation.NSString) *PHASEChannelMixerDefinition

@method initWithChannelLayout:identifier @abstract Create a new PHASEChannelMixerDefinition @note Any connected sampler must match this channel layout. @param layout The input channel layout. @param identifier An optional custom identifier to give to this object @return A new PHASEChannelMixerDefinition object

func (*PHASEChannelMixerDefinition) InputChannelLayout ¶

func (o *PHASEChannelMixerDefinition) InputChannelLayout() *avfaudio.AVAudioChannelLayout

func (*PHASEConeDirectivityModelParameters) InitWithSubbandParameters ¶

func (o *PHASEConeDirectivityModelParameters) InitWithSubbandParameters(subbandParameters *foundation.NSArray[*PHASEConeDirectivityModelSubbandParameters]) *PHASEConeDirectivityModelParameters

func (*PHASEConeDirectivityModelParameters) SubbandParameters ¶

func (o *PHASEConeDirectivityModelParameters) SubbandParameters() *foundation.NSArray[*PHASEConeDirectivityModelSubbandParameters]

func (*PHASEConeDirectivityModelSubbandParameters) Frequency ¶

func (o *PHASEConeDirectivityModelSubbandParameters) Frequency() float64

@property frequency @abstract The frequency of the subband, in hertz. @note Default value is 1000.0.

func (*PHASEConeDirectivityModelSubbandParameters) Init ¶

func (o *PHASEConeDirectivityModelSubbandParameters) Init() *PHASEConeDirectivityModelSubbandParameters

func (*PHASEConeDirectivityModelSubbandParameters) InnerAngle ¶

func (o *PHASEConeDirectivityModelSubbandParameters) InnerAngle() float64

@property innerAngle @abstract The inner angle, in degrees. @note Default value is 360.0.

func (*PHASEConeDirectivityModelSubbandParameters) OuterAngle ¶

func (o *PHASEConeDirectivityModelSubbandParameters) OuterAngle() float64

@property outerAngle @abstract The outer angle, in degrees. @note Default value is 360.0.

func (*PHASEConeDirectivityModelSubbandParameters) OuterGain ¶

func (o *PHASEConeDirectivityModelSubbandParameters) OuterGain() float64

@property outerGain @abstract The outer gain. @note Values are clamped to the range [0.0, 1.0]. Default value is 1.0.

func (*PHASEConeDirectivityModelSubbandParameters) SetFrequency ¶

func (o *PHASEConeDirectivityModelSubbandParameters) SetFrequency(frequency float64)

func (*PHASEConeDirectivityModelSubbandParameters) SetInnerAngleOuterAngle ¶

func (o *PHASEConeDirectivityModelSubbandParameters) SetInnerAngleOuterAngle(innerAngle float64, outerAngle float64)

@method setInnerAngle:outerAngle @abstract Set the innerAngle and outerAngle of the Cone Directivity Model Subband @param innerAngle The inner angle of the cone directivity model, must be less than or equal to outer angle. @param outerAngle The outer angle of the cone directivity model, must be greater than or equal to inner angle. @note The default value for each angle is 360.0. outerAngle must be >= innerAngle.

func (*PHASEConeDirectivityModelSubbandParameters) SetOuterGain ¶

func (o *PHASEConeDirectivityModelSubbandParameters) SetOuterGain(outerGain float64)

func (*PHASEContainerNodeDefinition) AddSubtree ¶

func (o *PHASEContainerNodeDefinition) AddSubtree(subtree *PHASESoundEventNodeDefinition)

@method addSubtree @abstract Add a subtree to this node @param subtree Add a subtree of PHASESoundEventNodeDefinition nodes beneath this node.

func (*PHASEContainerNodeDefinition) Init ¶

func (o *PHASEContainerNodeDefinition) Init() *PHASEContainerNodeDefinition

@method init @abstract Create a container node definition @return A new PHASEContainerNodeDefinition object

func (*PHASEContainerNodeDefinition) InitWithIdentifier ¶

func (o *PHASEContainerNodeDefinition) InitWithIdentifier(identifier *foundation.NSString) *PHASEContainerNodeDefinition

@method initWithIdentifier @abstract Create a container node definition @param identifier An optional custom identifier to give to this object @return A new PHASEContainerNodeDefinition object

func (PHASECullOption) String ¶

func (e PHASECullOption) String() string

func (PHASECurveType) String ¶

func (e PHASECurveType) String() string

func (*PHASEDefinition) Identifier ¶

func (o *PHASEDefinition) Identifier() *foundation.NSString

func (*PHASEDistanceModelFadeOutParameters) CullDistance ¶

func (o *PHASEDistanceModelFadeOutParameters) CullDistance() float64

func (*PHASEDistanceModelFadeOutParameters) InitWithCullDistance ¶

func (o *PHASEDistanceModelFadeOutParameters) InitWithCullDistance(cullDistance float64) *PHASEDistanceModelFadeOutParameters

@method initWithCullDistance @abstract Initialize with a cullDistance. @param cullDistance The distance beyond which the sound will be culled. Values must be >= 1. @note The cullDistance is scaled by unitsPerMeter internally, so can be provided at the client's native spatial scale. The system will smoothly fade the sound to zero before reaching this distance to avoid any audible artifacts. @return An instance, or nil if initialization fails.

func (*PHASEDistanceModelParameters) FadeOutParameters ¶

func (o *PHASEDistanceModelParameters) FadeOutParameters() *PHASEDistanceModelFadeOutParameters

func (*PHASEDistanceModelParameters) SetFadeOutParameters ¶

func (o *PHASEDistanceModelParameters) SetFadeOutParameters(fadeOutParameters *PHASEDistanceModelFadeOutParameters)

func (*PHASEDucker) Activate ¶

func (o *PHASEDucker) Activate()

@method activate @abstract Activates the ducker

func (*PHASEDucker) AttackCurve ¶

func (o *PHASEDucker) AttackCurve() PHASECurveType

@property attackCurve @abstract The type of curve function to use during the attack phase of gain reduction.

func (*PHASEDucker) AttackTime ¶

func (o *PHASEDucker) AttackTime() float64

@property attackTime @abstract 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.

func (*PHASEDucker) Deactivate ¶

func (o *PHASEDucker) Deactivate()

@method deactivate @abstract Deactivates the ducker

func (*PHASEDucker) Gain ¶

func (o *PHASEDucker) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEDucker) Identifier ¶

func (o *PHASEDucker) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this ducker.

func (*PHASEDucker) InitWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve ¶

func (o *PHASEDucker) InitWithEngineSourceGroupsTargetGroupsGainAttackTimeReleaseTimeAttackCurveReleaseCurve(engine *PHASEEngine, sourceGroups *foundation.NSSet[*PHASEGroup], targetGroups *foundation.NSSet[*PHASEGroup], gain float64, attackTime float64, releaseTime float64, attackCurve PHASECurveType, releaseCurve PHASECurveType) *PHASEDucker

@method initWithSourceGroups:targetGroups:attenuation:attackTime:releaseTime: @discussion 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. @param engine The engine to register this ducker with. @param sourceGroups The source groups that will trigger the ducker when a sound in one of the source groups starts playback. @param targetGroups The target groups that will be ducked when a sound in one of the source groups triggers the ducker. @param 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]. @param 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. @param 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. @param attackCurve The type of curve function to use during the attack phase of gain reduction. @param releaseCurve The type of curve function to use during the release phase of gain reduction.

func (*PHASEDucker) IsActive ¶

func (o *PHASEDucker) IsActive() bool

@property active @abstract YES if the ducker is active; otherwise, NO.

func (*PHASEDucker) ReleaseCurve ¶

func (o *PHASEDucker) ReleaseCurve() PHASECurveType

@property releaseCurve @abstract The type of curve function to use during the release phase of gain reduction.

func (*PHASEDucker) ReleaseTime ¶

func (o *PHASEDucker) ReleaseTime() float64

@property releaseTime @abstract 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.

func (*PHASEDucker) SourceGroups ¶

func (o *PHASEDucker) SourceGroups() *foundation.NSSet[*PHASEGroup]

@property sourceGroups @abstract The source groups that will trigger the ducker when a sound in one of the source groups starts playback.

func (*PHASEDucker) TargetGroups ¶

func (o *PHASEDucker) TargetGroups() *foundation.NSSet[*PHASEGroup]

@property targetGroups @abstract The target groups that will be ducked when a sound in one of the source groups triggers the ducker.

func (*PHASEEngine) ActiveGroupPreset ¶

func (o *PHASEEngine) ActiveGroupPreset() *PHASEGroupPreset

@property activeGroupPreset @abstract The active group mixer preset in the system @discussion Returns nil if there are no active group presets in the engine. Activate or Deactivate the preset via [PHASEGroupPreset activate] and [PHASEGroupPreset deactivate]

func (*PHASEEngine) AssetRegistry ¶

func (o *PHASEEngine) AssetRegistry() *PHASEAssetRegistry

@property assetRegistry @abstract A registry for assets available to the engine

func (*PHASEEngine) DefaultMedium ¶

func (o *PHASEEngine) DefaultMedium() *PHASEMedium

@property defaultMedium @abstract The default medium in the engine. @discussion The default value is PHASEMediumPresetAir.

func (*PHASEEngine) DefaultReverbPreset ¶

func (o *PHASEEngine) DefaultReverbPreset() PHASEReverbPreset

@property defaultReverbPreset @abstract The default reverb preset in the engine. @discussion The default value is PHASEReverbPresetNone.

func (*PHASEEngine) Duckers ¶

func (o *PHASEEngine) Duckers() *foundation.NSArray[*PHASEDucker]

@property duckers @abstract An array of the ducker objects in the system @discussion Returns a dictionary of the ducker objects at the time it is retrieved.

func (*PHASEEngine) Groups ¶

func (o *PHASEEngine) Groups() *foundation.NSDictionary[*foundation.NSString, *PHASEGroup]

@property groups @abstract A dictionary of the groups in the system @discussion Returns a dictionary of the groups at the time it is retrieved.

func (*PHASEEngine) InitWithUpdateMode ¶

func (o *PHASEEngine) InitWithUpdateMode(updateMode PHASEUpdateMode) *PHASEEngine

@method initWithUpdateMode: @abstract Initialize a new engine with an update mode. @param updateMode Defines how the engine will be updated.

func (*PHASEEngine) LastRenderTime ¶

func (o *PHASEEngine) LastRenderTime() *avfaudio.AVAudioTime

@property lastRenderTime @abstract Obtain the time for which the engine most recently rendered. @discussion Will return nil if the engine is not running

func (*PHASEEngine) OutputSpatializationMode ¶

func (o *PHASEEngine) OutputSpatializationMode() PHASESpatializationMode

@property outputSpatializationMode @discussion When set to a value other than PHASESpatializationModeAutomatic, overrides the default output spatializer and uses the specified one instead.

func (*PHASEEngine) Pause ¶

func (o *PHASEEngine) Pause()

@method pause @abstract Pause the engine.

func (*PHASEEngine) RenderingState ¶

func (o *PHASEEngine) RenderingState() PHASERenderingState

@property renderingState @abstract The engine's current rendering state.

func (*PHASEEngine) RootObject ¶

func (o *PHASEEngine) RootObject() *PHASEObject

@property rootObject @abstract The root object of the engine's scene graph. @discussion Attach objects to the engine's rootObject or one of its children to make them active within the engine's scene graph. This will ensure they take part in the simulation. @note The rootObject is created and owned by the engine. The rootObject may not be set as the child of another object. This will cause an error to be thrown. The rootObject's transform may not be changed. This will cause an error to be thrown. The rootObject may not be copied. This will cause an error to be thrown.

func (*PHASEEngine) SetDefaultMedium ¶

func (o *PHASEEngine) SetDefaultMedium(defaultMedium *PHASEMedium)

func (*PHASEEngine) SetDefaultReverbPreset ¶

func (o *PHASEEngine) SetDefaultReverbPreset(defaultReverbPreset PHASEReverbPreset)

func (*PHASEEngine) SetOutputSpatializationMode ¶

func (o *PHASEEngine) SetOutputSpatializationMode(outputSpatializationMode PHASESpatializationMode)

func (*PHASEEngine) SetUnitsPerMeter ¶

func (o *PHASEEngine) SetUnitsPerMeter(unitsPerMeter float64)

func (*PHASEEngine) SetUnitsPerSecond ¶

func (o *PHASEEngine) SetUnitsPerSecond(unitsPerSecond float64)

func (*PHASEEngine) SoundEvents ¶

func (o *PHASEEngine) SoundEvents() *foundation.NSArray[*PHASESoundEvent]

@property soundEvents @abstract An array of the active sound event objects in the system @discussion Returns a dictionary of the sound events at the time it is retrieved. This includes all sound events that are registered with the engine, including those that are preparing, playing, paused or stopping.

func (*PHASEEngine) StartAndReturnError ¶

func (o *PHASEEngine) StartAndReturnError() (bool, error)

@method startAndReturnError: @abstract Start or resume the engine. @return YES for success.

func (*PHASEEngine) Stop ¶

func (o *PHASEEngine) Stop()

@method stop @abstract Stop the engine.

func (*PHASEEngine) UnitsPerMeter ¶

func (o *PHASEEngine) UnitsPerMeter() float64

@property unitsPerMeter @abstract The number of units in a meter. @discussion The unitsPerMeter is used internally to scale metric values passed to the API. This allows clients to pass metric values in their own native spatial scale. @note Values are clamped to the range (0, inf]. Default value is 1.

func (*PHASEEngine) UnitsPerSecond ¶

func (o *PHASEEngine) UnitsPerSecond() float64

@property unitsPerSecond @abstract The number of units in a second. @discussion The unitsPerSecond is used internally to scale time/duration values passed to the API. This allows clients to pass time/duration values in their own native time scale. @note Values are clamped to the range (0, inf]. Default value is 1.

func (*PHASEEngine) Update ¶

func (o *PHASEEngine) Update()

@method update: @abstract Manually update the engine instance on the calling thread. @discussion This will kick off all of the API commands called since the last call to update, update any systems and objects that need to be kept current, and call any registered handlers. @note This function has no effect if the engine's update mode is PHASEUpdateModeAutomatic.

func (*PHASEEnvelope) Domain ¶

func (o *PHASEEnvelope) Domain() *PHASENumericPair

@property domain @abstract The domain (along the x-axis). @discussion The first value in the pair is the minimum value of the domain. The second value in the pair is the maximum value of the domain.

func (*PHASEEnvelope) EvaluateForValue ¶

func (o *PHASEEnvelope) EvaluateForValue(x float64) float64

@method evaluateForValue @abstract Evaluates the envelope. @discussion If required, x will be clamped to the envelope's domain. @param x The input along the x-axis. @return The output along the y-axis.

func (*PHASEEnvelope) InitWithStartPointSegments ¶

func (o *PHASEEnvelope) InitWithStartPointSegments(startPoint unsafe.Pointer, segments *foundation.NSArray[*PHASEEnvelopeSegment]) *PHASEEnvelope

@method initWithStartPoint:segments @abstract Initialize an envelope from a start point and an array of segments. @discussion If the segment array is empty (i.e., count == 0), the envelope will internally create a single segment with an end point matching the start point. If the segment array has more than one segment, segments will be sorted internally in ascending order of x value. Note that the startPoint.x value must be <= the segment with the lowest x value provided in segments. Failure to do so will cause this function to return nil. @param startPoint The start point of the envelope. @param segments An array of segments. @return A new envelope.

func (*PHASEEnvelope) Range ¶

func (o *PHASEEnvelope) Range() *PHASENumericPair

@property range @abstract The range (along the y-axis). @discussion The first value in the pair is the minimum value of the range. The second value in the pair is the maximum value of the range.

func (*PHASEEnvelope) Segments ¶

func (o *PHASEEnvelope) Segments() *foundation.NSArray[*PHASEEnvelopeSegment]

@property segments @abstract The segments of the envelope.

func (*PHASEEnvelope) StartPoint ¶

func (o *PHASEEnvelope) StartPoint() unsafe.Pointer

@property startPoint @abstract The start point of the envelope.

func (*PHASEEnvelopeDistanceModelParameters) Envelope ¶

func (o *PHASEEnvelopeDistanceModelParameters) Envelope() *PHASEEnvelope

func (*PHASEEnvelopeDistanceModelParameters) InitWithEnvelope ¶

func (o *PHASEEnvelopeDistanceModelParameters) InitWithEnvelope(envelope *PHASEEnvelope) *PHASEEnvelopeDistanceModelParameters

@method initWithEnvelope @abstract Initialize a PHASEEnvelopeDistanceModelParameters with a PHASEEnvelope @param envelope An envelope object where x values are interpreted as distance and the y values interpreted as gain. @return An instance, or nil if initialization failed.

func (*PHASEEnvelopeSegment) CurveType ¶

func (o *PHASEEnvelopeSegment) CurveType() PHASECurveType

@property curveType @abstract The curve type of the envelope segment. @discussion The default value is PHASECurveTypeLinear.

func (*PHASEEnvelopeSegment) EndPoint ¶

func (o *PHASEEnvelopeSegment) EndPoint() unsafe.Pointer

@property endPoint @abstract The end point of the envelope segment. @discussion The default value is [0.0, 0.0].

func (*PHASEEnvelopeSegment) InitWithEndPointCurveType ¶

func (o *PHASEEnvelopeSegment) InitWithEndPointCurveType(endPoint unsafe.Pointer, curveType PHASECurveType) *PHASEEnvelopeSegment

@method initWithEndPoint:curveType @abstract Initialize an envelope segment with an endPoint and a curveType. @param endPoint The end point of the segment. @param curveType The curve type. @return A new envelope.

func (*PHASEEnvelopeSegment) SetCurveType ¶

func (o *PHASEEnvelopeSegment) SetCurveType(curveType PHASECurveType)

func (*PHASEEnvelopeSegment) SetEndPoint ¶

func (o *PHASEEnvelopeSegment) SetEndPoint(endPoint unsafe.Pointer)

func (PHASEError) String ¶

func (e PHASEError) String() string

func (*PHASEGeneratorNodeDefinition) CalibrationMode ¶

func (o *PHASEGeneratorNodeDefinition) CalibrationMode() PHASECalibrationMode

@property calibrationMode @abstract The generator's calibration mode. The default value is PHASECalibrationModeNone.

func (*PHASEGeneratorNodeDefinition) GainMetaParameterDefinition ¶

func (o *PHASEGeneratorNodeDefinition) GainMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property gainMetaParameterDefinition @abstract Optionally attach a metaparameter definition here to enable dynamic control of the gain during playback.

func (*PHASEGeneratorNodeDefinition) Group ¶

func (o *PHASEGeneratorNodeDefinition) Group() *PHASEGroup

@property group @abstract The PHASEGroup object this generator should be associated with for gain and rate control.

func (*PHASEGeneratorNodeDefinition) Level ¶

func (o *PHASEGeneratorNodeDefinition) Level() float64

@property level @abstract The generator's level. The default value is 1. @note The level's underlying unit and range are dependent on the calibrationMode.

func (*PHASEGeneratorNodeDefinition) MixerDefinition ¶

func (o *PHASEGeneratorNodeDefinition) MixerDefinition() *PHASEMixerDefinition

@property mixerDefinition @abstract The readonly property that returns the PHASEMixerDefinition this generator was created with and assigned to.

func (*PHASEGeneratorNodeDefinition) Rate ¶

func (o *PHASEGeneratorNodeDefinition) Rate() float64

@property rate @abstract Linear rate scalar. @note Values are clamped to the range [0.25, 4]. Default value is 1.

func (*PHASEGeneratorNodeDefinition) RateMetaParameterDefinition ¶

func (o *PHASEGeneratorNodeDefinition) RateMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property rateMetaParameterDefinition @abstract Optionally attach a metaparameter definition here to enable dynamic control of the rate during playback.

func (*PHASEGeneratorNodeDefinition) SetCalibrationModeLevel ¶

func (o *PHASEGeneratorNodeDefinition) SetCalibrationModeLevel(calibrationMode PHASECalibrationMode, level float64)

@method setCalibrationMode:level @abstract Set the generator's calibration mode and level. @param calibrationMode The calibration mode. @param level The level. @note The level, including its underlying unit and range, are dependent on the calibration mode.

func (*PHASEGeneratorNodeDefinition) SetGainMetaParameterDefinition ¶

func (o *PHASEGeneratorNodeDefinition) SetGainMetaParameterDefinition(gainMetaParameterDefinition *PHASENumberMetaParameterDefinition)

func (*PHASEGeneratorNodeDefinition) SetGroup ¶

func (o *PHASEGeneratorNodeDefinition) SetGroup(group *PHASEGroup)

func (*PHASEGeneratorNodeDefinition) SetRate ¶

func (o *PHASEGeneratorNodeDefinition) SetRate(rate float64)

func (*PHASEGeneratorNodeDefinition) SetRateMetaParameterDefinition ¶

func (o *PHASEGeneratorNodeDefinition) SetRateMetaParameterDefinition(rateMetaParameterDefinition *PHASENumberMetaParameterDefinition)

func (*PHASEGeometricSpreadingDistanceModelParameters) Init ¶

func (o *PHASEGeometricSpreadingDistanceModelParameters) Init() *PHASEGeometricSpreadingDistanceModelParameters

func (*PHASEGeometricSpreadingDistanceModelParameters) RolloffFactor ¶

func (o *PHASEGeometricSpreadingDistanceModelParameters) RolloffFactor() float64

func (*PHASEGeometricSpreadingDistanceModelParameters) SetRolloffFactor ¶

func (o *PHASEGeometricSpreadingDistanceModelParameters) SetRolloffFactor(rolloffFactor float64)

func (*PHASEGroup) FadeGainDurationCurveType ¶

func (o *PHASEGroup) FadeGainDurationCurveType(gain float64, duration float64, curveType PHASECurveType)

@method fadeGain:duration:curveType: @abstract Fade the gain of this group over a specified duration and curve. @note The fade gain is applied on top of the base gain of the group. @param gain A target linear gain scalar. Values are clamped to the range [0, 1]. @param duration The duration over which to ramp to the target linear gain scalar. Values must be >= 0. The duration is scaled by unitsPerSecond internally, so can be provided at the client's native time scale. @param curveType The type of curve function that is applied during the fade.

func (*PHASEGroup) FadeRateDurationCurveType ¶

func (o *PHASEGroup) FadeRateDurationCurveType(rate float64, duration float64, curveType PHASECurveType)

@method fadeRate:duration:curveType: @abstract Fade the playback rate of this group over a specified duration and curve. @note The fade gain is applied on top of the base gain of the group. @param rate A target linear rate scalar. Values are clamped to the range [0.25, 4.0]. @param duration The duration over which to ramp to the target linear rate scalar. Values must be >= 0. The duration is scaled by unitsPerSecond internally, so can be provided at the client's native time scale. @param curveType The type of curve function that is applied during the fade.

func (*PHASEGroup) Gain ¶

func (o *PHASEGroup) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEGroup) Identifier ¶

func (o *PHASEGroup) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this group.

func (*PHASEGroup) InitWithIdentifier ¶

func (o *PHASEGroup) InitWithIdentifier(identifier *foundation.NSString) *PHASEGroup

@method initWithIdentifier: @abstract Create a new group. @param identifier The identifier that uniquely represents this group.

func (*PHASEGroup) IsMuted ¶

func (o *PHASEGroup) IsMuted() bool

@property muted @abstract Whether or not this group is muted.

func (*PHASEGroup) IsSoloed ¶

func (o *PHASEGroup) IsSoloed() bool

@property soloed @abstract Whether or not this group is soloed.

func (*PHASEGroup) Mute ¶

func (o *PHASEGroup) Mute()

@method mute @abstract Mute the group.

func (*PHASEGroup) Rate ¶

func (o *PHASEGroup) Rate() float64

@property rate @abstract Linear rate scalar. @note Values are clamped to the range [0.25, 4]. Default value is 1.

func (*PHASEGroup) RegisterWithEngine ¶

func (o *PHASEGroup) RegisterWithEngine(engine *PHASEEngine)

@method registerWithEngine @abstract Registers a group with a particular engine so that referenced assets can find it. @note An exception will be thrown if the engine is invalid or the group already exists. @param engine An engine object to associate this group with.

func (*PHASEGroup) SetGain ¶

func (o *PHASEGroup) SetGain(gain float64)

func (*PHASEGroup) SetRate ¶

func (o *PHASEGroup) SetRate(rate float64)

func (*PHASEGroup) Solo ¶

func (o *PHASEGroup) Solo()

@method solo @abstract Solo the group.

func (*PHASEGroup) Unmute ¶

func (o *PHASEGroup) Unmute()

@method unmute @abstract Unmute the group.

func (*PHASEGroup) UnregisterFromEngine ¶

func (o *PHASEGroup) UnregisterFromEngine()

@method unregisterFromEngine @abstract Unregister the group from a particular engine.

func (*PHASEGroup) Unsolo ¶

func (o *PHASEGroup) Unsolo()

@method unsolo @abstract Unsolo the group.

func (*PHASEGroupPreset) Activate ¶

func (o *PHASEGroupPreset) Activate()

@method activate @abstract Activate this preset in the PHASEEngine object it was initialized with. The internal timeToTarget value is used. The current preset will be deactivated automatically.

func (*PHASEGroupPreset) ActivateWithTimeToTargetOverride ¶

func (o *PHASEGroupPreset) ActivateWithTimeToTargetOverride(timeToTargetOverride float64)

@method activateWithTimeToTargetOverride @abstract Activate this preset in the PHASEEngine object it was initialized with. The current preset will be deactivated automatically. @param timeToTargetOverride Override the timeToTarget value in the preset with this value. @note The timeToTargetOverride is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEGroupPreset) Deactivate ¶

func (o *PHASEGroupPreset) Deactivate()

@method deactivate @abstract Deactivate this preset and return the system to default unity values. The internal timeToReset value is used.

func (*PHASEGroupPreset) DeactivateWithTimeToResetOverride ¶

func (o *PHASEGroupPreset) DeactivateWithTimeToResetOverride(timeToResetOverride float64)

@method deactivateWithTimeToResetOverride @abstract Deactivate this preset and return the system to default unity values. @param timeToResetOverride Override the timeToReset value in the preset with this value. @note The timeToResetOverride is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEGroupPreset) InitWithEngineSettingsTimeToTargetTimeToReset ¶

func (o *PHASEGroupPreset) InitWithEngineSettingsTimeToTargetTimeToReset(engine *PHASEEngine, settings *foundation.NSDictionary[*foundation.NSString, *PHASEGroupPresetSetting], timeToTarget float64, timeToReset float64) *PHASEGroupPreset

@method initWithEngine @abstract Create a new PHASEGroupPreset object with a given PHASEEngine object. @param engine The PHASEEngine object to register this preset with. @param settings A dictionary containing PHASEGroupPresetSetting objects paired with PHASEGroup objects as keys. @param timeToTarget The time interval that all group settings in this preset will take to gradually fade to the new value @param timeToReset The time interval that all group settings in this preset will take to gradually fade to the unity value @note The timeToTarget and timeToReset are scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEGroupPreset) Settings ¶

func (o *PHASEGroupPreset) Settings() *foundation.NSDictionary[*foundation.NSString, *PHASEGroupPresetSetting]

@property settings @abstract The collection of PHASEGroupPresetSetting objects to apply when this preset is activated.

func (*PHASEGroupPreset) TimeToReset ¶

func (o *PHASEGroupPreset) TimeToReset() float64

@property timeToReset @abstract The time interval that all group settings in this preset will take to gradually fade to the unity value @note The timeToReset is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEGroupPreset) TimeToTarget ¶

func (o *PHASEGroupPreset) TimeToTarget() float64

@property timeToTarget @abstract The time interval that all group settings in this preset will take to gradually fade to the new value @note The timeToTarget is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASEGroupPresetSetting) Gain ¶

func (o *PHASEGroupPresetSetting) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEGroupPresetSetting) GainCurveType ¶

func (o *PHASEGroupPresetSetting) GainCurveType() PHASECurveType

@property gainCurveType @abstract The type of curve to apply to the gain as the preset changes to this new setting.

func (*PHASEGroupPresetSetting) InitWithGainRateGainCurveTypeRateCurveType ¶

func (o *PHASEGroupPresetSetting) InitWithGainRateGainCurveTypeRateCurveType(gain float64, rate float64, gainCurveType PHASECurveType, rateCurveType PHASECurveType) *PHASEGroupPresetSetting

@method initWithGain:rate:gainCurveType:rateCurveType @abstract Initialize the PHASEGroupPresetSetting object with an existing PHASEGroup object. @param gain The main gain setting to apply to the group. Values are clamped to the range [0, 1]. Default value is 1. @param rate The playback rate setting to apply to the group. Values are clamped to the range [0.25, 4]. Default value is 1. @param gainCurveType The type of curve to apply to the gain as the preset changes to this new setting. @param rateCurveType The type of curve to apply to the rate as the preset changes to this new setting.

func (*PHASEGroupPresetSetting) Rate ¶

func (o *PHASEGroupPresetSetting) Rate() float64

@property rate @abstract Linear rate scalar.

func (*PHASEGroupPresetSetting) RateCurveType ¶

func (o *PHASEGroupPresetSetting) RateCurveType() PHASECurveType

@property rateCurveType @abstract The type of curve to apply to the rate as the preset changes to this new setting.

func (*PHASEListener) AutomaticHeadTrackingFlags ¶

func (o *PHASEListener) AutomaticHeadTrackingFlags() PHASEAutomaticHeadTrackingFlags

@property automaticHeadTrackingFlags @abstract A combination of flags to express automatic headtracking behaviors for this listener.

func (*PHASEListener) Gain ¶

func (o *PHASEListener) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEListener) InitWithEngine ¶

func (o *PHASEListener) InitWithEngine(engine *PHASEEngine) *PHASEListener

@method initWithEngine: @abstract Initialize a new listener.

func (*PHASEListener) SetAutomaticHeadTrackingFlags ¶

func (o *PHASEListener) SetAutomaticHeadTrackingFlags(automaticHeadTrackingFlags PHASEAutomaticHeadTrackingFlags)

@property automaticHeadTrackingFlags @abstract A combination of flags to express automatic headtracking behaviors for this listener.

func (*PHASEListener) SetGain ¶

func (o *PHASEListener) SetGain(gain float64)

func (*PHASEMappedMetaParameterDefinition) Envelope ¶

func (o *PHASEMappedMetaParameterDefinition) Envelope() *PHASEEnvelope

@property envelope @abstract An Envelope to define segments of curves

func (*PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelope ¶

func (o *PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelope(inputMetaParameterDefinition *PHASENumberMetaParameterDefinition, envelope *PHASEEnvelope) *PHASEMappedMetaParameterDefinition

@method initWithInputMetaParameterDefinition @abstract Create a new mapped range metaparameter definition @param inputMetaParameterDefinition The metaparameter that will provide an input for this mapped metaparameter @param envelope The envelope to use. @return The new PHASEMappedMetaParameterDefinition object

func (*PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelopeIdentifier ¶

func (o *PHASEMappedMetaParameterDefinition) InitWithInputMetaParameterDefinitionEnvelopeIdentifier(inputMetaParameterDefinition *PHASENumberMetaParameterDefinition, envelope *PHASEEnvelope, identifier *foundation.NSString) *PHASEMappedMetaParameterDefinition

@method initWithInputMetaParameterDefinition:identifier @abstract Create a new mapped range metaparameter definition @param inputMetaParameterDefinition The metaparameter that will provide an input for this mapped metaparameter @param envelope The envelope to use. @param identifier An optional custom identifier to give to this object @return The new PHASEMappedMetaParameterDefinition object

func (*PHASEMappedMetaParameterDefinition) InputMetaParameterDefinition ¶

func (o *PHASEMappedMetaParameterDefinition) InputMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property inputMetaParameterDefinition @abstract The readonly PHASENumberMetaParameterDefinition that this metaparameter definition was initialized with

func (*PHASEMaterial) InitWithEnginePreset ¶

func (o *PHASEMaterial) InitWithEnginePreset(engine *PHASEEngine, preset PHASEMaterialPreset) *PHASEMaterial

@method initWithEngine:preset @abstract Initialize a new material from a preset.

func (PHASEMaterialPreset) String ¶

func (e PHASEMaterialPreset) String() string

func (*PHASEMedium) InitWithEnginePreset ¶

func (o *PHASEMedium) InitWithEnginePreset(engine *PHASEEngine, preset PHASEMediumPreset) *PHASEMedium

@method initWithEngine:preset @abstract Initialize a new medium from a preset.

func (PHASEMediumPreset) String ¶

func (e PHASEMediumPreset) String() string

func (*PHASEMetaParameter) Identifier ¶

func (o *PHASEMetaParameter) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this metaparameter.

func (*PHASEMetaParameter) SetValue ¶

func (o *PHASEMetaParameter) SetValue(value objc.ID)

func (*PHASEMetaParameter) Value ¶

func (o *PHASEMetaParameter) Value() objc.ID

@property value @abstract The value of this metaparameter

func (*PHASEMetaParameterDefinition) Value ¶

func (o *PHASEMetaParameterDefinition) Value() objc.ID

func (*PHASEMixer) Gain ¶

func (o *PHASEMixer) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEMixer) GainMetaParameter ¶

func (o *PHASEMixer) GainMetaParameter() *PHASEMetaParameter

@property gainMetaParameter @abstract The metaparameter that can be used to adjust the gain during playback

func (*PHASEMixer) Identifier ¶

func (o *PHASEMixer) Identifier() *foundation.NSString

@property identifier @abstract The identifier that uniquely represents this mixer.

func (*PHASEMixerDefinition) Gain ¶

func (o *PHASEMixerDefinition) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASEMixerDefinition) GainMetaParameterDefinition ¶

func (o *PHASEMixerDefinition) GainMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property gainMetaParameterDefinition @abstract Optionally attach a metaparameter definition here to enable real-time control of the gain during playback.

func (*PHASEMixerDefinition) SetGain ¶

func (o *PHASEMixerDefinition) SetGain(gain float64)

func (*PHASEMixerDefinition) SetGainMetaParameterDefinition ¶

func (o *PHASEMixerDefinition) SetGainMetaParameterDefinition(gainMetaParameterDefinition *PHASENumberMetaParameterDefinition)

func (*PHASEMixerParameters) AddAmbientMixerParametersWithIdentifierListener ¶

func (o *PHASEMixerParameters) AddAmbientMixerParametersWithIdentifierListener(identifier *foundation.NSString, listener *PHASEListener)

@method addAmbientMixerParametersWithIdentifier:listener @abstract Adds runtime parameters for an ambient mixer @param identifier The unique identifier assigned to a spatial submixer object. @param listener The PHASEListener object that this mixer will use to orient sounds.

func (*PHASEMixerParameters) AddSpatialMixerParametersWithIdentifierSourceListener ¶

func (o *PHASEMixerParameters) AddSpatialMixerParametersWithIdentifierSourceListener(identifier *foundation.NSString, source *PHASESource, listener *PHASEListener)

@method addSpatialMixerParametersWithIdentifier:source:listener @abstract Adds runtime parameters for a spatial mixer @param identifier The unique identifier assigned to a spatial submixer object. @param source The PHASESource object that this mixer will use to spatialize sounds. @param listener The PHASEListener object that this mixer will use to spatialize sounds.

func (PHASENormalizationMode) String ¶

func (e PHASENormalizationMode) String() string

func (*PHASENumberMetaParameter) FadeToValueDuration ¶

func (o *PHASENumberMetaParameter) FadeToValueDuration(value float64, duration float64)

@method fadeToValue @abstract Fades to a new value over an interval of time @param value The new destination value to fade to @param duration The length of time it takes to arrive at the destination value

func (*PHASENumberMetaParameter) Maximum ¶

func (o *PHASENumberMetaParameter) Maximum() float64

@property maximum @abstract The maximum value this metaparameter can be set to

func (*PHASENumberMetaParameter) Minimum ¶

func (o *PHASENumberMetaParameter) Minimum() float64

@property minimum @abstract The minimum value this metaparameter can be set to

func (*PHASENumberMetaParameterDefinition) InitWithValue ¶

func (o *PHASENumberMetaParameterDefinition) InitWithValue(value float64) *PHASENumberMetaParameterDefinition

@method initWithValue @abstract Create a new numeric metaparameter definition @param value The initial value of the metaparameter @return The new PHASENumberMetaParameterDefinition object

func (*PHASENumberMetaParameterDefinition) InitWithValueIdentifier ¶

func (o *PHASENumberMetaParameterDefinition) InitWithValueIdentifier(value float64, identifier *foundation.NSString) *PHASENumberMetaParameterDefinition

@method initWithValue:identifier @abstract Create a new numeric metaparameter definition @param value The initial value of the metaparameter @param identifier An optional custom identifier to give to this object @return The new PHASENumberMetaParameterDefinition object

func (*PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximum ¶

func (o *PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximum(value float64, minimum float64, maximum float64) *PHASENumberMetaParameterDefinition

@method initWithValue:minimum:maximum @abstract Create a new numeric metaparameter definition and a predefined min and maximum range @param value The initial value of the metaparameter @param minimum The minimum value for this metaparameter. Values set to this metaparamter less than the minimum will be clamped. @param maximum The maximum value for this metaparameter. Values set to this metaparamter less than the minimum will be clamped. @return The new PHASENumberMetaParameterDefinition object

func (*PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximumIdentifier ¶

func (o *PHASENumberMetaParameterDefinition) InitWithValueMinimumMaximumIdentifier(value float64, minimum float64, maximum float64, identifier *foundation.NSString) *PHASENumberMetaParameterDefinition

@method initWithValue:minimum:maximum:identifier @abstract Create a new numeric metaparameter definition and a predefined min and maximum range @param value The initial value of the metaparameter @param minimum The minimum value for this metaparameter. Values set to this metaparamter less than the minimum will be clamped. @param maximum The maximum value for this metaparameter. Values set to this metaparamter less than the minimum will be clamped. @param identifier An optional custom identifier to give to this object @return The new PHASENumberMetaParameterDefinition object

func (*PHASENumberMetaParameterDefinition) Maximum ¶

func (o *PHASENumberMetaParameterDefinition) Maximum() float64

@property maximum @abstract The readonly maximum that this metaparameter definition was initialized with

func (*PHASENumberMetaParameterDefinition) Minimum ¶

func (o *PHASENumberMetaParameterDefinition) Minimum() float64

@property minimum @abstract The readonly minimum that this metaparameter definition was initialized with

func (*PHASENumericPair) First ¶

func (o *PHASENumericPair) First() float64

@property first @abstract The first value in the numeric pair. @discussion The default value is 0.0.

func (*PHASENumericPair) InitWithFirstValueSecondValue ¶

func (o *PHASENumericPair) InitWithFirstValueSecondValue(first float64, second float64) *PHASENumericPair

@method initWithFirstValue:secondValue @abstract Initialize a numeric pair with a first and second value. @param first The first value in the pair. @param second The second value in the pair. @return A new pair.

func (*PHASENumericPair) Second ¶

func (o *PHASENumericPair) Second() float64

@property second @abstract The second value in the numeric pair. @discussion The default value is 0.0.

func (*PHASENumericPair) SetFirst ¶

func (o *PHASENumericPair) SetFirst(first float64)

func (*PHASENumericPair) SetSecond ¶

func (o *PHASENumericPair) SetSecond(second float64)

func (*PHASEObject) AddChildError ¶

func (o *PHASEObject) AddChildError(child *PHASEObject) (bool, error)

@method addChild:error: @abstract Add a child to this object @param child The child object @param error Returns an error if the child already has a parent. @return YES for success

func (*PHASEObject) Children ¶

func (o *PHASEObject) Children() *foundation.NSArray[*PHASEObject]

@property children @abstract The children of this object.

func (*PHASEObject) InitWithEngine ¶

func (o *PHASEObject) InitWithEngine(engine *PHASEEngine) *PHASEObject

@method initWithEngine: @abstract Initialize a new object.

func (*PHASEObject) Parent ¶

func (o *PHASEObject) Parent() *PHASEObject

@property parent @abstract The parent of this object, or nil if this object doesn't have a parent object.

func (*PHASEObject) RemoveChild ¶

func (o *PHASEObject) RemoveChild(child *PHASEObject)

@method removeChild: @abstract Remove a child from this object.

func (*PHASEObject) RemoveChildren ¶

func (o *PHASEObject) RemoveChildren()

@method removeChildren @abstract Remove all the children from this object

func (*PHASEObject) SetTransform ¶

func (o *PHASEObject) SetTransform(transform unsafe.Pointer)

func (*PHASEObject) SetWorldTransform ¶

func (o *PHASEObject) SetWorldTransform(worldTransform unsafe.Pointer)

func (*PHASEObject) Transform ¶

func (o *PHASEObject) Transform() unsafe.Pointer

@property transform @abstract The object's transform. @note The transform must have orthogonal basis vectors and uniform scale.

func (*PHASEObject) WorldTransform ¶

func (o *PHASEObject) WorldTransform() unsafe.Pointer

@property worldTransform @abstract The world transform applied to the object. @note The transform must have orthogonal basis vectors and uniform scale.

func (*PHASEOccluder) InitWithEngineShapes ¶

func (o *PHASEOccluder) InitWithEngineShapes(engine *PHASEEngine, shapes *foundation.NSArray[*PHASEShape]) *PHASEOccluder

@method initWithEngine:shapes: @abstract Initialize a new occluder with shapes. @discussion The shapes array cannot be empty, otherwise an exception is thrown. @note This function is thread-safe. Clients can safely run this function to create multiple occluders from multiple threads, if required.

func (*PHASEOccluder) Shapes ¶

func (o *PHASEOccluder) Shapes() *foundation.NSArray[*PHASEShape]

func (PHASEPlaybackMode) String ¶

func (e PHASEPlaybackMode) String() string

func (*PHASEPullStreamNode) RenderBlock ¶

func (o *PHASEPullStreamNode) RenderBlock() objc.Block

func (*PHASEPullStreamNode) SetRenderBlock ¶

func (o *PHASEPullStreamNode) SetRenderBlock(renderBlock func(*bool, *coreaudiotypes.AudioTimeStamp, uint32, *coreaudiotypes.AudioBufferList) int)

func (*PHASEPullStreamNodeDefinition) Format ¶

func (o *PHASEPullStreamNodeDefinition) Format() *avfaudio.AVAudioFormat

@property format @abstract The readonly property that returns the AVAudioFormat that this stream was initialized with

func (*PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormat ¶

func (o *PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormat(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat) *PHASEPullStreamNodeDefinition

@method initWithMixerDefinition:format @abstract Create a pull stream node definition @param mixerDefinition The mixer definition this stream will be assigned to @param format The AVAudioFormat object that will define the attributes of the audio this node will accept. Only Core Audio's standard deinterleaved 32-bit floating-point formats are supported. @return A new PHASEPullStreamNodeDefinition object

func (*PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier ¶

func (o *PHASEPullStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat, identifier *foundation.NSString) *PHASEPullStreamNodeDefinition

@method initWithMixerDefinition:format:identifier @abstract Create a pull stream node definition @param mixerDefinition The mixer definition this stream will be assigned to @param format The AVAudioFormat object that will define the attributes of the audio this node will accept. Only Core Audio's standard deinterleaved 32-bit floating-point formats are supported. @param identifier An optional custom identifier to give to this object @return A new PHASEPullStreamNodeDefinition object

func (*PHASEPullStreamNodeDefinition) Normalize ¶

func (o *PHASEPullStreamNodeDefinition) Normalize() bool

@property normalize @abstract Determines whether or not the engine should normalize the stream. The default value is NO. @discussion In general, clients are advised to normalize the input. Normalization is required to properly calibrate the output level. If you set this value to NO, it's advised that you do custom normalization of the audio data prior to passing the buffers to PHASE.

func (*PHASEPullStreamNodeDefinition) SetNormalize ¶

func (o *PHASEPullStreamNodeDefinition) SetNormalize(normalize bool)

func (PHASEPushStreamBufferOptions) String ¶

func (e PHASEPushStreamBufferOptions) String() string

func (PHASEPushStreamCompletionCallbackCondition) String ¶

func (e PHASEPushStreamCompletionCallbackCondition) String() string

func (*PHASEPushStreamNode) ScheduleBuffer ¶

func (o *PHASEPushStreamNode) ScheduleBuffer(buffer *avfaudio.AVAudioPCMBuffer)

@method scheduleBuffer @abstract Schedule a buffer for playback. @param buffer The buffer with PCM audio data. @discussion Schedules the buffer to be played following any previously scheduled buffer(s). The buffer format must be same as format specified during player instantiation

func (*PHASEPushStreamNode) ScheduleBufferAtTimeOptions ¶

func (o *PHASEPushStreamNode) ScheduleBufferAtTimeOptions(buffer *avfaudio.AVAudioPCMBuffer, when *avfaudio.AVAudioTime, options PHASEPushStreamBufferOptions)

@method scheduleBuffer:atTime:options: @abstract Schedule a buffer for playback at a given time. @discussion The buffer format must be same as format specified during player instantiation @param buffer The buffer with PCM audio data. @param when The time at which to play the buffer. @param options Options for looping, interrupting other buffers, etc.

func (*PHASEPushStreamNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler ¶

func (o *PHASEPushStreamNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler(buffer *avfaudio.AVAudioPCMBuffer, when *avfaudio.AVAudioTime, options PHASEPushStreamBufferOptions, completionCallbackType PHASEPushStreamCompletionCallbackCondition, completionHandler func(PHASEPushStreamCompletionCallbackCondition))

@method scheduleBuffer:atTime:options:completionCallbackType:completionHandler: @abstract Schedule a buffer for playback at a given time. @discussion The buffer format must be same as format specified during player instantiation @param buffer The buffer with PCM audio data. @param when The time at which to play the buffer. @param options Options for looping, interrupting other buffers, etc. @param completionCallbackType Option to specify when the completion handler must be called. @param completionHandler The completionHandler to be called as per the callback type specified or when the player is stopped, at which point the buffer can be recycled.

func (*PHASEPushStreamNode) ScheduleBufferCompletionCallbackTypeCompletionHandler ¶

func (o *PHASEPushStreamNode) ScheduleBufferCompletionCallbackTypeCompletionHandler(buffer *avfaudio.AVAudioPCMBuffer, completionCallbackType PHASEPushStreamCompletionCallbackCondition, completionHandler func(PHASEPushStreamCompletionCallbackCondition))

@method scheduleBuffer:completionCallbackType:completionHandler: @abstract Schedule a buffer for playback. @discussion Schedules the buffer to be played following any previously scheduled buffer(s). The buffer format must be same as format specified during player instantiation @param buffer The buffer with PCM audio data. @param completionCallbackType Option to specify when the completion handler must be called. @param completionHandler The completionHandler to be called as per the specified completion callback type or when the player is stopped, at which point the buffer can be recycled.

func (*PHASEPushStreamNodeDefinition) Format ¶

func (o *PHASEPushStreamNodeDefinition) Format() *avfaudio.AVAudioFormat

@property format @abstract The readonly property that returns the AVAudioFormat that this stream was initialized with

func (*PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormat ¶

func (o *PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormat(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat) *PHASEPushStreamNodeDefinition

@method initWithMixerDefinition:format @abstract Create a push stream node definition @param mixerDefinition The mixer definition this stream will be assigned to @param format The AVAudioFormat object that will define the attributes of the audio this node will accept. Only Core Audio's standard deinterleaved 32-bit floating-point formats are supported. @return A new PHASEPushStreamNodeDefinition object

func (*PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier ¶

func (o *PHASEPushStreamNodeDefinition) InitWithMixerDefinitionFormatIdentifier(mixerDefinition *PHASEMixerDefinition, format *avfaudio.AVAudioFormat, identifier *foundation.NSString) *PHASEPushStreamNodeDefinition

@method initWithMixerDefinition:format:identifier @abstract Create a push stream node definition @param mixerDefinition The mixer definition this stream will be assigned to @param format The AVAudioFormat object that will define the attributes of the audio this node will accept. Only Core Audio's standard deinterleaved 32-bit floating-point formats are supported. @param identifier An optional custom identifier to give to this object @return A new PHASEPushStreamNodeDefinition object

func (*PHASEPushStreamNodeDefinition) Normalize ¶

func (o *PHASEPushStreamNodeDefinition) Normalize() bool

@property normalize @abstract Determines whether or not the engine should normalize the stream. The default value is NO. @discussion In general, clients are advised to normalize the input. Normalization is required to properly calibrate the output level. If you set this value to NO, it's advised that you do custom normalization of the audio data prior to passing the buffers to PHASE.

func (*PHASEPushStreamNodeDefinition) SetNormalize ¶

func (o *PHASEPushStreamNodeDefinition) SetNormalize(normalize bool)

func (*PHASERandomNodeDefinition) AddSubtreeWeight ¶

func (o *PHASERandomNodeDefinition) AddSubtreeWeight(subtree *PHASESoundEventNodeDefinition, weight *foundation.NSNumber)

@method addSubtree @abstract Add a subtree to a random node @param subtree A PHASESoundEventNodeDefinition that will be a child node of this random node @param weight The probability weight of this subtree. Higher numbers compared to other subtree weights will increase the likelihood of being chosen. This value must be greater than or equal to 1, and is clamped otherwise.

func (*PHASERandomNodeDefinition) Init ¶

func (o *PHASERandomNodeDefinition) Init() *PHASERandomNodeDefinition

@method init @abstract Create a random node definition @return A new PHASERandomNodeDefinition object

func (*PHASERandomNodeDefinition) InitWithIdentifier ¶

func (o *PHASERandomNodeDefinition) InitWithIdentifier(identifier *foundation.NSString) *PHASERandomNodeDefinition

@method initWithIdentifier @abstract Create a random node definition @param identifier An optional custom identifier to give to this object @return A new PHASERandomNodeDefinition object

func (*PHASERandomNodeDefinition) SetUniqueSelectionQueueLength ¶

func (o *PHASERandomNodeDefinition) SetUniqueSelectionQueueLength(uniqueSelectionQueueLength int)

func (*PHASERandomNodeDefinition) UniqueSelectionQueueLength ¶

func (o *PHASERandomNodeDefinition) UniqueSelectionQueueLength() int

func (PHASERenderingState) String ¶

func (e PHASERenderingState) String() string

func (PHASEReverbPreset) String ¶

func (e PHASEReverbPreset) String() string

func (*PHASESamplerNodeDefinition) AssetIdentifier ¶

func (o *PHASESamplerNodeDefinition) AssetIdentifier() *foundation.NSString

@property assetIdentifier @abstract The identifier that uniquely represents the registered sound asset this sampler will play.

func (*PHASESamplerNodeDefinition) CullOption ¶

func (o *PHASESamplerNodeDefinition) CullOption() PHASECullOption

@property cullOption @abstract The cull option for the sampler. @discussion The default value is PHASECullOptionTerminate.

func (*PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinition ¶

func (o *PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinition(soundAssetIdentifier *foundation.NSString, mixerDefinition *PHASEMixerDefinition) *PHASESamplerNodeDefinition

@method initWithSoundAssetIdentifier:mixerDefinition @abstract Create a sampler node definition @param soundAssetIdentifier The identifier of the registered sound asset this sampler will play @param mixerDefinition The mixer definition this sampler will be assigned to @return A new PHASESamplerNodeDefinition object

func (*PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinitionIdentifier ¶

func (o *PHASESamplerNodeDefinition) InitWithSoundAssetIdentifierMixerDefinitionIdentifier(soundAssetIdentifier *foundation.NSString, mixerDefinition *PHASEMixerDefinition, identifier *foundation.NSString) *PHASESamplerNodeDefinition

@method initWithSoundAssetIdentifier:mixerDefinition:identifier @abstract Create a sampler node definition @param soundAssetIdentifier The identifier of the registered sound asset this sampler will play @param mixerDefinition The mixer definition this sampler will be assigned to @param identifier An optional custom identifier to give to this object @return A new PHASESamplerNodeDefinition object

func (*PHASESamplerNodeDefinition) PlaybackMode ¶

func (o *PHASESamplerNodeDefinition) PlaybackMode() PHASEPlaybackMode

@property playbackMode @abstract The playback mode for the sampler. @discussion If the playback mode is set to PHASEPlaybackModeOneShot, you need to make sure the the audio data in the registered sound asset associated with this sampler begins and ends at zero crossings. Otherwise, you'll hear a click when beginning playback and / or ending playback. If the playback mode is set to PHASEPlaybackModeLooping, you need to make sure the audio data in the registered sound asset associated with this sampler loops smoothly from the end sample to the start sample. Please verify this during authoring. Failing to do so will result in audible clicks at loop boundaries. The default value is PHASEPlaybackModeOneShot.

func (*PHASESamplerNodeDefinition) SetCullOption ¶

func (o *PHASESamplerNodeDefinition) SetCullOption(cullOption PHASECullOption)

func (*PHASESamplerNodeDefinition) SetPlaybackMode ¶

func (o *PHASESamplerNodeDefinition) SetPlaybackMode(playbackMode PHASEPlaybackMode)

func (*PHASEShape) Elements ¶

func (o *PHASEShape) Elements() *foundation.NSArray[*PHASEShapeElement]

func (*PHASEShape) InitWithEngineMesh ¶

func (o *PHASEShape) InitWithEngineMesh(engine *PHASEEngine, mesh *modelio.MDLMesh) *PHASEShape

@method initWithEngine:mesh @abstract Initialize a shape from a mesh. @discussion One PHASEShapeElement will be created for every submesh within the mesh. @note A single shape can be used to create multiple instances of sources and occluders. For example, a client could create a single shape for a window, then create multiple occluders from it. The same can be done with with sources. @param engine The engine this shape will be used with. @param mesh A Model I/O mesh object. @return A new shape object

func (*PHASEShape) InitWithEngineMeshMaterials ¶

func (o *PHASEShape) InitWithEngineMeshMaterials(engine *PHASEEngine, mesh *modelio.MDLMesh, materials *foundation.NSArray[*PHASEMaterial]) *PHASEShape

@method initWithEngine:mesh @abstract Initialize a shape from an MDLMesh and a list of materials @param engine The engine this shape will be used with @param mesh A Model I/O mesh object. @param materials An array of PHASEMaterial objects that overrides any acoustical materials within the mesh object @return A new shape object @discussion The materials array cannot be empty and cannot contain nil entries, otherwise an exception is thrown. If the number of submeshes within the mesh are less than or equal to the size of the material array, the material will be assigned to the corresponding element. If the number of submeshes within the mesh is greater than the size of the material array, the material assigned to the element will be the index of the element modulo the number of materials. IE: given a mesh with 6 submeshes and an array of 3 materials, the element at index 5 will be assigned the material at index: 5 % 3 = 2.

func (*PHASEShapeElement) Material ¶

func (o *PHASEShapeElement) Material() *PHASEMaterial

func (*PHASEShapeElement) SetMaterial ¶

func (o *PHASEShapeElement) SetMaterial(material *PHASEMaterial)

func (*PHASESoundAsset) Data ¶

func (o *PHASESoundAsset) Data() *foundation.NSData

@property data @abstract The buffer for the sound asset, if applicable.

func (*PHASESoundAsset) Type ¶

func (o *PHASESoundAsset) Type() PHASEAssetType

@property type @abstract The sound asset type.

func (*PHASESoundAsset) Url ¶

func (o *PHASESoundAsset) Url() *foundation.NSURL

@property url @abstract The URL of the sound asset, if applicable.

func (*PHASESoundEvent) InitWithEngineAssetIdentifierError ¶

func (o *PHASESoundEvent) InitWithEngineAssetIdentifierError(engine *PHASEEngine, assetIdentifier *foundation.NSString) (*PHASESoundEvent, error)

@method initWithEngine:assetIdentifier:error @abstract Creates a new sound event instance @param engine The PHASEEngine object that the sound event will be played by. @param assetIdentifier The identifier registered with the Asset Registry for the particular PHASESoundEventNodeAsset that this sound event will play. If the asset identifier is not registered, this function will fail. @discussion This will look up the asset in the asset registry and create the necessary objects to play the sound event

func (*PHASESoundEvent) InitWithEngineAssetIdentifierMixerParametersError ¶

func (o *PHASESoundEvent) InitWithEngineAssetIdentifierMixerParametersError(engine *PHASEEngine, assetIdentifier *foundation.NSString, mixerParameters *PHASEMixerParameters) (*PHASESoundEvent, error)

@method initWithEngine:assetIdentifier:mixerParameters:error @abstract Creates a new sound event instance @param engine The PHASEEngine object that the sound event will be played by. @param assetIdentifier The identifier registered with the Asset Registry for the particular PHASESoundEventNodeAsset that this sound instance will play. If the asset identifier is not registered, this function will fail. @param mixerParameters A dictionary of PHASEMixerParameters objects with keys that match the identifiers of the spatial mixers in the sound event @discussion This will look up the asset in the asset registry and create the necessary objects to play the sound event

func (*PHASESoundEvent) IsIndefinite ¶

func (o *PHASESoundEvent) IsIndefinite() bool

@property indefinite @abstract A boolean that tell if this sound event will run indefinitely, or finish executing on its own

func (*PHASESoundEvent) MetaParameters ¶

func (o *PHASESoundEvent) MetaParameters() *foundation.NSDictionary[*foundation.NSString, *PHASEMetaParameter]

@property metaParameters @abstract A Dictionary containing the MetaParameters associated with this sound event

func (*PHASESoundEvent) Mixers ¶

func (o *PHASESoundEvent) Mixers() *foundation.NSDictionary[*foundation.NSString, *PHASEMixer]

@property mixNodes @abstract A Dictionary containing the mix nodes associated with this sound event

func (*PHASESoundEvent) Pause ¶

func (o *PHASESoundEvent) Pause()

@method pause @abstract Pause the sound event.

func (*PHASESoundEvent) PrepareState ¶

func (o *PHASESoundEvent) PrepareState() PHASESoundEventPrepareState

@property prepareState @abstract Sound Event's current preparation state

func (*PHASESoundEvent) PrepareWithCompletion ¶

func (o *PHASESoundEvent) PrepareWithCompletion(handler func(PHASESoundEventPrepareHandlerReason))

@method prepareWithCompletion @abstract Prepare the sound event @param handler The block that will be called when the PHASESoundEvent has finished preparing and is ready to start. Pass in nil for no handler. @discussion This function notifies the engine to begin preparing a sound event, then returns immediately. Once the sound event is prepared (or has failed to prepare), you will receive a callback via the completion. If you call startWithCompletion() before receiving the callback, the sound event will start as soon as it's prepared.

func (*PHASESoundEvent) PullStreamNodes ¶

func (o *PHASESoundEvent) PullStreamNodes() *foundation.NSDictionary[*foundation.NSString, *PHASEPullStreamNode]

@property pullStreamNodes @abstract A Dictionary containing the pull stream nodes associated with this sound event, for setting renderBlocks on.

func (*PHASESoundEvent) PushStreamNodes ¶

func (o *PHASESoundEvent) PushStreamNodes() *foundation.NSDictionary[*foundation.NSString, *PHASEPushStreamNode]

@property pushStreamNodes @abstract A Dictionary containing the push stream nodes associated with this sound event, for pushing buffers to.

func (*PHASESoundEvent) RenderingState ¶

func (o *PHASESoundEvent) RenderingState() PHASERenderingState

@property renderingState @abstract Sound Event's current rendering state

func (*PHASESoundEvent) Resume ¶

func (o *PHASESoundEvent) Resume()

@method resume @abstract Resume the sound event.

func (*PHASESoundEvent) ResumeAtTime ¶

func (o *PHASESoundEvent) ResumeAtTime(time_ *avfaudio.AVAudioTime)

@method resumeAtTime @abstract Resume the sound event at a specific time @param time The desired start time based on the engine time retrieved from [PHASEEngine lastRenderTime] @discussion A nil time parameter will resume immediately. The device time is not scaled by UnitsPerSecond and is in seconds.

func (*PHASESoundEvent) SeekToTimeCompletion ¶

func (o *PHASESoundEvent) SeekToTimeCompletion(time_ float64, handler func(PHASESoundEventSeekHandlerReason))

@method seekToTime:completion @abstract Seeks all leaf nodes in a PHASESoundEvent to a specified time relative to the start of the sound event. @discussion This function notifies the engine to seek the sound event, then returns immediately. Once the sound event has seeked to the new offset (or has failed to seek), you will receive a callback via the completion. If any leaf nodes do not support seeking, those nodes will ignore this command. Nodes that have finished playing or have stopped will not seek. Nodes that are sleeping will seek, and will resume at the correct time when they wake up. @note The time is scaled by unitsPerSecond internally, so can be provided at the client's native time scale.

func (*PHASESoundEvent) SeekToTimeResumeAtEngineTimeCompletion ¶

func (o *PHASESoundEvent) SeekToTimeResumeAtEngineTimeCompletion(time_ float64, engineTime *avfaudio.AVAudioTime, handler func(PHASESoundEventSeekHandlerReason))

@method seekToTime:resumeAtEngineTime:completion @abstract Seeks all leaf nodes in a PHASESoundEvent to the specified time, and automatically resumes playback at the specified engine time. @param time The desired time position in seconds to seek the nodes to. @param engineTime The engine time to resume playback. @param handler The completion callback that will be called when seeking is complete. @discussion This is a low latency convenience method that allows for tight deadlines to be met. However if the seek fails the node state will not be changed. You should check the callback and handle the failure appropriately. The time parameter will seek the nodes to the equivalent sample position based on the sample rate of the asset. The engineTime parameter is the engine timestamp to resume rendering at, based off of [PHASEEngine lastRenderTime]. If any leaf nodes do not support seeking, those nodes will ignore this command. Nodes that have finished playing or have stopped will not seek. The time parameter is in seconds and will be scaled by unitsPerSecond. The time in the AVAudioTime structure is not scaled by unitsPerSecond. The engineTime parameter will use the sample time if valid, if not, then the host time if valid.

func (*PHASESoundEvent) StartAtTimeCompletion ¶

func (o *PHASESoundEvent) StartAtTimeCompletion(when *avfaudio.AVAudioTime, handler func(PHASESoundEventStartHandlerReason))

@method startAtTime:completion @abstract Start the sound event @param when The desired start time based on the engine time retrieved from [PHASEEngine lastRenderTime] If the sound event starts immediately with an audible sound, it will begin rendering at this time. The sound event will otherwise begin operating at this time. A nil value will start the sound event immediately This time is not scaled by unitsPerSecond. @param handler The block that will be called when the sound event has stopped. @discussion This function notifies the engine to start the sound event, then returns immediately. Once the sound event is playing (or has failed to start), you will receive a callback via the completion. Playback will begin at the requested time if the sound event has finished preparing in time. You may wait for preparation to finish with the [PHASESoundEvent prepare:completion] method before calling startAtTime, to ensure that the sound event will start at the desired time. However if the desired time is far enough into the future to allow for preparation to happen, you may skip calling prepare entirely and just call startAtTime.

func (*PHASESoundEvent) StartWithCompletion ¶

func (o *PHASESoundEvent) StartWithCompletion(handler func(PHASESoundEventStartHandlerReason))

@method startWithCompletion @abstract Start the sound event @param handler The block that will be called when the sound event has stopped. @discussion This function notifies the engine to start the sound event, then returns immediately. Once the sound event is playing (or has failed to start), you will receive a callback via the completion. Playback will begin immediately if the sound event has been prepared; otherwise, it will start as soon as it is finished preparing.

func (*PHASESoundEvent) StopAndInvalidate ¶

func (o *PHASESoundEvent) StopAndInvalidate()

@method stopAndInvalidate @abstract stop and invalidate the sound event

func (PHASESoundEventError) String ¶

func (e PHASESoundEventError) String() string

func (*PHASESoundEventNodeDefinition) Children ¶

func (o *PHASESoundEventNodeDefinition) Children() *foundation.NSArray[*PHASESoundEventNodeDefinition]

func (PHASESoundEventPrepareHandlerReason) String ¶

func (e PHASESoundEventPrepareHandlerReason) String() string

func (PHASESoundEventPrepareState) String ¶

func (e PHASESoundEventPrepareState) String() string

func (PHASESoundEventSeekHandlerReason) String ¶

func (e PHASESoundEventSeekHandlerReason) String() string

func (PHASESoundEventStartHandlerReason) String ¶

func (e PHASESoundEventStartHandlerReason) String() string

func (*PHASESource) Gain ¶

func (o *PHASESource) Gain() float64

@property gain @abstract Linear gain scalar. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASESource) InitWithEngine ¶

func (o *PHASESource) InitWithEngine(engine *PHASEEngine) *PHASESource

@method initWithEngine: @abstract Initialize a new point source.

func (*PHASESource) InitWithEngineShapes ¶

func (o *PHASESource) InitWithEngineShapes(engine *PHASEEngine, shapes *foundation.NSArray[*PHASEShape]) *PHASESource

@method initWithEngine:shapes: @abstract Initialize a new volumetric source with shapes. @param shapes The shape(s) of the source within the world @discussion The shapes array cannot be empty, otherwise an exception is thrown. @note This function is thread-safe. Clients can safely run this function to create multiple sources from multiple threads, if required.

func (*PHASESource) SetGain ¶

func (o *PHASESource) SetGain(gain float64)

func (*PHASESource) Shapes ¶

func (o *PHASESource) Shapes() *foundation.NSArray[*PHASEShape]

@property shapes @abstract Array of shapes associated with this source.

func (*PHASESpatialMixerDefinition) DistanceModelParameters ¶

func (o *PHASESpatialMixerDefinition) DistanceModelParameters() *PHASEDistanceModelParameters

@property distanceModelParameters @abstract Distance model parameters (optional).

func (*PHASESpatialMixerDefinition) InitWithSpatialPipeline ¶

func (o *PHASESpatialMixerDefinition) InitWithSpatialPipeline(spatialPipeline *PHASESpatialPipeline) *PHASESpatialMixerDefinition

@method initWithSpatialPipeline @abstract Create a new PHASESpatialMixerDefinition @param spatialPipeline A spatial pipeline. @return A new PHASESpatialMixerDefinition object

func (*PHASESpatialMixerDefinition) InitWithSpatialPipelineIdentifier ¶

func (o *PHASESpatialMixerDefinition) InitWithSpatialPipelineIdentifier(spatialPipeline *PHASESpatialPipeline, identifier *foundation.NSString) *PHASESpatialMixerDefinition

@method initWithSpatialPipeline:identifier @abstract Create a new PHASESpatialMixerDefinition @param spatialPipeline A spatial pipeline. @param identifier An optional custom identifier to give to this object @return A new PHASESpatialMixerDefinition object

func (*PHASESpatialMixerDefinition) ListenerDirectivityModelParameters ¶

func (o *PHASESpatialMixerDefinition) ListenerDirectivityModelParameters() *PHASEDirectivityModelParameters

@property listenerDirectivityModelParameters @abstract Listener directivity model parameters (optional).

func (*PHASESpatialMixerDefinition) SetDistanceModelParameters ¶

func (o *PHASESpatialMixerDefinition) SetDistanceModelParameters(distanceModelParameters *PHASEDistanceModelParameters)

func (*PHASESpatialMixerDefinition) SetListenerDirectivityModelParameters ¶

func (o *PHASESpatialMixerDefinition) SetListenerDirectivityModelParameters(listenerDirectivityModelParameters *PHASEDirectivityModelParameters)

func (*PHASESpatialMixerDefinition) SetSourceDirectivityModelParameters ¶

func (o *PHASESpatialMixerDefinition) SetSourceDirectivityModelParameters(sourceDirectivityModelParameters *PHASEDirectivityModelParameters)

func (*PHASESpatialMixerDefinition) SourceDirectivityModelParameters ¶

func (o *PHASESpatialMixerDefinition) SourceDirectivityModelParameters() *PHASEDirectivityModelParameters

@property sourceDirectivityModelParameters @abstract Source directivity model parameters (optional).

func (*PHASESpatialMixerDefinition) SpatialPipeline ¶

func (o *PHASESpatialMixerDefinition) SpatialPipeline() *PHASESpatialPipeline

@property spatialPipeline @abstract Spatial Pipeline.

func (*PHASESpatialPipeline) Entries ¶

func (o *PHASESpatialPipeline) Entries() *foundation.NSDictionary[*foundation.NSString, *PHASESpatialPipelineEntry]

@property entries @abstract A dictionary of entries in the Spatial Pipeline. @discussion Upon initialization, an entry will be created for every flag in the PHASESpatialPipelineFlags passed to PHASESpatialPipeline:initWithFlags.

func (*PHASESpatialPipeline) Flags ¶

func (o *PHASESpatialPipeline) Flags() PHASESpatialPipelineFlags

@property flags @abstract Spatial Pipeline Flags.

func (*PHASESpatialPipeline) InitWithFlags ¶

func (o *PHASESpatialPipeline) InitWithFlags(flags PHASESpatialPipelineFlags) *PHASESpatialPipeline

@method initWithFlags @abstract Initialize a Spatial Pipeline with the provided flags. @discussion It's invalid to pass flags == 0 to this function. Doing so will return nil. @param flags Options for direct path transmission, early reflections, late reverb, etc.

func (*PHASESpatialPipelineEntry) SendLevel ¶

func (o *PHASESpatialPipelineEntry) SendLevel() float64

@property sendLevel @abstract Send level. @note Values are clamped to the range [0, 1]. Default value is 1.

func (*PHASESpatialPipelineEntry) SendLevelMetaParameterDefinition ¶

func (o *PHASESpatialPipelineEntry) SendLevelMetaParameterDefinition() *PHASENumberMetaParameterDefinition

@property sendLevelMetaParameterDefinition @abstract An optional metaparameter used to drive the send level during playback.

func (*PHASESpatialPipelineEntry) SetSendLevel ¶

func (o *PHASESpatialPipelineEntry) SetSendLevel(sendLevel float64)

func (*PHASESpatialPipelineEntry) SetSendLevelMetaParameterDefinition ¶

func (o *PHASESpatialPipelineEntry) SetSendLevelMetaParameterDefinition(sendLevelMetaParameterDefinition *PHASENumberMetaParameterDefinition)

func (PHASESpatialPipelineFlags) String ¶

func (e PHASESpatialPipelineFlags) String() string

func (PHASESpatializationMode) String ¶

func (e PHASESpatializationMode) String() string

func (*PHASEStreamNode) Format ¶

func (o *PHASEStreamNode) Format() *avfaudio.AVAudioFormat

@property format @abstract The readonly property that returns the AVAudioFormat that this stream was initialized with.

func (*PHASEStreamNode) GainMetaParameter ¶

func (o *PHASEStreamNode) GainMetaParameter() *PHASENumberMetaParameter

@property gainMetaParameter @abstract If specified during construction, the metaparameter for controlling gain will be available here

func (*PHASEStreamNode) Mixer ¶

func (o *PHASEStreamNode) Mixer() *PHASEMixer

@property mixer @abstract The readonly property that returns the PHASEMixer this stream was created with and assigned to.

func (*PHASEStreamNode) RateMetaParameter ¶

func (o *PHASEStreamNode) RateMetaParameter() *PHASENumberMetaParameter

@property rateMetaParameter @abstract If specified during construction, the metaparameter for controlling rate/pitch will be available here

func (*PHASEStringMetaParameterDefinition) InitWithValue ¶

func (o *PHASEStringMetaParameterDefinition) InitWithValue(value *foundation.NSString) *PHASEStringMetaParameterDefinition

@method initWithValue @abstract Create a new string metaparameter definition @param value The initial value of the metaparameter @return The new PHASEStringMetaParameterDefinition object

func (*PHASEStringMetaParameterDefinition) InitWithValueIdentifier ¶

func (o *PHASEStringMetaParameterDefinition) InitWithValueIdentifier(value *foundation.NSString, identifier *foundation.NSString) *PHASEStringMetaParameterDefinition

@method initWithValue:identifier @abstract Create a new string metaparameter definition @param value The initial value of the metaparameter @param identifier An optional custom identifier to give to this object @return The new PHASEStringMetaParameterDefinition object

func (*PHASESwitchNodeDefinition) AddSubtreeSwitchValue ¶

func (o *PHASESwitchNodeDefinition) AddSubtreeSwitchValue(subtree *PHASESoundEventNodeDefinition, switchValue *foundation.NSString)

@method addSubtree @abstract Add a subtree to a switch node @param subtree A PHASESoundEventNodeDefinition that will be a child node of this switch node @param switchValue A string value that the metaparameter will use to activate this subtree

func (*PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinition ¶

func (o *PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinition(switchMetaParameterDefinition *PHASEStringMetaParameterDefinition) *PHASESwitchNodeDefinition

@method initWithSwitchMetaParameterDefinition @abstract Create a switch node definition @param switchMetaParameterDefinition A metaparameter definition that wil be used to control the parameter of the switch node at runtime. @return A new PHASESwitchNodeDefinition object

func (*PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinitionIdentifier ¶

func (o *PHASESwitchNodeDefinition) InitWithSwitchMetaParameterDefinitionIdentifier(switchMetaParameterDefinition *PHASEStringMetaParameterDefinition, identifier *foundation.NSString) *PHASESwitchNodeDefinition

@method initWithSwitchMetaParameterDefinition:identifier @abstract Create a switch node definition @param switchMetaParameterDefinition A metaparameter definition that wil be used to control the parameter of the switch node at runtime. @param identifier An optional custom identifier to give to this object @return A new PHASESwitchNodeDefinition object

func (*PHASESwitchNodeDefinition) SwitchMetaParameterDefinition ¶

func (o *PHASESwitchNodeDefinition) SwitchMetaParameterDefinition() *PHASEStringMetaParameterDefinition

func (PHASEUpdateMode) String ¶

func (e PHASEUpdateMode) String() string

func (PMPageToPaperMappingType) String ¶

func (e PMPageToPaperMappingType) String() string

func (Ptrauth_key) String ¶

func (e Ptrauth_key) String() string

func (Qos_class_t) String ¶

func (e Qos_class_t) String() string

func (Virtual_memory_guard_exception_code_t) String ¶

func (e Virtual_memory_guard_exception_code_t) String() string

func (Xpc_listener_create_flags_t) String ¶

func (e Xpc_listener_create_flags_t) String() string

func (Xpc_session_create_flags_t) String ¶